docs: Enhance GitHub Sign-In setup, customizations, and troubleshooting#521
Draft
Zfinix wants to merge 3 commits into
Draft
docs: Enhance GitHub Sign-In setup, customizations, and troubleshooting#521Zfinix wants to merge 3 commits into
Zfinix wants to merge 3 commits into
Conversation
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
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.
Problem
The Sign in with GitHub docs lagged behind Google and Apple in structure and depth: no Prerequisites section, title-case headings inconsistent with sibling providers, no production deployment guidance, no troubleshooting page, stale screenshots, and a thin customizations page missing the server-side API hook, global auth user hooks, and parameter reference. The Web flow also predated the new
FlutterWebAuth2CallbackRouteand relied on a manually-createdauth.htmleven when Serverpod could serve the callback itself.Solution
## Publishing to productionsection with self-hosted and Serverpod Cloud (scloud password set) paths. Web flow refactored into Serverpod-hosted (usingpod.configureFlutterWebAuth2CallbackRoute()and/auth/callback) and separately-hosted (staticauth.html) sub-paths. Five new screenshots replace the stale set.02-configuration.mdto02-customizations.mdfor parity with Google. AddedGitHubIdpConfigvsGitHubIdpConfigFromPasswordsintro, manual credential loading, server-side API access viagetExtraGitHubInfoCallback, globalonBeforeAuthUserCreated/onAfterAuthUserCreatedhooks, and a parameter reference table.redirect_uri_mismatch, callback handling for both web flows, email null, dev-vs-prod failures, installation scope, org OAuth restrictions,bad_verification_code, rate limits, permission re-authorization, and migration issues.Requires
serverpod_auth_idp_server3.5.0-beta.8 or later forconfigureFlutterWebAuth2CallbackRoute. Depends on serverpod/serverpod#5133.