Skip to content

docs: Update Google Sign-In setup and configuration documentation#471

Open
Zfinix wants to merge 3 commits intomainfrom
chore/update-sign-in-with-google-docs
Open

docs: Update Google Sign-In setup and configuration documentation#471
Zfinix wants to merge 3 commits intomainfrom
chore/update-sign-in-with-google-docs

Conversation

@Zfinix
Copy link
Copy Markdown
Contributor

@Zfinix Zfinix commented Apr 21, 2026

Problem

The Sign in with Google docs lacked screenshots for the Google Cloud Console setup steps, had no clear separation between what iOS, Android, and Web each require, and didn't explain key gotchas (YAML indentation, SHA-1 debug vs release mismatch, missing People API). There was also no troubleshooting page and the migration steps were incomplete.

Solution

  • Setup page -- Added 4 screenshots for the People API, Audience, iOS OAuth client, and Android OAuth client creation steps. Added a platform requirements table, step-by-step numbered instructions for each platform, explicit migration commands (serverpod create-migration), Firebase disambiguation note, and warnings for common mistakes.
  • Configuration page -- Added a GoogleIdpConfig parameter reference table with passwords.yaml key column and environment variable equivalents section. Improved link text for accessibility.
  • Troubleshooting page (new) -- Setup checklist and 10 documented failure scenarios with cause and fix for each, including SHA-1 mismatch, redirect_uri_mismatch, missing People API, token expiration on Web, and more.

@Zfinix Zfinix requested a review from Swiftaxe April 21, 2026 08:29
Sign in with Google requires a Google Cloud project linked to your organization's Google account. You also need platform-specific OAuth credentials depending on which platforms you target.

:::caution
You need to install the auth module before you continue, see [Setup](../../setup).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we have to simplify this a bit. Sending people to another setup page with quite some stuff to grasp is making it harder. We want a smooth and simple how-to guide. Part of this is probably simplifying the setup page for installing the auth module.

:::note
Right now, we have official support for iOS, Android, and Web for Google Sign In.
:::
Sign in with Google requires a Google Cloud project linked to your organization's Google account. You also need platform-specific OAuth credentials depending on which platforms you target.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do I setup a Google cloud project? If google has a great guide on this a link may suffice.
All these prerequisites should be in a section "prerequisites".

Copy link
Copy Markdown
Contributor

@Swiftaxe Swiftaxe Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Saw now that the "Cloud Project" is below. We need to rethink the structure here so the user understand the instructions for this follows below. This is like a lead sentence to setting these things up.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This screenshot should focus on the enable button. Terms of Service, etc is irrelevant. Also make sure it is up to date with what this page looks like now.
This goes for all images. Focus on what the user needs to see to understand and follow.

…on setup, and match actual Serverpod 3.4.7 template
@Zfinix Zfinix requested a review from Swiftaxe April 27, 2026 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants