- ejabberd 2.0.0-rc1
+ ejabberd 2.0.0
Installation and Operation Guide
<HR SIZE=2><BR>
<BR>
-<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 2.0.0-rc1 </B></FONT></TD></TR>
+<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 2.0.0 </B></FONT></TD></TR>
<TR><TD ALIGN=right NOWRAP> </TD></TR>
<TR><TD ALIGN=right NOWRAP> <FONT SIZE=6>Installation and Operation Guide</FONT></TD></TR>
</TABLE><BR>
</LI><LI CLASS="li-toc"><A HREF="#htoc36">3.3.3  <TT>mod_announce</TT></A>
</LI><LI CLASS="li-toc"><A HREF="#htoc37">3.3.4  <TT>mod_disco</TT></A>
</LI><LI CLASS="li-toc"><A HREF="#htoc38">3.3.5  <TT>mod_echo</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc39">3.3.6  <TT>mod_irc</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc40">3.3.7  <TT>mod_last</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc41">3.3.8  <TT>mod_muc</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc42">3.3.9  <TT>mod_muc_log</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc43">3.3.10  <TT>mod_offline</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc44">3.3.11  <TT>mod_privacy</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc45">3.3.12  <TT>mod_private</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc46">3.3.13  <TT>mod_proxy65</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.14  <TT>mod_pubsub</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.15  <TT>mod_register</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.16  <TT>mod_roster</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.17  <TT>mod_service_log</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.18  <TT>mod_shared_roster</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.19  <TT>mod_stats</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.20  <TT>mod_time</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.21  <TT>mod_vcard</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.22  <TT>mod_vcard_ldap</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.23  <TT>mod_version</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc39">3.3.6  <TT>mod_http_bind</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc40">3.3.7  <TT>mod_http_fileserver</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc41">3.3.8  <TT>mod_irc</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc42">3.3.9  <TT>mod_last</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc43">3.3.10  <TT>mod_muc</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc44">3.3.11  <TT>mod_muc_log</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc45">3.3.12  <TT>mod_offline</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc46">3.3.13  <TT>mod_privacy</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.14  <TT>mod_private</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.15  <TT>mod_proxy65</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.16  <TT>mod_pubsub</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.17  <TT>mod_register</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.18  <TT>mod_roster</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.19  <TT>mod_service_log</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.20  <TT>mod_shared_roster</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.21  <TT>mod_stats</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.22  <TT>mod_time</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.23  <TT>mod_vcard</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc57">3.3.24  <TT>mod_vcard_ldap</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc58">3.3.25  <TT>mod_version</TT></A>
</LI></UL>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc57">Chapter 4  Managing an <TT>ejabberd</TT> server</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc59">Chapter 4  Managing an <TT>ejabberd</TT> server</A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc58">4.1  <TT>ejabberdctl</TT></A>
+<A HREF="#htoc60">4.1  <TT>ejabberdctl</TT></A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc59">4.1.1  Commands</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc60">4.1.2  Erlang runtime system</A>
+<A HREF="#htoc61">4.1.1  Commands</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc62">4.1.2  Erlang runtime system</A>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc61">4.2  Web Admin</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc62">4.3  Ad-hoc Commands</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc63">4.4  Change Computer Hostname</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc63">4.2  Web Admin</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc64">4.3  Ad-hoc Commands</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc65">4.4  Change Computer Hostname</A>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc64">Chapter 5  Securing <TT>ejabberd</TT></A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc66">Chapter 5  Securing <TT>ejabberd</TT></A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc65">5.1  Firewall Settings</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc66">5.2  epmd </A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc67">5.3  Erlang Cookie</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc68">5.4  Erlang node name</A>
+<A HREF="#htoc67">5.1  Firewall Settings</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc68">5.2  epmd </A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc69">5.3  Erlang Cookie</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc70">5.4  Erlang node name</A>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc69">Chapter 6  Clustering</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc71">Chapter 6  Clustering</A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc70">6.1  How it Works</A>
+<A HREF="#htoc72">6.1  How it Works</A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc71">6.1.1  Router</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc72">6.1.2  Local Router</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc73">6.1.3  Session Manager</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc74">6.1.4  s2s Manager</A>
+<A HREF="#htoc73">6.1.1  Router</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc74">6.1.2  Local Router</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc75">6.1.3  Session Manager</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc76">6.1.4  s2s Manager</A>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc75">6.2  Clustering Setup</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc76">6.3  Service Load-Balancing</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc77">6.2  Clustering Setup</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc78">6.3  Service Load-Balancing</A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc77">6.3.1  Components Load-Balancing</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc78">6.3.2  Domain Load-Balancing Algorithm</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc79">6.3.3  Load-Balancing Buckets</A>
+<A HREF="#htoc79">6.3.1  Components Load-Balancing</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc80">6.3.2  Domain Load-Balancing Algorithm</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc81">6.3.3  Load-Balancing Buckets</A>
</LI></UL>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc80">Chapter 7  Debugging</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc82">Chapter 7  Debugging</A>
<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc81">7.1  Watchdog Alerts</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc82">7.2  Log Files</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc83">7.3  Debug Console</A>
+<A HREF="#htoc83">7.1  Watchdog Alerts</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc84">7.2  Log Files</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc85">7.3  Debug Console</A>
</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc84">Appendix A  Internationalization and Localization</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc85">Appendix B  Release Notes</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc86">Appendix C  Acknowledgements</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc87">Appendix D  Copyright Information</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc86">Appendix A  Internationalization and Localization</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc87">Appendix B  Release Notes</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc88">Appendix C  Acknowledgements</A>
+</LI><LI CLASS="li-toc"><A HREF="#htoc89">Appendix D  Copyright Information</A>
</LI></UL><!--TOC chapter Introduction-->
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc1">Chapter 1</A>  Introduction</H1><!--SEC END --><P>
<A NAME="intro"></A></P><P><TT>ejabberd</TT> is a free and open source instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.</P><P><TT>ejabberd</TT> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a rock-solid and feature rich XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.</P><!--TOC section Key Features-->
</PRE><P>The installer generates desktop shortcuts to start and stop ejabberd.</P><P>The Windows installer also adds ejabberd as a system service,
and a shortcut to a debug console for experienced administrators.
You can start ejabberd using the shortcut or the Windows service.
+Note that the Windows service is a feature still in development,
+and for example it doesn’t keep track of changes made manually in ejabberdctl.cfg.
If you want ejabberd to be started automatically at boot time,
-go to service settings and set ejabberd to be automatic started.</P><P>On a Linux system, if you want ejabberd to start as daemon at boot time,
+go to
the Windows service settings and set ejabberd to be automatic started.</P><P>On a Linux system, if you want ejabberd to start as daemon at boot time,
copy <TT>ejabberd.init</TT> from the bin directory to something like <TT>/etc/init.d/ejabberd</TT>
(depending on your distribution) and call <TT>/etc/inid.d/ejabberd start</TT> to start it.</P><P>The <TT>ejabberdctl</TT> administration script is included in the <TT>bin</TT> directory.
Please refer to the section <A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>,
<OL CLASS="enumerate" type=a><LI CLASS="li-enumerate">
Using <TT>ejabberdctl</TT> (see section <A HREF="#ejabberdctl">4.1</A>):
<PRE CLASS="verbatim">% ejabberdctl register admin1 example.org FgT5bk3
-</PRE></LI><LI CLASS="li-enumerate">Using a Jabber client and In-Band Registration (see section <A HREF="#modregister">3.3.15</A>).
+</PRE></LI><LI CLASS="li-enumerate">Using a Jabber client and In-Band Registration (see section <A HREF="#modregister">3.3.17</A>).
</LI></OL>
</LI><LI CLASS="li-enumerate">Edit the <TT>ejabberd</TT> configuration file to give administration rights to the Jabber account you created:
<PRE CLASS="verbatim"> {acl, admins, {user, "admin1", "example.org"}}.
to several resources, only the resource with the highest priority will receive
the message. If the registered user is not connected, the message will be
stored offline in assumption that offline storage
-(see section <A HREF="#modoffline">3.3.10</A>) is enabled.
+(see section <A HREF="#modoffline">3.3.12</A>) is enabled.
</DD><DT CLASS="dt-description"><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B></DT><DD CLASS="dd-description">The
message is sent to all connected users. If the user is online and connected
to several resources, all resources will receive the message.
{mod_echo, [{host, "mirror.example.org"}]},
...
]}.
+</PRE><!--TOC subsection <TT>mod_http_bind</TT>-->
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc39">3.3.6</A>  <TT>mod_http_bind</TT></H3><!--SEC END --><P>
+<A NAME="modhttpbind"></A>
+</P><P>This module implements XMPP over Bosh (formerly known as HTTP Binding)
+as outlined by <A HREF="http://www.xmpp.org/extensions/xep-0206.html">XEP-0206</A>.
+It extends ejabberd’s built in HTTP service with a configurable
+resource at which this service will be hosted.</P><P>To use HTTP-Binding, enable the module:
+</P><PRE CLASS="verbatim">{modules,
+ [
+ ...
+ {mod_http_bind, []},
+ ...
+]}.
+</PRE><P>and add <CODE>http_bind</CODE> in the HTTP service. For example:
+</P><PRE CLASS="verbatim">{listen,
+ [
+ ...
+ {5280, ejabberd_http, [
+ http_bind,
+ http_poll,
+ web_admin
+ ]
+ },
+ ...
+]}.
+</PRE><P>With this configuration, the module will serve the requests sent to
+<CODE>http://example.org:5280/http-bind/</CODE>
+Remember that this page is not designed to be used by web browsers,
+it is used by Jabber clients that support XMPP over Bosh.</P><P>If you want to set the service in a different URI path or use a different module,
+you can configure it manually using the option <CODE>request_handlers</CODE>.
+For example:
+</P><PRE CLASS="verbatim">{listen,
+ [
+ ...
+ {5280, ejabberd_http, [
+ {request_handlers, [{["http-bind"], mod_http_bind}]},
+ http_poll,
+ web_admin
+ ]
+ },
+ ...
+]}.
+</PRE><!--TOC subsection <TT>mod_http_fileserver</TT>-->
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc40">3.3.7</A>  <TT>mod_http_fileserver</TT></H3><!--SEC END --><P>
+<A NAME="modhttpfileserver"></A>
+</P><P>This simple module serves files from the local disk over HTTP.</P><P>Options:
+</P><DL CLASS="description"><DT CLASS="dt-description">
+<B><TT>docroot</TT></B></DT><DD CLASS="dd-description">
+Directory to serve the files.
+</DD><DT CLASS="dt-description"><B><TT>accesslog</TT></B></DT><DD CLASS="dd-description">
+File to log accesses using an Apache-like format.
+No log will be recorded if this option is not specified.
+</DD></DL><P>This example configuration will serve the files from
+the local directory <CODE>/var/www</CODE>
+in the address <CODE>http://example.org:5280/pub/archive/</CODE>.
+To use this module you must enable it:
+</P><PRE CLASS="verbatim">{modules,
+ [
+ ...
+ {mod_http_fileserver, [
+ {docroot, "/var/www"},
+ {accesslog, "/var/log/ejabberd/access.log"}
+ ]
+ },
+ ...
+]}.
+</PRE><P>And define it as a handler in the HTTP service:
+</P><PRE CLASS="verbatim">{listen,
+ [
+ ...
+ {5280, ejabberd_http, [
+ ...
+ {request_handlers, [
+ ...
+ {["pub", "archive"], mod_http_fileserver},
+ ...
+ ]
+ },
+ ...
+ ]
+ },
+ ...
+]}.
</PRE><!--TOC subsection <TT>mod_irc</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
39">3.3.6</A>  <TT>mod_irc</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
41">3.3.8</A>  <TT>mod_irc</TT></H3><!--SEC END --><P>
<A NAME="modirc"></A>
</P><P>This module is an IRC transport that can be used to join channels on IRC
servers.</P><P>End user information:
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_last</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
0">3.3.7</A>  <TT>mod_last</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
2">3.3.9</A>  <TT>mod_last</TT></H3><!--SEC END --><P>
<A NAME="modlast"></A>
</P><P>This module adds support for Last Activity (<A HREF="http://www.xmpp.org/extensions/xep-0012.html">XEP-0012</A>). It can be used to
discover when a disconnected user last accessed the server, to know when a
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
</DD></DL><!--TOC subsection <TT>mod_muc</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
1">3.3.8</A>  <TT>mod_muc</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
3">3.3.10</A>  <TT>mod_muc</TT></H3><!--SEC END --><P>
<A NAME="modmuc"></A>
</P><P>With this module enabled, your server will support Multi-User Chat
(<A HREF="http://www.xmpp.org/extensions/xep-0045.html">XEP-0045</A>). End users will be able to join text conferences.</P><P>Some of the features of Multi-User Chat:
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_muc_log</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
2">3.3.9</A>  <TT>mod_muc_log</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
4">3.3.11</A>  <TT>mod_muc_log</TT></H3><!--SEC END --><P>
<A NAME="modmuclog"></A>
</P><P>This module enables optional logging of Multi-User Chat (MUC) conversations to
HTML. Once you enable this module, users can join a chatroom using a MUC capable
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_offline</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
3">3.3.10</A>  <TT>mod_offline</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
5">3.3.12</A>  <TT>mod_offline</TT></H3><!--SEC END --><P>
<A NAME="modoffline"></A>
</P><P>This module implements offline message storage. This means that all messages
sent to an offline user will be stored on the server until that user comes
value can be either <TT>infinity</TT> or a strictly positive
integer. The default value is <TT>infinity</TT>.
</DD></DL><!--TOC subsection <TT>mod_privacy</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
4">3.3.11</A>  <TT>mod_privacy</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
6">3.3.13</A>  <TT>mod_privacy</TT></H3><!--SEC END --><P>
<A NAME="modprivacy"></A>
</P><P>This module implements Blocking Communication (also known as Privacy Rules)
as defined in section 10 from XMPP IM. If end users have support for it in
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
</DD></DL><!--TOC subsection <TT>mod_private</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
5">3.3.12</A>  <TT>mod_private</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
7">3.3.14</A>  <TT>mod_private</TT></H3><!--SEC END --><P>
<A NAME="modprivate"></A>
</P><P>This module adds support for Private XML Storage (<A HREF="http://www.xmpp.org/extensions/xep-0049.html">XEP-0049</A>):
</P><BLOCKQUOTE CLASS="quote">
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
</DD></DL><!--TOC subsection <TT>mod_proxy65</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
6">3.3.13</A>  <TT>mod_proxy65</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
8">3.3.15</A>  <TT>mod_proxy65</TT></H3><!--SEC END --><P>
<A NAME="modproxy"></A>
</P><P>This module implements SOCKS5 Bytestreams (<A HREF="http://www.xmpp.org/extensions/xep-0065.html">XEP-0065</A>).
It allows <TT>ejabberd</TT> to act as a file transfer proxy between two
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_pubsub</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
7">3.3.14</A>  <TT>mod_pubsub</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4
9">3.3.16</A>  <TT>mod_pubsub</TT></H3><!--SEC END --><P>
<A NAME="modpubsub"></A>
</P><P>This module offers a Publish-Subscribe Service (<A HREF="http://www.xmpp.org/extensions/xep-0060.html">XEP-0060</A>).
The functionality in <TT>mod_pubsub</TT> can be extended using plugins.
...
]}.
</PRE><!--TOC subsection <TT>mod_register</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
48">3.3.15</A>  <TT>mod_register</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
50">3.3.17</A>  <TT>mod_register</TT></H3><!--SEC END --><P>
<A NAME="modregister"></A>
</P><P>This module adds support for In-Band Registration (<A HREF="http://www.xmpp.org/extensions/xep-0077.html">XEP-0077</A>). This protocol
enables end users to use a Jabber client to:
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_roster</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
49">3.3.16</A>  <TT>mod_roster</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
51">3.3.18</A>  <TT>mod_roster</TT></H3><!--SEC END --><P>
<A NAME="modroster"></A>
</P><P>This module implements roster management as defined in <A HREF="http://www.xmpp.org/specs/rfc3921.html#roster">RFC 3921: XMPP IM</A>.</P><P>Options:
</P><DL CLASS="description"><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
</DD></DL><!--TOC subsection <TT>mod_service_log</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
0">3.3.17</A>  <TT>mod_service_log</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
2">3.3.19</A>  <TT>mod_service_log</TT></H3><!--SEC END --><P>
<A NAME="modservicelog"></A>
</P><P>This module adds support for logging end user packets via a Jabber message
auditing service such as
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_shared_roster</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
1">3.3.18</A>  <TT>mod_shared_roster</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
3">3.3.20</A>  <TT>mod_shared_roster</TT></H3><!--SEC END --><P>
<A NAME="modsharedroster"></A>
</P><P>This module enables you to create shared roster groups. This means that you can
create groups of people that can see members from (other) groups in their
</TABLE>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
</LI></UL><!--TOC subsection <TT>mod_stats</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
2">3.3.19</A>  <TT>mod_stats</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
4">3.3.21</A>  <TT>mod_stats</TT></H3><!--SEC END --><P>
<A NAME="modstats"></A>
</P><P>This module adds support for Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>). This protocol
allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment:
</query>
</iq>
</PRE></LI></UL><!--TOC subsection <TT>mod_time</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
3">3.3.20</A>  <TT>mod_time</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
5">3.3.22</A>  <TT>mod_time</TT></H3><!--SEC END --><P>
<A NAME="modtime"></A>
</P><P>This module features support for Entity Time (<A HREF="http://www.xmpp.org/extensions/xep-0090.html">XEP-0090</A>). By using this XEP,
you are able to discover the time at another entity’s location.</P><P>Options:
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
</DD></DL><!--TOC subsection <TT>mod_vcard</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
4">3.3.21</A>  <TT>mod_vcard</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
6">3.3.23</A>  <TT>mod_vcard</TT></H3><!--SEC END --><P>
<A NAME="modvcard"></A>
</P><P>This module allows end users to store and retrieve their vCard, and to retrieve
other users vCards, as defined in vcard-temp (<A HREF="http://www.xmpp.org/extensions/xep-0054.html">XEP-0054</A>). The module also
...
]}.
</PRE></LI></UL><!--TOC subsection <TT>mod_vcard_ldap</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
5">3.3.22</A>  <TT>mod_vcard_ldap</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
7">3.3.24</A>  <TT>mod_vcard_ldap</TT></H3><!--SEC END --><P>
<A NAME="modvcardldap"></A>
</P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is
implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the
{"Nickname", "NICK"}
]},
</PRE></LI></UL><!--TOC subsection <TT>mod_version</TT>-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
6">3.3.23</A>  <TT>mod_version</TT></H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5
8">3.3.25</A>  <TT>mod_version</TT></H3><!--SEC END --><P>
<A NAME="modversion"></A>
</P><P>This module implements Software Version (<A HREF="http://www.xmpp.org/extensions/xep-0092.html">XEP-0092</A>). Consequently, it
answers <TT>ejabberd</TT>’s version when queried.</P><P>Options:
</DD><DT CLASS="dt-description"><B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
</DD></DL><!--TOC chapter Managing an <TT>ejabberd</TT> server-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc57">Chapter 4</A>  Managing an <TT>ejabberd</TT> server</H1><!--SEC END --><!--TOC section <TT>ejabberdctl</TT>-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc
58">4.1</A>  <TT>ejabberdctl</TT></H2><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc59">Chapter 4</A>  Managing an <TT>ejabberd</TT> server</H1><!--SEC END --><!--TOC section <TT>ejabberdctl</TT>-->
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc
60">4.1</A>  <TT>ejabberdctl</TT></H2><!--SEC END --><P>
<A NAME="ejabberdctl"></A></P><!--TOC subsection Commands-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
59">4.1.1</A>  Commands</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
61">4.1.1</A>  Commands</H3><!--SEC END --><P>
<A NAME="commands"></A></P><P>The <TT>ejabberdctl</TT> command line script allows to start, stop and perform
many other administrative tasks in a local or remote <TT>ejabberd</TT> server.</P><P>When <TT>ejabberdctl</TT> is executed without any parameter,
it displays the available options. If there isn’t an <TT>ejabberd</TT> server running,
</DD></DL><P>The <TT>ejabberdctl</TT> script also allows the argument <TT>--node NODENAME</TT>.
This allows to administer a remote node.</P><P>The <TT>ejabberdctl</TT> administration script can be configured in the file ejabberdctl.cfg.
This file provides detailed information about each configurable option.</P><!--TOC subsection Erlang runtime system-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc6
0">4.1.2</A>  Erlang runtime system</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc6
2">4.1.2</A>  Erlang runtime system</H3><!--SEC END --><P>
<A NAME="erlangconfiguration"></A></P><P><TT>ejabberd</TT> is an Erlang/OTP application that runs inside an Erlang runtime system.
This system is configured using environment variables and command line parameters.
The <TT>ejabberdctl</TT> administration script uses many of those possibilities.
</DD></DL><P>
Note that some characters need to be escaped when used in shell scripts, for instance <CODE>"</CODE> and <CODE>{}</CODE>.
You can find other options in the Erlang manual page (<TT>erl -man erl</TT>).</P><!--TOC section Web Admin-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
1">4.2</A>  Web Admin</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
3">4.2</A>  Web Admin</H2><!--SEC END --><P>
<A NAME="webadmin"></A>
</P><P>The <TT>ejabberd</TT> Web Admin allows to administer most of <TT>ejabberd</TT> using a web browser.</P><P>This feature is enabled by default:
a <TT>ejabberd_http</TT> listener with the option <TT>web_admin</TT> (see
]
}.
</PRE></LI></UL><!--TOC section Ad-hoc Commands-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
2">4.3</A>  Ad-hoc Commands</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
4">4.3</A>  Ad-hoc Commands</H2><!--SEC END --><P>
<A NAME="adhoccommands"></A></P><P>If you enable <TT>mod_configure</TT> and <TT>mod_adhoc</TT>,
you can perform several administrative tasks in <TT>ejabberd</TT>
with a Jabber client.
The client must support Ad-Hoc Commands (<A HREF="http://www.xmpp.org/extensions/xep-0050.html">XEP-0050</A>),
and you must login in the Jabber server with
an account with proper privileges.</P><!--TOC section Change Computer Hostname-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
3">4.4</A>  Change Computer Hostname</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
5">4.4</A>  Change Computer Hostname</H2><!--SEC END --><P>
<A NAME="changeerlangnodename"></A></P><P><TT>ejabberd</TT> uses the distributed Mnesia database.
Being distributed, Mnesia enforces consistency of its file,
so it stores the name of the Erlang node in it.
For example:
<PRE CLASS="verbatim">ejabberdctl restore /tmp/ejabberd-oldhost.backup
</PRE></LI></OL><!--TOC chapter Securing <TT>ejabberd</TT>-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc64">Chapter 5</A>  Securing <TT>ejabberd</TT></H1><!--SEC END --><!--TOC section Firewall Settings-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
5">5.1</A>  Firewall Settings</H2><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc66">Chapter 5</A>  Securing <TT>ejabberd</TT></H1><!--SEC END --><!--TOC section Firewall Settings-->
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
7">5.1</A>  Firewall Settings</H2><!--SEC END --><P>
<A NAME="firewall"></A>
</P><P>You need to take the following TCP ports in mind when configuring your firewall:
</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable.</TD></TR>
</TABLE>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><!--TOC section epmd -->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
6">5.2</A>  epmd </H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
8">5.2</A>  epmd </H2><!--SEC END --><P>
<A NAME="epmd"></A></P><P><A HREF="http://www.erlang.org/doc/man/epmd.html">epmd (Erlang Port Mapper Daemon)</A>
is a small name server included in Erlang/OTP
and used by Erlang programs when establishing distributed Erlang communications.
You can limit the range of ports when starting Erlang with a command-line parameter, for example:
</P><PRE CLASS="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
</PRE><!--TOC section Erlang Cookie-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
7">5.3</A>  Erlang Cookie</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc6
9">5.3</A>  Erlang Cookie</H2><!--SEC END --><P>
<A NAME="cookie"></A></P><P>The Erlang cookie is a string with numbers and letters.
An Erlang node reads the cookie at startup from the command-line parameter <TT>-setcookie</TT>
or from a cookie file.
The communication between Erlang nodes are not encrypted,
so the cookie could be read sniffing the traffic on the network.
The recommended way to secure the Erlang node is to block the port 4369.</P><!--TOC section Erlang node name-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc
68">5.4</A>  Erlang node name</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc
70">5.4</A>  Erlang node name</H2><!--SEC END --><P>
<A NAME="nodename"></A></P><P>An Erlang node may have a node name.
The name can be short (if indicated with the command-line parameter <TT>-sname</TT>)
or long (if indicated with the parameter <TT>-name</TT>).
because it may be possible to fake the fact that you are on another network
using a modified version of Erlang <TT>epmd</TT>.
The recommended way to secure the Erlang node is to block the port 4369.</P><!--TOC chapter Clustering-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc
69">Chapter 6</A>  Clustering</H1><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc
71">Chapter 6</A>  Clustering</H1><!--SEC END --><P>
<A NAME="clustering"></A>
</P><!--TOC section How it Works-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc7
0">6.1</A>  How it Works</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc7
2">6.1</A>  How it Works</H2><!--SEC END --><P>
<A NAME="howitworks"></A>
</P><P>A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
be run on different machines that are connected via a network. They all
</LI><LI CLASS="li-itemize">session manager,
</LI><LI CLASS="li-itemize">s2s manager.
</LI></UL><!--TOC subsection Router-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
1">6.1.1</A>  Router</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
3">6.1.1</A>  Router</H3><!--SEC END --><P>
<A NAME="router"></A>
</P><P>This module is the main router of Jabber packets on each node. It
routes them based on their destination’s domains. It uses a global
routing table. The domain of the packet’s destination is searched in the
routing table, and if it is found, the packet is routed to the
appropriate process. If not, it is sent to the s2s manager.</P><!--TOC subsection Local Router-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
2">6.1.2</A>  Local Router</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
4">6.1.2</A>  Local Router</H3><!--SEC END --><P>
<A NAME="localrouter"></A>
</P><P>This module routes packets which have a destination domain equal to
one of this server’s host names. If the destination JID has a non-empty user
part, it is routed to the session manager, otherwise it is processed depending
on its content.</P><!--TOC subsection Session Manager-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
3">6.1.3</A>  Session Manager</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
5">6.1.3</A>  Session Manager</H3><!--SEC END --><P>
<A NAME="sessionmanager"></A>
</P><P>This module routes packets to local users. It looks up to which user
resource a packet must be sent via a presence table. Then the packet is
either routed to the appropriate c2s process, or stored in offline
storage, or bounced back.</P><!--TOC subsection s2s Manager-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
4">6.1.4</A>  s2s Manager</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
6">6.1.4</A>  s2s Manager</H3><!--SEC END --><P>
<A NAME="s2smanager"></A>
</P><P>This module routes packets to other Jabber servers. First, it
checks if an opened s2s connection from the domain of the packet’s
source to the domain of the packet’s destination exists. If that is the case,
the s2s manager routes the packet to the process
serving this connection, otherwise a new connection is opened.</P><!--TOC section Clustering Setup-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc7
5">6.2</A>  Clustering Setup</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc7
7">6.2</A>  Clustering Setup</H2><!--SEC END --><P>
<A NAME="cluster"></A>
</P><P>Suppose you already configured <TT>ejabberd</TT> on one machine named (<TT>first</TT>),
and you need to setup another one to make an <TT>ejabberd</TT> cluster. Then do
enabled only on one machine in the cluster).
</LI></OL><P>You can repeat these steps for other machines supposed to serve this
domain.</P><!--TOC section Service Load-Balancing-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc76">6.3</A>  Service Load-Balancing</H2><!--SEC END --><!--TOC subsection Components Load-Balancing-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
7">6.3.1</A>  Components Load-Balancing</H3><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc78">6.3</A>  Service Load-Balancing</H2><!--SEC END --><!--TOC subsection Components Load-Balancing-->
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7
9">6.3.1</A>  Components Load-Balancing</H3><!--SEC END --><P>
<A NAME="componentlb"></A>
</P><!--TOC subsection Domain Load-Balancing Algorithm-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
78">6.3.2</A>  Domain Load-Balancing Algorithm</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
80">6.3.2</A>  Domain Load-Balancing Algorithm</H3><!--SEC END --><P>
<A NAME="domainlb"></A>
</P><P><TT>ejabberd</TT> includes an algorithm to load balance the components that are plugged on an <TT>ejabberd</TT> cluster. It means that you can plug one or several instances of the same component on each <TT>ejabberd</TT> cluster and that the traffic will be automatically distributed.</P><P>The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.</P><P>If you need a different behaviour, you can change the load balancing behaviour with the option <TT>domain_balancing</TT>. The syntax of the option is the following:</P><PRE CLASS="verbatim"> {domain_balancing, "component.example.com", <balancing_criterium>}.
</PRE><P>Several balancing criteria are available:
</LI><LI CLASS="li-itemize"><TT>bare_destination</TT>: the bare JID (without resource) of the packet <TT>to</TT> attribute is used.
</LI><LI CLASS="li-itemize"><TT>bare_source</TT>: the bare JID (without resource) of the packet <TT>from</TT> attribute is used.
</LI></UL><P>If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.</P><!--TOC subsection Load-Balancing Buckets-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
79">6.3.3</A>  Load-Balancing Buckets</H3><!--SEC END --><P>
+<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc
81">6.3.3</A>  Load-Balancing Buckets</H3><!--SEC END --><P>
<A NAME="lbbuckets"></A>
</P><P>When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.</P><P>In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the <TT>domain_balancing_component_number</TT> option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.</P><P>The syntax is the following:
</P><PRE CLASS="verbatim"> {domain_balancing_component_number, "component.example.com", N}
</PRE><!--TOC chapter Debugging-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
0">Chapter 7</A>  Debugging</H1><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
2">Chapter 7</A>  Debugging</H1><!--SEC END --><P>
<A NAME="debugging"></A>
</P><!--TOC section Watchdog Alerts-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8
1">7.1</A>  Watchdog Alerts</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8
3">7.1</A>  Watchdog Alerts</H2><!--SEC END --><P>
<A NAME="watchdog"></A>
</P><P><TT>ejabberd</TT> includes a watchdog mechanism.
If a process in the <TT>ejabberd</TT> server consumes too much memory,
Example configuration:
</P><PRE CLASS="verbatim">{watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
</PRE><!--TOC section Log Files-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8
2">7.2</A>  Log Files</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8
4">7.2</A>  Log Files</H2><!--SEC END --><P>
<A NAME="logfiles"></A></P><P>An <TT>ejabberd</TT> node writes two log files:
</P><DL CLASS="description"><DT CLASS="dt-description">
<B><TT>ejabberd.log</TT></B></DT><DD CLASS="dd-description"> is the ejabberd service log, with the messages reported by <TT>ejabberd</TT> code
For example, the default configuration is:
</P><PRE CLASS="verbatim">{loglevel, 4}.
</PRE><!--TOC section Debug Console-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8
3">7.3</A>  Debug Console</H2><!--SEC END --><P>
+<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8
5">7.3</A>  Debug Console</H2><!--SEC END --><P>
<A NAME="debugconsole"></A></P><P>The Debug Console is an Erlang shell attached to an already running <TT>ejabberd</TT> server.
With this Erlang shell, an experienced administrator can perform complex tasks.</P><P>This shell gives complete control over the <TT>ejabberd</TT> server,
so it is important to use it with extremely care.
There are some simple and safe examples in the article
<A HREF="http://www.ejabberd.im/interconnect-erl-nodes">Interconnecting Erlang Nodes</A></P><P>To exit the shell, close the window or press the keys: control+c control+c.</P><!--TOC chapter Internationalization and Localization-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
4">Appendix A</A>  Internationalization and Localization</H1><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
6">Appendix A</A>  Internationalization and Localization</H1><!--SEC END --><P>
<A NAME="i18nl10n"></A>
</P><P>All built-in modules support the <TT>xml:lang</TT> attribute inside IQ queries.
Figure <A HREF="#fig:discorus">A.1</A>, for example, shows the reply to the following query:
</TABLE></DIV>
<A NAME="fig:webadmmainru"></A>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><!--TOC chapter Release Notes-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
5">Appendix B</A>  Release Notes</H1><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
7">Appendix B</A>  Release Notes</H1><!--SEC END --><P>
<A NAME="releasenotes"></A>
</P><P>Release notes are available from <A HREF="http://www.process-one.net/en/ejabberd/release_notes/">ejabberd Home Page</A></P><!--TOC chapter Acknowledgements-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
6">Appendix C</A>  Acknowledgements</H1><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
8">Appendix C</A>  Acknowledgements</H1><!--SEC END --><P>
<A NAME="acknowledgements"></A>
Thanks to all people who contributed to this guide:
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
</LI><LI CLASS="li-itemize">Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>)
</LI><LI CLASS="li-itemize">Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>)
</LI></UL><!--TOC chapter Copyright Information-->
-<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
7">Appendix D</A>  Copyright Information</H1><!--SEC END --><P>
+<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc8
9">Appendix D</A>  Copyright Information</H1><!--SEC END --><P>
<A NAME="copyright"></A></P><P>Ejabberd Installation and Operation Guide.<BR>
Copyright © 2003 — 2008 Process-one</P><P>This document is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
projects / ejabberd / commitdiff