Skip to content

docs: Improve Apple Sign-In setup with missing steps and troubleshooting#473

Open
Zfinix wants to merge 5 commits into
mainfrom
chore/update-sign-in-with-apple-docs
Open

docs: Improve Apple Sign-In setup with missing steps and troubleshooting#473
Zfinix wants to merge 5 commits into
mainfrom
chore/update-sign-in-with-apple-docs

Conversation

@Zfinix
Copy link
Copy Markdown
Contributor

@Zfinix Zfinix commented Apr 29, 2026

Summary

  • Added missing Apple JS SDK script tag for Web setup
  • Added --dart-define instructions for Web/Android client configuration
  • Added troubleshooting entries for missing JS SDK and macOS sandbox conflict
  • Organized troubleshooting checklist by category (Portal / Server / Client)
  • Consolidated 3 back-to-back admonitions into 1 tip
  • Fixed broken link and removed $ prefix from bash commands

Test plan

  • Followed every step from a fresh serverpod create project
  • Verified Apple Sign-In on Safari (Web) and macOS native
  • Confirmed each new troubleshooting entry matches a real failure mode

@Zfinix Zfinix requested a review from Swiftaxe April 29, 2026 10:38
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/02-customizations.md Outdated
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/02-customizations.md Outdated
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/02-customizations.md Outdated
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/02-customizations.md Outdated
Copy link
Copy Markdown
Contributor

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

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

Found some things to improve above. Will continue review later.

@Zfinix Zfinix force-pushed the chore/update-sign-in-with-apple-docs branch from 7b94a3d to 132800b Compare May 4, 2026 16:48
@Zfinix Zfinix force-pushed the chore/update-sign-in-with-apple-docs branch from 910cc7e to 12648da Compare May 4, 2026 16:54
@Zfinix Zfinix requested a review from Swiftaxe May 5, 2026 08:20
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md Outdated
…omization options, and troubleshooting details
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md Outdated
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md Outdated
Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md Outdated
In your server project directory, add the auth IDP server package:

```bash
dart pub add serverpod_auth_idp_server
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.

Do they need to do this if they fulfilled the prerequisites above? (ie have the auth module installed)

Copy link
Copy Markdown
Contributor Author

@Zfinix Zfinix May 11, 2026

Choose a reason for hiding this comment

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

Reworded the step as a fallback for upgraded projects rather than a required install.

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.

It is better now. However, a user having an old project still has to follow the full guide to install the auth module, right?

Is it better to refer to the full setup guide instead?
We do that under prerequisites, but if they rushed past it, this is good place to remind them.

Comment thread docs/06-concepts/11-authentication/04-providers/04-apple/01-setup.md Outdated
Zfinix added 2 commits May 11, 2026 03:25
…ions, customization tips, and additional notes on credential management
`serverpod create` already ships `serverpod_auth_idp_server` and
`serverpod_auth_idp_flutter` in the generated pubspecs, so the bare
`pub add` steps were redundant for users on the standard template.
@Zfinix Zfinix requested a review from Swiftaxe May 12, 2026 08:09
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