* doc/guide.tex: Added recommandations on max_stanza options usage.

SVN Revision: 822

diff --git a/ChangeLog b/ChangeLog
index 182461b8aea35cee03f64a46685c2b3dab39dc61..0ae2ea0894172b9dfe43f54983634af730c69f9a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2007-07-24  Mickael Remond  <mickael.remond@process-one.net>
 
+       * doc/guide.tex: Added recommandations on max_stanza options
+       usage.
+
        * src/ejabberd_s2s_out.erl: Autodisconnect s2s connections which
        are overloaded (EJAB-287).
        * src/p1_fsm.erl: Likewise.

diff --git a/doc/guide.html b/doc/guide.html
index f0de1e5cf1befb399a39f9fa49a96b26e080853c..52090d3dac9e87b389376ac89a7df8abed381753 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -6,7 +6,7 @@
  
  
 
-   & ejabberd 2.0.0 beta 1 
+   & ejabberd 1.1.2 
    &
    & Installation and Operation Guide
  
@@ -85,7 +85,7 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
 <HR SIZE=2><BR>
 <BR>
 
-<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD VALIGN=top ALIGN=left>&nbsp;</TD><TD VALIGN=top ALIGN=right NOWRAP><FONT SIZE=6><B>ejabberd 2.0.0 beta 1 </B></FONT></TD></TR>
+<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD VALIGN=top ALIGN=left>&nbsp;</TD><TD VALIGN=top ALIGN=right NOWRAP><FONT SIZE=6><B>ejabberd 1.1.2 </B></FONT></TD></TR>
 <TR><TD VALIGN=top ALIGN=left>&nbsp;</TD><TD VALIGN=top ALIGN=right NOWRAP>&nbsp;</TD></TR>
 <TR><TD VALIGN=top ALIGN=left>&nbsp;</TD><TD VALIGN=top ALIGN=right NOWRAP><FONT SIZE=6>Installation and Operation Guide</FONT></TD></TR>
 </TABLE><BR>
@@ -541,11 +541,15 @@ instructions for <TT>ejabberd</TT>).
 </P></DD><DT CLASS="dt-description"><B><TT>inet6</TT></B></DT><DD CLASS="dd-description"> Set up the socket for IPv6.
 </DD><DT CLASS="dt-description"><B><TT>{ip, IPAddress}</TT></B></DT><DD CLASS="dd-description"> This option specifies which network
 interface to listen for. For example <CODE>{ip, {192, 168, 1, 1}}</CODE>.
-</DD><DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B></DT><DD CLASS="dd-description"> This
-option specifies an approximate maximum size in bytes of XML stanzas.
-Approximate, because it is calculated with the precision of one block of
-readed data. For example <CODE>{max_stanza_size, 65536}</CODE>. The default
-value is <TT>infinity</TT>.
+</DD><DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B></DT><DD CLASS="dd-description">
+This option specifies an
+approximate maximum size in bytes of XML stanzas. Approximate,
+because it is calculated with the precision of one block of readed
+data. For example <CODE>{max_stanza_size, 65536}</CODE>. The default
+value is <TT>infinity</TT>. Recommanded values are 65536 for c2s
+connections and 131072 for s2s connections. s2s max stanza size
+must always much higher than c2s limit. Change this value with
+extreme care as it can cause unwanted disconnect if set too low.
 </DD><DT CLASS="dt-description"><B><TT>{shaper, &lt;access rule&gt;}</TT></B></DT><DD CLASS="dd-description"> This option defines a
 shaper for the port (see section&#XA0;<A HREF="#shapers">3.1.6</A>). The default value
 is <TT>none</TT>.

diff --git a/doc/guide.tex b/doc/guide.tex
index f8377bed6c4769f18b9aed527f40388499b8f63e..b5175f93c764f1976bb79fe8c697787711d66979 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -539,11 +539,15 @@ The following options are available:
   \titem{inet6} \ind{options!inet6}\ind{IPv6}Set up the socket for IPv6.
   \titem{\{ip, IPAddress\}} \ind{options!ip}This option specifies which network
     interface to listen for. For example \verb|{ip, {192, 168, 1, 1}}|.
-  \titem{\{max\_stanza\_size, Size\}} \ind{options!max\_stanza\_size}This
-    option specifies an approximate maximum size in bytes of XML stanzas.
-    Approximate, because it is calculated with the precision of one block of
-    readed data. For example \verb|{max_stanza_size, 65536}|.  The default
-    value is \term{infinity}.
+    \titem{\{max\_stanza\_size, Size\}}
+    \ind{options!max\_stanza\_size}This option specifies an
+    approximate maximum size in bytes of XML stanzas.  Approximate,
+    because it is calculated with the precision of one block of readed
+    data. For example \verb|{max_stanza_size, 65536}|.  The default
+    value is \term{infinity}. Recommanded values are 65536 for c2s
+    connections and 131072 for s2s connections. s2s max stanza size
+    must always much higher than c2s limit. Change this value with
+    extreme care as it can cause unwanted disconnect if set too low.
   \titem{\{shaper, <access rule>\}} \ind{options!shaper}This option defines a
     shaper for the port (see section~\ref{shapers}). The default value
     is \term{none}.