25
1
mirror of https://github.com/processone/ejabberd.git synced 2024-11-20 16:15:59 +01:00

Improve documentation of ldap_servers and ldap_backups options (#3977)

This commit is contained in:
Badlop 2024-09-09 18:42:34 +02:00
parent 941d51a6e7
commit eec836239f

View File

@ -750,19 +750,22 @@ doc() ->
{ldap_servers, {ldap_servers,
#{value => "[Host, ...]", #{value => "[Host, ...]",
desc => desc =>
?T("A list of IP addresses or DNS names of your LDAP servers. " ?T("A list of IP addresses or DNS names of your LDAP servers (see "
"_`../configuration/ldap.md#ldap-connection|LDAP connection`_). "
"ejabberd connects immediately to all of them, "
"and reconnects infinitely if connection is lost. "
"The default value is '[localhost]'.")}}, "The default value is '[localhost]'.")}},
{ldap_backups, {ldap_backups,
#{value => "[Host, ...]", #{value => "[Host, ...]",
desc => desc =>
?T("A list of IP addresses or DNS names of LDAP backup servers. " ?T("A list of IP addresses or DNS names of LDAP backup servers (see "
"_`../configuration/ldap.md#ldap-connection|LDAP connection`_). "
"When no servers listed in _`ldap_servers`_ option are reachable, " "When no servers listed in _`ldap_servers`_ option are reachable, "
"ejabberd will try to connect to these backup servers. " "ejabberd connects to these backup servers. "
"The default is an empty list, i.e. no backup servers specified. " "The default is an empty list, i.e. no backup servers specified. "
"WARNING: ejabberd doesn't try to reconnect back to the main " "Please notice that ejabberd only connects to the next server "
"servers when they become operational again, so the only way " "when the existing connection is lost; it doesn't detect when a "
"to restore these connections is to restart ejabberd. This " "previously-attempted server becomes available again.")}},
"limitation might be fixed in future releases.")}},
{ldap_encrypt, {ldap_encrypt,
#{value => "tls | none", #{value => "tls | none",
desc => desc =>