Skip to content
This repository was archived by the owner on Jul 24, 2023. It is now read-only.

Commit f0f3c9e

Browse files
committed
Formatting and doc tweaks.
1 parent f32cdcc commit f0f3c9e

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

src/Config/auth.php

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| Connection
88
|--------------------------------------------------------------------------
99
|
10-
| The connection to use for authentication.
10+
| The LDAP connection to use for laravel authentication.
1111
|
1212
| You must specify connections in your `config/adldap.php` configuration file.
1313
|
@@ -26,11 +26,10 @@
2626
| attribute to discover the user by. The reason for this is to hide
2727
| the attribute that you're using to login users.
2828
|
29-
| For example, if your HTML input name is `email` and you'd like users
30-
| to login by their LDAP `mail` attribute, then keep the
31-
| configuration below. However, if you'd like to login users
32-
| by their usernames, then change `mail` to `samaccountname`.
33-
| and `email` to `username`.
29+
| For example, if your HTML input name is `email` and you'd like users to login
30+
| by their LDAP `mail` attribute, then keep the configuration below. However,
31+
| if you'd like to login users by their usernames, then change `mail`
32+
| to `samaccountname`. and `email` to `username`.
3433
|
3534
| This must be an array with a key - value pair.
3635
|
@@ -46,7 +45,13 @@
4645
| The limitation filter allows you to enter a raw filter to only allow
4746
| specific users / groups / ous to authenticate.
4847
|
49-
| This should be a standard LDAP filter.
48+
| For an example, to only allow users inside of a group
49+
| named 'Accounting', you would insert the Accounting
50+
| groups full distinguished name inside the filter:
51+
|
52+
| '(memberof=cn=Accounting,dc=corp,dc=acme,dc=org)'
53+
|
54+
| This value must be a standard LDAP filter.
5055
|
5156
*/
5257

@@ -91,7 +96,7 @@
9196
|
9297
| The password sync option allows you to automatically synchronize
9398
| users AD passwords to your local database. These passwords are
94-
| hashed natively by laravel.
99+
| hashed natively by laravel using the bcrypt() method.
95100
|
96101
| Enabling this option would also allow users to login to their
97102
| accounts using the password last used when an AD connection
@@ -155,15 +160,14 @@
155160
| Bind User to Model
156161
|--------------------------------------------------------------------------
157162
|
158-
| The bind user to model option allows you to access the Adldap user model
159-
| instance on your laravel database model to be able run operations
160-
| or retrieve extra attributes on the Adldap user model instance.
163+
| The 'bind user to model' option allows you to access the authenticated
164+
| Adldap user model instance on your laravel User model.
161165
|
162166
| If this option is true, you must insert the trait:
163167
|
164168
| `Adldap\Laravel\Traits\AdldapUserModelTrait`
165169
|
166-
| Onto your User model configured in `config/auth.php`.
170+
| Onto your User model that is configured in `config/auth.php`.
167171
|
168172
| Then use `Auth::user()->adldapUser` to access.
169173
|
@@ -185,8 +189,8 @@
185189
| The array key represents the Laravel model key, and the value
186190
| represents the Active Directory attribute to set it to.
187191
|
188-
| Your login attribute is already synchronized and does not need to be
189-
| added to this array.
192+
| Your login attribute (configured above) is already synchronized
193+
| and does not need to be added to this array.
190194
|
191195
*/
192196

@@ -206,6 +210,9 @@
206210
| If no attributes are given inside the array, all attributes on the
207211
| user are selected.
208212
|
213+
| This is configurable to allow for faster LDAP queries, rather
214+
| than retrieving all attributes on every login.
215+
|
209216
| ** Note ** : Keep in mind you must include attributes that you would
210217
| like to synchronize, as well as your login attribute.
211218
|

0 commit comments

Comments
 (0)