docs: Improve Apple Sign-In setup with missing steps and troubleshooting#473
docs: Improve Apple Sign-In setup with missing steps and troubleshooting#473
Conversation
…error resolutions and configuration clarifications
…pecify two methods
|
|
||
| ### Loading credentials manually | ||
|
|
||
| If you use `AppleIdpConfig` instead of `AppleIdpConfigFromPasswords`, you must provide each credential explicitly: |
There was a problem hiding this comment.
Same here as with the Google sign-in. Mentioning 'FromPasswords' here like this, can be interpreted as that you can use any of these classes to load manually. Improve clarity:
| If you use `AppleIdpConfig` instead of `AppleIdpConfigFromPasswords`, you must provide each credential explicitly: | |
| For more control over how credentials are loaded, use `AppleIdpConfig`. You must provide each credential explicitly: |
|
|
||
| Go through this before investigating a specific error. Most problems come from a missed step. | ||
|
|
||
| #### Apple Developer Portal |
There was a problem hiding this comment.
Double check we are not missing any important step, that the user could have missed, in these checklists below.
| * [ ] Make sure **`appleKey`** in your config holds the raw `.p8` file contents (not a pre-generated JWT). | ||
| * [ ] Double-check the **`.p8` key** is indented consistently under `appleKey: |` in `passwords.yaml`. | ||
| * [ ] Run **`serverpod generate`** after adding the Apple provider, and apply migrations using `--apply-migrations`. | ||
| * [ ] Create a **Sign in with Apple key** and download the `.p8` file. |
There was a problem hiding this comment.
Should we also add checking Domains and Subdomains to the portal list?
| Sign-in with Apple requires that you have a subscription to the [Apple Developer Program](https://developer.apple.com/programs/), even if you only want to test the feature in development mode. | ||
|
|
||
| :::caution | ||
| You need to install the auth module before you continue, see [Setup](../../setup). |
There was a problem hiding this comment.
The note about installing the auth module is removed. It is not great to direct users to the Setup page though, especially if they unknowingly have it installed from the create template.
Do we need a note down under 'Configure the server' to verify they have the package in pubspec.yaml, and if not, they need to go to Setup?
|
|
||
| You can use the `onAfterAppleAccountCreated` callback to run logic after a new Apple account has been created and linked to an auth user. This callback is only invoked for new accounts, not for returning users. | ||
|
|
||
| This callback is complimentary to the [core `onAfterAuthUserCreated` callback](../../working-with-users#reacting-to-the-user-created-event) to perform side-effects that are specific to a login on this provider - like storing analytics, sending a welcome email, or storing additional data. |
There was a problem hiding this comment.
This link looks weird having the onAfterAuthUserCreated in the middle. Consider linking only the onAfterAuthUserCreated part. (not 'core' and 'callback'.
| ::: | ||
|
|
||
| ## `AppleIdpConfig` parameter reference | ||
| ## All configuration parameters |
There was a problem hiding this comment.
The Google sign-in docs list the GoogleIdpConfig params. Should we list the AppleIdpConfig params here as well?
There was a problem hiding this comment.
There's no need as we already did list them above, Apple and Google config are not the same they have different rules and different ways to implement them
2 participants
Summary
--dart-defineinstructions for Web/Android client configuration$prefix from bash commandsTest plan
serverpod createproject