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.
Get started fast
Section titled “Get started fast”The minimum config specifies your MongoDB connection. MongoDB is the only storage backend:
storage: mongodb: uri: "mongodb://localhost:27017" database: opentremorThis 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_devNo 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.
storage: mongodb: uri: "mongodb://mcp_app:secret@mongo:27017/opentremor?authSource=opentremor" database: opentremor
cors: allow_origins: ["https://dashboard.example.com"]
auth: api_key: "my-strong-api-key"Set JWT_SECRET and SECRETS_ENCRYPTION_KEY through environment variables. See the production checklist below.
In the dashboard: Platform Admin → System → General. Set public_base_url and other Platform settings. Or use the API:
curl -X PATCH https://mcp-pack.example.com/v1/admin/settings \ -H "X-API-Key: my-strong-api-key" -H "Content-Type: application/json" \ -d '{"server_public_base_url": "https://mcp-pack.example.com"}'Nothing needs to be configured at the platform level beyond server.public_base_url from “Production” above. GitHub must be able to reach it for the webhook and manifest redirect. There is no platform-wide App.
Each organization creates its own App. An org admin selects the LLM connection, model, and App name in Organization → Connections → GitHub, clicks Create GitHub App, then installs the App on its repositories. See GitHub App Integration.
To accept webhooks only from GitHub’s addresses, use Platform Admin → Connections → GitHub Webhooks. See Expose only the webhook.
Production checklist
Section titled “Production checklist”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 this | Via | Why |
|---|---|---|
storage.mongodb.uri | MONGODB_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.secret | JWT_SECRET env var | The random per-process default invalidates logged-in sessions after a restart, and replicas can’t validate each other’s sessions |
secrets.encryption_key | SECRETS_ENCRYPTION_KEY env var | The random default makes stored secrets (LLM credentials, SSO client secrets, notification channels, and the GitHub App key) unreadable across restarts or replicas |
auth.api_key | YAML (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_url | PATCH /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_secret | PATCH /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.