Skip to content

Commit e4996fb

Browse files
RickyGenzRickyGenz
andauthored
update hostname to connection_string (#58)
Co-authored-by: RickyGenz <rgenz1@gmail.com>
1 parent 050dfe5 commit e4996fb

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

docs/ldap.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,12 @@ authentication source:
2828
'ldap:Ldap',
2929

3030
/**
31-
* The connection string for the LDAP-server.
31+
* The connection string for the LDAP server.
3232
* You can add multiple by separating them with a space.
33+
* Cannot contain simple hostnames or IP-addresses,
34+
* but must be given one or more ldap(s):// URIs.
3335
*/
34-
'connection_string' => 'ldap.example.org',
36+
'connection_string' => 'ldaps://ldap.example.org',
3537

3638
/**
3739
* Whether SSL/TLS should be used when contacting the LDAP server.
@@ -161,8 +163,8 @@ See:
161163

162164
You should update the name of this authentication source
163165
(`example-ldap`) to have a name which makes sense to your organization.
164-
You also need to update the `hostname` and `dnpattern` options. The
165-
`hostname` should be the hostname of your LDAP server, and the
166+
You also need to update the `connection_string` and `dnpattern` options. The
167+
`connection_string` should be the connection string for your LDAP server, and the
166168
`dnpattern` should be a pattern which can be used to generate the `dn`
167169
of a user with a given username.
168170

@@ -196,8 +198,8 @@ is the password for that `dn`.
196198

197199
## Configuring failover
198200

199-
You can configure multiple LDAP servers in the hostname option by separating
200-
the individual hosts with a space. This enables the builtin LDAP failover
201+
You can configure multiple LDAP servers in the `connection_string` option by separating
202+
the individual connections with a space. This enables the builtin LDAP failover
201203
in OpenLDAP.
202204

203205
Note that OpenLDAP waits for a timeout from the first server before attempting
@@ -215,10 +217,10 @@ In this case, if we are unable to connect to the first LDAP server within
215217
Example:
216218

217219
```php
218-
/* Configuration that uses two ldap servers. */
220+
/* Configuration that uses two LDAP servers. */
219221
'example-ldap' => [
220222
'ldap:Ldap',
221-
/* The hostname of the LDAP server. */
223+
/* The connection string for the LDAP servers. */
222224
'connect_string' => 'ldaps://ldap1.example.org ldaps://ldap2.example.org',
223225
'dnpattern' => 'uid=%username%,ou=people,dc=example,dc=org',
224226
],
@@ -394,7 +396,7 @@ required, see the config options for ldap:AttributeAddFromLDAP above.
394396
```php
395397
50 => [
396398
'class' => 'ldap:AttributeAddFromLDAP',
397-
'connection_string' => 'ldap.example.org',
399+
'connection_string' => 'ldaps://ldap.example.org',
398400
'search.username' => 'CN=LDAP User,CN=Users,DC=example,DC=org',
399401
'search.password' => 'Abc123',
400402
'search.base' => ['DC=example,DC=org'],
@@ -419,11 +421,11 @@ a listing of all configuration options and their details.
419421

420422

421423
/**
422-
* LDAP connection settings can be retrieved from an ldap:LDAP
424+
* LDAP connection settings can be retrieved from an ldap:Ldap
423425
* authsource. Specify the authsource name here to pull that
424426
* data from the authsources.php file in the config folder.
425427
*
426-
* Note: ldap:LDAPMulti is not supported as the SimpleSAMLphp
428+
* Note: ldap:LdapMulti is not supported as the SimpleSAMLphp
427429
* framework does not pass any information about which
428430
* LDAP source the user selected.
429431
*
@@ -480,18 +482,20 @@ a listing of all configuration options and their details.
480482

481483

482484
/**
483-
* This is the hostname string of LDAP server(s) to try
485+
* This is the connection string of LDAP server(s) to try
484486
* and connect to. It should be the same format as the
485-
* LDAP authsource hostname as it is passed to that class.
487+
* LDAP authsource connection_string as it is passed to that class.
486488
*
487489
* Note: Multiple servers are separated by a space.
490+
* Cannot contain simple hostnames or IP-addresses,
491+
* but must be given one or more ldap(s):// URIs.
488492
*
489493
* Default: NULL
490494
* Required: Yes, unless authsource is used
491-
* AuthSource: hostname
495+
* AuthSource: connection_string
492496
*/
493-
'connection_string' => 'ldap.example.org',
494-
'connection_string' => 'ad1.example.org ad2.example.org',
497+
'connection_string' => 'ldaps://ldap.example.org',
498+
'connection_string' => 'ldaps://ad1.example.org ldaps://ad2.example.org',
495499

496500

497501
/**

0 commit comments

Comments
 (0)