You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Learning any new authentication system can be difficult, especially as they get more flexible and sophisticated. This guide is intended to provide short examples for common actions you'll take when working with Shield. It is not intended to be the exhaustive documentation for each section. That's better handled through the area-specific doc files.
4
4
5
-
> **Note** The examples assume that you have run the setup script and that you have copies of the `Auth` and `AuthGroups` config files in your application's `app/Config` folder.
5
+
> **Note** The examples assume that you have run the setup script and that you have copies of the `Auth` and `AuthGroups` config files in your application's **app/Config** folder.
6
6
7
7
-[Quick Start Guide](#quick-start-guide)
8
8
-[Authentication Flow](#authentication-flow)
@@ -37,10 +37,10 @@ Learning any new authentication system can be difficult, especially as they get
37
37
38
38
#### Configure Redirect URLs
39
39
40
-
If you need everyone to redirect to a single URL after login/logout/register actions, you can modify the `Config\Auth::$redirects` array in `app/Config/Auth.php` to specify the url to redirect to.
40
+
If you need everyone to redirect to a single URL after login/logout/register actions, you can modify the `Config\Auth::$redirects` array in **app/Config/Auth.php**`** to specify the url to redirect to.
41
41
42
42
By default, a successful login or register attempt will all redirect to `/`, while a logout action
43
-
will redirect to a [named route](https://codeigniter.com/user_guide/incoming/routing.html#using-named-routes"See routing docs")`login` or a *URI path*`/login`. You can change the default URLs used within the `app/Config/Auth.php` config file:
43
+
will redirect to a [named route](https://codeigniter.com/user_guide/incoming/routing.html#using-named-routes"See routing docs")`login` or a *URI path*`/login`. You can change the default URLs used within the **`**app/Config/Auth.php** config file:
44
44
45
45
```php
46
46
public array $redirects = [
@@ -75,7 +75,7 @@ public int $unusedTokenLifetime = YEAR;
75
75
76
76
#### Enable Account Activation via Email
77
77
78
-
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
78
+
> **Note** You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
79
79
80
80
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.
81
81
@@ -88,7 +88,7 @@ public array $actions = [
88
88
89
89
#### Enable Two-Factor Authentication
90
90
91
-
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
91
+
> **Note** You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
92
92
93
93
Turned off by default, Shield's Email-based 2FA can be enabled by specifying the class to use in the `Auth` config file.
94
94
@@ -101,7 +101,7 @@ public array $actions = [
101
101
102
102
### Responding to Magic Link Logins
103
103
104
-
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
104
+
> **Note** You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
105
105
106
106
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.
107
107
@@ -138,7 +138,7 @@ Events::on('magicLogin', static function () {
138
138
139
139
#### Change Available Groups
140
140
141
-
The available groups are defined in the `app/Config/AuthGroups.php` config file, under the `$groups` property. Add new entries to the array, or remove existing ones to make them available throughout your application.
141
+
The available groups are defined in the **app/Config/AuthGroups.php** config file, under the `$groups` property. Add new entries to the array, or remove existing ones to make them available throughout your application.
0 commit comments