Skip to content

docs(streaming): a container's broker_secret overrides STREAMING_BROKER_SECRET - #180

Open
LoneAngelFayt wants to merge 1 commit into
rommapp:mainfrom
LoneAngelFayt:docs/streaming-secret-precedence
Open

LoneAngelFayt wants to merge 1 commit into
rommapp:mainfrom
LoneAngelFayt:docs/streaming-secret-precedence

Conversation

@LoneAngelFayt

Copy link
Copy Markdown
Contributor

Companion to rommapp/romm#5259, which reverses the broker secret precedence for streaming containers. A container's own broker_secret in config.yml now wins, and STREAMING_BROKER_SECRET is the fallback for containers that set none. Merge this when #5259 ships in a release.

The current pages say the opposite, which would send someone debugging a 403 bad broker secret off changing the env var while the container's value still wins:

  • docs/using/emulator-streaming.md, "Set the shared secret": per-container secrets and the env var can now be mixed.
  • docs/troubleshooting/emulator-streaming.md, "Launch or save errors out": names which secret RomM actually sends.
  • docs/reference/configuration-file.md: the broker_secret row and the example's comment.

docs/resources/snippets/env-vars.md also carries the old wording, but it is generated from romm's env.template by scripts/gen_env_vars.py, and #5259 updates env.template, so it picks up the new text on the next regeneration after the pinned romm ref moves.

uv run mkdocs build --strict passes, and Prettier 3.5.2 with the trunk config is clean on all three files. trunk check couldn't run its tools locally (the same missing shared library as before), so CI is the lint gate.

AI assistance: this PR was written by Claude Code, under my direction and review.

…ER_SECRET

Companion to rommapp/romm#5259, which reverses the precedence: the per-container
broker_secret now wins and the env var is the fallback for containers that set
none.

This branch has not been deployed

No deployments
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.

1 participant