Configuration
Learn how authentication works in MakerKit and how to configure it.
The way you want your users to authenticate can be driven via configuration.
If you open the global configuration at src/configuration.ts, you'll find the auth object:
auth: {
requireEmailConfirmation: false,
providers: {
emailPassword: true,
phoneNumber: false,
emailLink: false,
oAuth: ['google'] as Provider[],
},
}
As you can see, the providers object can be configured to only display the auth methods we want to use.
- For example, by setting both
phoneNumberandemailLinktotrue, the authentication pages will display theEmail Linkauthentication and thePhone Numberauthentication forms. - Instead, by setting
emailPasswordtofalse, we will remove theemail/passwordform from the authentication and user profile pages.
Requiring Email Verification
If you require email confirmation before your users can sign in, you will have to flip the following flag in your configuration:
auth: {
requireEmailConfirmation: false,
}
When the flag is set to true, the user will not be redirected to the onboarding flow, but will instead see a successful alert asking them to confirm their email. After confirmation, they will be able to sign in.
When the flag is set to false, the application will redirect them directly to the onboarding flow.
Email Testing
In development, emails are sent to InBucket: this is where you can find emails related to password reset, sign-in links, and email verifications.
To access the InBucket instance, you can go to the following URL: http://localhost:54324/. Save this URL, you will use it very often.