Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LoneAngelFayt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ Add one entry per container, not per platform. A container serves every platform
| `label` | No | Name for the container, shown in the fleet view. The play action is named after the emulator instead |
| `subfolder` | No | URL prefix the broker is served under, matching the container's `SUBFOLDER` |
| `broker_host` | No | Server-to-broker API base. Derived from `host` when omitted, and **required** when `host` is a path |
| `broker_secret` | No | Secret for this container, used only when the `STREAMING_BROKER_SECRET` env var is unset |
| `broker_secret` | No | Secret for this container. Overrides the `STREAMING_BROKER_SECRET` env var, which covers containers that set none |
| `library_path` | No | In-container path to the RomM library, if it is mounted somewhere other than the default `/romm/library` |
| `emulator` | No | Lowercased name grouping states and memory cards. Ignored when `platforms` is used, since each platform's own emulator names them |
| `memory_card_sync` | No | Sync the whole memory card to the RomM library. Ignored only on platforms known to have no card (`wii`, `psx`, `ps3`, `ps4`, `xbox`, `xbox360`, `wiiu`, `3ds`, `switch`) |
Expand All @@ -589,7 +589,7 @@ streaming:
host: https://192.168.1.56:3010 # browser-facing, must be HTTPS
subfolder: /streaming # matches the container's SUBFOLDER
library_path: /romm # where it mounts your ROM library
broker_secret: change-me # matches the container's BROKER_SECRET
broker_secret: change-me # the container's BROKER_SECRET; overrides STREAMING_BROKER_SECRET
label: Emulation station
platforms:
snes: retroarch # the emulator name directly...
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/emulator-streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The broker is served under the container's `SUBFOLDER` on the same origin as the

## Launch or save errors out

Either the server can't reach `broker_host` or the secret is wrong. Check that `STREAMING_BROKER_SECRET` matches the container's `BROKER_SECRET`, and that `broker_host` resolves from the RomM server. A `broker_secret` in `config.yml` is ignored whenever `STREAMING_BROKER_SECRET` is set (see [Set the shared secret](../using/emulator-streaming.md#set-the-shared-secret)).
Either the server can't reach `broker_host` or the secret is wrong. Check that the secret RomM sends matches the container's `BROKER_SECRET`: that is the entry's `broker_secret` in `config.yml` when it sets one, and `STREAMING_BROKER_SECRET` otherwise (see [Set the shared secret](../using/emulator-streaming.md#set-the-shared-secret)). Also check that `broker_host` resolves from the RomM server.

## The emulator can't find the game

Expand Down
4 changes: 2 additions & 2 deletions docs/using/emulator-streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,9 @@ Four of those keys have consequences worth knowing before you pick their values:

### Set the shared secret

`STREAMING_BROKER_SECRET` is what authenticates RomM to the broker, and it has to match the container's `BROKER_SECRET`. Use the same value everywhere.
`STREAMING_BROKER_SECRET` is what authenticates RomM to the broker, and it has to match the container's `BROKER_SECRET`. One value covers every container that shares it.

If one broker needs its own secret, put `broker_secret` on that entry in `config.yml` and leave `STREAMING_BROKER_SECRET` unset entirely. The env var beats the per-container value whenever it's set, so you can't mix the two.
If one broker needs its own secret, put `broker_secret` on that entry in `config.yml`. A container's own `broker_secret` wins over `STREAMING_BROKER_SECRET`, which only covers the containers that set none, so you can mix the two.

### Tune the timeouts

Expand Down