* doc/guide.tex: Document ldap_local_filter (EJAB-179)

SVN Revision: 1353

diff --git a/ChangeLog b/ChangeLog
index de112f5df4a51815ce846114435c90214719cc2c..f247972bc77b768930c0f4aa1267f089dee70916 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,7 +2,9 @@
 
        * doc/guide.tex: Table of listener modules converted to
        description. Table of modules overview simplified, and module
-       names link to their sections.
+       names link to their sections. Document
+       ldap_local_filter (EJAB-179)
+
        * doc/guide.html: Regenerated with all the latest changes
 
 2008-06-12  Badlop  <badlop@process-one.net>

diff --git a/doc/guide.tex b/doc/guide.tex
index 63e164cb8a6119f4f06849c7cd8a72be42bad240..6cd71c7f0a2877da4d3240db33fe434f97190276 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -144,7 +144,8 @@ ejabberd Development Team
 
 %% To by-pass errors in the HTML version:
 \newstyle{.SPAN}{width:20\%; float:right; text-align:left; margin-left:auto;}
-\newstyle{H1 A, H2 A, H3 A, H4 A}{color:\#000000; text-decoration:none;}
+\newstyle{H1.chapter A, H2.section A, H3.subsection A, H4.subsubsection A, H5.paragraph A}
+  {color:\#000000; text-decoration:none;}
 \newstyle{pre.verbatim}{margin:1ex 2ex;border:1px dashed lightgrey;background-color:\#f9f9f9;padding:0.5ex;}
 \newstyle{.dt-description}{margin:0ex 2ex;}
 \newstyle{table[border="1"]}{border-collapse:collapse;margin-bottom:1em;}
@@ -1737,6 +1738,21 @@ You can authenticate users against an LDAP directory. Available options are:
   not forget to close brackets and do not use superfluous whitespaces. Also you
   \emph{must not} use \option{ldap\_uidattr} attribute in filter because this
   attribute will be substituted in LDAP filter automatically.
+
+  \titem{ldap\_local\_filter}\ind{options!ldap\_local\_filter}
+  If you can't use \term{ldap\_filter} due to performance reasons
+  (the LDAP server has many users registered),
+  you can use this local filter.
+  The local filter checks an attribute in ejabberd,
+  not in LDAP, so this limits the load on the LDAP directory.
+  The default filter is: \term{undefined}.
+  Example values:
+\begin{verbatim}
+{ldap_local_filter, {notequal, {"accountStatus",["disabled"]}}}.
+{ldap_local_filter, {equal, {"accountStatus",["enabled"]}}}.
+{ldap_local_filter, undefined}.
+\end{verbatim}
+
 \end{description}
 
 \makesubsubsection{ldapexamples}{Examples}