Skip to content

docs: remove nonexistent TALOS_ prefix from Talos config env vars - #2688

Merged
jonas-jonas merged 2 commits into
masterfrom
talos-remove-config-env-prefix
Jul 24, 2026
Merged

docs: remove nonexistent TALOS_ prefix from Talos config env vars#2688
jonas-jonas merged 2 commits into
masterfrom
talos-remove-config-env-prefix

Conversation

@jonas-jonas

@jonas-jonas jonas-jonas commented Jul 22, 2026

Copy link
Copy Markdown
Member

The Talos server only reads unprefixed config env vars (e.g. SECRETS_HMAC_CURRENT), so the documented TALOS_-prefixed forms are silently ignored and the published docker instructions fail. Removes the prefix from the config reference, CLI pages, and all operate guides

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated configuration guidance to describe environment-variable overrides without requiring the legacy environment-variable prefix.
    • Revised operational docs and examples (database DSNs, HMAC/secrets, tracing, Docker quick start, and debug logging) to use the current environment-variable names.
    • Updated CLI help and reference pages to clarify that, when no config file is provided, schema defaults and environment variables apply (without restricting to the legacy prefix).
    • Improved consistency across guides and command-line help.

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>
@jonas-jonas
jonas-jonas requested a review from vinckr as a code owner July 22, 2026 22:18
Copilot AI review requested due to automatic review settings July 22, 2026 22:18
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Talos operational and CLI documentation was updated to replace TALOS_-prefixed environment-variable examples and descriptions with unprefixed variables and generalized environment-variable behavior.

Changes

Talos environment variable documentation

Layer / File(s) Summary
Operational configuration examples
docs/talos/operate/...
Configuration, database, Docker, tracing, secrets, security, and troubleshooting examples now use unprefixed environment-variable names.
JWK and keys CLI help text
docs/talos/reference/cli/talos-jwk-*.md, docs/talos/reference/cli/talos-keys-*.md
CLI descriptions now state that schema defaults and environment variables apply when --config is omitted.
Migration, proxy, and serve CLI help text
docs/talos/reference/cli/talos-migrate*.md, docs/talos/reference/cli/talos-proxy.md, docs/talos/reference/cli/talos-serve*.md, docs/talos/reference/cli/talos.md
Inherited --config descriptions no longer restrict environment variables to the TALOS_ prefix.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • ory/docs#2516: Updates Talos documentation environment-variable naming conventions in related operational pages.
  • ory/docs#2603: Modifies Talos configuration environment-variable naming and precedence documentation.

Suggested reviewers: aeneasr, unatasha8

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely summarizes the main documentation change across Talos config env vars.
Description check ✅ Passed The description explains the motivation and scope, but it omits the template sections and checklist details.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch talos-remove-config-env-prefix

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/talos/operate/secrets.md Outdated

@unatasha8 unatasha8 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix underscore-to-dot issue, instead use dot-to-underscore

Otherwise, LGTM

Comment thread docs/talos/operate/secrets.md Outdated
@jonas-jonas
jonas-jonas merged commit 68499be into master Jul 24, 2026
12 checks passed
@jonas-jonas
jonas-jonas deleted the talos-remove-config-env-prefix branch July 24, 2026 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants