Skip to content

Commit ea432c3

Browse files
committed
Update documentation
1 parent 0509008 commit ea432c3

File tree

1 file changed

+92
-17
lines changed

1 file changed

+92
-17
lines changed

doc/auth.conf.pod

+92-17
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,36 @@ Search the whole tree below the base object. This is the default.
205205

206206
=back
207207

208+
=item C<deref>
209+
210+
Default value: C<find>
211+
212+
Specifies how to dereference aliases.
213+
214+
Introduced on Sympa 6.2.74.
215+
216+
=over
217+
218+
=item C<never>
219+
220+
Aliases are never dereferenced.
221+
222+
=item C<search>
223+
224+
Aliases are dereferenced in searching subordinates of the base object.
225+
226+
=item C<find>
227+
228+
Aliases are derefernced in locating the base object, but
229+
not in searching subordinates of the base object.
230+
This is the default.
231+
232+
=item C<always>
233+
234+
Aliases are always dereferenced.
235+
236+
=back
237+
208238
=item C<authentication_info_url>
209239

210240
Defines the URL of a document describing LDAP password management. When
@@ -385,31 +415,50 @@ not defined>:
385415

386416
=over
387417

388-
=item C<ldap_host>
418+
=item C<host>
389419

390-
The LDAP host Sympa will connect to fetch user email. The C<ldap_host>
420+
(formerly C<ldap_host>)
421+
422+
The LDAP host Sympa will connect to fetch user email. The C<host>
391423
include the port number and it may be a comma separated list of redundant
392424
hosts.
393425

394-
=item C<ldap_bind_dn>
426+
=item C<bind_dn>
427+
428+
(formerly C<ldap_bind_dn>)
395429

396430
The DN used to bind to this server. Anonymous bind is used if this parameter
397431
is not defined.
398432

399-
=item C<ldap_bind_password>
433+
=item C<bind_password>
434+
435+
(formerly C<ldap_bind_password>)
400436

401437
The password used unless anonymous bind is used.
402438

403-
=item C<ldap_suffix>
439+
=item C<suffix>
440+
441+
(formerly C<ldap_suffix>)
404442

405443
The LDAP suffix used when searching user email.
406444

407-
=item C<ldap_scope>
445+
=item C<scope>
446+
447+
(formerly C<ldap_scope>)
408448

409449
The scope used when searching user email. Possible values are C<sub>, C<base>
410450
and C<one>.
411451

412-
=item C<ldap_get_email_by_uid_filter>
452+
=item C<deref>
453+
454+
(introduced on 6.2.74)
455+
456+
How to dereference the aliases on searching LDAP.
457+
Possible values are C<never>, C<search>, C<find> and C<always>.
458+
459+
=item C<get_email_by_uid_filter>
460+
461+
(formerly C<ldap_get_email_by_uid_filter>)
413462

414463
The filter used to perform the email search. It can refer to any environment
415464
variables inherited from the SSO module, as shown below.
@@ -418,12 +467,16 @@ Example:
418467

419468
ldap_get_email_by_uid_filter (mail=[SSL_CLIENT_S_DN_Email])
420469

421-
=item C<ldap_email_attribute>
470+
=item C<email_attribute>
471+
472+
(formerly C<ldap_email_attribute>)
422473

423474
The attribute name to be used as user canonical email. In the current version
424475
of Sympa, only the first value returned by the LDAP server is used.
425476

426-
=item C<ldap_timeout>
477+
=item C<timeout>
478+
479+
(formerly C<ldap_timeout>)
427480

428481
The time out for the search.
429482

@@ -519,40 +572,62 @@ The proxy validate service path, only used by the Sympa SOAP server.
519572

520573
=over
521574

522-
=item C<ldap_host>
575+
=item C<host>
576+
577+
(formerly C<ldap_host>)
523578

524579
The LDAP host Sympa will connect to fetch user email when user uid is return
525580
by CAS service. The C<ldap_host> includes the port number and it may be a
526581
comma separated list of redundant hosts.
527582

528-
=item C<ldap_bind_dn>
583+
=item C<bind_dn>
584+
585+
(formerly C<ldap_bind_dn>)
529586

530587
The DN used to bind to this server. Anonymous bind is used if this parameter
531588
is not defined.
532589

533-
=item C<ldap_bind_password>
590+
=item C<bind_password>
591+
592+
(formerly C<ldap_bind_password>)
534593

535594
The password used unless anonymous bind is used.
536595

537-
=item C<ldap_suffix>
596+
=item C<suffix>
597+
598+
(formerly C<ldap_suffix>)
538599

539600
The LDAP suffix used when searching user email.
540601

541-
=item C<ldap_scope>
602+
=item C<scope>
603+
604+
(formerly C<ldap_scope>)
542605

543606
The scope used when searching user email. Possible values are C<sub>, C<base>
544607
and C<one>.
545608

546-
=item C<ldap_get_email_by_uid_filter>
609+
=item C<deref>
610+
611+
(introduced on 6.2.74)
612+
613+
How to dereference the aliases on searching LDAP.
614+
615+
=item C<get_email_by_uid_filter>
616+
617+
(formerly C<ldap_get_email_by_uid_filter>)
547618

548619
The filter used to perform the email search.
549620

550-
=item C<ldap_email_attribute>
621+
=item C<email_attribute>
622+
623+
(formerly C<ldap_email_attribute>)
551624

552625
The attribute name to be used as user canonical email. In the current version
553626
of Sympa, only the first value returned by the LDAP server is used.
554627

555-
=item C<ldap_timeout>
628+
=item C<timeout>
629+
630+
(formerly C<ldap_timeout>)
556631

557632
The time out for the search.
558633

0 commit comments

Comments
 (0)