Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-12-02 16:37:52 +01:00
Code Releases Activity

* doc/guide.tex: Describe option Matches in mod_vcard_ldap (thanks

Browse Source 
to Evgeniy Khramtsov)(EJAB-530).  Fix typo in the description of
ldap_server option.
* doc/guide.html: Likewise

SVN Revision: 1229
This commit is contained in:
Badlop 2008-03-13 10:59:57 +00:00
parent 17e751521f
commit ffb1f97cf4
3 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,5 +1,10 @@
2008-03-13 Badlop <badlop@process-one.net> 2008-03-13 Badlop <badlop@process-one.net>
* 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 * src/mod_echo.erl: Small change to avoid a compilation warning of
unused function unused function

21
doc/guide.html
View File

@ -559,7 +559,7 @@ you can define the global <TT>modules</TT> option with the common modules,
and later add specific modules to certain virtual hosts. and later add specific modules to certain virtual hosts.
To accomplish that, instead of defining each option in <TT>host_config</TT> with the syntax To accomplish that, instead of defining each option in <TT>host_config</TT> with the syntax
</P><PRE CLASS="verbatim"> {&lt;option-name&gt;, &lt;option-value&gt;} </P><PRE CLASS="verbatim"> {&lt;option-name&gt;, &lt;option-value&gt;}
</PRE><P>you must use this syntax: </PRE><P>use this syntax:
</P><PRE CLASS="verbatim"> {{add, &lt;option-name&gt;}, &lt;option-value&gt;} </P><PRE CLASS="verbatim"> {{add, &lt;option-name&gt;}, &lt;option-value&gt;}
</PRE><P>In this example three virtual hosts have some similar modules, but there are also </PRE><P>In this example three virtual hosts have some similar modules, but there are also
other different modules for some specific virtual hosts: other different modules for some specific virtual hosts:
@ -1320,8 +1320,8 @@ yet.</P><!--TOC subsubsection Connection-->
<H4 CLASS="subsubsection"><!--SEC ANCHOR -->Connection</H4><!--SEC END --><P> <H4 CLASS="subsubsection"><!--SEC ANCHOR -->Connection</H4><!--SEC END --><P>
<A NAME="ldapconnection"></A></P><P>Parameters: <A NAME="ldapconnection"></A></P><P>Parameters:
</P><DL CLASS="description"><DT CLASS="dt-description"> </P><DL CLASS="description"><DT CLASS="dt-description">
<B><TT>ldap_server</TT></B></DT><DD CLASS="dd-description"> IP address or dns name of your <B><TT>ldap_servers</TT></B></DT><DD CLASS="dd-description"> List of IP addresses or DNS names of your
LDAP server. This option is required. LDAP servers. This option is required.
</DD><DT CLASS="dt-description"><B><TT>ldap_port</TT></B></DT><DD CLASS="dd-description"> Port to connect to your LDAP server. </DD><DT CLASS="dt-description"><B><TT>ldap_port</TT></B></DT><DD CLASS="dd-description"> Port to connect to your LDAP server.
The initial default value is&#XA0;389, so it is used when nothing is set into the The initial default value is&#XA0;389, so it is used when nothing is set into the
configuration file. configuration file.
@ -1623,13 +1623,14 @@ the "@HOST@" keyword must be used:
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc36">3.3.3</A>&#XA0;&#XA0;<TT>mod_announce</TT></H3><!--SEC END --><P> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc36">3.3.3</A>&#XA0;&#XA0;<TT>mod_announce</TT></H3><!--SEC END --><P>
<A NAME="modannounce"></A> <A NAME="modannounce"></A>
</P><P>This module enables configured users to broadcast announcements and to set </P><P>This module enables configured users to broadcast announcements and to set
the message of the day (MOTD). </P><P>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 Jabber client either using Ad-hoc commands
or sending messages to specific JIDs.</P><P>The Ad-hoc commands are listed in the Server Discovery. or sending messages to specific JIDs.</P><P>The Ad-hoc commands are listed in the Server Discovery.
For this feature to work, <TT>mod_adhoc</TT>must be enabled.</P><P>The specific JIDs where messages can be sent are listed listed now. For this feature to work, <TT>mod_adhoc</TT> must be enabled.</P><P>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 The first JID in each entry will apply only to the specified virtual host
<TT>example.org</TT>, while the JID between brackets will apply to all virtual <TT>example.org</TT>, while the JID between brackets will apply to all virtual
hosts in ejabberd: hosts in ejabberd.
</P><DL CLASS="description"><DT CLASS="dt-description"> </P><DL CLASS="description"><DT CLASS="dt-description">
<B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B></DT><DD CLASS="dd-description"> The <B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B></DT><DD CLASS="dd-description"> The
message is sent to all registered users. If the user is online and connected message is sent to all registered users. If the user is online and connected
@ -2573,6 +2574,7 @@ users who added some information to their vCard. The default value is
</DD><DT CLASS="dt-description"><B><TT>search_all_hosts</TT></B></DT><DD CLASS="dd-description">If this option is set </DD><DT CLASS="dt-description"><B><TT>search_all_hosts</TT></B></DT><DD CLASS="dd-description">If this option is set
to <TT>true</TT>, search operations will apply to all virtual hosts. Otherwise to <TT>true</TT>, search operations will apply to all virtual hosts. Otherwise
only the current host will be searched. The default value is <TT>true</TT>. only the current host will be searched. The default value is <TT>true</TT>.
This option is available in <TT>mod_vcard</TT>, but not available in <TT>mod_vcard_odbc</TT>.
</DD></DL><P>Examples: </DD></DL><P>Examples:
</P><UL CLASS="itemize"><LI CLASS="li-itemize"> </P><UL CLASS="itemize"><LI CLASS="li-itemize">
In this first situation, search results are limited to twenty items, In this first situation, search results are limited to twenty items,
@ -2602,14 +2604,14 @@ and that all virtual hosts will be searched instead of only the current one:
<A NAME="modvcardldap"></A> <A NAME="modvcardldap"></A>
</P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is </P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is
implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the
authentication method (see&#XA0;<A HREF="#ldapauth">3.2.5</A>). The <TT>mod_vcard_ldap</TT> module has authentication method (see&#XA0;<A HREF="#ldapauth">3.2.5</A>).</P><P>The <TT>mod_vcard_ldap</TT> module has
its own optional parameters. The first group of parameters has the same its own optional parameters. The first group of parameters has the same
meaning as the top-level LDAP parameters to set the authentication method: meaning as the top-level LDAP parameters to set the authentication method:
<TT>ldap_servers</TT>, <TT>ldap_port</TT>, <TT>ldap_rootdn</TT>, <TT>ldap_servers</TT>, <TT>ldap_port</TT>, <TT>ldap_rootdn</TT>,
<TT>ldap_password</TT>, <TT>ldap_base</TT>, <TT>ldap_uids</TT>, and <TT>ldap_password</TT>, <TT>ldap_base</TT>, <TT>ldap_uids</TT>, and
<TT>ldap_filter</TT>. See section&#XA0;<A HREF="#ldapauth">3.2.5</A> for detailed information <TT>ldap_filter</TT>. See section&#XA0;<A HREF="#ldapauth">3.2.5</A> for detailed information
about these options. If one of these options is not set, <TT>ejabberd</TT> will look about these options. If one of these options is not set, <TT>ejabberd</TT> 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.</P><P>The second group of parameters
consists of the following <TT>mod_vcard_ldap</TT>-specific options:</P><DL CLASS="description"><DT CLASS="dt-description"> consists of the following <TT>mod_vcard_ldap</TT>-specific options:</P><DL CLASS="description"><DT CLASS="dt-description">
<B><TT>host</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the <B><TT>host</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the
@ -2624,6 +2626,9 @@ functionality is enabled (value: <TT>true</TT>) or disabled (value:
<TT>false</TT>). If disabled, the option <TT>host</TT> will be ignored and the <TT>false</TT>). If disabled, the option <TT>host</TT> will be ignored and the
Jabber User Directory service will not appear in the Service Discovery item Jabber User Directory service will not appear in the Service Discovery item
list. The default value is <TT>true</TT>. list. The default value is <TT>true</TT>.
</DD><DT CLASS="dt-description"><B><TT>matches</TT></B></DT><DD CLASS="dd-description">With this option, the number of reported
search results can be limited. If the option&#X2019;s value is set to <TT>infinity</TT>,
all search results are reported. The default value is <TT>30</TT>.
</DD><DT CLASS="dt-description"><B><TT>ldap_vcard_map</TT></B></DT><DD CLASS="dd-description">With this option you can </DD><DT CLASS="dt-description"><B><TT>ldap_vcard_map</TT></B></DT><DD CLASS="dd-description">With this option you can
set the table that maps LDAP attributes to vCard fields. The format is: set the table that maps LDAP attributes to vCard fields. The format is:
<TT>[</TT><TT>Name_of_vCard_field, Pattern, List_of_LDAP_attributes</TT><TT>, ...]</TT>. <TT>[</TT><TT>Name_of_vCard_field, Pattern, List_of_LDAP_attributes</TT><TT>, ...]</TT>.

16
doc/guide.tex
View File

@ -1657,8 +1657,8 @@ yet.
Parameters: Parameters:
\begin{description} \begin{description}
\titem{ldap\_server} \ind{options!ldap\_server}IP address or dns name of your \titem{ldap\_servers} \ind{options!ldap\_server}List of IP addresses or DNS names of your
LDAP server. This option is required. LDAP servers. This option is required.
\titem{ldap\_port} \ind{options!ldap\_port}Port to connect to your LDAP server. \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 The initial default value is~389, so it is used when nothing is set into the
configuration file. configuration file.
@ -3111,6 +3111,7 @@ Options:
\titem{search\_all\_hosts}\ind{options!search\_all\_hosts}If this option is set \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 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}. 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} \end{description}
Examples: Examples:
@ -3151,14 +3152,18 @@ Examples:
\ejabberd{} can map LDAP attributes to vCard fields. This behaviour is \ejabberd{} can map LDAP attributes to vCard fields. This behaviour is
implemented in the \modvcardldap{} module. This module does not depend on the 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 its own optional parameters. The first group of parameters has the same
meaning as the top-level LDAP parameters to set the authentication method: meaning as the top-level LDAP parameters to set the authentication method:
\option{ldap\_servers}, \option{ldap\_port}, \option{ldap\_rootdn}, \option{ldap\_servers}, \option{ldap\_port}, \option{ldap\_rootdn},
\option{ldap\_password}, \option{ldap\_base}, \option{ldap\_uids}, and \option{ldap\_password}, \option{ldap\_base}, \option{ldap\_uids}, and
\option{ldap\_filter}. See section~\ref{ldapauth} for detailed information \option{ldap\_filter}. See section~\ref{ldapauth} for detailed information
about these options. If one of these options is not set, \ejabberd{} will look 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: consists of the following \modvcardldap{}-specific options:
\begin{description} \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 \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 \Jabber{} User Directory service will not appear in the Service Discovery item
list. The default value is \term{true}. 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 \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: 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} \term{[{Name\_of\_vCard\_field, Pattern, List\_of\_LDAP\_attributes}, ...]}.\ind{protocols!RFC 2426: vCard MIME Directory Profile}