summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_ldap.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual/mod/mod_ldap.xml')
-rw-r--r--docs/manual/mod/mod_ldap.xml23
1 files changed, 18 insertions, 5 deletions
diff --git a/docs/manual/mod/mod_ldap.xml b/docs/manual/mod/mod_ldap.xml
index f41f77d138..0bef2b366b 100644
--- a/docs/manual/mod/mod_ldap.xml
+++ b/docs/manual/mod/mod_ldap.xml
@@ -631,11 +631,24 @@ connection client certificates.</description>
<contextlist><context>server config</context></contextlist>
<usage>
- <p>Specifies the timeout value (in seconds) in which the module will
- attempt to connect to the LDAP server. If a connection is not
- successful with the timeout period, either an error will be
- returned or the module will attempt to connect to a secondary LDAP
- server if one is specified. The default is 10 seconds.</p>
+ <p>This directive configures the LDAP_OPT_NETWORK_TIMEOUT option in the
+ underlying LDAP client library, when available. This value typically
+ controls how long the LDAP client library will wait for various network
+ calls to complete, including establishing a connection to the target LDAP
+ server.</p>
+
+ <p> If a connection is not successful with the timeout period, either an error will be
+ returned or the LDAP client library will attempt to connect to a secondary LDAP
+ server if one is specified (via a space-separated list of hostnames in the
+ <directive module="mod_ldap">AuthLDAPURL</directive>).</p>
+
+ <p>The default is 10 seconds, if the LDAP client library linked with the
+ server supports the LDAP_OPT_NETWORK_TIMEOUT option.</p>
+
+ <note>LDAPConnectionTimeout is only available when the LDAP client library linked
+ with the server supports the LDAP_OPT_NETWORK_TIMEOUT option, and the
+ ultimate behavior is dictated entirely by the LDAP client library.
+ </note>
</usage>
</directivesynopsis>