docs: Document serverpod_auth_email setup and migrating from serverpod_auth to the new provider using serverpod_auth_migration
#302
Conversation
…rpod_auth` to the new provider using `serverpod_auth_migration` Closes serverpod/serverpod#3663
📝 WalkthroughWalkthroughTwo new documentation files are added: one provides a detailed guide for setting up authentication in Serverpod using modular packages, and the other outlines the migration process from the legacy Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Docs
Developer->>Docs: Read setup_new.md
Docs-->>Developer: Instructions for setting up modular authentication
Developer->>Docs: Read upgrading-from-serverpod_auth.md
Docs-->>Developer: Guidance for migrating legacy auth data and endpoints
Assessment against linked issues
Possibly related issues
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (11)
docs/06-concepts/11-authentication/01-setup_new.md (7)
3-3: Fix verb agreement (“modules make”).Plural subject → plural verb.
- The modules makes it easy to authenticate + The modules make it easy to authenticate
9-9: Hyphenate “ready-to-use”.Correct compound adjective spelling improves readability.
-We provide the following packages of ready-to use authentication providers. +We provide the following ready-to-use authentication provider packages.
15-15: Typo: “Sing” → “Sign”.-|`serverpod_auth_google`|Ready to use "Sing in with Google authentication.| +|`serverpod_auth_google`|Ready to use "Sign in with Google" authentication.|
17-17: Plural noun & missing comma.-If you would like the basic authentication offered by these package, but combine them with a different approach to session management or another kind of user profile have +If you would like the basic authentication offered by these packages, but want to combine them with a different approach to session management or another kind of user profile, have
27-29: Hyphenate “email-based” & add comma after “By default”.-To get started with email based authentications, +To get started with email-based authentication, ... -By default this adds user profiles +By default, this adds user profiles
58-59: Awkward sentence – clarify override usage.The current phrasing is hard to parse.
-In this `class` `@override`s could be used to augment the default endpoint implementation. +You can override individual methods in this class to augment the default endpoint implementation.
121-122: Typo: “roatation” → “rotation”.-... and thus a roatation would invalidate previously created credentials. +... and thus a rotation would invalidate previously created credentials.docs/08-upgrading/06-upgrading-from-serverpod_auth.md (4)
3-3: Past participle missing (“was replaced”).-... package was replace with a set of modular packages ... +... package was replaced with a set of modular packages ...
24-24: Add apostrophe (“one’s”).-... update ones own data ... +... update one’s own data ...
46-48: Insert comma after introductory phrase & remove “In order to”.-During a login we can verify the incoming credentials, +During a login, we can verify the incoming credentials, ... -In order to avoid creating duplicate accounts +To avoid creating duplicate accounts
100-100: Spell out abbreviation (“e.g.”).-... request (eg. registering a new account ... +... request (e.g., registering a new account ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/06-concepts/11-authentication/01-setup_new.md(1 hunks)docs/08-upgrading/06-upgrading-from-serverpod_auth.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/08-upgrading/06-upgrading-from-serverpod_auth.md
[grammar] ~3-~3: Consider using either the past participle “replaced” or the present participle “replacing” here.
Context: ...gle legacy serverpod_auth package was replace with a set of modular packages providin...
(BEEN_PART_AGREEMENT)
[uncategorized] ~24-~24: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...p 6, one needs to ensure to also update ones own data to point to the new AuthUser...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[typographical] ~46-~46: Consider adding a comma after this introductory phrase.
Context: ...and the email authentication. During a login we can verify the incoming credentials,...
(AS_A_NN_COMMA)
[style] ~48-~48: Consider a more concise word here.
Context: ...ll have to resort to a password reset. In order to avoid creating duplicate accounts for t...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~100-~100: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...en proceeding with the desired request (eg. registering a new account if none exist...
(E_G)
docs/06-concepts/11-authentication/01-setup_new.md
[grammar] ~3-~3: You should probably use “make”.
Context: ...serverpod_auth_* modules. The modules makes it easy to authenticate with email or s...
(AGREEMENT_SENT_START)
[uncategorized] ~17-~17: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...e basic authentication offered by these package, but combine them with a different appr...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~17-~17: A comma might be missing here.
Context: ...sion management or another kind of user profile have [a look at the underlying packages...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~27-~27: This expression is usually spelled with a hyphen.
Context: ...nstance. ## Email To get started with email based authentications, add `serverpod_auth_em...
(BASED_HYPHEN)
[uncategorized] ~27-~27: Did you mean: “By default,”?
Context: ...ent (through serverpod_auth_session). By default this adds user profiles for each regist...
(BY_DEFAULT_COMMA)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...ub add serverpod_auth_email_server ``` Further it's advisable to depend on `serverpod_...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~46-~46: Consider a more concise word here.
Context: ... has to be added to the current project in order to expose its APIs to outside client. For...
(IN_ORDER_TO_PREMIUM)
[typographical] ~47-~47: Use a comma after an introductory phrase.
Context: ... to expose its APIs to outside client. For this add an email_account_endpoint.dart fi...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[style] ~76-~76: Consider a more concise word here.
Context: ...er, // Add this line ); ... } ``` In order to generate server and client the code for...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~82-~82: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...run: bash $ serverpod generate Additionally the database schema will need to be ext...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[typographical] ~89-~89: Use a comma after an introductory phrase.
Context: ...ation package needs to be configured. For this set the EmailAccounts.config from pac...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
[typographical] ~90-~90: It appears that a comma is missing.
Context: ...kage needs to be configured. For this set the EmailAccounts.config from package...
(DURING_THAT_TIME_COMMA)
[style] ~90-~90: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...he await pod.start(); call. Callbacks need to be provided for at least `sendRegistrat...
(REP_NEED_TO_VB)
[uncategorized] ~120-~120: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...ight want to send the "request ID" --> Additionally you need to update the passwords.yaml...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~121-~121: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... the "request ID" --> Additionally you need to update the passwords.yaml file to inc...
(REP_NEED_TO_VB)
[typographical] ~124-~124: Consider inserting a comma for improved readability.
Context: ...tials. After a restart of the Serverpod the new endpoints will be usable from the c...
(INITIAL_ADVP_COMMA)
[uncategorized] ~202-~202: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...# Authentication The following package provide the core authentication functionality, ...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~202-~202: A comma may be missing after the conjunctive/linking adverb ‘Thus’.
Context: ...default Endpoint base implementation. Thus they can be combined with another sessi...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~202-~202: A comma might be missing here.
Context: ... include further modification, like for example a custom user profile. |Package|Functi...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🔇 Additional comments (1)
docs/06-concepts/11-authentication/01-setup_new.md (1)
150-164: Potential ordering issue in client initialization.
sessionManagerusesclient.modulesbutclientis assigned afterwards; this would benullat construction time. Swap initialization order or pass a temporary client.
Closes serverpod/serverpod#3663
Summary by CodeRabbit