Skip to content
DashboardWebsite

Configuration

This page helps engineers configure OpenTremor for local development or production. The server reads one YAML file at startup and validates it with Pydantic. Most fields have defaults, but MongoDB settings are required; the server refuses to start without them.

Set the file path with the CONFIG_FILE environment variable. The Compose files and Helm chart set it for you. See Environment Variables.


The minimum config specifies your MongoDB connection. MongoDB is the only storage backend:

storage:
mongodb:
uri: "mongodb://localhost:27017"
database: opentremor

This is a complete, valid config file. Authentication is disabled by default, so no other setup is required. See Quick Start to run your first analysis.

Choose the setup closest to yours:

storage:
mongodb:
uri: "mongodb://localhost:27017" # docker run -d -p 27017:27017 mongo:7.0
database: opentremor_dev

No auth or secrets are needed. The workspace stacks (make up, make up-dev) don’t use this file. They read OpenTremor-deployments/configs/opentremor-local.yaml, which also turns authentication on.


The settings below are optional in development because they use random defaults or the feature is disabled. Set them explicitly in production and share them across replicas:

Set thisViaWhy
storage.mongodb.uriMONGODB_URI env var (don’t put credentials in the YAML)Keeps credentials out of a file that is easy to share; the server refuses to start without MongoDB settings
jwt.secretJWT_SECRET env varThe random per-process default invalidates logged-in sessions after a restart, and replicas can’t validate each other’s sessions
secrets.encryption_keySECRETS_ENCRYPTION_KEY env varThe random default makes stored secrets (LLM credentials, SSO client secrets, notification channels, and the GitHub App key) unreadable across restarts or replicas
auth.api_keyYAML (or omit it and use human registration instead)If left null, the server is wide open: anyone gets owner of the default org
server.public_base_urlPATCH /v1/admin/settings (not YAML — see Platform settings)Without it, reports have no shareable link, emailed links are not sent, and the GitHub manifest flow returns 501
github.app_id/private_key/webhook_secretPATCH /v1/admin/settings (not YAML/env — same reason as above)Only needed if you’re using the operator’s shared GitHub App integration; otherwise leave unset

See Environment Variables for the complete list.