From a407f570efb598e17954abb40ef771ecd9c1796e Mon Sep 17 00:00:00 2001 From: kenjis Date: Sun, 25 Dec 2022 15:50:34 +0900 Subject: [PATCH 1/3] docs: add configuration for Config\Email --- docs/install.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/docs/install.md b/docs/install.md index f64ed004d..6b73465e4 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. + + ```php + Date: Sun, 25 Dec 2022 17:52:27 +0900 Subject: [PATCH 2/3] docs: add link to CI4 User Guide --- docs/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install.md b/docs/install.md index 6b73465e4..4edbb74c8 100644 --- a/docs/install.md +++ b/docs/install.md @@ -73,7 +73,7 @@ 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. +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 Date: Sun, 25 Dec 2022 17:52:51 +0900 Subject: [PATCH 3/3] docs: add note for email sending --- docs/quickstart.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/quickstart.md b/docs/quickstart.md index 7b86b1698..c5b039625 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -109,6 +109,8 @@ public int $unusedTokenLifetime = YEAR; ### Enable Account Activation via Email +> **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