Skip to content

Repository and Development

Ra's al Ghul edited this page Aug 9, 2026 · 1 revision

Repository and Development

Layout

server.js          Main Node.js service
worker.js          Cloudflare Worker entrypoint
lib/               Mail processing, crypto, queue, relay, and provider modules
test/              Node test suite
scripts/setup.js   Interactive configuration generator
Dockerfile         Production container image
docker-compose.yml Local deployment
entrypoint.sh       Container process supervisor

There is no browser frontend in this repository.

Commands

npm install
npm test
npm start
npm run setup
npx wrangler deploy --dry-run
docker compose up -d --build

Contribution guardrails

  • Preserve authenticated inbound webhooks.
  • Preserve ciphertext-only R2 storage and local private-key ownership.
  • Preserve encrypted-at-rest retry files.
  • Keep the SMTP relay disabled and CIDR-restricted by default.
  • Prefer fail-closed spam filtering unless explicitly configured otherwise.
  • Add tests for parsing, cryptography, queues, spam logic, webhook behavior, and provider changes.
  • Never commit live .env files, wrangler.toml with production values, runtime databases, or private keys.

See AGENTS.md and CLAUDE.md for the complete repository instructions.

Clone this wiki locally