Skip to content

Configuration

The server reads a single YAML file at startup, validated by Pydantic. All fields have sensible defaults — a minimal file only needs storage.backend.

Set the path with the CONFIG_FILE environment variable (default: configs/opentremor-core-local.yaml).


The absolute minimum — zero config, in-memory, nothing to install:

storage:
backend: memory

That’s a complete, valid config file. Auth is disabled by default too, so there’s genuinely nothing else to set up — see Quick Start to go from here to your first analysis in a few commands.

Pick the setup closest to yours:

storage:
backend: memory

No database, no auth, no secrets. Data is lost on restart — see In-Memory Backend.


Everything below is optional in dev (random defaults, or the feature is simply disabled) but must be set explicitly — and shared across every replica — once you’re running more than one process or care about surviving a restart:

Set thisViaWhy
storage.mongodb.uriMONGODB_URI env var (don’t put credentials in the YAML)Without it there’s no persistence at all (backend: memory)
jwt.secretJWT_SECRET env varLeft as the random per-process default, every restart invalidates all logged-in sessions, and replicas can’t validate each other’s sessions
llm.credential_encryption_keyLLM_CREDENTIAL_KEY env varLeft as the random default, stored LLM credentials become unreadable across restarts/replicas
auth.api_keyYAML (or omit and use human registration instead)Left null, the server is wide open — anyone gets owner of the default org
server.public_base_urlPATCH /admin/settings (not YAML — see Platform settings)Report links and the GitHub manifest flow otherwise fall back to request headers, or 501
github.app_id/private_key/webhook_secretPATCH /admin/settings (not YAML/env — same reason as above)Only needed if you’re using the platform’s own GitHub App integration — otherwise leave unset

See Environment Variables for the complete list.