docs: cover 5.1.0-beta.1 and beta.2 env vars and config - #106
Merged
Conversation
Bump the pinned romm ref to 5.1.0-beta.2 and regenerate the env-vars and supported-platforms snippets, then document the new env vars and config options by hand where they fit the existing structure. - env-vars: STREAMING_BROKER_SECRET, STREAMING_SAVE_TIMEOUT (beta.1); ROMM_CORS_ALLOWED_ORIGINS, ROMM_SESSION_SECURE_COOKIE, MAX_ASSET_UPLOAD_SIZE_BYTES, MAX_AUTOCLEANUP_LIMIT (beta.2) - config: scan.priority.cover/screenshot/manual per-field artwork overrides - metadata-providers: PLAYMATCH_API_URL for self-hosted Playmatch - reverse-proxy: cookie/CORS hardening behind HTTPS - uploads: MAX_ASSET_UPLOAD_SIZE_BYTES troubleshooting note - platforms: regenerate for win9x and steam; fix gen_platforms.py for the upstream utils/ -> tools/ move Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the new environment variables, config options, and platforms introduced across 5.1.0-beta.1 and 5.1.0-beta.2.
Env vars
Bumped the pinned romm ref in
scripts/sources.toml(master→5.1.0-beta.2) and regeneratedenv-vars.md. Newly surfaced:STREAMING_BROKER_SECRETSTREAMING_SAVE_TIMEOUTROMM_CORS_ALLOWED_ORIGINSROMM_SESSION_SECURE_COOKIEMAX_ASSET_UPLOAD_SIZE_BYTESMAX_AUTOCLEANUP_LIMITPLAYMATCH_API_URLis commented out in upstreamenv.template, so the generator skips it; documented in prose instead.Hand-written additions where they fit the existing structure
scan.priority.cover/screenshot/manualin the configuration-file reference.PLAYMATCH_API_URLnote in metadata-providers.Platforms
Regenerated
supported-platforms.mdforwin9x(beta.1) andsteam. This required updatingscripts/gen_platforms.pyfor the upstream move of the generator frombackend/utils/tobackend/tools/. Verified the local romm checkout is at5.1.0-beta.2+ 3 unrelated commits, so the table matches beta.2.Notes
STREAMING_BROKER_SECRETrenders a bare-description because itsenv.templateline has no inline comment upstream. It's fully explained inemulator-streaming.md; an upstream comment would tidy the generated table.api-reference.mdin this PR.🤖 Generated with Claude Code