Reference
Environment variables
Generated from the source tree by cmd/docsgen. Do not edit: your change would be overwritten on the next run, and the point of this page is that it cannot disagree with the binary.
Configuration is entirely environment variables. There is no config file, and no flag that reads one. This list is generated from the os.Getenv calls in the binary, so it cannot name a variable the code does not read.
Not everything the binary reads is listed. Test switches and hosted-mode flags are deliberately withheld: publishing them would offer configuration nobody supports. Every variable in the source carries an explicit classification, and an unclassified one fails the build rather than defaulting either way.
Keys you must back up
These two are not ordinary configuration. Each is a root key that other secrets are sealed against: lose it and the data sealed with it is permanently unopenable, with no recovery path. Back them up before you store anything with them.
| Variable | What depends on it |
|---|---|
GARBOARD_SECRET_KEY | The envelope root key. Every per-org secret is sealed against it — most visibly an organisation's SSO client secret. Without it set, an admin cannot save an identity provider at all. |
GARBOARD_KMS_KEY_ID | Selects an external KMS key instead of the local envelope key. Same consequence, managed elsewhere. |
All public variables
Alphabetical, because an operator searches for a name rather than a topic.
| Variable |
|---|
ANTHROPIC_API_KEY |
GARBOARD_AUDIT_RETENTION_DAYS |
GARBOARD_AUTH |
GARBOARD_BASE_URL |
GARBOARD_DB_URL |
GARBOARD_EMBEDDER |
GARBOARD_EMBEDDER_DIM |
GARBOARD_EMBEDDER_MODEL |
GARBOARD_EMBEDDER_URL |
GARBOARD_GITHUB_APP_ID |
GARBOARD_GITHUB_PRIVATE_KEY |
GARBOARD_GITHUB_PRIVATE_KEY_FILE |
GARBOARD_GITLAB_GROUP |
GARBOARD_GITLAB_TOKEN |
GARBOARD_GITLAB_URL |
GARBOARD_GITLAB_WEBHOOK_SECRET |
GARBOARD_GIT_PROVIDER |
GARBOARD_KMS_KEY_ID |
GARBOARD_OIDC_CLIENT_ID |
GARBOARD_OIDC_CLIENT_SECRET |
GARBOARD_OIDC_ISSUER |
GARBOARD_OIDC_REDIRECT_URL |
GARBOARD_RECEIPT_KEY |
GARBOARD_RECEIPT_RETIRED_KEYS |
GARBOARD_SCHEMA_DIR |
GARBOARD_SECRET_KEY |
GARBOARD_SIGNUP_DISABLED |
GARBOARD_SLACK_WEBHOOK |
GARBOARD_SSO_ALLOWED_DOMAINS |
GARBOARD_TOKEN |
GARBOARD_UI_URL |
GARBOARD_WEBHOOK_SECRET |
