* doc/guide.tex: Document option registration_timeout (EJAB-614)

SVN Revision: 1302

diff --git a/ChangeLog b/ChangeLog
index d712b3a7f3780d714c3d70d89e556c05ed8f5c14..922e144b23ca0eee953ddd02a98e27a9968b319b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2008-04-26  Badlop  <badlop@process-one.net>
+
+       * doc/guide.tex: Document option registration_timeout (EJAB-614)
+
 2008-04-25  Badlop  <badlop@process-one.net>
        
        * src/ejabberd_c2s.erl: Added forbidden_session_hook
@@ -14,7 +18,7 @@
        activated when registration fails
 
        * src/mod_register.erl: Restrict registration frequency per IP or
-       user
+       user (EJAB-614)
        * src/ejabberd_c2s.erl: Pass IP to the c2s_unauthenticated_iq hook
        * src/ejabberd_config.erl: Added registration_timeout option
 

diff --git a/doc/guide.tex b/doc/guide.tex
index b8b9fd1db3c3fb1b25b80cb8ab76e145599acb0f..2fcffc610f74ab5901ea097e997945c8923c9be7 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3001,6 +3001,14 @@ Options:
 \iqdiscitem{In-Band Registration (\ns{jabber:iq:register})}
 \end{description}
 
+This module reads also another option defined globably for the server:
+\term{\{registration\_timeout, Timeout\}}. \ind{options!registratimeout}
+This option limits the frequency of registration from a given IP or username.
+So, a user can't register a new account from the same IP address or JID during
+this number of seconds after previous registration.
+Timeout is expressed in seconds, and must be an integer.
+Default value: 600 seconds.
+
 Examples:
 \begin{itemize}
 \item Next example prohibits the registration of too short account names:
@@ -3035,8 +3043,10 @@ Examples:
     ...
    ]}.
 \end{verbatim}
-\item Define the welcome message and three registration watchers:
+\item Define the welcome message and three registration watchers.
+Also define a registration timeout of one hour:
   \begin{verbatim}
+  {registration_timeout, 3600}.
   {modules,
    [
     ...