diff --git a/ChangeLog b/ChangeLog index 7df9dfa5f..49d3091ee 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2008-03-13 Badlop + * doc/guide.tex: Describe option Matches in mod_vcard_ldap (thanks + to Evgeniy Khramtsov)(EJAB-530). Fix typo in the description of + ldap_server option. + * doc/guide.html: Likewise + * src/mod_echo.erl: Small change to avoid a compilation warning of unused function diff --git a/doc/guide.html b/doc/guide.html index 687e18b5f..5c6dda11c 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -557,7 +557,7 @@ you can define the global modules option with the common modules, and later add specific modules to certain virtual hosts. To accomplish that, instead of defining each option in host_config with the syntax 

  {<option-name>, <option-value>}
-

you must use this syntax: +

use this syntax: 

  {{add, <option-name>}, <option-value>}

In this example three virtual hosts have some similar modules, but there are also other different modules for some specific virtual hosts: @@ -1318,8 +1318,8 @@ yet.

Connection

Parameters:

-ldap_server
IP address or dns name of your -LDAP server. This option is required. +ldap_servers
List of IP addresses or DNS names of your +LDAP servers. This option is required.
ldap_port
Port to connect to your LDAP server. The initial default value is 389, so it is used when nothing is set into the configuration file. @@ -1621,13 +1621,14 @@ the "@HOST@" keyword must be used:

3.3.3  mod_announce

This module enables configured users to broadcast announcements and to set -the message of the day (MOTD).

Configured users can perform these actions with a +the message of the day (MOTD). +Configured users can perform these actions with a Jabber client either using Ad-hoc commands or sending messages to specific JIDs.

The Ad-hoc commands are listed in the Server Discovery. -For this feature to work, mod_adhocmust be enabled.

The specific JIDs where messages can be sent are listed listed now. +For this feature to work, mod_adhoc must be enabled.

The specific JIDs where messages can be sent are listed bellow. The first JID in each entry will apply only to the specified virtual host example.org, while the JID between brackets will apply to all virtual -hosts in ejabberd: +hosts in ejabberd.

example.org/announce/all (example.org/announce/all-hosts/all)
The message is sent to all registered users. If the user is online and connected @@ -2488,6 +2489,7 @@ users who added some information to their vCard. The default value is
search_all_hosts
If this option is set to true, search operations will apply to all virtual hosts. Otherwise only the current host will be searched. The default value is true. +This option is available in mod_vcard, but not available in mod_vcard_odbc.

Examples:

  • In this first situation, search results are limited to twenty items, @@ -2517,14 +2519,14 @@ and that all virtual hosts will be searched instead of only the current one:

    ejabberd can map LDAP attributes to vCard fields. This behaviour is implemented in the mod_vcard_ldap module. This module does not depend on the -authentication method (see 3.2.5). The mod_vcard_ldap module has +authentication method (see 3.2.5).

    The mod_vcard_ldap module has its own optional parameters. The first group of parameters has the same meaning as the top-level LDAP parameters to set the authentication method: ldap_servers, ldap_port, ldap_rootdn, ldap_password, ldap_base, ldap_uids, and ldap_filter. See section 3.2.5 for detailed information about these options. If one of these options is not set, ejabberd will look -for the top-level option with the same name. The second group of parameters +for the top-level option with the same name.

    The second group of parameters consists of the following mod_vcard_ldap-specific options:

    host
    This option defines the Jabber ID of the @@ -2539,6 +2541,9 @@ functionality is enabled (value: true) or disabled (value: false). If disabled, the option host will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true. +
    matches
    With this option, the number of reported +search results can be limited. If the option’s value is set to infinity, +all search results are reported. The default value is 30.
    ldap_vcard_map
    With this option you can set the table that maps LDAP attributes to vCard fields. The format is: [Name_of_vCard_field, Pattern, List_of_LDAP_attributes, ...]. diff --git a/doc/guide.tex b/doc/guide.tex index 56a2521e0..79422d9ba 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1657,8 +1657,8 @@ yet. Parameters: \begin{description} -\titem{ldap\_server} \ind{options!ldap\_server}IP address or dns name of your -LDAP server. This option is required. +\titem{ldap\_servers} \ind{options!ldap\_server}List of IP addresses or DNS names of your +LDAP servers. This option is required. \titem{ldap\_port} \ind{options!ldap\_port}Port to connect to your LDAP server. The initial default value is~389, so it is used when nothing is set into the configuration file. @@ -3111,6 +3111,7 @@ Options: \titem{search\_all\_hosts}\ind{options!search\_all\_hosts}If this option is set to \term{true}, search operations will apply to all virtual hosts. Otherwise only the current host will be searched. The default value is \term{true}. + This option is available in \modvcard, but not available in \modvcardodbc. \end{description} Examples: @@ -3151,14 +3152,18 @@ Examples: \ejabberd{} can map LDAP attributes to vCard fields. This behaviour is implemented in the \modvcardldap{} module. This module does not depend on the -authentication method (see~\ref{ldapauth}). The \modvcardldap{} module has +authentication method (see~\ref{ldapauth}). + +The \modvcardldap{} module has its own optional parameters. The first group of parameters has the same meaning as the top-level LDAP parameters to set the authentication method: \option{ldap\_servers}, \option{ldap\_port}, \option{ldap\_rootdn}, \option{ldap\_password}, \option{ldap\_base}, \option{ldap\_uids}, and \option{ldap\_filter}. See section~\ref{ldapauth} for detailed information about these options. If one of these options is not set, \ejabberd{} will look -for the top-level option with the same name. The second group of parameters +for the top-level option with the same name. + +The second group of parameters consists of the following \modvcardldap{}-specific options: \begin{description} @@ -3169,6 +3174,9 @@ consists of the following \modvcardldap{}-specific options: \term{false}). If disabled, the option \term{host} will be ignored and the \Jabber{} User Directory service will not appear in the Service Discovery item list. The default value is \term{true}. +\titem{matches}\ind{options!matches}With this option, the number of reported + search results can be limited. If the option's value is set to \term{infinity}, + all search results are reported. The default value is \term{30}. \titem{ldap\_vcard\_map}\ind{options!ldap\_vcard\_map}With this option you can set the table that maps LDAP attributes to vCard fields. The format is: \term{[{Name\_of\_vCard\_field, Pattern, List\_of\_LDAP\_attributes}, ...]}.\ind{protocols!RFC 2426: vCard MIME Directory Profile}