docs: remove nonexistent TALOS_ prefix from Talos config env vars#2688
docs: remove nonexistent TALOS_ prefix from Talos config env vars#2688jonas-jonas wants to merge 1 commit into
Conversation
The Talos server reads unprefixed environment variables (SECRETS_HMAC_CURRENT, DB_DSN, ...); the documented TALOS_-prefixed forms are silently ignored and make the documented docker setup fail to start. See ory-corp/cloud#13016 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (47)
📝 WalkthroughWalkthroughTalos operational and CLI documentation was updated to replace ChangesTalos environment variable documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR fixes Ory Talos documentation so configuration via environment variables matches actual server behavior (unprefixed env vars), preventing broken Docker/ops setups caused by silently ignored TALOS_-prefixed variables.
Changes:
- Updates the Talos configuration reference to document unprefixed env vars (for all config keys, including required vars).
- Updates all Talos CLI reference pages to remove wording that implies
TALOS_-prefixed env vars. - Updates Talos operate guides (deploy, database, troubleshooting, secrets, tracing, configuration) to use unprefixed env var examples.
Reviewed changes
Copilot reviewed 48 out of 48 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/talos/reference/config.mdx | Removes TALOS_ prefix from env-var mapping and all “Env Var” table entries. |
| docs/talos/reference/cli/talos.md | Updates inherited --config help text to refer to env vars (no TALOS_ prefix). |
| docs/talos/reference/cli/talos-serve.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-serve-public.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-serve-admin.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-proxy.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-migrate.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-migrate-up.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-migrate-status.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-migrate-force.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-migrate-down.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-verify.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-self-revoke.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued-update.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued-rotate.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued-revoke.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued-list.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued-issue.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issued-get.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-issue.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-update.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-revoke.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-list.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-import.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-get.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-delete.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-imported-batch-import.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-derive-token.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-keys-batch-verify.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk-get.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk-generate.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk-generate-rsa.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk-generate-hmac.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk-generate-eddsa.md | Same --config help text adjustment. |
| docs/talos/reference/cli/talos-jwk-generate-ecdsa.md | Same --config help text adjustment. |
| docs/talos/operate/troubleshooting.md | Updates logging env var example to LOG_LEVEL. |
| docs/talos/operate/security-hardening.md | Updates secret injection guidance to SECRETS_HMAC_CURRENT. |
| docs/talos/operate/secrets.md | Updates secrets env var examples to unprefixed vars and adjusts mapping-rule wording. |
| docs/talos/operate/monitoring/tracing.md | Updates tracing env var examples to unprefixed vars. |
| docs/talos/operate/deploy/docker.md | Fixes Docker run example to use unprefixed required config env vars. |
| docs/talos/operate/database/postgresql.md | Updates DB_DSN env var example. |
| docs/talos/operate/database/mysql.md | Updates DB_DSN env var example. |
| docs/talos/operate/database/cockroachdb.md | Updates DB_DSN env var example. |
| docs/talos/operate/configure.md | Updates prose/examples to describe unprefixed env var overrides. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The Talos server only reads unprefixed config env vars (e.g.
SECRETS_HMAC_CURRENT), so the documentedTALOS_-prefixed forms are silently ignored and the published docker instructions fail. Removes the prefix from the config reference, CLI pages, and all operate guides; see ory-corp/cloud#13016.🤖 Generated with Claude Code
Summary by CodeRabbit