annotate config/auth.php @ 2:90296614b7e2 default tip

Adding in the base for the clients table
author luka
date Thu, 28 Aug 2025 20:55:40 -0400
parents 9d7dcd54c677
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
1 <?php
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
2
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
3 return [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
4
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
5 /*
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
6 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
7 | Authentication Defaults
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
8 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
9 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
10 | This option defines the default authentication "guard" and password
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
11 | reset "broker" for your application. You may change these values
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
12 | as required, but they're a perfect start for most applications.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
13 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
14 */
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
15
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
16 'defaults' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
17 'guard' => env('AUTH_GUARD', 'web'),
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
18 'passwords' => env('AUTH_PASSWORD_BROKER', 'users'),
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
19 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
20
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
21 /*
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
22 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
23 | Authentication Guards
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
24 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
25 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
26 | Next, you may define every authentication guard for your application.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
27 | Of course, a great default configuration has been defined for you
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
28 | which utilizes session storage plus the Eloquent user provider.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
29 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
30 | All authentication guards have a user provider, which defines how the
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
31 | users are actually retrieved out of your database or other storage
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
32 | system used by the application. Typically, Eloquent is utilized.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
33 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
34 | Supported: "session"
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
35 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
36 */
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
37
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
38 'guards' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
39 'web' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
40 'driver' => 'session',
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
41 'provider' => 'users',
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
42 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
43 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
44
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
45 /*
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
46 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
47 | User Providers
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
48 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
49 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
50 | All authentication guards have a user provider, which defines how the
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
51 | users are actually retrieved out of your database or other storage
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
52 | system used by the application. Typically, Eloquent is utilized.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
53 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
54 | If you have multiple user tables or models you may configure multiple
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
55 | providers to represent the model / table. These providers may then
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
56 | be assigned to any extra authentication guards you have defined.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
57 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
58 | Supported: "database", "eloquent"
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
59 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
60 */
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
61
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
62 'providers' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
63 'users' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
64 'driver' => 'eloquent',
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
65 'model' => env('AUTH_MODEL', App\Models\User::class),
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
66 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
67
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
68 // 'users' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
69 // 'driver' => 'database',
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
70 // 'table' => 'users',
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
71 // ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
72 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
73
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
74 /*
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
75 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
76 | Resetting Passwords
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
77 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
78 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
79 | These configuration options specify the behavior of Laravel's password
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
80 | reset functionality, including the table utilized for token storage
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
81 | and the user provider that is invoked to actually retrieve users.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
82 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
83 | The expiry time is the number of minutes that each reset token will be
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
84 | considered valid. This security feature keeps tokens short-lived so
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
85 | they have less time to be guessed. You may change this as needed.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
86 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
87 | The throttle setting is the number of seconds a user must wait before
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
88 | generating more password reset tokens. This prevents the user from
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
89 | quickly generating a very large amount of password reset tokens.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
90 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
91 */
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
92
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
93 'passwords' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
94 'users' => [
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
95 'provider' => 'users',
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
96 'table' => env('AUTH_PASSWORD_RESET_TOKEN_TABLE', 'password_reset_tokens'),
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
97 'expire' => 60,
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
98 'throttle' => 60,
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
99 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
100 ],
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
101
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
102 /*
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
103 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
104 | Password Confirmation Timeout
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
105 |--------------------------------------------------------------------------
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
106 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
107 | Here you may define the number of seconds before a password confirmation
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
108 | window expires and users are asked to re-enter their password via the
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
109 | confirmation screen. By default, the timeout lasts for three hours.
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
110 |
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
111 */
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
112
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
113 'password_timeout' => env('AUTH_PASSWORD_TIMEOUT', 10800),
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
114
9d7dcd54c677 Initial Commit and package setup
luka
parents:
diff changeset
115 ];