Skip to content

docs: Add macOS Keychain Sharing guide for authentication (#4512)#665

Open
abdulawalarif wants to merge 1 commit into
serverpod:mainfrom
abdulawalarif:fix-macos-email-auth-docs
Open

docs: Add macOS Keychain Sharing guide for authentication (#4512)#665
abdulawalarif wants to merge 1 commit into
serverpod:mainfrom
abdulawalarif:fix-macos-email-auth-docs

Conversation

@abdulawalarif

Copy link
Copy Markdown
Contributor

Summary

  • Adds a new guide, Set up authentication on macOS, documenting the Keychain Sharing entitlement required for sign-in sessions to persist on macOS.
  • Covers the default fix (empty keychain-access-groups in entitlements files), verification steps, Xcode setup, and a local-development alternative using the login keychain.
  • Adds troubleshooting for the PlatformException(-34018, A required entitlement isn't present, ...) error reported in Email auth does not work out of the box on MacOS and error message is unclear. serverpod#4512.
  • Links to the new page from Get started, Setup, Authentication basics, and the Facebook provider macOS section.

Closes serverpod/serverpod#4512 (docs portion).

Test plan

  • Run npm run build locally and confirm the site builds without broken links
  • Confirm the new page appears under Authentication in the sidebar
  • Verify cross-links resolve: ./macos-authentication from get-started, setup, basics, and Facebook setup
  • Review the entitlements XML snippet and troubleshooting steps against a macOS Flutter project

@abdulawalarif abdulawalarif changed the title Add macOS Keychain Sharing guide for authentication (#4512) docs: Add macOS Keychain Sharing guide for authentication (#4512) Jul 1, 2026
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.

Email auth does not work out of the box on MacOS and error message is unclear.

1 participant