Skip to content

Commit 02c36a8

Browse files
committed
docs: add note for email sending
1 parent 9e62424 commit 02c36a8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/quickstart.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ public int $unusedTokenLifetime = YEAR;
109109

110110
### Enable Account Activation via Email
111111

112+
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
113+
112114
By default, once a user registers they have an active account that can be used. You can enable Shield's built-in, email-based activation flow within the `Auth` config file.
113115

114116
```php
@@ -120,6 +122,8 @@ public array $actions = [
120122

121123
### Enable Two-Factor Authentication
122124

125+
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
126+
123127
Turned off by default, Shield's Email-based 2FA can be enabled by specifying the class to use in the `Auth` config file.
124128

125129
```php
@@ -131,6 +135,8 @@ public array $actions = [
131135

132136
### Responding to Magic Link Logins
133137

138+
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
139+
134140
Magic Link logins allow a user that has forgotten their password to have an email sent with a unique, one-time login link. Once they've logged in you can decide how to respond. In some cases, you might want to redirect them to a special page where they must choose a new password. In other cases, you might simply want to display a one-time message prompting them to go to their account page and choose a new password.
135141

136142
#### Session Notification

0 commit comments

Comments
 (0)