Skip to content
DashboardWebsite

Environment Variables

Environment variables take precedence over the YAML file. Use them to inject secrets through a Kubernetes Secret, a systemd EnvironmentFile, or Docker --env-file without putting them in the config file.

VariableDefaultDescription
CONFIG_FILESee note belowPath to the YAML config file
HOST0.0.0.0Address the API server binds to
PORT8000Port the API server binds to
RELOADfalseEnables hot reload; use for development
LOG_LEVELinfoLog level at startup. The logging.level platform setting replaces it once the server runs
LOG_FORMATjsonjson: one JSON object per line on stdout. text: readable lines for a terminal. See Logs and Troubleshooting
SENTRY_DSN—Where error reports go: GlitchTip, a self-hosted Sentry, or sentry.io. Empty means no reports are sent. See Error reporting
SENTRY_ENVIRONMENTproductionEnvironment name attached to each error report
SENTRY_TRACES_SAMPLE_RATE0.05Fraction of requests sampled for traces
MONGODB_URI—Overrides storage.mongodb.uri
JWT_SECRET—Overrides jwt.secret; set this in multi-replica or production deployments
TWO_FACTOR_SECRET_KEY—Overrides two_factor.secret_encryption_key; set this in multi-replica or production deployments
SECRETS_ENCRYPTION_KEY—Overrides secrets.encryption_key, which encrypts stored secrets; set this in multi-replica or production deployments
SMTP_PASSWORD—Overrides mail.smtp.password; see Email
AUTH_API_KEY—Overrides auth.api_key, the bootstrap credential. Set this. If unset, authentication is disabled and every caller becomes an anonymous superadmin. See the caution below
DEFAULT_ADMIN_EMAIL—Overrides auth.default_admin_email. Used at first boot to create the initial superadmin; ignored afterwards
DEFAULT_ADMIN_PASSWORD—Overrides auth.default_admin_password. Used at first boot to create the initial superadmin; passwords shorter than 8 characters skip account creation
DEPLOYMENT_MODEself_hostedOverrides deployment.mode (self_hosted or cloud). Identifies this deployment, not an org setting. See Billing / quota enforcement
BACKUP_AGE_RECIPIENTS—Overrides backup.recipients: comma-separated age public keys (age1…) used to encrypt backups. When set, it pins the keys so the dashboard cannot change them. When empty, a platform admin sets them in Platform Admin → System → Backups → Encryption key. See Backups and Restore
BACKUP_LOCAL_DIR/var/lib/opentremor/backupsOverrides backup.local_dir, the directory used to write and keep backups for the local target
JOB_WORKER_ENABLEDtrueOverrides worker.enabled. false stops this process from running queued background jobs; it still enqueues them. See worker
TRUSTED_PROXIES—Overrides network.trusted_proxies: comma-separated IPs or CIDRs for reverse proxies in front of the server. The server trusts X-Forwarded-For only for hops these proxies added. If unset, it ignores the header, so callers appear to come from the proxy. File or environment only
NETWORK_FILTER_ENABLEDtrueOverrides network.filter_enabled. false disables every network access rule. Use it to recover from a lockout. File or environment only
NETWORK_LIST_SOURCES_DIR—Overrides network.list_sources_dir, the directory containing file address lists. If unset, file lists are refused
SERVER_COOKIE_DOMAIN—Seeds server.cookie_domain on first boot; it does not override an existing value. server is platform-managed, so this supports split-domain deployments. PATCH /v1/admin/settings takes precedence after the initial seed

See Full Reference for what each corresponding YAML field controls.


Pydantic validates configuration at startup. Invalid values, such as values of the wrong type or out-of-range numbers, raise an error before the server binds to a port.