* doc/guide.tex: Documentation for domain balancing.

SVN Revision: 710

diff --git a/ChangeLog b/ChangeLog
index 696591f21e1401b1f88c62749bbbc9ca2aa0a450..b92b9b1bfad9d6ef8764361d2152e81b1d0c79c4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,8 @@
 2007-01-24  Mickael Remond  <mickael.remond@process-one.net>
 
-       * doc/guide.tex: mod_muc now support cluster.
+       * doc/guide.tex: Documentation for domain balancing.
+
+       * doc/guide.tex: mod_muc now supports cluster.
 
        * doc/guide.tex: Updated the max_user_sessions section. 
 

diff --git a/doc/guide.tex b/doc/guide.tex
index a3686993b0fb8dc6d8552a3627a74106011b049f..49569980864946956c1bf917ecbfa9e8d00a5048 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -907,6 +907,27 @@ Examples:
 
 \section{Advanced configuration}
 
+\subsection{Components Load-Balancing}
+
+\ejabberd{} includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
+
+The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances.
+
+If you need a different behaviour, you can change the load balancing behaviour with the option \option{domain_balancing}. The syntax of the option is the following:
+
+\begin{verbatim}
+       {domain_balancing, "component.example.com", <balancing_criterium>}.                                   
+\end{verbatim}
+
+Several balancing criterium are available:
+\begin{itemize}
+\item \term{destination}: the full JID of the packet \term{to} attribute is used.
+\item \term{source}: the full JID of the packet \term{from} attribute is used.
+\item \term{bare_destination}: the bare JID (without resource) of the packet \term{to} attribute is used.
+\item \term{bare_source}: the bare JID (without resource) of the packet \term{from} attribute is used.
+\end{itemize}
+
+If the value corresponding to the criterium is the same, the same component instance in the cluster will be used.
 
 \section{Database and LDAP Configuration}
 \label{database}