docs: cover RomM 5.0.0-beta.1 config, auth, and admin changes#93
Merged
Conversation
Update the config/setup/env/admin surface for the 5.0 beta: - Regenerate env-vars reference (adds DISABLE_LOGS_VIEWER and OIDC_ALLOW_REGISTRATION) - Rewrite Users & Roles around User/Admin + the new permission-group model (grant matrix, per-user overrides, hidden entities) and add an OAuth scopes reference (incl. new logs.read) - Document OIDC_ALLOW_REGISTRATION and reframe OIDC role mapping around User/Admin; flag OIDC_ROLE_VIEWER/EDITOR as legacy no-ops - Add the in-app logs viewer (DISABLE_LOGS_VIEWER) to Observability - Smaller items: box2d_side media type, Turkish locale, glossary rewrite, and sweep stale Viewer/Editor references out of the API, uploads, collections, ROM patcher, netplay, and profile pages Generated-By: PostHog Code Task-Id: 13e38ba8-2f24-44e4-bf28-90f68145bfa6
5.0 moves patching from the browser to the server (patcherjs). Rewrite the page around the Patcher tab flow: pick a base ROM + patch from the library, apply server-side, then download and/or upload back (with an automatic scan). Update permissions to roms.read (apply) / roms.write (upload), document the ROM_PATCHER_MAX_FILE_SIZE_BYTES limit and the checksum-validation warning, and drop the browser-memory framing. Generated-By: PostHog Code Task-Id: 13e38ba8-2f24-44e4-bf28-90f68145bfa6
Add miximage_v2, logo, and video_normalized to the scan.media table to match the MetadataMediaType enum in 5.0. Generated-By: PostHog Code Task-Id: 13e38ba8-2f24-44e4-bf28-90f68145bfa6
d7bf201 was formatted with bare prettier (2-space), which diverges from the repo's trunk-enforced prettier config (4-space). Reformat with trunk so it matches CI; also adds the box2d_back media row that the reindent had obscured. No content change beyond the scan.media additions. Generated-By: PostHog Code Task-Id: 13e38ba8-2f24-44e4-bf28-90f68145bfa6
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.
What
Updates the configuration / setup / env-var / admin surface of the docs to match RomM 5.0.0-beta.1. Verified against source at the beta tag (env template,
Roleenum,permission.py,Scopeenum).Changes
env-vars.mdsnippet; addsDISABLE_LOGS_VIEWERandOIDC_ALLOW_REGISTRATION(only diff is those two vars).own_only, default group, per-user overrides, hidden platforms/ROMs). Replaced the old role-column scope matrix with an OAuth scopes reference (20 dotted scopes incl. the newlogs.read).OIDC_ALLOW_REGISTRATION, reframed role mapping around User/Admin, flaggedOIDC_ROLE_VIEWER/OIDC_ROLE_EDITORas legacy no-ops (touchesauthentication.md,invitations-and-registration.md,oidc/index.md,oidc/keycloak.md,oidc/zitadel.md).DISABLE_LOGS_VIEWER(also disablesGET /api/logs).box2d_sidemedia type in the config reference; Turkish (tr_TR) locale; glossary rewrite; swept stale Viewer/Editor references out of the developer API docs, uploads, collections, ROM patcher (+ light server-side-patching note), netplay, account/profile, and Playnite pages.Notes
env.templatestill shipsOIDC_ROLE_VIEWER/EDITOR, so the autogenerated table still lists them; their legacy behavior is covered in prose instead.Verification
mkdocs buildpasses with no link/anchor warnings (validated with the social-cards plugin disabled to sidestep a localcairosvgnative-lib issue). No pages moved, so redirects are unaffected.Created with PostHog Code