Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 991 Bytes

File metadata and controls

44 lines (30 loc) · 991 Bytes

Configuration

midemail supports a universal env-style config file plus environment overrides.

Universal config file

Format: KEY=VALUE

Recommended:

cp midemail.env.example midemail.env

Search order

  1. MIDEMAIL_CONFIG_FILE (explicit path)
  2. ./midemail.env
  3. ./.midemail.env
  4. ./config/midemail.env
  5. /etc/midemail/midemail.env
  6. ~/.config/midemail/midemail.env

Environment variables override file values.

Required keys

  • DATABASE_URL
  • JWT_SECRET

Important groups

  • Core: APP_NAME, NODE_NAME, HTTP_ADDR, REDIS_ADDR
  • SMTP: SMTP_*
  • IMAP: IMAP_*
  • Streams: STREAM_*
  • Worker/orchestrator tuning: WORKER_*, ORCH_*
  • Storage: STORAGE_*, GCS_*, AZURE_*
  • Push: PUSH_*
  • OAuth: GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, GOOGLE_REDIRECT_URL

Best practices

  • Keep secrets in env or secret manager.
  • Keep non-secret defaults in midemail.env.
  • For Kubernetes, keep defaults in ConfigMap and secrets in Secret.