diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guide.html | 39 | ||||
| -rw-r--r-- | doc/guide.tex | 42 |
2 files changed, 71 insertions, 10 deletions
diff --git a/doc/guide.html b/doc/guide.html index b67031a26..1cd15fece 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -695,13 +695,14 @@ these queries. Possible values are: be processed until finished this. Hence this discipline is not recommended if processing of query can take relative many time. <DT><B><TT>one_queue</TT></B><DD> In this case created separate queue for processing - IQ queries of namespace with this discipline, and processing of this queue - done in parallel with processing of other packets. This discipline is most + of IQ queries of namespace with this discipline, and processing of this queue + is done in parallel with processing of other packets. This discipline is most recommended. <DT><B><TT>parallel</TT></B><DD> In this case for all packets with this discipline spawned separate Erlang process, so all these packets processed in parallel. - Although spawning of Erlang process have relative low cost, this can broke - server normal work, because Erlang have limit of 32000 processes. + Although spawning of Erlang process have relatively low cost, this can broke + server normal work, because Erlang emulator have limit on number of processes + (32000 by default). </DL> Example: <PRE> @@ -731,6 +732,33 @@ Example: <H3><A NAME="htoc35">A.2</A> <TT>mod_register</TT></H3><!--SEC END --> <A NAME="sec:modregister"></A> +This module adds support for +<A HREF="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</A> (In-Band +Registration). There is possible to restrict registration via ``register'' +access rule. If this rule returns ``deny'' on requested user name, then +registration is not allowed for it.<BR> +<BR> +Options: +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:register</TT> IQ queries processing + discipline. +</DL> +Example: +<PRE> +% Deny registration for users with too short name +{acl, shortname, {user_glob, "?"}}. +{acl, shortname, {user_glob, "??"}}. +% Another variant: {acl, shortname, {user_regexp, "^..?$"}}. + +{access, register, [{deny, shortname}, + {allow, all}]}. + +{modules, [ + ... + {mod_register, []}, + ... + ]}. +</PRE> <!--TOC subsection <TT>mod_roster</TT>--> <H3><A NAME="htoc36">A.3</A> <TT>mod_roster</TT></H3><!--SEC END --> @@ -772,7 +800,8 @@ Example: <A NAME="sec:modstats"></A> This module adds support for -<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A> (Statistics Gathering).<BR> +<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A> (Statistics +Gathering).<BR> <BR> Options: <DL COMPACT=compact><DT> diff --git a/doc/guide.tex b/doc/guide.tex index e07f93401..53bbdd036 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -658,13 +658,14 @@ these queries. Possible values are: be processed until finished this. Hence this discipline is not recommended if processing of query can take relative many time. \item[\texttt{one\_queue}] In this case created separate queue for processing - IQ queries of namespace with this discipline, and processing of this queue - done in parallel with processing of other packets. This discipline is most + of IQ queries of namespace with this discipline, and processing of this queue + is done in parallel with processing of other packets. This discipline is most recommended. \item[\texttt{parallel}] In this case for all packets with this discipline spawned separate Erlang process, so all these packets processed in parallel. - Although spawning of Erlang process have relative low cost, this can broke - server normal work, because Erlang have limit of 32000 processes. + Although spawning of Erlang process have relatively low cost, this can broke + server normal work, because Erlang emulator have limit on number of processes + (32000 by default). \end{description} Example: @@ -696,6 +697,36 @@ Example: \subsection{\modregister{}} \label{sec:modregister} +This module adds support for +\footahref{http://www.jabber.org/jeps/jep-0077.html}{JEP-0077} (In-Band +Registration). There is possible to restrict registration via ``register'' +access rule. If this rule returns ``deny'' on requested user name, then +registration is not allowed for it. + +Options: +\begin{description} +\item[\texttt{iqdisc}] \ns{jabber:iq:register} IQ queries processing + discipline. +\end{description} + +Example: +\begin{verbatim} +% Deny registration for users with too short name +{acl, shortname, {user_glob, "?"}}. +{acl, shortname, {user_glob, "??"}}. +% Another variant: {acl, shortname, {user_regexp, "^..?$"}}. + +{access, register, [{deny, shortname}, + {allow, all}]}. + +{modules, [ + ... + {mod_register, []}, + ... + ]}. +\end{verbatim} + + \subsection{\modroster{}} @@ -738,7 +769,8 @@ Example: \label{sec:modstats} This module adds support for -\footahref{http://www.jabber.org/jeps/jep-0039.html}{JEP-0039} (Statistics Gathering). +\footahref{http://www.jabber.org/jeps/jep-0039.html}{JEP-0039} (Statistics +Gathering). Options: \begin{description} |