diff options
Diffstat (limited to 'doc/guide.html')
| -rw-r--r-- | doc/guide.html | 364 |
1 files changed, 133 insertions, 231 deletions
diff --git a/doc/guide.html b/doc/guide.html index 08f8bb14a..9520f4b70 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -6,7 +6,7 @@ - ejabberd 2.1.0 + ejabberd 3.0.0-alpha Installation and Operation Guide @@ -76,7 +76,7 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;} <HR SIZE=2><BR> <BR> -<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 2.1.0 </B></FONT></TD></TR> +<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 3.0.0-alpha </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> @@ -146,78 +146,77 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;} </LI><LI CLASS="li-toc"><A HREF="#htoc44">3.3.5  <TT>mod_echo</TT></A> </LI><LI CLASS="li-toc"><A HREF="#htoc45">3.3.6  <TT>mod_http_bind</TT></A> </LI><LI CLASS="li-toc"><A HREF="#htoc46">3.3.7  <TT>mod_http_fileserver</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.8  <TT>mod_irc</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.9  <TT>mod_last</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.10  <TT>mod_muc</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.11  <TT>mod_muc_log</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.12  <TT>mod_offline</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.13  <TT>mod_ping</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.14  <TT>mod_privacy</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.15  <TT>mod_private</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.16  <TT>mod_proxy65</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.17  <TT>mod_pubsub</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc57">3.3.18  <TT>mod_register</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc58">3.3.19  <TT>mod_roster</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc59">3.3.20  <TT>mod_service_log</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc60">3.3.21  <TT>mod_shared_roster</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc61">3.3.22  <TT>mod_stats</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc62">3.3.23  <TT>mod_time</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc63">3.3.24  <TT>mod_vcard</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc64">3.3.25  <TT>mod_vcard_ldap</TT></A> -</LI><LI CLASS="li-toc"><A HREF="#htoc65">3.3.26  <TT>mod_version</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.8  <TT>mod_last</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.9  <TT>mod_muc</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.10  <TT>mod_muc_log</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.11  <TT>mod_offline</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.12  <TT>mod_ping</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.13  <TT>mod_privacy</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.14  <TT>mod_private</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.15  <TT>mod_proxy65</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.16  <TT>mod_pubsub</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.17  <TT>mod_register</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc57">3.3.18  <TT>mod_roster</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc58">3.3.19  <TT>mod_service_log</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc59">3.3.20  <TT>mod_shared_roster</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc60">3.3.21  <TT>mod_stats</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc61">3.3.22  <TT>mod_time</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc62">3.3.23  <TT>mod_vcard</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc63">3.3.24  <TT>mod_vcard_ldap</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc64">3.3.25  <TT>mod_version</TT></A> </LI></UL> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc66">Chapter 4  Managing an <TT>ejabberd</TT> Server</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc65">Chapter 4  Managing an <TT>ejabberd</TT> Server</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc67">4.1  <TT>ejabberdctl</TT></A> +<A HREF="#htoc66">4.1  <TT>ejabberdctl</TT></A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc68">4.1.1  ejabberdctl Commands</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc69">4.1.2  Erlang Runtime System</A> +<A HREF="#htoc67">4.1.1  ejabberdctl Commands</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc68">4.1.2  Erlang Runtime System</A> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc70">4.2  <TT>ejabberd</TT> Commands</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc69">4.2  <TT>ejabberd</TT> Commands</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc71">4.2.1  List of ejabberd Commands</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc72">4.2.2  Restrict Execution with AccessCommands</A> +<A HREF="#htoc70">4.2.1  List of ejabberd Commands</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc71">4.2.2  Restrict Execution with AccessCommands</A> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc73">4.3  Web Admin</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc74">4.4  Ad-hoc Commands</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc75">4.5  Change Computer Hostname</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc72">4.3  Web Admin</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc73">4.4  Ad-hoc Commands</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc74">4.5  Change Computer Hostname</A> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc76">Chapter 5  Securing <TT>ejabberd</TT></A> +</LI><LI CLASS="li-toc"><A HREF="#htoc75">Chapter 5  Securing <TT>ejabberd</TT></A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc77">5.1  Firewall Settings</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc78">5.2  epmd</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc79">5.3  Erlang Cookie</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc80">5.4  Erlang Node Name</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc81">5.5  Securing Sensitive Files</A> +<A HREF="#htoc76">5.1  Firewall Settings</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc77">5.2  epmd</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc78">5.3  Erlang Cookie</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc79">5.4  Erlang Node Name</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc80">5.5  Securing Sensitive Files</A> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc82">Chapter 6  Clustering</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc81">Chapter 6  Clustering</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc83">6.1  How it Works</A> +<A HREF="#htoc82">6.1  How it Works</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc84">6.1.1  Router</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc85">6.1.2  Local Router</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc86">6.1.3  Session Manager</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc87">6.1.4  s2s Manager</A> +<A HREF="#htoc83">6.1.1  Router</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc84">6.1.2  Local Router</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc85">6.1.3  Session Manager</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc86">6.1.4  s2s Manager</A> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc88">6.2  Clustering Setup</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc89">6.3  Service Load-Balancing</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc87">6.2  Clustering Setup</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc88">6.3  Service Load-Balancing</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc90">6.3.1  Components Load-Balancing</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc91">6.3.2  Domain Load-Balancing Algorithm</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc92">6.3.3  Load-Balancing Buckets</A> +<A HREF="#htoc89">6.3.1  Components Load-Balancing</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc90">6.3.2  Domain Load-Balancing Algorithm</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc91">6.3.3  Load-Balancing Buckets</A> </LI></UL> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc93">Chapter 7  Debugging</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc92">Chapter 7  Debugging</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc94">7.1  Log Files</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc95">7.2  Debug Console</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc96">7.3  Watchdog Alerts</A> +<A HREF="#htoc93">7.1  Log Files</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc94">7.2  Debug Console</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc95">7.3  Watchdog Alerts</A> </LI></UL> -</LI><LI CLASS="li-toc"><A HREF="#htoc97">Appendix A  Internationalization and Localization</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc98">Appendix B  Release Notes</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc99">Appendix C  Acknowledgements</A> -</LI><LI CLASS="li-toc"><A HREF="#htoc100">Appendix D  Copyright Information</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc96">Appendix A  Internationalization and Localization</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc97">Appendix B  Release Notes</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc98">Appendix C  Acknowledgements</A> +</LI><LI CLASS="li-toc"><A HREF="#htoc99">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/OTP</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--> @@ -234,7 +233,7 @@ Comprehensive documentation. </LI><LI CLASS="li-itemize">Capability to send announce messages. </LI></UL></LI><LI CLASS="li-itemize">Internationalized: <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are: <UL CLASS="itemize"><LI CLASS="li-itemize"> -Translated to 25 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. +Translated to 24 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. </LI></UL></LI><LI CLASS="li-itemize">Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard. <UL CLASS="itemize"><LI CLASS="li-itemize"> Fully XMPP compliant. @@ -277,7 +276,6 @@ Support for virtual hosting. </LI><LI CLASS="li-itemize"><A HREF="http://xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards. </LI><LI CLASS="li-itemize"><A HREF="http://xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>. </LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services. -</LI><LI CLASS="li-itemize">IRC transport. </LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. </LI></UL> </LI></UL><P> <A NAME="installing"></A> </P><!--TOC chapter Installing <TT>ejabberd</TT>--> @@ -343,16 +341,14 @@ as long as your system have all the dependencies.</P><P> <A NAME="installreq"></ </P><UL CLASS="itemize"><LI CLASS="li-itemize"> GNU Make </LI><LI CLASS="li-itemize">GCC -</LI><LI CLASS="li-itemize">Libexpat 1.95 or higher -</LI><LI CLASS="li-itemize">Erlang/OTP R10B-9 or higher. The recommended version is R12B-5. Support for R13 is experimental. +</LI><LI CLASS="li-itemize">Erlang/OTP R12B-4 or higher, R13B or higher. +</LI><LI CLASS="li-itemize">exmpp 0.9.1 or higher </LI><LI CLASS="li-itemize">OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended. </LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional. </LI><LI CLASS="li-itemize">Erlang mysql library. Optional. For MySQL authentication or storage. See section <A HREF="#compilemysql">3.2.1</A>. </LI><LI CLASS="li-itemize">Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section <A HREF="#compilepgsql">3.2.3</A>. </LI><LI CLASS="li-itemize">PAM library. Optional. For Pluggable Authentication Modules (PAM). See section <A HREF="#pam">3.1.4</A>. -</LI><LI CLASS="li-itemize">GNU Iconv 1.8 or higher, for the IRC Transport (mod_irc). Optional. Not needed on systems with GNU Libc. See section <A HREF="#modirc">3.3.8</A>. </LI><LI CLASS="li-itemize">ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section <A HREF="#captcha">3.1.8</A>. -</LI><LI CLASS="li-itemize">exmpp 0.9.1 or higher. Optional. For import/export user data with <A HREF="http://xmpp.org/extensions/xep-0227.html">XEP-0227</A> XML files. </LI></UL><P> <A NAME="download"></A> </P><!--TOC subsection Download Source Code--> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc10">2.4.2</A>  <A HREF="#download">Download Source Code</A></H3><!--SEC END --><P> <A NAME="download"></A> </P><P>Released versions of <TT>ejabberd</TT> are available in the ProcessOne <TT>ejabberd</TT> downloads page: @@ -479,31 +475,25 @@ for example: <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowsreq">Requirements</A></H4><!--SEC END --><P> <A NAME="windowsreq"></A> </P><P>To compile <TT>ejabberd</TT> on a Microsoft Windows system, you need: </P><UL CLASS="itemize"><LI CLASS="li-itemize"> MS Visual C++ 6.0 Compiler -</LI><LI CLASS="li-itemize"><A HREF="http://www.erlang.org/download.html">Erlang/OTP R11B-5</A> +</LI><LI CLASS="li-itemize"><A HREF="http://www.erlang.org/download.html">Erlang/OTP R12B-5</A>. Support for R13 or higher is experimental. +</LI><LI CLASS="li-itemize"><A HREF="http://support.process-one.net/doc/display/EXMPP">exmpp 0.9.1 or higher</A> </LI><LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 2.0.0 or higher</A> -</LI><LI CLASS="li-itemize"><A HREF="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.2</A> -(optional) </LI><LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8d or higher</A> (to enable SSL connections) </LI><LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A> </LI></UL><P> <A NAME="windowscom"></A> </P><!--TOC subsubsection Compilation--> <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowscom">Compilation</A></H4><!--SEC END --><P> <A NAME="windowscom"></A> </P><P>We assume that we will try to put as much library as possible into <CODE>C:\sdk\</CODE> to make it easier to track what is install for <TT>ejabberd</TT>.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> -Install Erlang emulator (for example, into <CODE>C:\sdk\erl5.5.5</CODE>). +Install Erlang emulator (for example, into <CODE>C:\sdk\erl5.6.5</CODE>). </LI><LI CLASS="li-enumerate">Install Expat library into <CODE>C:\sdk\Expat-2.0.0</CODE> directory.<P>Copy file <CODE>C:\sdk\Expat-2.0.0\Libs\libexpat.dll</CODE> to your Windows system directory (for example, <CODE>C:\WINNT</CODE> or <CODE>C:\WINNT\System32</CODE>) -</P></LI><LI CLASS="li-enumerate">Build and install the Iconv library into the directory -<CODE>C:\sdk\GnuWin32</CODE>.<P>Copy file <CODE>C:\sdk\GnuWin32\bin\lib*.dll</CODE> to your -Windows system directory (more installation instructions can be found in the -file README.woe32 in the iconv distribution).</P><P>Note: instead of copying libexpat.dll and iconv.dll to the Windows -directory, you can add the directories -<CODE>C:\sdk\Expat-2.0.0\Libs</CODE> and -<CODE>C:\sdk\GnuWin32\bin</CODE> to the <CODE>PATH</CODE> environment -variable. +Note: instead of copying libexpat.dll to the Windows +directory, you can add the directory <CODE>C:\sdk\Expat-2.0.0\Libs</CODE> +to the <CODE>PATH</CODE> environment variable. </P></LI><LI CLASS="li-enumerate">Install OpenSSL in <CODE>C:\sdk\OpenSSL</CODE> and add <CODE>C:\sdk\OpenSSL\lib\VC</CODE> to your path or copy the binaries to your system directory. </LI><LI CLASS="li-enumerate">Install ZLib in <CODE>C:\sdk\gnuWin32</CODE>. Copy -<CODE>C:\sdk\GnuWin32\bin\zlib1.dll</CODE> to your system directory. If you change your path it should already be set after libiconv install. +<CODE>C:\sdk\GnuWin32\bin\zlib1.dll</CODE> to your system directory. </LI><LI CLASS="li-enumerate">Make sure the you can access Erlang binaries from your path. For example: <CODE>set PATH=%PATH%;"C:\sdk\erl5.6.5\bin"</CODE> </LI><LI CLASS="li-enumerate">Depending on how you end up actually installing the library you might need to check and tweak the paths in the file configure.erl. </LI><LI CLASS="li-enumerate">While in the directory <CODE>ejabberd\src</CODE> run: @@ -520,7 +510,7 @@ There are two ways to register a XMPP account: <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 XMPP client and In-Band Registration (see section <A HREF="#modregister">3.3.18</A>). +</PRE></LI><LI CLASS="li-enumerate">Using a XMPP 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 XMPP account you created: <PRE CLASS="verbatim">{acl, admins, {user, "admin1", "example.org"}}. @@ -1825,8 +1815,7 @@ all entries end with a comma: <TR><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD><TD ALIGN=left NOWRAP>Entity Capabilities (<A HREF="http://xmpp.org/extensions/xep-0115.html">XEP-0115</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> <TR><TD ALIGN=left NOWRAP><TT>mod_configure</TT></TD><TD ALIGN=left NOWRAP>Server configuration using Ad-Hoc</TD><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#moddisco"><TT>mod_disco</TT></A></TD><TD ALIGN=left NOWRAP>Service Discovery (<A HREF="http://xmpp.org/extensions/xep-0030.html">XEP-0030</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modecho"><TT>mod_echo</TT></A></TD><TD ALIGN=left NOWRAP>Echoes XMPP stanzas</TD><TD ALIGN=left NOWRAP> </TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modirc"><TT>mod_irc</TT></A></TD><TD ALIGN=left NOWRAP>IRC transport</TD><TD ALIGN=left NOWRAP> </TD></TR> +<TR><TD ALIGN=left NOWRAP><A HREF="#modecho"><TT>mod_echo</TT></A></TD><TD ALIGN=left NOWRAP>Echoes Jabber packets</TD><TD ALIGN=left NOWRAP> </TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modmuc"><TT>mod_muc</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> @@ -1840,7 +1829,6 @@ all entries end with a comma: <TR><TD ALIGN=left NOWRAP><A HREF="#modprivate"><TT>mod_private_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modproxy"><TT>mod_proxy65</TT></A></TD><TD ALIGN=left NOWRAP>SOCKS5 Bytestreams (<A HREF="http://xmpp.org/extensions/xep-0065.html">XEP-0065</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modpubsub"><TT>mod_pubsub</TT></A></TD><TD ALIGN=left NOWRAP>Pub-Sub (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>), PEP (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>)</TD><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD></TR> -<TR><TD ALIGN=left NOWRAP><A HREF="#modpubsub"><TT>mod_pubsub_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Pub-Sub (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>), PEP (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*) and <TT>mod_caps</TT></TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modregister"><TT>mod_register</TT></A></TD><TD ALIGN=left NOWRAP>In-Band Registration (<A HREF="http://xmpp.org/extensions/xep-0077.html">XEP-0077</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR> <TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR> @@ -1951,7 +1939,7 @@ message is sent to all registered users. If the user is online and connected 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.12</A>) is enabled. +(see section <A HREF="#modoffline">3.3.11</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. @@ -2205,69 +2193,8 @@ To use this module you must enable it: }, ... ]}. -</PRE><P> <A NAME="modirc"></A> </P><!--TOC subsection <TT>mod_irc</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc47">3.3.8</A>  <A HREF="#modirc"><TT>mod_irc</TT></A></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: - -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -A XMPP client with ‘groupchat 1.0’ support or Multi-User -Chat support (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>) is necessary to join IRC channels. -</LI><LI CLASS="li-itemize">An IRC channel can be joined in nearly the same way as joining a -XMPP Multi-User Chat room. The difference is that the room name will -be ‘channel%<TT>irc.example.org</TT>’ in case <TT>irc.example.org</TT> is -the IRC server hosting ‘channel’. And of course the host should point -to the IRC transport instead of the Multi-User Chat service. -</LI><LI CLASS="li-itemize">You can register your nickame by sending ‘IDENTIFY password’ to<BR> - <TT>nickserver!irc.example.org@irc.jabberserver.org</TT>. -</LI><LI CLASS="li-itemize">Entering your password is possible by sending ‘LOGIN nick password’<BR> - to <TT>nickserver!irc.example.org@irc.jabberserver.org</TT>. -</LI><LI CLASS="li-itemize">The IRC transport provides Ad-Hoc Commands (<A HREF="http://xmpp.org/extensions/xep-0050.html">XEP-0050</A>) -to join a channel, and to set custom IRC username and encoding. -</LI><LI CLASS="li-itemize">When using a popular XMPP server, it can occur that no -connection can be achieved with some IRC servers because they limit the -number of conections from one IP. -</LI></UL><P>Options: -</P><DL CLASS="description"><DT CLASS="dt-description"> - -<B><TT>{host, HostName}</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the -service. If the <TT>host</TT> option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘<TT>irc.</TT>’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -</DD><DT CLASS="dt-description"><B><TT>{access, AccessName}</TT></B></DT><DD CLASS="dd-description"> This option can be used to specify who -may use the IRC transport (default value: <TT>all</TT>). -</DD><DT CLASS="dt-description"><B><TT>{default_encoding, Encoding}</TT></B></DT><DD CLASS="dd-description"> Set the default IRC encoding. -Default value: <TT>"koi8-r"</TT> -</DD></DL><P>Examples: -</P><UL CLASS="itemize"><LI CLASS="li-itemize"> -In the first example, the IRC transport is available on (all) your -virtual host(s) with the prefix ‘<TT>irc.</TT>’. Furthermore, anyone is -able to use the transport. The default encoding is set to "iso8859-15". -<PRE CLASS="verbatim">{modules, - [ - ... - {mod_irc, [{access, all}, {default_encoding, "iso8859-15"}]}, - ... - ]}. -</PRE></LI><LI CLASS="li-itemize">In next example the IRC transport is available with JIDs with prefix <TT>irc-t.net</TT>. -Moreover, the transport is only accessible to two users -of <TT>example.org</TT>, and any user of <TT>example.com</TT>: -<PRE CLASS="verbatim">{acl, paying_customers, {user, "customer1", "example.org"}}. -{acl, paying_customers, {user, "customer2", "example.org"}}. -{acl, paying_customers, {server, "example.com"}}. - -{access, irc_users, [{allow, paying_customers}, {deny, all}]}. - -{modules, - [ - ... - {mod_irc, [{access, irc_users}, - {host, "irc.example.net"}]}, - ... - ]}. -</PRE></LI></UL><P> <A NAME="modlast"></A> </P><!--TOC subsection <TT>mod_last</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc48">3.3.9</A>  <A HREF="#modlast"><TT>mod_last</TT></A></H3><!--SEC END --><P> <A NAME="modlast"></A> +</PRE><P> <A NAME="modlast"></A> </P><!--TOC subsection <TT>mod_last</TT>--> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc47">3.3.8</A>  <A HREF="#modlast"><TT>mod_last</TT></A></H3><!--SEC END --><P> <A NAME="modlast"></A> </P><P>This module adds support for Last Activity (<A HREF="http://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 connected user was last active on the server, or to query the uptime of the @@ -2276,7 +2203,7 @@ connected user was last active on the server, or to query the uptime of the <B><TT>{iqdisc, Discipline}</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><P> <A NAME="modmuc"></A> </P><!--TOC subsection <TT>mod_muc</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc49">3.3.10</A>  <A HREF="#modmuc"><TT>mod_muc</TT></A></H3><!--SEC END --><P> <A NAME="modmuc"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc48">3.3.9</A>  <A HREF="#modmuc"><TT>mod_muc</TT></A></H3><!--SEC END --><P> <A NAME="modmuc"></A> </P><P>This module provides a Multi-User Chat (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>) service. Users can discover existing rooms, join or create them. Occupants of a room can chat in public or have private chats.</P><P>Some of the features of Multi-User Chat: @@ -2499,7 +2426,7 @@ the newly created rooms have by default those options. ... ]}. </PRE></LI></UL><P> <A NAME="modmuclog"></A> </P><!--TOC subsection <TT>mod_muc_log</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc50">3.3.11</A>  <A HREF="#modmuclog"><TT>mod_muc_log</TT></A></H3><!--SEC END --><P> <A NAME="modmuclog"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc49">3.3.10</A>  <A HREF="#modmuclog"><TT>mod_muc_log</TT></A></H3><!--SEC END --><P> <A NAME="modmuclog"></A> </P><P>This module enables optional logging of Multi-User Chat (MUC) public conversations to HTML. Once you enable this module, users can join a room using a MUC capable XMPP client, and if they have enough privileges, they can request the @@ -2618,7 +2545,7 @@ top link will be the default <CODE><a href="/">Home</a></CODE>. ... ]}. </PRE></LI></UL><P> <A NAME="modoffline"></A> </P><!--TOC subsection <TT>mod_offline</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc51">3.3.12</A>  <A HREF="#modoffline"><TT>mod_offline</TT></A></H3><!--SEC END --><P> <A NAME="modoffline"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc50">3.3.11</A>  <A HREF="#modoffline"><TT>mod_offline</TT></A></H3><!--SEC END --><P> <A NAME="modoffline"></A> </P><P>This module implements offline message storage (<A HREF="http://xmpp.org/extensions/xep-0160.html">XEP-0160</A>). This means that all messages sent to an offline user will be stored on the server until that user comes @@ -2650,7 +2577,7 @@ and all the other users up to 100. ... ]}. </PRE><P> <A NAME="modping"></A> </P><!--TOC subsection <TT>mod_ping</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc52">3.3.13</A>  <A HREF="#modping"><TT>mod_ping</TT></A></H3><!--SEC END --><P> <A NAME="modping"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc51">3.3.12</A>  <A HREF="#modping"><TT>mod_ping</TT></A></H3><!--SEC END --><P> <A NAME="modping"></A> </P><P>This module implements support for XMPP Ping (<A HREF="http://xmpp.org/extensions/xep-0199.html">XEP-0199</A>) and periodic keepalives. When this module is enabled ejabberd responds correctly to ping requests, as defined in the protocol.</P><P>Configuration options: @@ -2678,7 +2605,7 @@ and if a client does not answer to the ping in less than 32 seconds, its connect ... ]}. </PRE><P> <A NAME="modprivacy"></A> </P><!--TOC subsection <TT>mod_privacy</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc53">3.3.14</A>  <A HREF="#modprivacy"><TT>mod_privacy</TT></A></H3><!--SEC END --><P> <A NAME="modprivacy"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc52">3.3.13</A>  <A HREF="#modprivacy"><TT>mod_privacy</TT></A></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 their XMPP client, they will be able to: @@ -2706,7 +2633,7 @@ subscription type (or globally). <B><TT>{iqdisc, Discipline}</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><P> <A NAME="modprivate"></A> </P><!--TOC subsection <TT>mod_private</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc54">3.3.15</A>  <A HREF="#modprivate"><TT>mod_private</TT></A></H3><!--SEC END --><P> <A NAME="modprivate"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc53">3.3.14</A>  <A HREF="#modprivate"><TT>mod_private</TT></A></H3><!--SEC END --><P> <A NAME="modprivate"></A> </P><P>This module adds support for Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>): </P><BLOCKQUOTE CLASS="quote"> Using this method, XMPP entities can store private data on the server and @@ -2718,7 +2645,7 @@ of client-specific preferences; another is Bookmark Storage (<A HREF="http://xmp <B><TT>{iqdisc, Discipline}</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><P> <A NAME="modproxy"></A> </P><!--TOC subsection <TT>mod_proxy65</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc55">3.3.16</A>  <A HREF="#modproxy"><TT>mod_proxy65</TT></A></H3><!--SEC END --><P> <A NAME="modproxy"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc54">3.3.15</A>  <A HREF="#modproxy"><TT>mod_proxy65</TT></A></H3><!--SEC END --><P> <A NAME="modproxy"></A> </P><P>This module implements SOCKS5 Bytestreams (<A HREF="http://xmpp.org/extensions/xep-0065.html">XEP-0065</A>). It allows <TT>ejabberd</TT> to act as a file transfer proxy between two XMPP clients.</P><P>Options: @@ -2776,7 +2703,7 @@ The simpliest configuration of the module: ... ]}. </PRE></LI></UL><P> <A NAME="modpubsub"></A> </P><!--TOC subsection <TT>mod_pubsub</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc56">3.3.17</A>  <A HREF="#modpubsub"><TT>mod_pubsub</TT></A></H3><!--SEC END --><P> <A NAME="modpubsub"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc55">3.3.16</A>  <A HREF="#modpubsub"><TT>mod_pubsub</TT></A></H3><!--SEC END --><P> <A NAME="modpubsub"></A> </P><P>This module offers a Publish-Subscribe Service (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>). The functionality in <TT>mod_pubsub</TT> can be extended using plugins. The plugin that implements PEP (Personal Eventing via Pubsub) (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>) @@ -2797,27 +2724,13 @@ By default any account in the local ejabberd server is allowed to create pubsub Define the maximum number of items that can be stored in a node. Default value is 10. </DD><DT CLASS="dt-description"><B><TT>{plugins, [ Plugin, ...]}</TT></B></DT><DD CLASS="dd-description"> -To specify which pubsub node plugins to use. -The first one in the list is used by default. -If this option is not defined, the default plugins list is: <TT>["flat"]</TT>. -PubSub clients can define which plugin to use when creating a node: -add <TT>type=’plugin-name’</TT> attribute to the <TT>create</TT> stanza element. -</DD><DT CLASS="dt-description"><B><TT>{nodetree, Nodetree}</TT></B></DT><DD CLASS="dd-description"> -To specify which nodetree to use. -If not defined, the default pubsub nodetree is used: "tree". -Only one nodetree can be used per host, and is shared by all node plugins.<P>The "virtual" nodetree does not store nodes on database. -This saves resources on systems with tons of nodes. -If using the "virtual" nodetree, -you can only enable those node plugins: -["flat","pep"] or ["flat"]; -any other plugins configuration will not work. -Also, all nodes will have the defaut configuration, -and this can not be changed. -Using "virtual" nodetree requires to start from a clean database, -it will not work if you used the default "tree" nodetree before.</P><P>The "dag" nodetree provides experimental support for PubSub Collection Nodes (<A HREF="http://xmpp.org/extensions/xep-0248.html">XEP-0248</A>). -In that case you should also add "dag" node plugin as default, for example: -<TT>{plugins, ["dag","flat","hometree","pep"]}</TT> -</P></DD><DT CLASS="dt-description"><B><TT>{ignore_pep_from_offline, false|true}</TT></B></DT><DD CLASS="dd-description"> +To specify which pubsub node plugins to use. If not defined, the default +pubsub plugin is always used. +</DD><DT CLASS="dt-description"><B><TT>{nodetree, Name}</TT></B></DT><DD CLASS="dd-description"> +To specify which nodetree to use. If not defined, the default pubsub +nodetree is used. Only one nodetree can be used per host, +and is shared by all node plugins. +</DD><DT CLASS="dt-description"><B><TT>{ignore_pep_from_offline, false|true}</TT></B></DT><DD CLASS="dd-description"> To specify whether or not we should get last published PEP items from users in our roster which are offline when we connect. Value is true or false. If not defined, pubsub assumes true so we only get last items of online contacts. @@ -2830,29 +2743,18 @@ usage, as every item is stored in memory. This allow to define a Key-Value list to choose defined node plugins on given PEP namespace. The following example will use node_tune instead of node_pep for every PEP node with tune namespace: <PRE CLASS="verbatim"> {mod_pubsub, [{pep_mapping, [{"http://jabber.org/protocol/tune", "tune"}]}]} -</PRE></DD></DL><P>Example of configuration that uses flat nodes as default, and allows use of flat, nodetree and pep nodes: +</PRE></DD></DL><P>Example: </P><PRE CLASS="verbatim">{modules, [ ... {mod_pubsub, [ {access_createnode, pubsub_createnode}, - {plugins, ["flat", "hometree", "pep"]} - ]}, - ... - ]}. -</PRE><P>Using ODBC database requires use of dedicated plugins. The following example shows previous configuration -with ODBC usage: -</P><PRE CLASS="verbatim">{modules, - [ - ... - {mod_pubsub_odbc, [ - {access_createnode, pubsub_createnode}, - {plugins, ["flat_odbc", "hometree_odbc", "pep_odbc"]} - ]}, + {plugins, ["default", "pep"]} + ]} ... ]}. </PRE><P> <A NAME="modregister"></A> </P><!--TOC subsection <TT>mod_register</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc57">3.3.18</A>  <A HREF="#modregister"><TT>mod_register</TT></A></H3><!--SEC END --><P> <A NAME="modregister"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc56">3.3.17</A>  <A HREF="#modregister"><TT>mod_register</TT></A></H3><!--SEC END --><P> <A NAME="modregister"></A> </P><P>This module adds support for In-Band Registration (<A HREF="http://xmpp.org/extensions/xep-0077.html">XEP-0077</A>). This protocol enables end users to use a XMPP client to: </P><UL CLASS="itemize"><LI CLASS="li-itemize"> @@ -2931,7 +2833,7 @@ Also define a registration timeout of one hour: ... ]}. </PRE></LI></UL><P> <A NAME="modroster"></A> </P><!--TOC subsection <TT>mod_roster</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc58">3.3.19</A>  <A HREF="#modroster"><TT>mod_roster</TT></A></H3><!--SEC END --><P> <A NAME="modroster"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc57">3.3.18</A>  <A HREF="#modroster"><TT>mod_roster</TT></A></H3><!--SEC END --><P> <A NAME="modroster"></A> </P><P>This module implements roster management as defined in <A HREF="http://xmpp.org/specs/rfc3921.html#roster">RFC 3921: XMPP IM</A>. It also supports Roster Versioning (<A HREF="http://xmpp.org/extensions/xep-0237.html">XEP-0237</A>).</P><P>Options: @@ -2957,7 +2859,7 @@ Important: if you use <TT>mod_shared_roster</TT>, you must disable this option. ... ]}. </PRE><P> <A NAME="modservicelog"></A> </P><!--TOC subsection <TT>mod_service_log</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc59">3.3.20</A>  <A HREF="#modservicelog"><TT>mod_service_log</TT></A></H3><!--SEC END --><P> <A NAME="modservicelog"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc58">3.3.19</A>  <A HREF="#modservicelog"><TT>mod_service_log</TT></A></H3><!--SEC END --><P> <A NAME="modservicelog"></A> </P><P>This module adds support for logging end user packets via a XMPP message auditing service such as <A HREF="http://www.funkypenguin.info/project/bandersnatch/">Bandersnatch</A>. All user @@ -2987,7 +2889,7 @@ To log all end user packets to the Bandersnatch service running on ... ]}. </PRE></LI></UL><P> <A NAME="modsharedroster"></A> </P><!--TOC subsection <TT>mod_shared_roster</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc60">3.3.21</A>  <A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></H3><!--SEC END --><P> <A NAME="modsharedroster"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc59">3.3.20</A>  <A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></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 rosters. The big advantages of this feature are that end users do not need to @@ -3062,7 +2964,7 @@ roster groups as shown in the following table: </TABLE> <DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> </LI></UL><P> <A NAME="modstats"></A> </P><!--TOC subsection <TT>mod_stats</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc61">3.3.22</A>  <A HREF="#modstats"><TT>mod_stats</TT></A></H3><!--SEC END --><P> <A NAME="modstats"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc60">3.3.21</A>  <A HREF="#modstats"><TT>mod_stats</TT></A></H3><!--SEC END --><P> <A NAME="modstats"></A> </P><P>This module adds support for Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>). This protocol allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment: </P><UL CLASS="itemize"><LI CLASS="li-itemize"> @@ -3094,14 +2996,14 @@ by sending: </query> </iq> </PRE></LI></UL><P> <A NAME="modtime"></A> </P><!--TOC subsection <TT>mod_time</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc62">3.3.23</A>  <A HREF="#modtime"><TT>mod_time</TT></A></H3><!--SEC END --><P> <A NAME="modtime"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc61">3.3.22</A>  <A HREF="#modtime"><TT>mod_time</TT></A></H3><!--SEC END --><P> <A NAME="modtime"></A> </P><P>This module features support for Entity Time (<A HREF="http://xmpp.org/extensions/xep-0202.html">XEP-0202</A>). By using this XEP, you are able to discover the time at another entity’s location.</P><P>Options: </P><DL CLASS="description"><DT CLASS="dt-description"> <B><TT>{iqdisc, Discipline}</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><P> <A NAME="modvcard"></A> </P><!--TOC subsection <TT>mod_vcard</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc63">3.3.24</A>  <A HREF="#modvcard"><TT>mod_vcard</TT></A></H3><!--SEC END --><P> <A NAME="modvcard"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc62">3.3.23</A>  <A HREF="#modvcard"><TT>mod_vcard</TT></A></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://xmpp.org/extensions/xep-0054.html">XEP-0054</A>). The module also implements an uncomplicated Jabber User Directory based on the vCards of @@ -3156,7 +3058,7 @@ and that all virtual hosts will be searched instead of only the current one: ... ]}. </PRE></LI></UL><P> <A NAME="modvcardldap"></A> </P><!--TOC subsection <TT>mod_vcard_ldap</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc64">3.3.25</A>  <A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></H3><!--SEC END --><P> <A NAME="modvcardldap"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc63">3.3.24</A>  <A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></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 authentication method (see <A HREF="#ldapauth">3.2.5</A>).</P><P>Note that <TT>ejabberd</TT> treats LDAP as a read-only storage: @@ -3335,7 +3237,7 @@ searching his info in LDAP.</P></LI><LI CLASS="li-itemize"><TT>ldap_vcard_map</T {"Nickname", "NICKNAME"} ]}, </PRE></LI></UL><P> <A NAME="modversion"></A> </P><!--TOC subsection <TT>mod_version</TT>--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc65">3.3.26</A>  <A HREF="#modversion"><TT>mod_version</TT></A></H3><!--SEC END --><P> <A NAME="modversion"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc64">3.3.25</A>  <A HREF="#modversion"><TT>mod_version</TT></A></H3><!--SEC END --><P> <A NAME="modversion"></A> </P><P>This module implements Software Version (<A HREF="http://xmpp.org/extensions/xep-0092.html">XEP-0092</A>). Consequently, it answers <TT>ejabberd</TT>’s version when queried.</P><P>Options: </P><DL CLASS="description"><DT CLASS="dt-description"> @@ -3344,8 +3246,8 @@ The default value is <TT>true</TT>. </DD><DT CLASS="dt-description"><B><TT>{iqdisc, Discipline}</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><P> <A NAME="manage"></A> </P><!--TOC chapter Managing an <TT>ejabberd</TT> Server--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc66">Chapter 4</A>  <A HREF="#manage">Managing an <TT>ejabberd</TT> Server</A></H1><!--SEC END --><P> <A NAME="manage"></A> </P><P> <A NAME="ejabberdctl"></A> </P><!--TOC section <TT>ejabberdctl</TT>--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc67">4.1</A>  <A HREF="#ejabberdctl"><TT>ejabberdctl</TT></A></H2><!--SEC END --><P> <A NAME="ejabberdctl"></A> </P><P>With the <TT>ejabberdctl</TT> command line administration script +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc65">Chapter 4</A>  <A HREF="#manage">Managing an <TT>ejabberd</TT> Server</A></H1><!--SEC END --><P> <A NAME="manage"></A> </P><P> <A NAME="ejabberdctl"></A> </P><!--TOC section <TT>ejabberdctl</TT>--> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc66">4.1</A>  <A HREF="#ejabberdctl"><TT>ejabberdctl</TT></A></H2><!--SEC END --><P> <A NAME="ejabberdctl"></A> </P><P>With the <TT>ejabberdctl</TT> command line administration script you can execute <TT>ejabberdctl commands</TT> (described in the next section, <A HREF="#ectl-commands">4.1.1</A>) and also many general <TT>ejabberd commands</TT> (described in section <A HREF="#eja-commands">4.2</A>). This means you can start, stop and perform many other administrative tasks @@ -3357,7 +3259,7 @@ and other codes may be used for specific results. This can be used by other scripts to determine automatically if a command succeeded or failed, for example using: <TT>echo $?</TT></P><P> <A NAME="ectl-commands"></A> </P><!--TOC subsection ejabberdctl Commands--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc68">4.1.1</A>  <A HREF="#ectl-commands">ejabberdctl Commands</A></H3><!--SEC END --><P> <A NAME="ectl-commands"></A> </P><P>When <TT>ejabberdctl</TT> is executed without any parameter, +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc67">4.1.1</A>  <A HREF="#ectl-commands">ejabberdctl Commands</A></H3><!--SEC END --><P> <A NAME="ectl-commands"></A> </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, the available parameters are: </P><DL CLASS="description"><DT CLASS="dt-description"> @@ -3393,7 +3295,7 @@ robot1 testuser1 testuser2 </PRE><P> <A NAME="erlangconfiguration"></A> </P><!--TOC subsection Erlang Runtime System--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc69">4.1.2</A>  <A HREF="#erlangconfiguration">Erlang Runtime System</A></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. +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc68">4.1.2</A>  <A HREF="#erlangconfiguration">Erlang Runtime System</A></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. You can configure some of them with the file <TT>ejabberdctl.cfg</TT>, @@ -3470,7 +3372,7 @@ not “Simple Authentication and Security Layer”. </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><P> <A NAME="eja-commands"></A> </P><!--TOC section <TT>ejabberd</TT> Commands--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc70">4.2</A>  <A HREF="#eja-commands"><TT>ejabberd</TT> Commands</A></H2><!--SEC END --><P> <A NAME="eja-commands"></A> </P><P>An <TT>ejabberd command</TT> is an abstract function identified by a name, +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc69">4.2</A>  <A HREF="#eja-commands"><TT>ejabberd</TT> Commands</A></H2><!--SEC END --><P> <A NAME="eja-commands"></A> </P><P>An <TT>ejabberd command</TT> is an abstract function identified by a name, with a defined number and type of calling arguments and type of result that is registered in the <TT>ejabberd_commands</TT> service. Those commands can be defined in any Erlang module and executed using any valid frontend.</P><P><TT>ejabberd</TT> includes a frontend to execute <TT>ejabberd commands</TT>: the script <TT>ejabberdctl</TT>. @@ -3478,7 +3380,7 @@ Other known frontends that can be installed to execute ejabberd commands in diff <TT>ejabberd_xmlrpc</TT> (XML-RPC service), <TT>mod_rest</TT> (HTTP POST service), <TT>mod_shcommands</TT> (ejabberd WebAdmin page).</P><P> <A NAME="list-eja-commands"></A> </P><!--TOC subsection List of ejabberd Commands--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc71">4.2.1</A>  <A HREF="#list-eja-commands">List of ejabberd Commands</A></H3><!--SEC END --><P> <A NAME="list-eja-commands"></A> </P><P><TT>ejabberd</TT> includes a few ejabberd Commands by default. +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc70">4.2.1</A>  <A HREF="#list-eja-commands">List of ejabberd Commands</A></H3><!--SEC END --><P> <A NAME="list-eja-commands"></A> </P><P><TT>ejabberd</TT> includes a few ejabberd Commands by default. When more modules are installed, new commands may be available in the frontends.</P><P>The easiest way to get a list of the available commands, and get help for them is to use the ejabberdctl script: </P><PRE CLASS="verbatim">$ ejabberdctl help @@ -3529,7 +3431,7 @@ is very high. </DD><DT CLASS="dt-description"><B><TT>register user host password</TT></B></DT><DD CLASS="dd-description"> Register an account in that domain with the given password. </DD><DT CLASS="dt-description"><B><TT>unregister user host</TT></B></DT><DD CLASS="dd-description"> Unregister the given account. </DD></DL><P> <A NAME="accesscommands"></A> </P><!--TOC subsection Restrict Execution with AccessCommands--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc72">4.2.2</A>  <A HREF="#accesscommands">Restrict Execution with AccessCommands</A></H3><!--SEC END --><P> <A NAME="accesscommands"></A> </P><P>The frontends can be configured to restrict access to certain commands. +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc71">4.2.2</A>  <A HREF="#accesscommands">Restrict Execution with AccessCommands</A></H3><!--SEC END --><P> <A NAME="accesscommands"></A> </P><P>The frontends can be configured to restrict access to certain commands. In that case, authentication information must be provided. In each frontend the <TT>AccessCommands</TT> option is defined in a different place. But in all cases the option syntax is the same: @@ -3575,7 +3477,7 @@ and the provided arguments do not contradict Arguments.</P><P>As an example to u {_bot_reg_test, [register, unregister], [{host, "test.org"}]} ] </PRE><P> <A NAME="webadmin"></A> </P><!--TOC section Web Admin--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc73">4.3</A>  <A HREF="#webadmin">Web Admin</A></H2><!--SEC END --><P> <A NAME="webadmin"></A> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc72">4.3</A>  <A HREF="#webadmin">Web Admin</A></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 section <A HREF="#listened">3.1.3</A>) is included in the listening ports. Then you can open @@ -3647,13 +3549,13 @@ The file is searched by default in The directory of the documentation can be specified in the environment variable <TT>EJABBERD_DOC_PATH</TT>. See section <A HREF="#erlangconfiguration">4.1.2</A>.</P><P> <A NAME="adhoccommands"></A> </P><!--TOC section Ad-hoc Commands--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc74">4.4</A>  <A HREF="#adhoccommands">Ad-hoc Commands</A></H2><!--SEC END --><P> <A NAME="adhoccommands"></A> </P><P>If you enable <TT>mod_configure</TT> and <TT>mod_adhoc</TT>, +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc73">4.4</A>  <A HREF="#adhoccommands">Ad-hoc Commands</A></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 XMPP client. The client must support Ad-Hoc Commands (<A HREF="http://xmpp.org/extensions/xep-0050.html">XEP-0050</A>), and you must login in the XMPP server with an account with proper privileges.</P><P> <A NAME="changeerlangnodename"></A> </P><!--TOC section Change Computer Hostname--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc75">4.5</A>  <A HREF="#changeerlangnodename">Change Computer Hostname</A></H2><!--SEC END --><P> <A NAME="changeerlangnodename"></A> </P><P><TT>ejabberd</TT> uses the distributed Mnesia database. +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc74">4.5</A>  <A HREF="#changeerlangnodename">Change Computer Hostname</A></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 (see section <A HREF="#nodename">5.4</A>). The name of an Erlang node includes the hostname of the computer. @@ -3690,8 +3592,8 @@ mv /var/lib/ejabberd/*.* /var/lib/ejabberd/oldfiles/ </PRE></LI><LI CLASS="li-enumerate">Check that the information of the old database is available: accounts, rosters... After you finish, remember to delete the temporary backup files from public directories. </LI></OL><P> <A NAME="secure"></A> </P><!--TOC chapter Securing <TT>ejabberd</TT>--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc76">Chapter 5</A>  <A HREF="#secure">Securing <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="secure"></A> </P><P> <A NAME="firewall"></A> </P><!--TOC section Firewall Settings--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc77">5.1</A>  <A HREF="#firewall">Firewall Settings</A></H2><!--SEC END --><P> <A NAME="firewall"></A> +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc75">Chapter 5</A>  <A HREF="#secure">Securing <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="secure"></A> </P><P> <A NAME="firewall"></A> </P><!--TOC section Firewall Settings--> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc76">5.1</A>  <A HREF="#firewall">Firewall Settings</A></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> <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Port</B></TD><TD ALIGN=left NOWRAP><B>Description</B></TD></TR> @@ -3702,7 +3604,7 @@ After you finish, remember to delete the temporary backup files from public dire <TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable (see section <A HREF="#epmd">5.2</A>).</TD></TR> </TABLE> <DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="epmd"></A> </P><!--TOC section epmd--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc78">5.2</A>  <A HREF="#epmd">epmd</A></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> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc77">5.2</A>  <A HREF="#epmd">epmd</A></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. <TT>ejabberd</TT> needs <TT>epmd</TT> to use <TT>ejabberdctl</TT> and also when clustering <TT>ejabberd</TT> nodes. @@ -3727,7 +3629,7 @@ but can be configured in the file <TT>ejabberdctl.cfg</TT>. The Erlang command-line parameter used internally is, for example: </P><PRE CLASS="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375 </PRE><P> <A NAME="cookie"></A> </P><!--TOC section Erlang Cookie--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc79">5.3</A>  <A HREF="#cookie">Erlang Cookie</A></H2><!--SEC END --><P> <A NAME="cookie"></A> </P><P>The Erlang cookie is a string with numbers and letters. +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc78">5.3</A>  <A HREF="#cookie">Erlang Cookie</A></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>. If not indicated, the cookie is read from the cookie file <TT>$HOME/.erlang.cookie</TT>. If this file does not exist, it is created immediately with a random cookie. @@ -3741,7 +3643,7 @@ to prevent unauthorized access or intrusion to an Erlang node. 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><P> <A NAME="nodename"></A> </P><!--TOC section Erlang Node Name--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc80">5.4</A>  <A HREF="#nodename">Erlang Node Name</A></H2><!--SEC END --><P> <A NAME="nodename"></A> </P><P>An Erlang node may have a node name. +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc79">5.4</A>  <A HREF="#nodename">Erlang Node Name</A></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>). Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.</P><P>Using the option <TT>-sname</TT> instead of <TT>-name</TT> is a simple method @@ -3750,7 +3652,7 @@ However, it is not ultimately effective to prevent access to the Erlang node, 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><P> <A NAME="secure-files"></A> </P><!--TOC section Securing Sensitive Files--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc81">5.5</A>  <A HREF="#secure-files">Securing Sensitive Files</A></H2><!--SEC END --><P> <A NAME="secure-files"></A> </P><P><TT>ejabberd</TT> stores sensitive data in the file system either in plain text or binary files. +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc80">5.5</A>  <A HREF="#secure-files">Securing Sensitive Files</A></H2><!--SEC END --><P> <A NAME="secure-files"></A> </P><P><TT>ejabberd</TT> stores sensitive data in the file system either in plain text or binary files. The file system permissions should be set to only allow the proper user to read, write and execute those files and directories.</P><DL CLASS="description"><DT CLASS="dt-description"> <B><TT>ejabberd configuration file: /etc/ejabberd/ejabberd.cfg</TT></B></DT><DD CLASS="dd-description"> @@ -3770,9 +3672,9 @@ so it is preferable to secure the whole <TT>/var/lib/ejabberd/</TT> directory. </DD><DT CLASS="dt-description"><B><TT>Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</TT></B></DT><DD CLASS="dd-description"> See section <A HREF="#cookie">5.3</A>. </DD></DL><P> <A NAME="clustering"></A> </P><!--TOC chapter Clustering--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc82">Chapter 6</A>  <A HREF="#clustering">Clustering</A></H1><!--SEC END --><P> <A NAME="clustering"></A> +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc81">Chapter 6</A>  <A HREF="#clustering">Clustering</A></H1><!--SEC END --><P> <A NAME="clustering"></A> </P><P> <A NAME="howitworks"></A> </P><!--TOC section How it Works--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc83">6.1</A>  <A HREF="#howitworks">How it Works</A></H2><!--SEC END --><P> <A NAME="howitworks"></A> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc82">6.1</A>  <A HREF="#howitworks">How it Works</A></H2><!--SEC END --><P> <A NAME="howitworks"></A> </P><P>A XMPP 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 must have the ability to connect to port 4369 of all another nodes, and must @@ -3786,29 +3688,29 @@ router, </LI><LI CLASS="li-itemize">session manager, </LI><LI CLASS="li-itemize">s2s manager. </LI></UL><P> <A NAME="router"></A> </P><!--TOC subsection Router--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc84">6.1.1</A>  <A HREF="#router">Router</A></H3><!--SEC END --><P> <A NAME="router"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc83">6.1.1</A>  <A HREF="#router">Router</A></H3><!--SEC END --><P> <A NAME="router"></A> </P><P>This module is the main router of XMPP 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><P> <A NAME="localrouter"></A> </P><!--TOC subsection Local Router--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc85">6.1.2</A>  <A HREF="#localrouter">Local Router</A></H3><!--SEC END --><P> <A NAME="localrouter"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc84">6.1.2</A>  <A HREF="#localrouter">Local Router</A></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><P> <A NAME="sessionmanager"></A> </P><!--TOC subsection Session Manager--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc86">6.1.3</A>  <A HREF="#sessionmanager">Session Manager</A></H3><!--SEC END --><P> <A NAME="sessionmanager"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc85">6.1.3</A>  <A HREF="#sessionmanager">Session Manager</A></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><P> <A NAME="s2smanager"></A> </P><!--TOC subsection s2s Manager--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc87">6.1.4</A>  <A HREF="#s2smanager">s2s Manager</A></H3><!--SEC END --><P> <A NAME="s2smanager"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc86">6.1.4</A>  <A HREF="#s2smanager">s2s Manager</A></H3><!--SEC END --><P> <A NAME="s2smanager"></A> </P><P>This module routes packets to other XMPP 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><P> <A NAME="cluster"></A> </P><!--TOC section Clustering Setup--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc88">6.2</A>  <A HREF="#cluster">Clustering Setup</A></H2><!--SEC END --><P> <A NAME="cluster"></A> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc87">6.2</A>  <A HREF="#cluster">Clustering Setup</A></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 following steps:</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> @@ -3842,14 +3744,14 @@ the Erlang shell. This probably can take some time if Mnesia has not yet transfered and processed all data it needed from <TT>first</TT>.</LI><LI CLASS="li-enumerate">Now run <TT>ejabberd</TT> on <TT>second</TT> with a configuration similar as on <TT>first</TT>: you probably do not need to duplicate ‘<CODE>acl</CODE>’ and ‘<CODE>access</CODE>’ options because they will be taken from -<TT>first</TT>; and <CODE>mod_irc</CODE> should be +<TT>first</TT>. If you installed <CODE>mod_irc</CODE>, notice that it should be 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><P> <A NAME="servicelb"></A> </P><!--TOC section Service Load-Balancing--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc89">6.3</A>  <A HREF="#servicelb">Service Load-Balancing</A></H2><!--SEC END --><P> <A NAME="servicelb"></A> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc88">6.3</A>  <A HREF="#servicelb">Service Load-Balancing</A></H2><!--SEC END --><P> <A NAME="servicelb"></A> </P><P> <A NAME="componentlb"></A> </P><!--TOC subsection Components Load-Balancing--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc90">6.3.1</A>  <A HREF="#componentlb">Components Load-Balancing</A></H3><!--SEC END --><P> <A NAME="componentlb"></A> </P><P> <A NAME="domainlb"></A> </P><!--TOC subsection Domain Load-Balancing Algorithm--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc91">6.3.2</A>  <A HREF="#domainlb">Domain Load-Balancing Algorithm</A></H3><!--SEC END --><P> <A NAME="domainlb"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc89">6.3.1</A>  <A HREF="#componentlb">Components Load-Balancing</A></H3><!--SEC END --><P> <A NAME="componentlb"></A> </P><P> <A NAME="domainlb"></A> </P><!--TOC subsection Domain Load-Balancing Algorithm--> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc90">6.3.2</A>  <A HREF="#domainlb">Domain Load-Balancing Algorithm</A></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><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{domain_balancing, "component.example.com", BalancingCriteria}.</TT></B></DT></DL><P>Several balancing criteria are available: </P><UL CLASS="itemize"><LI CLASS="li-itemize"> @@ -3858,12 +3760,12 @@ domain.</P><P> <A NAME="servicelb"></A> </P><!--TOC section Service Load-Balanci </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><P> <A NAME="lbbuckets"></A> </P><!--TOC subsection Load-Balancing Buckets--> -<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc92">6.3.3</A>  <A HREF="#lbbuckets">Load-Balancing Buckets</A></H3><!--SEC END --><P> <A NAME="lbbuckets"></A> +<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc91">6.3.3</A>  <A HREF="#lbbuckets">Load-Balancing Buckets</A></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: </P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{domain_balancing_component_number, "component.example.com", Number}.</TT></B></DT></DL><P> <A NAME="debugging"></A> </P><!--TOC chapter Debugging--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc93">Chapter 7</A>  <A HREF="#debugging">Debugging</A></H1><!--SEC END --><P> <A NAME="debugging"></A> +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc92">Chapter 7</A>  <A HREF="#debugging">Debugging</A></H1><!--SEC END --><P> <A NAME="debugging"></A> </P><P> <A NAME="logfiles"></A> </P><!--TOC section Log Files--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc94">7.1</A>  <A HREF="#logfiles">Log Files</A></H2><!--SEC END --><P> <A NAME="logfiles"></A> </P><P>An <TT>ejabberd</TT> node writes two log files: +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc93">7.1</A>  <A HREF="#logfiles">Log Files</A></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 </DD><DT CLASS="dt-description"><B><TT>erlang.log</TT></B></DT><DD CLASS="dd-description"> is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries) @@ -3885,12 +3787,12 @@ The ejabberdctl command <TT>reopen-log</TT> (please refer to section <A HREF="#ectl-commands">4.1.1</A>) reopens the log files, and also renames the old ones if you didn’t rename them.</P><P> <A NAME="debugconsole"></A> </P><!--TOC section Debug Console--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc95">7.2</A>  <A HREF="#debugconsole">Debug Console</A></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. +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc94">7.2</A>  <A HREF="#debugconsole">Debug Console</A></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><P> <A NAME="watchdog"></A> </P><!--TOC section Watchdog Alerts--> -<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc96">7.3</A>  <A HREF="#watchdog">Watchdog Alerts</A></H2><!--SEC END --><P> <A NAME="watchdog"></A> +<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc95">7.3</A>  <A HREF="#watchdog">Watchdog Alerts</A></H2><!--SEC END --><P> <A NAME="watchdog"></A> </P><P><TT>ejabberd</TT> includes a watchdog mechanism that may be useful to developers when troubleshooting a problem related to memory usage. If a process in the <TT>ejabberd</TT> server consumes more memory than the configured threshold, @@ -3910,7 +3812,7 @@ or in a conversation with the watchdog alert bot.</P><P>The syntax is: To remove all watchdog admins, set the option with an empty list: </P><PRE CLASS="verbatim">{watchdog_admins, []}. </PRE><P> <A NAME="i18ni10n"></A> </P><!--TOC chapter Internationalization and Localization--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc97">Appendix A</A>  <A HREF="#i18ni10n">Internationalization and Localization</A></H1><!--SEC END --><P> <A NAME="i18ni10n"></A> +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc96">Appendix A</A>  <A HREF="#i18ni10n">Internationalization and Localization</A></H1><!--SEC END --><P> <A NAME="i18ni10n"></A> </P><P>The source code of <TT>ejabberd</TT> supports localization. The translators can edit the <A HREF="http://www.gnu.org/software/gettext/">gettext</A> .po files @@ -3945,9 +3847,9 @@ HTTP header ‘Accept-Language: ru’</TD></TR> </TABLE></DIV> <A NAME="fig:webadmmainru"></A> <DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="releasenotes"></A> </P><!--TOC chapter Release Notes--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc98">Appendix B</A>  <A HREF="#releasenotes">Release Notes</A></H1><!--SEC END --><P> <A NAME="releasenotes"></A> +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc97">Appendix B</A>  <A HREF="#releasenotes">Release Notes</A></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><P> <A NAME="acknowledgements"></A> </P><!--TOC chapter Acknowledgements--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc99">Appendix C</A>  <A HREF="#acknowledgements">Acknowledgements</A></H1><!--SEC END --><P> <A NAME="acknowledgements"></A> </P><P>Thanks to all people who contributed to this guide: +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc98">Appendix C</A>  <A HREF="#acknowledgements">Acknowledgements</A></H1><!--SEC END --><P> <A NAME="acknowledgements"></A> </P><P>Thanks to all people who contributed to this guide: </P><UL CLASS="itemize"><LI CLASS="li-itemize"> Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A>) </LI><LI CLASS="li-itemize">Badlop (<A HREF="xmpp:badlop@jabberes.org"><TT>xmpp:badlop@jabberes.org</TT></A>) @@ -3959,7 +3861,7 @@ Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT </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><P> <A NAME="copyright"></A> </P><!--TOC chapter Copyright Information--> -<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc100">Appendix D</A>  <A HREF="#copyright">Copyright Information</A></H1><!--SEC END --><P> <A NAME="copyright"></A> </P><P>Ejabberd Installation and Operation Guide.<BR> +<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc99">Appendix D</A>  <A HREF="#copyright">Copyright Information</A></H1><!--SEC END --><P> <A NAME="copyright"></A> </P><P>Ejabberd Installation and Operation Guide.<BR> Copyright © 2003 — 2009 ProcessOne</P><P>This document is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 |