diff --git a/docs/install.md b/docs/install.md index f64ed004d..4edbb74c8 100644 --- a/docs/install.md +++ b/docs/install.md @@ -73,6 +73,31 @@ Require it with an explicit version constraint allowing its desired stability. php spark shield:setup ``` +2. Configure `app/Config/Email.php` to allow Shield to send emails with the [Email Class](https://codeigniter.com/user_guide/libraries/email.html). + + ```php + **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup). + 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. ```php @@ -120,6 +122,8 @@ public array $actions = [ ### Enable Two-Factor Authentication +> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup). + Turned off by default, Shield's Email-based 2FA can be enabled by specifying the class to use in the `Auth` config file. ```php @@ -131,6 +135,8 @@ public array $actions = [ ### Responding to Magic Link Logins +> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup). + 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. #### Session Notification