docs: document ScreenScraper developer credentials - #121
Merged
Conversation
RomM sends ScreenScraper developer (application) credentials alongside the user credentials on every request. They're injected at image build time, so installs that don't use our official image (builds from source, third-party packages like the new nixpkgs one) send empty values and get a 403 that surfaces as "401: Invalid ScreenScraper credentials". Explain the second credential pair in the ScreenScraper setup section and add a scanning troubleshooting entry with the actual log lines, so the misleading error message is searchable. Reported in NixOS/nixpkgs#547607 Co-Authored-By: Claude Opus 5 (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.
Reported in NixOS/nixpkgs#547607: ScreenScraper stops authenticating when RomM runs from the new nixpkgs package instead of our container image.
RomM sends ScreenScraper developer (application) credentials alongside the user credentials on every request, and those come from
ARG SCREENSCRAPER_DEV_ID/SCREENSCRAPER_DEV_PASSWORDat image build time. Installs that don't use our official image (builds from source, third-party packages) send empty values, and ScreenScraper answers403 Forbidden, which the scanner reports as401: Invalid ScreenScraper credentials. That message sends people off checking their account, which is fine.Changes
getting-started/metadata-providers.md: the ScreenScraper section now explains the second credential pair, notes the official images carry it, and adds an admonition for source builds and third-party packages pointing atSCREENSCRAPER_DEV_ID/SCREENSCRAPER_DEV_PASSWORD. Per @06kellyjac's request it mentions the credentials exist in the image without explaining how to extract them.troubleshooting/scanning.md: new "ScreenScraper fails with 403 Forbidden" entry with the real log lines so the misleading error is searchable, plus the user-credential and quota fallbacks for people on the official image.Env var names verified against
backend/config/__init__.pyinrommapp/romm.reference/environment-variables.mdis untouched since its table is generated from upstreamenv.template, which deliberately omits the dev vars. Whether they belong there is a separate call.Related: #112 (NixOS install guide) can link to the ScreenScraper section rather than duplicating this.
🤖 Generated with Claude Code