fix(docs): add mandatory flags missing from runnable examples - #89
Merged
Conversation
Three blocks could not boot as written: - sso-guide: no --jwt-*, --client-id/secret or --admin-secret. Fails on `missing jwt type` after --encryption-key passes. - rate-limiting compose: no --jwt-* or --admin-secret. - mcp: no --jwt-*. `authorizer mcp` validates the bearer itself, so it needs the same JWT settings as the server that minted it — without them every tool call returns Unauthenticated. Verified the corrected sso-guide flag set boots against a build of main. Also documents persisting SQLite across restarts with a named volume; the Docker quick start writes the database inside the container, so every restart began from an empty one.
✅ Deploy Preview for authorizerdev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The server exits at boot without --url (authorizerdev/authorizer#764). These commands could not start as written.
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.
Why
Three documented commands could not boot as written. Each fails on a flag the server now requires, before reaching the rest:
sso-guide--jwt-*,--client-id/secret,--admin-secretmissing jwt typerate-limiting(compose)--jwt-*,--admin-secretmissing jwt typemcp(both bash and JSON forms)--jwt-*UnauthenticatedThe MCP one is the subtle case:
authorizer mcpopens the database and validates the bearer itself, so it needs the same--jwt-*settings as the server that minted the token. Without them it starts fine and then fails every call, which reads as a permissions bug rather than missing config.Verified the corrected
sso-guideflag set boots against a build ofauthorizermain— it reaches the HTTP listener instead of exiting.Also: persisting data
The Docker quick start wrote SQLite inside the container, so every restart began from an empty database and nothing said so. Adds a named-volume variant, including why
-u rootis needed (the image runs as uid 1000, and a named volume mounted at a path it does not already own is created root-owned).Scope
Only blocks that actually start a server. Left alone: per-engine flag fragments in
databases.md, the FGA store snippet inauthorization.md, the v1 "before" examples, and the env-var mapping blocks that end in....npm run buildclean, zero broken-link or anchor warnings.