Edictum

Environment Variables

Current environment variables for edictum-api.

AI Assistance

Right page if: you need the current edictum-api environment variables. Wrong page if: you need retired edictum-server variables or Docker Compose setup. Gotcha: the current hosted backend is edictum-api. The old EDICTUM_DATABASE_URL / EDICTUM_REDIS_URL / bootstrap-admin docs were for the retired server stack.

This page documents the current edictum-api environment variables.

Required

VariablePurpose
DATABASE_URLPostgreSQL connection string
API_KEY_SALTDeployment-specific secret used for API key hashing
NOTIFICATION_CONFIG_KEY64 hex characters (32 bytes) used to encrypt notification config at rest

Common Hosted / Production Settings

VariablePurpose
CLERK_SECRET_KEYEnables Clerk-authenticated operator traffic
CLERK_PROXY_URLOptional Clerk proxy origin
EDICTUM_BASE_URLPublic API origin, used for generated callback URLs and origin normalization
EDICTUM_CORS_ORIGINSComma-separated browser origins allowed to call the API
CORS_ALLOWED_ORIGINSLegacy fallback name if EDICTUM_CORS_ORIGINS is unset

Listener / Runtime

VariableDefaultPurpose
HOST127.0.0.1Host for local listen address construction
PORT8080Port for local listen address construction
LISTEN_ADDRHOST:PORTFull listen address override
SHUTDOWN_TIMEOUT10sGraceful shutdown timeout
READ_HEADER_TIMEOUT5sHTTP read-header timeout
APPROVAL_SWEEP_EVERY1mInterval for approval timeout sweep

Notes

  • CLERK_SECRET_KEY is optional in local development, but required for the full hosted human-auth flow.
  • EDICTUM_CORS_ORIGINS should be set to the exact app origins that need browser access.
  • EDICTUM_BASE_URL should be the public API origin, for example https://api.edictum.ai.
  • NOTIFICATION_CONFIG_KEY must be exactly 64 hex characters.

No Longer Current

These variables belonged to the retired edictum-server docs and are not the current public API config surface:

  • EDICTUM_DATABASE_URL
  • EDICTUM_REDIS_URL
  • EDICTUM_ADMIN_EMAIL
  • EDICTUM_ADMIN_PASSWORD
  • EDICTUM_SECRET_KEY
  • EDICTUM_SIGNING_KEY_SECRET

Example .env.local

DATABASE_URL=postgres://edictum:edictum@localhost:5432/edictum?sslmode=disable
API_KEY_SALT=replace-me
PORT=8000
CLERK_SECRET_KEY=sk_test_replace_me
EDICTUM_CORS_ORIGINS=http://localhost:5173
EDICTUM_BASE_URL=http://127.0.0.1:8000
NOTIFICATION_CONFIG_KEY=00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff

Last updated on

On this page