-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
- "http://www.w3.org/TR/REC-html40/loose.dtd">
-<HTML>
-<HEAD>
-<TITLE>Ejabberd 2.1.12 Developers Guide
-</TITLE>
-
-<META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<META name="GENERATOR" content="hevea 1.10">
-<STYLE type="text/css">
+<!DOCTYPE html>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<meta name="generator" content="hevea 2.09">
+<style type="text/css">
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
.toc{list-style:none;}
+.footnotetext{margin:0ex; padding:0ex;}
+div.footnotetext P{margin:0px; text-indent:1em;}
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.footnoterule{margin:1em auto 1em 0px;width:50%;}
.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
.title{margin:2ex auto;text-align:center}
+.titlemain{margin:1ex 2ex 2ex 1ex;}
+.titlerest{margin:0ex 2ex;}
.center{text-align:center;margin-left:auto;margin-right:auto;}
.flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
.flushright{text-align:right;margin-left:auto;margin-right:0ex;}
-DIV TABLE{margin-left:inherit;margin-right:inherit;}
-PRE{text-align:left;margin-left:0ex;margin-right:auto;}
-BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
-TD P{margin:0px;}
+div table{margin-left:inherit;margin-right:inherit;margin-bottom:2px;margin-top:2px}
+td table{margin:auto;}
+table{border-collapse:collapse;}
+td{padding:0;}
+.cellpadding0 tr td{padding:0;}
+.cellpadding1 tr td{padding:1px;}
+pre{text-align:left;margin-left:0ex;margin-right:auto;}
+blockquote{margin-left:4ex;margin-right:4ex;text-align:left;}
+td p{margin:0px;}
.boxed{border:1px solid black}
.textboxed{border:1px solid black}
.vbar{border:none;width:2px;background-color:black;}
.hbar{border:none;height:2px;width:100%;background-color:black;}
.hfill{border:none;height:1px;width:200%;background-color:black;}
.vdisplay{border-collapse:separate;border-spacing:2px;width:auto; empty-cells:show; border:2px solid red;}
-.vdcell{white-space:nowrap;padding:0px;width:auto; border:2px solid green;}
+.vdcell{white-space:nowrap;padding:0px; border:2px solid green;}
.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
-.dcell{white-space:nowrap;padding:0px;width:auto; border:none;}
+.dcell{white-space:nowrap;padding:0px; border:none;}
.dcenter{margin:0ex auto;}
.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
.minipage{text-align:left; margin-left:0em; margin-right:auto;}
.marginparright{float:right; margin-left:1ex; margin-right:0ex;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:2ex auto;text-align:center}
-</STYLE>
-</HEAD>
-<BODY >
+</style>
+<title>Ejabberd community 14.05-120-gedfb5fc Developers Guide
+</title>
+</head>
+<body >
<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic dev.tex -->
-<!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
+<!--CUT STYLE article--><!--CUT DEF section 1 --><p><a id="titlepage"></a>
-</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.1.12 Developers Guide</H1><H3 CLASS="titlerest">Alexey Shchepin<BR>
- <A HREF="mailto:alexey@sevcom.net"><TT>mailto:alexey@sevcom.net</TT></A><BR>
- <A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3></TD></TR>
-</TABLE><DIV CLASS="center">
+</p><table class="title"><tr><td style="padding:1ex"><h1 class="titlemain">Ejabberd community 14.05-120-gedfb5fc Developers Guide</h1><h3 class="titlerest">Alexey Shchepin <br>
+ <a href="mailto:alexey@sevcom.net"><span style="font-family:monospace">mailto:alexey@sevcom.net</span></a> <br>
+ <a href="xmpp:aleksey@jabber.ru"><span style="font-family:monospace">xmpp:aleksey@jabber.ru</span></a></h3></td></tr>
+</table><div class="center">
-<IMG SRC="logo.png" ALT="logo.png">
+<img src="logo.png" alt="logo.png">
-</DIV><BLOCKQUOTE CLASS="quotation"><I>I can thoroughly recommend ejabberd for ease of setup –
-Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE><!--TOC section Contents-->
-<H2 CLASS="section"><!--SEC ANCHOR -->Contents</H2><!--SEC END --><UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc1">1  Key Features</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc2">2  Additional Features</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc3">3  How it Works</A>
-<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc4">3.1  Router</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc5">3.2  Local Router</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc6">3.3  Session Manager</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc7">3.4  S2S Manager</A>
-</LI></UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc8">4  Authentication</A>
-<UL CLASS="toc">
-<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc9">4.0.1  External</A>
-</LI></UL>
-</UL>
-</LI><LI CLASS="li-toc"><A HREF="#htoc10">5  XML Representation</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc11">6  Module <TT>xml</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc12">7  Module <TT>xml_stream</TT></A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc13">8  Modules</A>
-<UL CLASS="toc"><LI CLASS="li-toc">
-<A HREF="#htoc14">8.1  Module gen_iq_handler</A>
-</LI><LI CLASS="li-toc"><A HREF="#htoc15">8.2  Services</A>
-</LI></UL>
-</LI></UL><P>Introduction
-<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-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1">1</A>  Key Features</H2><!--SEC END --><P>
-<A NAME="keyfeatures"></A>
-</P><P><TT>ejabberd</TT> is:
-</P><UL CLASS="itemize"><LI CLASS="li-itemize">
-Cross-platform: <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</LI><LI CLASS="li-itemize">Distributed: You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.</LI><LI CLASS="li-itemize">Fault-tolerant: You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.</LI><LI CLASS="li-itemize">Administrator Friendly: <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+</div><blockquote class="quotation"><span style="font-style:italic">I can thoroughly recommend ejabberd for ease of setup –
+Kevin Smith, Current maintainer of the Psi project</span></blockquote><!--TOC section id="intro" Contents-->
+<h2 id="intro" class="section">Contents</h2><!--SEC END --><ul class="toc"><li class="li-toc">
+<a href="#sec2">1  Key Features</a>
+</li><li class="li-toc"><a href="#sec3">2  Additional Features</a>
+</li><li class="li-toc"><a href="#sec4">3  How it Works</a>
+<ul class="toc"><li class="li-toc">
+<a href="#sec5">3.1  Router</a>
+</li><li class="li-toc"><a href="#sec6">3.2  Local Router</a>
+</li><li class="li-toc"><a href="#sec7">3.3  Session Manager</a>
+</li><li class="li-toc"><a href="#sec8">3.4  S2S Manager</a>
+</li></ul>
+</li><li class="li-toc"><a href="#sec9">4  Authentication</a>
+<ul class="toc">
+<ul class="toc"><li class="li-toc">
+<a href="#sec10">4.0.1  External</a>
+</li></ul>
+</ul>
+</li><li class="li-toc"><a href="#sec11">5  XML Representation</a>
+</li><li class="li-toc"><a href="#sec12">6  Module <span style="font-family:monospace">xml</span></a>
+</li><li class="li-toc"><a href="#sec13">7  Module <span style="font-family:monospace">xml_stream</span></a>
+</li><li class="li-toc"><a href="#sec14">8  Modules</a>
+<ul class="toc"><li class="li-toc">
+<a href="#sec15">8.1  Module gen_iq_handler</a>
+</li><li class="li-toc"><a href="#sec16">8.2  Services</a>
+</li></ul>
+</li></ul><p>Introduction
+</p><p><span style="font-family:monospace">ejabberd</span> is a free and open source instant messaging server written in <a href="http://www.erlang.org/">Erlang/OTP</a>.</p><p><span style="font-family:monospace">ejabberd</span> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</p><p><span style="font-family:monospace">ejabberd</span> is designed to be a rock-solid and feature rich XMPP server.</p><p><span style="font-family:monospace">ejabberd</span> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.</p>
+<!--TOC section id="sec2" Key Features-->
+<h2 id="sec2" class="section">1  Key Features</h2><!--SEC END --><p>
+<a id="keyfeatures"></a>
+</p><p><span style="font-family:monospace">ejabberd</span> is:
+</p><ul class="itemize"><li class="li-itemize">
+Cross-platform: <span style="font-family:monospace">ejabberd</span> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</li><li class="li-itemize">Distributed: You can run <span style="font-family:monospace">ejabberd</span> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.</li><li class="li-itemize">Fault-tolerant: You can deploy an <span style="font-family:monospace">ejabberd</span> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.</li><li class="li-itemize">Administrator Friendly: <span style="font-family:monospace">ejabberd</span> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
+<ul class="itemize"><li class="li-itemize">
Comprehensive documentation.
-</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration.
-</LI><LI CLASS="li-itemize">Shared Roster Groups.
-</LI><LI CLASS="li-itemize">Command line administration tool. </LI><LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
-</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>.
-</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">
+</li><li class="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </li><li class="li-itemize">Web Administration.
+</li><li class="li-itemize">Shared Roster Groups.
+</li><li class="li-itemize">Command line administration tool. </li><li class="li-itemize">Can integrate with existing authentication mechanisms.
+</li><li class="li-itemize">Capability to send announce messages.
+</li></ul></li><li class="li-itemize">Internationalized: <span style="font-family:monospace">ejabberd</span> 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>.
+</li></ul></li><li class="li-itemize">Open Standards: <span style="font-family:monospace">ejabberd</span> 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.
-</LI><LI CLASS="li-itemize">XML-based protocol.
-</LI><LI CLASS="li-itemize"><A HREF="http://www.ejabberd.im/protocols">Many protocols supported</A>.
-</LI></UL></LI></UL><!--TOC section Additional Features-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2">2</A>  Additional Features</H2><!--SEC END --><P>
-<A NAME="addfeatures"></A>
-</P><P>Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
-</P><UL CLASS="itemize"><LI CLASS="li-itemize">
+</li><li class="li-itemize">XML-based protocol.
+</li><li class="li-itemize"><a href="http://www.ejabberd.im/protocols">Many protocols supported</a>.
+</li></ul></li></ul>
+<!--TOC section id="sec3" Additional Features-->
+<h2 id="sec3" class="section">2  Additional Features</h2><!--SEC END --><p>
+<a id="addfeatures"></a>
+</p><p>Moreover, <span style="font-family:monospace">ejabberd</span> comes with a wide range of other state-of-the-art features:
+</p><ul class="itemize"><li class="li-itemize">
Modular
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+<ul class="itemize"><li class="li-itemize">
Load only the modules you want.
-</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
-</LI></UL>
-</LI><LI CLASS="li-itemize">Security
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+</li><li class="li-itemize">Extend <span style="font-family:monospace">ejabberd</span> with your own custom modules.
+</li></ul>
+</li><li class="li-itemize">Security
+<ul class="itemize"><li class="li-itemize">
SASL and STARTTLS for c2s and s2s connections.
-</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
-</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access.
-</LI></UL>
-</LI><LI CLASS="li-itemize">Databases
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+</li><li class="li-itemize">STARTTLS and Dialback s2s connections.
+</li><li class="li-itemize">Web Admin accessible via HTTPS secure access.
+</li></ul>
+</li><li class="li-itemize">Databases
+<ul class="itemize"><li class="li-itemize">
Internal database for fast deployment (Mnesia).
-</LI><LI CLASS="li-itemize">Native MySQL support.
-</LI><LI CLASS="li-itemize">Native PostgreSQL support.
-</LI><LI CLASS="li-itemize">ODBC data storage support.
-</LI><LI CLASS="li-itemize">Microsoft SQL Server support. </LI></UL>
-</LI><LI CLASS="li-itemize">Authentication
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+</li><li class="li-itemize">Native MySQL support.
+</li><li class="li-itemize">Native PostgreSQL support.
+</li><li class="li-itemize">ODBC data storage support.
+</li><li class="li-itemize">Microsoft SQL Server support. </li><li class="li-itemize">Riak NoSQL database support.
+</li></ul>
+</li><li class="li-itemize">Authentication
+<ul class="itemize"><li class="li-itemize">
Internal Authentication.
-</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script.
-</LI></UL>
-</LI><LI CLASS="li-itemize">Others
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+</li><li class="li-itemize">PAM, LDAP, ODBC and Riak. </li><li class="li-itemize">External Authentication script.
+</li></ul>
+</li><li class="li-itemize">Others
+<ul class="itemize"><li class="li-itemize">
Support for virtual hosting.
-</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
-</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
-</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
-</LI><LI CLASS="li-itemize"><A HREF="http://www.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://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
-</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.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><!--TOC section How it Works-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc3">3</A>  How it Works</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
+</li><li class="li-itemize">Compressing XML streams with Stream Compression (<a href="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</a>).
+</li><li class="li-itemize">Statistics via Statistics Gathering (<a href="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</a>).
+</li><li class="li-itemize">IPv6 support both for c2s and s2s connections.
+</li><li class="li-itemize"><a href="http://www.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://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</a> component with support for <a href="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</a>.
+</li><li class="li-itemize">Support for web clients: <a href="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</a> and <a href="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</a> services.
+</li><li class="li-itemize">IRC transport.
+</li><li class="li-itemize">SIP support.
+</li><li class="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
+</li></ul>
+</li></ul>
+<!--TOC section id="sec4" How it Works-->
+<h2 id="sec4" class="section">3  How it Works</h2><!--SEC END --><p>
+<a id="howitworks"></a></p><p>A XMPP domain is served by one or more <span style="font-family:monospace">ejabberd</span> 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 have
the same magic cookie (see Erlang/OTP documentation, in other words the file
-<TT>~ejabberd/.erlang.cookie</TT> must be the same on all nodes). This is
+<span style="font-family:monospace">~ejabberd/.erlang.cookie</span> must be the same on all nodes). This is
needed because all nodes exchange information about connected users, S2S
-connections, registered services, etc…</P><P>Each <TT>ejabberd</TT> node have following modules:
-</P><UL CLASS="itemize"><LI CLASS="li-itemize">
+connections, registered services, etc…</p><p>Each <span style="font-family:monospace">ejabberd</span> node have following modules:
+</p><ul class="itemize"><li class="li-itemize">
router;
-</LI><LI CLASS="li-itemize">local router.
-</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="htoc4">3.1</A>  Router</H3><!--SEC END --><P>This module is the main router of XMPP packets on each node. It routes
+</li><li class="li-itemize">local router.
+</li><li class="li-itemize">session manager;
+</li><li class="li-itemize">S2S manager;
+</li></ul>
+<!--TOC subsection id="sec5" Router-->
+<h3 id="sec5" class="subsection">3.1  Router</h3><!--SEC END --><p>This module is the main router of XMPP packets on each node. It routes
them based on their destinations domains. It has two tables: local and global
routes. First, domain of packet destination searched in local table, and if it
found, then the packet is routed to appropriate process. If no, then it
-searches in global table, and is routed to the appropriate <TT>ejabberd</TT> node or
+searches in global table, and is routed to the appropriate <span style="font-family:monospace">ejabberd</span> node or
process. If it does not exists in either tables, then it sent to the S2S
-manager.</P><!--TOC subsection Local Router-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5">3.2</A>  Local Router</H3><!--SEC END --><P>This module routes packets which have a destination domain equal to this server
+manager.</p>
+<!--TOC subsection id="sec6" Local Router-->
+<h3 id="sec6" class="subsection">3.2  Local Router</h3><!--SEC END --><p>This module routes packets which have a destination domain equal to this server
name. If destination JID has a non-empty user part, then it routed to the
-session manager, else it is processed depending on it’s content.</P><!--TOC subsection Session Manager-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc6">3.3</A>  Session Manager</H3><!--SEC END --><P>This module routes packets to local users. It searches for what user resource
+session manager, else it is processed depending on it’s content.</p>
+<!--TOC subsection id="sec7" Session Manager-->
+<h3 id="sec7" class="subsection">3.3  Session Manager</h3><!--SEC END --><p>This module routes packets to local users. It searches for what user resource
packet must be sent via presence table. If this resource is connected to
this node, it is routed to C2S process, if it connected via another node, then
-the packet is sent to session manager on that node.</P><!--TOC subsection S2S Manager-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7">3.4</A>  S2S Manager</H3><!--SEC END --><P>This module routes packets to other XMPP servers. First, it checks if an
+the packet is sent to session manager on that node.</p>
+<!--TOC subsection id="sec8" S2S Manager-->
+<h3 id="sec8" class="subsection">3.4  S2S Manager</h3><!--SEC END --><p>This module routes packets to other XMPP servers. First, it checks if an
open S2S connection from the domain of the packet source to the domain of
packet destination already exists. If it is open on another node, then it
routes the packet to S2S manager on that node, if it is open on this node, then
it is routed to the process that serves this connection, and if a connection
-does not exist, then it is opened and registered.</P><!--TOC section Authentication-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8">4</A>  Authentication</H2><!--SEC END --><!--TOC subsubsection External-->
-<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc9">4.0.1</A>  External</H4><!--SEC END --><P>
-<A NAME="externalauth"></A>
-</P><P>The external authentication script follows
-<A HREF="http://www.erlang.org/doc/tutorial/c_portdriver.html">the erlang port driver API</A>.</P><P>That script is supposed to do theses actions, in an infinite loop:
-</P><UL CLASS="itemize"><LI CLASS="li-itemize">
+does not exist, then it is opened and registered.</p>
+<!--TOC section id="sec9" Authentication-->
+<h2 id="sec9" class="section">4  Authentication</h2><!--SEC END -->
+<!--TOC subsubsection id="sec10" External-->
+<h4 id="sec10" class="subsubsection">4.0.1  External</h4><!--SEC END --><p>
+<a id="externalauth"></a>
+</p><p>The external authentication script follows
+<a href="http://www.erlang.org/doc/tutorial/c_portdriver.html">the erlang port driver API</a>.</p><p>That script is supposed to do theses actions, in an infinite loop:
+</p><ul class="itemize"><li class="li-itemize">
read from stdin: AABBBBBBBBB.....
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+<ul class="itemize"><li class="li-itemize">
A: 2 bytes of length data (a short in network byte order)
-</LI><LI CLASS="li-itemize">B: a string of length found in A that contains operation in plain text
+</li><li class="li-itemize">B: a string of length found in A that contains operation in plain text
operation are as follows:
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+<ul class="itemize"><li class="li-itemize">
auth:User:Server:Password (check if a username/password pair is correct)
-</LI><LI CLASS="li-itemize">isuser:User:Server (check if it’s a valid user)
-</LI><LI CLASS="li-itemize">setpass:User:Server:Password (set user’s password)
-</LI><LI CLASS="li-itemize">tryregister:User:Server:Password (try to register an account)
-</LI><LI CLASS="li-itemize">removeuser:User:Server (remove this account)
-</LI><LI CLASS="li-itemize">removeuser3:User:Server:Password (remove this account if the password is correct)
-</LI></UL>
-</LI></UL>
-</LI><LI CLASS="li-itemize">write to stdout: AABB
-<UL CLASS="itemize"><LI CLASS="li-itemize">
+</li><li class="li-itemize">isuser:User:Server (check if it’s a valid user)
+</li><li class="li-itemize">setpass:User:Server:Password (set user’s password)
+</li><li class="li-itemize">tryregister:User:Server:Password (try to register an account)
+</li><li class="li-itemize">removeuser:User:Server (remove this account)
+</li><li class="li-itemize">removeuser3:User:Server:Password (remove this account if the password is correct)
+</li></ul>
+</li></ul>
+</li><li class="li-itemize">write to stdout: AABB
+<ul class="itemize"><li class="li-itemize">
A: the number 2 (coded as a short, which is bytes length of following result)
-</LI><LI CLASS="li-itemize">B: the result code (coded as a short), should be 1 for success/valid, or 0 for failure/invalid
-</LI></UL>
-</LI></UL><P>Example python script
-</P><PRE CLASS="verbatim">#!/usr/bin/python
+</li><li class="li-itemize">B: the result code (coded as a short), should be 1 for success/valid, or 0 for failure/invalid
+</li></ul>
+</li></ul><p>Example python script
+</p><pre class="verbatim">#!/usr/bin/python
import sys
from struct import *
elif data[0] == "setpass":
success = setpass(data[1], data[2], data[3])
to_ejabberd(success)
-</PRE><!--TOC section XML Representation-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc10">5</A>  XML Representation</H2><!--SEC END --><P>
-<A NAME="xmlrepr"></A></P><P>Each XML stanza is represented as the following tuple:
-</P><PRE CLASS="verbatim">XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
+</pre>
+<!--TOC section id="sec11" XML Representation-->
+<h2 id="sec11" class="section">5  XML Representation</h2><!--SEC END --><p>
+<a id="xmlrepr"></a></p><p>Each XML stanza is represented as the following tuple:
+</p><pre class="verbatim">XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
Name = string()
Attrs = [Attr]
Attr = {Key, Val}
Val = string()
ElementOrCDATA = XMLElement | CDATA
CDATA = {xmlcdata, string()}
-</PRE><P>E. g. this stanza:
-</P><PRE CLASS="verbatim"><message to='test@conference.example.org' type='groupchat'>
+</pre><p>E. g. this stanza:
+</p><pre class="verbatim"><message to='test@conference.example.org' type='groupchat'>
<body>test</body>
</message>
-</PRE><P>is represented as the following structure:
-</P><PRE CLASS="verbatim">{xmlelement, "message",
+</pre><p>is represented as the following structure:
+</p><pre class="verbatim">{xmlelement, "message",
[{"to", "test@conference.example.org"},
{"type", "groupchat"}],
[{xmlelement, "body",
[],
[{xmlcdata, "test"}]}]}}
-</PRE><!--TOC section Module <TT>xml</TT>-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc11">6</A>  Module <TT>xml</TT></H2><!--SEC END --><P>
-<A NAME="xmlmod"></A></P><DL CLASS="description"><DT CLASS="dt-description">
-</DT><DD CLASS="dd-description"><CODE>element_to_string(El) -> string()</CODE>
-<PRE CLASS="verbatim">El = XMLElement
-</PRE>Returns string representation of XML stanza <TT>El</TT>.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>crypt(S) -> string()</CODE>
-<PRE CLASS="verbatim">S = string()
-</PRE>Returns string which correspond to <TT>S</TT> with encoded XML special
-characters.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>remove_cdata(ECList) -> EList</CODE>
-<PRE CLASS="verbatim">ECList = [ElementOrCDATA]
+</pre>
+<!--TOC section id="sec12" Module <span style="font-family:monospace">xml</span>-->
+<h2 id="sec12" class="section">6  Module <span style="font-family:monospace">xml</span></h2><!--SEC END --><p>
+<a id="xmlmod"></a></p><dl class="description"><dt class="dt-description">
+</dt><dd class="dd-description"><code>element_to_string(El) -> string()</code>
+<pre class="verbatim">El = XMLElement
+</pre>Returns string representation of XML stanza <span style="font-family:monospace">El</span>.</dd><dt class="dt-description"></dt><dd class="dd-description"><code>crypt(S) -> string()</code>
+<pre class="verbatim">S = string()
+</pre>Returns string which correspond to <span style="font-family:monospace">S</span> with encoded XML special
+characters.</dd><dt class="dt-description"></dt><dd class="dd-description"><code>remove_cdata(ECList) -> EList</code>
+<pre class="verbatim">ECList = [ElementOrCDATA]
EList = [XMLElement]
-</PRE><TT>EList</TT> is a list of all non-CDATA elements of ECList.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>get_path_s(El, Path) -> Res</CODE>
-<PRE CLASS="verbatim">El = XMLElement
+</pre><span style="font-family:monospace">EList</span> is a list of all non-CDATA elements of ECList.</dd><dt class="dt-description"></dt><dd class="dd-description"><code>get_path_s(El, Path) -> Res</code>
+<pre class="verbatim">El = XMLElement
Path = [PathItem]
PathItem = PathElem | PathAttr | PathCDATA
PathElem = {elem, Name}
PathCDATA = cdata
Name = string()
Res = string() | XMLElement
-</PRE>If <TT>Path</TT> is empty, then returns <TT>El</TT>. Else sequentially
-consider elements of <TT>Path</TT>. Each element is one of:
-<DL CLASS="description"><DT CLASS="dt-description">
-</DT><DD CLASS="dd-description"><CODE>{elem, Name}</CODE> <TT>Name</TT> is name of subelement of
-<TT>El</TT>, if such element exists, then this element considered in
+</pre>If <span style="font-family:monospace">Path</span> is empty, then returns <span style="font-family:monospace">El</span>. Else sequentially
+consider elements of <span style="font-family:monospace">Path</span>. Each element is one of:
+<dl class="description"><dt class="dt-description">
+</dt><dd class="dd-description"><code>{elem, Name}</code> <span style="font-family:monospace">Name</span> is name of subelement of
+<span style="font-family:monospace">El</span>, if such element exists, then this element considered in
following steps, else returns empty string.
-</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>{attr, Name}</CODE> If <TT>El</TT> have attribute <TT>Name</TT>, then
+</dd><dt class="dt-description"></dt><dd class="dd-description"><code>{attr, Name}</code> If <span style="font-family:monospace">El</span> have attribute <span style="font-family:monospace">Name</span>, then
returns value of this attribute, else returns empty string.
-</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>cdata</CODE> Returns CDATA of <TT>El</TT>.
-</DD></DL></DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description">TODO:
-<PRE CLASS="verbatim"> get_cdata/1, get_tag_cdata/1
+</dd><dt class="dt-description"></dt><dd class="dd-description"><code>cdata</code> Returns CDATA of <span style="font-family:monospace">El</span>.
+</dd></dl></dd><dt class="dt-description"></dt><dd class="dd-description">TODO:
+<pre class="verbatim"> get_cdata/1, get_tag_cdata/1
get_attr/2, get_attr_s/2
get_tag_attr/2, get_tag_attr_s/2
get_subtag/2
-</PRE></DD></DL><!--TOC section Module <TT>xml_stream</TT>-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc12">7</A>  Module <TT>xml_stream</TT></H2><!--SEC END --><P>
-<A NAME="xmlstreammod"></A></P><DL CLASS="description"><DT CLASS="dt-description">
-</DT><DD CLASS="dd-description"><CODE>parse_element(Str) -> XMLElement | {error, Err}</CODE>
-<PRE CLASS="verbatim">Str = string()
+</pre></dd></dl>
+<!--TOC section id="sec13" Module <span style="font-family:monospace">xml_stream</span>-->
+<h2 id="sec13" class="section">7  Module <span style="font-family:monospace">xml_stream</span></h2><!--SEC END --><p>
+<a id="xmlstreammod"></a></p><dl class="description"><dt class="dt-description">
+</dt><dd class="dd-description"><code>parse_element(Str) -> XMLElement | {error, Err}</code>
+<pre class="verbatim">Str = string()
Err = term()
-</PRE>Parses <TT>Str</TT> using XML parser, returns either parsed element or error
+</pre>Parses <span style="font-family:monospace">Str</span> using XML parser, returns either parsed element or error
tuple.
-</DD></DL><!--TOC section Modules-->
-<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc13">8</A>  Modules</H2><!--SEC END --><P>
-<A NAME="emods"></A></P><!--TOC subsection Module gen_iq_handler-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc14">8.1</A>  Module gen_iq_handler</H3><!--SEC END --><P>
-<A NAME="geniqhandl"></A></P><P>The module <CODE>gen_iq_handler</CODE> allows to easily write handlers for IQ packets
-of particular XML namespaces that addressed to server or to users bare JIDs.</P><P>In this module the following functions are defined:
-</P><DL CLASS="description"><DT CLASS="dt-description">
-</DT><DD CLASS="dd-description"><CODE>add_iq_handler(Component, Host, NS, Module, Function, Type)</CODE>
-<PRE CLASS="verbatim">Component = Module = Function = atom()
+</dd></dl>
+<!--TOC section id="sec14" Modules-->
+<h2 id="sec14" class="section">8  Modules</h2><!--SEC END --><p>
+<a id="emods"></a></p>
+<!--TOC subsection id="sec15" Module gen_iq_handler-->
+<h3 id="sec15" class="subsection">8.1  Module gen_iq_handler</h3><!--SEC END --><p>
+<a id="geniqhandl"></a></p><p>The module <code>gen_iq_handler</code> allows to easily write handlers for IQ packets
+of particular XML namespaces that addressed to server or to users bare JIDs.</p><p>In this module the following functions are defined:
+</p><dl class="description"><dt class="dt-description">
+</dt><dd class="dd-description"><code>add_iq_handler(Component, Host, NS, Module, Function, Type)</code>
+<pre class="verbatim">Component = Module = Function = atom()
Host = NS = string()
Type = no_queue | one_queue | parallel
-</PRE>Registers function <CODE>Module:Function</CODE> as handler for IQ packets on
-virtual host <CODE>Host</CODE> that contain child of namespace <CODE>NS</CODE> in
-<CODE>Component</CODE>. Queueing discipline is <CODE>Type</CODE>. There are at least
+</pre>Registers function <code>Module:Function</code> as handler for IQ packets on
+virtual host <code>Host</code> that contain child of namespace <code>NS</code> in
+<code>Component</code>. Queueing discipline is <code>Type</code>. There are at least
two components defined:
-<DL CLASS="description"><DT CLASS="dt-description">
-</DT><DD CLASS="dd-description"><CODE>ejabberd_local</CODE> Handles packets that addressed to server JID;
-</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>ejabberd_sm</CODE> Handles packets that addressed to users bare JIDs.
-</DD></DL>
-</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>remove_iq_handler(Component, Host, NS)</CODE>
-<PRE CLASS="verbatim">Component = atom()
+<dl class="description"><dt class="dt-description">
+</dt><dd class="dd-description"><code>ejabberd_local</code> Handles packets that addressed to server JID;
+</dd><dt class="dt-description"></dt><dd class="dd-description"><code>ejabberd_sm</code> Handles packets that addressed to users bare JIDs.
+</dd></dl>
+</dd><dt class="dt-description"></dt><dd class="dd-description"><code>remove_iq_handler(Component, Host, NS)</code>
+<pre class="verbatim">Component = atom()
Host = NS = string()
-</PRE>Removes IQ handler on virtual host <CODE>Host</CODE> for namespace <CODE>NS</CODE> from
-<CODE>Component</CODE>.
-</DD></DL><P>Handler function must have the following type:
-</P><DL CLASS="description"><DT CLASS="dt-description">
-</DT><DD CLASS="dd-description"><CODE>Module:Function(From, To, IQ)</CODE>
-<PRE CLASS="verbatim">From = To = jid()
-</PRE></DD></DL><PRE CLASS="verbatim">-module(mod_cputime).
+</pre>Removes IQ handler on virtual host <code>Host</code> for namespace <code>NS</code> from
+<code>Component</code>.
+</dd></dl><p>Handler function must have the following type:
+</p><dl class="description"><dt class="dt-description">
+</dt><dd class="dd-description"><code>Module:Function(From, To, IQ)</code>
+<pre class="verbatim">From = To = jid()
+</pre></dd></dl><pre class="verbatim">-module(mod_cputime).
-behaviour(gen_mod).
[{"xmlns", ?NS_CPUTIME}],
[{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]}
end.
-</PRE><!--TOC subsection Services-->
-<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc15">8.2</A>  Services</H3><!--SEC END --><P>
-<A NAME="services"></A></P><PRE CLASS="verbatim">-module(mod_echo).
+</pre>
+<!--TOC subsection id="sec16" Services-->
+<h3 id="sec16" class="subsection">8.2  Services</h3><!--SEC END --><p>
+<a id="services"></a></p><pre class="verbatim">-module(mod_echo).
-behaviour(gen_mod).
Proc = gen_mod:get_module_proc(Host, ?PROCNAME),
Proc ! stop,
{wait, Proc}.
-</PRE><!--CUT END -->
+</pre><!--CUT END -->
<!--HTMLFOOT-->
<!--ENDHTML-->
<!--FOOTER-->
-<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
-</EM><A HREF="http://hevea.inria.fr/index.html"><EM>H</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>V</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY>
-</HTML>
+<hr style="height:2"><blockquote class="quote"><em>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
+</em><a href="http://hevea.inria.fr/index.html"><em>H</em><em><span style="font-size:small"><sup>E</sup></span></em><em>V</em><em><span style="font-size:small"><sup>E</sup></span></em><em>A</em></a><em>.</em></blockquote></body>
+</html>
- ejabberd community
+ ejabberd community 14.05-120-gedfb5fc
Installation and Operation Guide
<hr style="height:2"><br>
<br>
-<table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:right;white-space:nowrap" > <span style="font-size:xx-large"><span style="font-weight:bold">ejabberd community</span></span> </td></tr>
+<table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:right;white-space:nowrap" > <span style="font-size:xx-large"><span style="font-weight:bold">ejabberd community 14.05-120-gedfb5fc </span></span> </td></tr>
<tr><td style="text-align:right;white-space:nowrap" > </td></tr>
<tr><td style="text-align:right;white-space:nowrap" > <span style="font-size:xx-large">Installation and Operation Guide</span>
</td></tr>
<ul class="toc"><li class="li-toc">
<a href="#sec50">3.2.1  ODBC</a>
</li><li class="li-toc"><a href="#sec52">3.2.2  LDAP</a>
+</li><li class="li-toc"><a href="#sec58">3.2.3  Riak</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec58">3.3  Modules Configuration</a>
+</li><li class="li-toc"><a href="#sec62">3.3  Modules Configuration</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec59">3.3.1  Modules Overview</a>
-</li><li class="li-toc"><a href="#sec60">3.3.2  Common Options</a>
-</li><li class="li-toc"><a href="#sec63">3.3.3  <span style="font-family:monospace">mod_announce</span></a>
-</li><li class="li-toc"><a href="#sec64">3.3.4  <span style="font-family:monospace">mod_disco</span></a>
-</li><li class="li-toc"><a href="#sec65">3.3.5  <span style="font-family:monospace">mod_echo</span></a>
-</li><li class="li-toc"><a href="#sec66">3.3.6  <span style="font-family:monospace">mod_http_bind</span></a>
-</li><li class="li-toc"><a href="#sec67">3.3.7  <span style="font-family:monospace">mod_http_fileserver</span></a>
-</li><li class="li-toc"><a href="#sec68">3.3.8  <span style="font-family:monospace">mod_irc</span></a>
-</li><li class="li-toc"><a href="#sec69">3.3.9  <span style="font-family:monospace">mod_last</span></a>
-</li><li class="li-toc"><a href="#sec70">3.3.10  <span style="font-family:monospace">mod_muc</span></a>
-</li><li class="li-toc"><a href="#sec71">3.3.11  <span style="font-family:monospace">mod_muc_log</span></a>
-</li><li class="li-toc"><a href="#sec72">3.3.12  <span style="font-family:monospace">mod_offline</span></a>
-</li><li class="li-toc"><a href="#sec73">3.3.13  <span style="font-family:monospace">mod_ping</span></a>
-</li><li class="li-toc"><a href="#sec74">3.3.14  <span style="font-family:monospace">mod_pres_counter</span></a>
-</li><li class="li-toc"><a href="#sec75">3.3.15  <span style="font-family:monospace">mod_privacy</span></a>
-</li><li class="li-toc"><a href="#sec76">3.3.16  <span style="font-family:monospace">mod_private</span></a>
-</li><li class="li-toc"><a href="#sec77">3.3.17  <span style="font-family:monospace">mod_proxy65</span></a>
-</li><li class="li-toc"><a href="#sec78">3.3.18  <span style="font-family:monospace">mod_pubsub</span></a>
-</li><li class="li-toc"><a href="#sec79">3.3.19  <span style="font-family:monospace">mod_register</span></a>
-</li><li class="li-toc"><a href="#sec80">3.3.20  <span style="font-family:monospace">mod_register_web</span></a>
-</li><li class="li-toc"><a href="#sec81">3.3.21  <span style="font-family:monospace">mod_roster</span></a>
-</li><li class="li-toc"><a href="#sec82">3.3.22  <span style="font-family:monospace">mod_service_log</span></a>
-</li><li class="li-toc"><a href="#sec83">3.3.23  <span style="font-family:monospace">mod_shared_roster</span></a>
-</li><li class="li-toc"><a href="#sec84">3.3.24  <span style="font-family:monospace">mod_shared_roster_ldap</span></a>
-</li><li class="li-toc"><a href="#sec94">3.3.25  <span style="font-family:monospace">mod_sic</span></a>
-</li><li class="li-toc"><a href="#sec95">3.3.26  <span style="font-family:monospace">mod_sip</span></a>
-</li><li class="li-toc"><a href="#sec96">3.3.27  <span style="font-family:monospace">mod_stats</span></a>
-</li><li class="li-toc"><a href="#sec97">3.3.28  <span style="font-family:monospace">mod_time</span></a>
-</li><li class="li-toc"><a href="#sec98">3.3.29  <span style="font-family:monospace">mod_vcard</span></a>
-</li><li class="li-toc"><a href="#sec99">3.3.30  <span style="font-family:monospace">mod_vcard_ldap</span></a>
-</li><li class="li-toc"><a href="#sec100">3.3.31  <span style="font-family:monospace">mod_vcard_xupdate</span></a>
-</li><li class="li-toc"><a href="#sec101">3.3.32  <span style="font-family:monospace">mod_version</span></a>
+<a href="#sec63">3.3.1  Modules Overview</a>
+</li><li class="li-toc"><a href="#sec64">3.3.2  Common Options</a>
+</li><li class="li-toc"><a href="#sec67">3.3.3  <span style="font-family:monospace">mod_announce</span></a>
+</li><li class="li-toc"><a href="#sec68">3.3.4  <span style="font-family:monospace">mod_disco</span></a>
+</li><li class="li-toc"><a href="#sec69">3.3.5  <span style="font-family:monospace">mod_echo</span></a>
+</li><li class="li-toc"><a href="#sec70">3.3.6  <span style="font-family:monospace">mod_http_bind</span></a>
+</li><li class="li-toc"><a href="#sec71">3.3.7  <span style="font-family:monospace">mod_http_fileserver</span></a>
+</li><li class="li-toc"><a href="#sec72">3.3.8  <span style="font-family:monospace">mod_irc</span></a>
+</li><li class="li-toc"><a href="#sec73">3.3.9  <span style="font-family:monospace">mod_last</span></a>
+</li><li class="li-toc"><a href="#sec74">3.3.10  <span style="font-family:monospace">mod_muc</span></a>
+</li><li class="li-toc"><a href="#sec75">3.3.11  <span style="font-family:monospace">mod_muc_log</span></a>
+</li><li class="li-toc"><a href="#sec76">3.3.12  <span style="font-family:monospace">mod_offline</span></a>
+</li><li class="li-toc"><a href="#sec77">3.3.13  <span style="font-family:monospace">mod_ping</span></a>
+</li><li class="li-toc"><a href="#sec78">3.3.14  <span style="font-family:monospace">mod_pres_counter</span></a>
+</li><li class="li-toc"><a href="#sec79">3.3.15  <span style="font-family:monospace">mod_privacy</span></a>
+</li><li class="li-toc"><a href="#sec80">3.3.16  <span style="font-family:monospace">mod_private</span></a>
+</li><li class="li-toc"><a href="#sec81">3.3.17  <span style="font-family:monospace">mod_proxy65</span></a>
+</li><li class="li-toc"><a href="#sec82">3.3.18  <span style="font-family:monospace">mod_pubsub</span></a>
+</li><li class="li-toc"><a href="#sec83">3.3.19  <span style="font-family:monospace">mod_register</span></a>
+</li><li class="li-toc"><a href="#sec84">3.3.20  <span style="font-family:monospace">mod_register_web</span></a>
+</li><li class="li-toc"><a href="#sec85">3.3.21  <span style="font-family:monospace">mod_roster</span></a>
+</li><li class="li-toc"><a href="#sec86">3.3.22  <span style="font-family:monospace">mod_service_log</span></a>
+</li><li class="li-toc"><a href="#sec87">3.3.23  <span style="font-family:monospace">mod_shared_roster</span></a>
+</li><li class="li-toc"><a href="#sec88">3.3.24  <span style="font-family:monospace">mod_shared_roster_ldap</span></a>
+</li><li class="li-toc"><a href="#sec98">3.3.25  <span style="font-family:monospace">mod_sic</span></a>
+</li><li class="li-toc"><a href="#sec99">3.3.26  <span style="font-family:monospace">mod_sip</span></a>
+</li><li class="li-toc"><a href="#sec100">3.3.27  <span style="font-family:monospace">mod_stats</span></a>
+</li><li class="li-toc"><a href="#sec101">3.3.28  <span style="font-family:monospace">mod_time</span></a>
+</li><li class="li-toc"><a href="#sec102">3.3.29  <span style="font-family:monospace">mod_vcard</span></a>
+</li><li class="li-toc"><a href="#sec103">3.3.30  <span style="font-family:monospace">mod_vcard_ldap</span></a>
+</li><li class="li-toc"><a href="#sec104">3.3.31  <span style="font-family:monospace">mod_vcard_xupdate</span></a>
+</li><li class="li-toc"><a href="#sec105">3.3.32  <span style="font-family:monospace">mod_version</span></a>
</li></ul>
</li></ul>
-</li><li class="li-toc"><a href="#sec102">Chapter 4  Managing an <span style="font-family:monospace">ejabberd</span> Server</a>
+</li><li class="li-toc"><a href="#sec106">Chapter 4  Managing an <span style="font-family:monospace">ejabberd</span> Server</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec103">4.1  <span style="font-family:monospace">ejabberdctl</span></a>
+<a href="#sec107">4.1  <span style="font-family:monospace">ejabberdctl</span></a>
<ul class="toc"><li class="li-toc">
-<a href="#sec104">4.1.1  ejabberdctl Commands</a>
-</li><li class="li-toc"><a href="#sec105">4.1.2  Erlang Runtime System</a>
+<a href="#sec108">4.1.1  ejabberdctl Commands</a>
+</li><li class="li-toc"><a href="#sec109">4.1.2  Erlang Runtime System</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec106">4.2  <span style="font-family:monospace">ejabberd</span> Commands</a>
+</li><li class="li-toc"><a href="#sec110">4.2  <span style="font-family:monospace">ejabberd</span> Commands</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec107">4.2.1  List of ejabberd Commands</a>
-</li><li class="li-toc"><a href="#sec108">4.2.2  Restrict Execution with AccessCommands</a>
+<a href="#sec111">4.2.1  List of ejabberd Commands</a>
+</li><li class="li-toc"><a href="#sec112">4.2.2  Restrict Execution with AccessCommands</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec109">4.3  Web Admin</a>
-</li><li class="li-toc"><a href="#sec110">4.4  Ad-hoc Commands</a>
-</li><li class="li-toc"><a href="#sec111">4.5  Change Computer Hostname</a>
+</li><li class="li-toc"><a href="#sec113">4.3  Web Admin</a>
+</li><li class="li-toc"><a href="#sec114">4.4  Ad-hoc Commands</a>
+</li><li class="li-toc"><a href="#sec115">4.5  Change Computer Hostname</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec112">Chapter 5  Securing <span style="font-family:monospace">ejabberd</span></a>
+</li><li class="li-toc"><a href="#sec116">Chapter 5  Securing <span style="font-family:monospace">ejabberd</span></a>
<ul class="toc"><li class="li-toc">
-<a href="#sec113">5.1  Firewall Settings</a>
-</li><li class="li-toc"><a href="#sec114">5.2  epmd</a>
-</li><li class="li-toc"><a href="#sec115">5.3  Erlang Cookie</a>
-</li><li class="li-toc"><a href="#sec116">5.4  Erlang Node Name</a>
-</li><li class="li-toc"><a href="#sec117">5.5  Securing Sensitive Files</a>
+<a href="#sec117">5.1  Firewall Settings</a>
+</li><li class="li-toc"><a href="#sec118">5.2  epmd</a>
+</li><li class="li-toc"><a href="#sec119">5.3  Erlang Cookie</a>
+</li><li class="li-toc"><a href="#sec120">5.4  Erlang Node Name</a>
+</li><li class="li-toc"><a href="#sec121">5.5  Securing Sensitive Files</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec118">Chapter 6  Clustering</a>
+</li><li class="li-toc"><a href="#sec122">Chapter 6  Clustering</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec119">6.1  How it Works</a>
+<a href="#sec123">6.1  How it Works</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec120">6.1.1  Router</a>
-</li><li class="li-toc"><a href="#sec121">6.1.2  Local Router</a>
-</li><li class="li-toc"><a href="#sec122">6.1.3  Session Manager</a>
-</li><li class="li-toc"><a href="#sec123">6.1.4  s2s Manager</a>
+<a href="#sec124">6.1.1  Router</a>
+</li><li class="li-toc"><a href="#sec125">6.1.2  Local Router</a>
+</li><li class="li-toc"><a href="#sec126">6.1.3  Session Manager</a>
+</li><li class="li-toc"><a href="#sec127">6.1.4  s2s Manager</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec124">6.2  Clustering Setup</a>
-</li><li class="li-toc"><a href="#sec125">6.3  Service Load-Balancing</a>
+</li><li class="li-toc"><a href="#sec128">6.2  Clustering Setup</a>
+</li><li class="li-toc"><a href="#sec129">6.3  Service Load-Balancing</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec126">6.3.1  Domain Load-Balancing Algorithm</a>
-</li><li class="li-toc"><a href="#sec127">6.3.2  Load-Balancing Buckets</a>
+<a href="#sec130">6.3.1  Domain Load-Balancing Algorithm</a>
+</li><li class="li-toc"><a href="#sec131">6.3.2  Load-Balancing Buckets</a>
</li></ul>
</li></ul>
-</li><li class="li-toc"><a href="#sec128">Chapter 7  Debugging</a>
+</li><li class="li-toc"><a href="#sec132">Chapter 7  Debugging</a>
<ul class="toc"><li class="li-toc">
-<a href="#sec129">7.1  Log Files</a>
-</li><li class="li-toc"><a href="#sec130">7.2  Debug Console</a>
-</li><li class="li-toc"><a href="#sec131">7.3  Watchdog Alerts</a>
+<a href="#sec133">7.1  Log Files</a>
+</li><li class="li-toc"><a href="#sec134">7.2  Debug Console</a>
+</li><li class="li-toc"><a href="#sec135">7.3  Watchdog Alerts</a>
</li></ul>
-</li><li class="li-toc"><a href="#sec132">Appendix A  Internationalization and Localization</a>
-</li><li class="li-toc"><a href="#sec133">Appendix B  Release Notes</a>
-</li><li class="li-toc"><a href="#sec134">Appendix C  Acknowledgements</a>
-</li><li class="li-toc"><a href="#sec135">Appendix D  Copyright Information</a>
+</li><li class="li-toc"><a href="#sec136">Appendix A  Internationalization and Localization</a>
+</li><li class="li-toc"><a href="#sec137">Appendix B  Release Notes</a>
+</li><li class="li-toc"><a href="#sec138">Appendix C  Acknowledgements</a>
+</li><li class="li-toc"><a href="#sec139">Appendix D  Copyright Information</a>
</li></ul>
<!--TOC chapter id="sec2" Introduction-->
<h1 id="sec2" class="chapter">Chapter 1  Introduction</h1><!--SEC END --><p>
</li><li class="li-itemize">Native MySQL support.
</li><li class="li-itemize">Native PostgreSQL support.
</li><li class="li-itemize">ODBC data storage support.
-</li><li class="li-itemize">Microsoft SQL Server support. </li></ul>
+</li><li class="li-itemize">Microsoft SQL Server support. </li><li class="li-itemize">Riak NoSQL database support.
+</li></ul>
</li><li class="li-itemize">Authentication
<ul class="itemize"><li class="li-itemize">
Internal Authentication.
-</li><li class="li-itemize">PAM, LDAP and ODBC. </li><li class="li-itemize">External Authentication script.
+</li><li class="li-itemize">PAM, LDAP, ODBC and Riak. </li><li class="li-itemize">External Authentication script.
</li></ul>
</li><li class="li-itemize">Others
<ul class="itemize"><li class="li-itemize">
</li><li class="li-itemize">GCC
</li><li class="li-itemize">Libexpat 1.95 or higher
</li><li class="li-itemize">Erlang/OTP R15B or higher.
-</li><li class="li-itemize">Libyaml 1.4 or higher
+</li><li class="li-itemize">Libyaml 0.1.4 or higher
</li><li class="li-itemize">OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption.
</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">PAM library. Optional. For Pluggable Authentication Modules (PAM). See section <a href="#pam">3.1.5</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.9</a>.
-</li><li class="li-itemize">exmpp 0.9.6 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 id="download"></a> </p>
<!--TOC subsection id="sec11" Download Source Code-->
<h3 id="sec11" class="subsection">2.4.2  <a href="#download">Download Source Code</a></h3><!--SEC END --><p> <a id="download"></a>
Enable the use of development tools.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-mysql</span></span></dt><dd class="dd-description">
Enable MySQL support (see section <a href="#odbc">3.2.1</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-pgsql</span></span></dt><dd class="dd-description">
Enable PostgreSQL support (see section <a href="#odbc">3.2.1</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-zlib</span></span></dt><dd class="dd-description">
-Enable Stream Compression (XEP-0138) using zlib.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-stun</span></span></dt><dd class="dd-description">
-Enable STUN/TURN support (see section <a href="#stun">3.1.10</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-iconv</span></span></dt><dd class="dd-description">
+Enable Stream Compression (XEP-0138) using zlib.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-iconv</span></span></dt><dd class="dd-description">
Enable iconv support. This is needed for <span style="font-family:monospace">mod_irc</span> (see seciont <a href="#modirc">3.3.8</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-debug</span></span></dt><dd class="dd-description">
Compile with <span style="font-family:monospace">+debug_info</span> enabled.<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-full-xml</span></span></dt><dd class="dd-description">
Enable the use of XML based optimisations.
Options: <span style="font-family:monospace">access_commands</span>, <span style="font-family:monospace">maxsessions</span>, <span style="font-family:monospace">timeout</span>.<br>
You can find option explanations, example configuration in old and new format,
and example calls in several languages in the old
-<a href="https://raw.github.com/processone/ejabberd-contrib/master/ejabberd_xmlrpc/README.txt">ejabberd_xmlrpc README.txt</a>
+<a href="http://www.ejabberd.im/ejabberd_xmlrpc">ejabberd_xmlrpc documentation</a>.
</dd></dl><p> <a id="listened-options"></a> </p>
<!--TOC subsubsection id="sec30" Options-->
<h4 id="sec30" class="subsubsection"><a href="#listened-options">Options</a></h4><!--SEC END --><p> <a id="listened-options"></a> </p><p>This is a detailed description of each option allowed by the listening modules:
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ciphers: Ciphers</span></span></dt><dd class="dd-description"> OpenSSL ciphers list in the same format accepted by
‘<code>openssl ciphers</code>’ command.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">protocol_options: ProtocolOpts</span></span></dt><dd class="dd-description">
-List of general options relating to SSL/TLS. These map to <code><a href="https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html">OpenSSL's set_options()</a></code>.
-For a full list of options available in ejabberd, <code><a href="https://github.com/processone/tls/blob/master/c_src/options.h">see the source</a></code>.
+List of general options relating to SSL/TLS. These map to
+<a href="https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html">OpenSSL’s set_options()</a>.
+For a full list of options available in ejabberd,
+<a href="https://github.com/processone/tls/blob/master/c_src/options.h">see the source</a>.
The default entry is: <code>"no_sslv2"</code>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">default_host: undefined|HostName}</span></span></dt><dd class="dd-description">
If the HTTP request received by ejabberd contains the HTTP header <span style="font-family:monospace">Host</span>
</p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_ack_queue: Size</span></span></dt><dd class="dd-description">
This option specifies the maximum number of unacknowledged stanzas
queued for possible retransmission if <span style="font-family:monospace">stream_management</span> is
-enabled. When the limit is reached, the first stanza is dropped from
-the queue before adding the next one. This option can be specified
-for <span style="font-family:monospace">ejabberd_c2s</span> listeners. The allowed values are positive
-integers and <span style="font-family:monospace">infinity</span>. Default value: <span style="font-family:monospace">500</span>.
+enabled. When the limit is exceeded, the client session is
+terminated. This option can be specified for <span style="font-family:monospace">ejabberd_c2s</span>
+listeners. The allowed values are positive integers and
+<span style="font-family:monospace">infinity</span>. Default value: <span style="font-family:monospace">500</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_fsm_queue: Size</span></span></dt><dd class="dd-description">
This option specifies the maximum number of elements in the queue of the FSM
(Finite State Machine).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_ciphers: Ciphers</span></span></dt><dd class="dd-description"> OpenSSL ciphers list
in the same format accepted by ‘<code>openssl ciphers</code>’ command.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_protocol_options: ProtocolOpts</span></span></dt><dd class="dd-description">
-List of general options relating to SSL/TLS. These map to <code><a href="https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html">OpenSSL's set_options()</a></code>.
-For a full list of options available in ejabberd, <code><a href="https://github.com/processone/tls/blob/protocol_options/c_src/options.h">see the source</a></code>.
+List of general options relating to SSL/TLS. These map to
+<a href="https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html">OpenSSL’s set_options()</a>.
+For a full list of options available in ejabberd,
+<a href="https://github.com/processone/tls/blob/master/c_src/options.h">see the source</a>.
The default entry is: <code>"no_sslv2"</code>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">outgoing_s2s_families: [Family, ...]</span></span></dt><dd class="dd-description">
Specify which address families to try, in what order.
<h2 id="sec49" class="section">3.2  <a href="#database">Database and LDAP Configuration</a></h2><!--SEC END --><p> <a id="database"></a>
</p><p><span style="font-family:monospace">ejabberd</span> uses its internal Mnesia database by default. However, it is
-possible to use a relational database or an LDAP server to store persistent,
+possible to use a relational database, key-value storage or an LDAP server to store persistent,
long-living data. <span style="font-family:monospace">ejabberd</span> is very flexible: you can configure different
authentication methods for different virtual hosts, you can configure different
authentication mechanisms for the same virtual host (fallback), you can set
</li><li class="li-itemize"><a href="http://www.mysql.com/">MySQL</a>
</li><li class="li-itemize"><a href="http://en.wikipedia.org/wiki/Open_Database_Connectivity">Any ODBC compatible database</a>
</li><li class="li-itemize"><a href="http://www.postgresql.org/">PostgreSQL</a>
+</li><li class="li-itemize"><a href="http://basho.com/riak/">Riak</a>
</li></ul><p>The following LDAP servers are tested with <span style="font-family:monospace">ejabberd</span>:
</p><ul class="itemize"><li class="li-itemize">
<a href="http://www.microsoft.com/activedirectory/">Active Directory</a>
"Nickname": "NICKNAME"
"Email": "EMAIL"
...
-</pre><p> <a id="modules"></a> </p>
-<!--TOC section id="sec58" Modules Configuration-->
-<h2 id="sec58" class="section">3.3  <a href="#modules">Modules Configuration</a></h2><!--SEC END --><p> <a id="modules"></a>
+</pre><p> <a id="riak"></a> </p>
+<!--TOC subsection id="sec58" Riak-->
+<h3 id="sec58" class="subsection">3.2.3  <a href="#riak">Riak</a></h3><!--SEC END --><p> <a id="riak"></a>
+</p><p><a href="http://basho.com/riak/">Riak</a> is a distributed NoSQL key-value data store.
+The actual database access is defined in the options with <span style="font-family:monospace">riak_</span> prefix.</p><p> <a id="riakconnection"></a> </p>
+<!--TOC subsubsection id="sec59" Connection-->
+<h4 id="sec59" class="subsubsection"><a href="#riakconnection">Connection</a></h4><!--SEC END --><p> <a id="riakconnection"></a>
+</p><p>The following paramaters are available:
+</p><dl class="description"><dt class="dt-description">
+<span style="font-weight:bold"><span style="font-family:monospace">riak_server: String</span></span></dt><dd class="dd-description"> A hostname of the Riak server. The default is
+<span style="font-family:monospace">‘‘localhost’’</span>.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">riak_port: Port</span></span></dt><dd class="dd-description"> The port where the Riak server is accepting connections.
+The defalt is 8087.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">riak_pool_size: N</span></span></dt><dd class="dd-description"> By default <span style="font-family:monospace">ejabberd</span> opens 10 connections to
+the Riak server. You can change this number by using this option.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">riak_start_interval: N</span></span></dt><dd class="dd-description"> If the connection to the Riak server fails,
+<span style="font-family:monospace">ejabberd</span> waits 30 seconds before retrying.
+You can modify this interval with this option.
+</dd></dl><p>Example configuration:
+</p><pre class="verbatim">riak_server: "riak.server.com"
+riak_port: 9097
+</pre><p> <a id="riakstorage"></a> </p>
+<!--TOC subsubsection id="sec60" Storage-->
+<h4 id="sec60" class="subsubsection"><a href="#riakstorage">Storage</a></h4><!--SEC END --><p> <a id="riakstorage"></a>
+</p><p>Several <span style="font-family:monospace">ejabberd</span> modules can be used to store information in Riak database.
+Refer to the corresponding module documentation to see if it supports such
+ability. To enable storage to Riak database, just make
+sure that your database is running well (see the next section), and add the
+module option <span style="font-family:monospace">db_type: riak</span>.</p><p> <a id="riakconfiguration"></a> </p>
+<!--TOC subsubsection id="sec61" Riak Configuration-->
+<h4 id="sec61" class="subsubsection"><a href="#riakconfiguration">Riak Configuration</a></h4><!--SEC END --><p> <a id="riakconfiguration"></a>
+</p><p>First, you need to configure Riak to use
+<a href="http://en.wikipedia.org/wiki/LevelDB">LevelDB</a> as a database backend.</p><p>If you are using Riak 2.x and higher, configure <span style="font-family:monospace">storage_backend</span> option
+of <span style="font-family:monospace">/etc/riak/riak.conf</span> as follows:
+</p><pre class="verbatim">...
+storage_backend = leveldb
+...
+</pre><p>If you are using Riak 1.4.x and older, configure <span style="font-family:monospace">storage_backend</span> option
+of <span style="font-family:monospace">/etc/riak/app.config</span> in the section <span style="font-family:monospace">riak_kv</span> as follows:
+</p><pre class="verbatim">...
+ {riak_kv, [
+ ...
+ {storage_backend, riak_kv_eleveldb_backend},
+...
+</pre><p>Second, Riak should be pointed to <span style="font-family:monospace">ejabberd</span> Erlang binary files (*.beam).
+As described in <a href="#install">2.4.4</a>, by default those are located
+in <span style="font-family:monospace">/lib/ejabberd/ebin</span> directory. So you
+should add the following to <span style="font-family:monospace">/etc/riak/vm.args</span>:
+</p><pre class="verbatim">...
+## Path to ejabberd beams in order to make map/reduce
+-pz /lib/ejabberd/ebin
+...
+</pre><p>Important notice: make sure Riak has at least read access to that directory.
+Otherwise its startup will likely fail.</p><p> <a id="modules"></a> </p>
+<!--TOC section id="sec62" Modules Configuration-->
+<h2 id="sec62" class="section">3.3  <a href="#modules">Modules Configuration</a></h2><!--SEC END --><p> <a id="modules"></a>
</p><p>The option <span style="font-family:monospace">modules</span> defines the list of modules that will be loaded after
<span style="font-family:monospace">ejabberd</span>’s startup. Each entry in the list is a tuple in which the first
element is the name of a module and the second is a list of options for that
mod_time: {}
mod_version: {}
</pre></li></ul><p> <a id="modoverview"></a> </p>
-<!--TOC subsection id="sec59" Modules Overview-->
-<h3 id="sec
59" class="subsection">3.3.1  <a href="#modoverview">Modules Overview</a></h3><!--SEC END --><p> <a id="modoverview"></a>
+<!--TOC subsection id="sec63" Modules Overview-->
+<h3 id="sec
63" class="subsection">3.3.1  <a href="#modoverview">Modules Overview</a></h3><!--SEC END --><p> <a id="modoverview"></a>
</p><p>The following table lists all modules included in <span style="font-family:monospace">ejabberd</span>.</p><blockquote class="table"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<table border=1 style="border-spacing:0;" class="cellpadding1"><tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Module</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Feature</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Dependencies</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_adhoc</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Ad-Hoc Commands (<a href="http://xmpp.org/extensions/xep-0050.html">XEP-0050</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
</li></ul><p>You can see which database backend each module needs by looking at the suffix:
</p><ul class="itemize"><li class="li-itemize">
No suffix, this means that the module uses Erlang’s built-in database
-Mnesia as backend,
or a ODBC database in some cases (see <a href="#database">3.2</a>).
+Mnesia as backend,
Riak key-value store or ODBC database (see <a href="#database">3.2</a>).
</li><li class="li-itemize">‘_ldap’, this means that the module needs an LDAP server as backend.
</li></ul><p>You can find more
<a href="http://www.ejabberd.im/contributions">contributed modules</a> on the
<span style="font-family:monospace">ejabberd</span> website. Please remember that these contributions might not work or
that they can contain severe bugs and security leaks. Therefore, use them at
your own risk!</p><p> <a id="modcommonoptions"></a> </p>
-<!--TOC subsection id="sec60" Common Options-->
-<h3 id="sec6
0" class="subsection">3.3.2  <a href="#modcommonoptions">Common Options</a></h3><!--SEC END --><p> <a id="modcommonoptions"></a> </p><p>The following options are used by many modules. Therefore, they are described in
+<!--TOC subsection id="sec64" Common Options-->
+<h3 id="sec6
4" class="subsection">3.3.2  <a href="#modcommonoptions">Common Options</a></h3><!--SEC END --><p> <a id="modcommonoptions"></a> </p><p>The following options are used by many modules. Therefore, they are described in
this separate section.</p><p> <a id="modiqdiscoption"></a> </p>
-<!--TOC subsubsection id="sec61" <span style="font-family:monospace">iqdisc</span>-->
-<h4 id="sec6
1" class="subsubsection"><a href="#modiqdiscoption"><span style="font-family:monospace">iqdisc</span></a></h4><!--SEC END --><p> <a id="modiqdiscoption"></a>
+<!--TOC subsubsection id="sec65" <span style="font-family:monospace">iqdisc</span>-->
+<h4 id="sec6
5" class="subsubsection"><a href="#modiqdiscoption"><span style="font-family:monospace">iqdisc</span></a></h4><!--SEC END --><p> <a id="modiqdiscoption"></a>
</p><p>Many modules define handlers for processing IQ queries of different namespaces
to this server or to a user (e. g. to <span style="font-family:monospace">example.org</span> or to
<span style="font-family:monospace">user@example.org</span>). This option defines processing discipline for
iqdisc: no_queue
...
</pre><p> <a id="modhostoption"></a> </p>
-<!--TOC subsubsection id="sec62" <span style="font-family:monospace">host</span>-->
-<h4 id="sec6
2" class="subsubsection"><a href="#modhostoption"><span style="font-family:monospace">host</span></a></h4><!--SEC END --><p> <a id="modhostoption"></a>
+<!--TOC subsubsection id="sec66" <span style="font-family:monospace">host</span>-->
+<h4 id="sec6
6" class="subsubsection"><a href="#modhostoption"><span style="font-family:monospace">host</span></a></h4><!--SEC END --><p> <a id="modhostoption"></a>
</p><p>This option defines the Jabber ID of a service provided by an <span style="font-family:monospace">ejabberd</span> module.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt></dl><p>If you include the keyword "@HOST@" in the HostName,
it is replaced at start time with the real virtual host string.</p><p>This example configures
host: "mirror.@HOST@"
...
</pre><p> <a id="modannounce"></a> </p>
-<!--TOC subsection id="sec63" <span style="font-family:monospace">mod_announce</span>-->
-<h3 id="sec6
3" class="subsection">3.3.3  <a href="#modannounce"><span style="font-family:monospace">mod_announce</span></a></h3><!--SEC END --><p> <a id="modannounce"></a>
+<!--TOC subsection id="sec67" <span style="font-family:monospace">mod_announce</span>-->
+<h3 id="sec6
7" class="subsection">3.3.3  <a href="#modannounce"><span style="font-family:monospace">mod_announce</span></a></h3><!--SEC END --><p> <a id="modannounce"></a>
</p><p>This module enables configured users to broadcast announcements and to set
the message of the day (MOTD).
Configured users can perform these actions with a
</pre></li></ul><p>Note that <span style="font-family:monospace">mod_announce</span> can be resource intensive on large
deployments as it can broadcast lot of messages. This module should be
disabled for instances of <span style="font-family:monospace">ejabberd</span> with hundreds of thousands users.</p><p> <a id="moddisco"></a> </p>
-<!--TOC subsection id="sec64" <span style="font-family:monospace">mod_disco</span>-->
-<h3 id="sec6
4" class="subsection">3.3.4  <a href="#moddisco"><span style="font-family:monospace">mod_disco</span></a></h3><!--SEC END --><p> <a id="moddisco"></a>
+<!--TOC subsection id="sec68" <span style="font-family:monospace">mod_disco</span>-->
+<h3 id="sec6
8" class="subsection">3.3.4  <a href="#moddisco"><span style="font-family:monospace">mod_disco</span></a></h3><!--SEC END --><p> <a id="moddisco"></a>
- "xmpp:admins@shakespeare.lit"
...
</pre></li></ul><p> <a id="modecho"></a> </p>
-<!--TOC subsection id="sec65" <span style="font-family:monospace">mod_echo</span>-->
-<h3 id="sec6
5" class="subsection">3.3.5  <a href="#modecho"><span style="font-family:monospace">mod_echo</span></a></h3><!--SEC END --><p> <a id="modecho"></a>
+<!--TOC subsection id="sec69" <span style="font-family:monospace">mod_echo</span>-->
+<h3 id="sec6
9" class="subsection">3.3.5  <a href="#modecho"><span style="font-family:monospace">mod_echo</span></a></h3><!--SEC END --><p> <a id="modecho"></a>
</p><p>This module simply echoes any XMPP
packet back to the sender. This mirror can be of interest for
<span style="font-family:monospace">ejabberd</span> and XMPP client debugging.</p><p>Options:
host: "mirror.example.org"
...
</pre><p> <a id="modhttpbind"></a> </p>
-<!--TOC subsection id="sec66" <span style="font-family:monospace">mod_http_bind</span>-->
-<h3 id="sec
66" class="subsection">3.3.6  <a href="#modhttpbind"><span style="font-family:monospace">mod_http_bind</span></a></h3><!--SEC END --><p> <a id="modhttpbind"></a>
+<!--TOC subsection id="sec70" <span style="font-family:monospace">mod_http_bind</span>-->
+<h3 id="sec
70" class="subsection">3.3.6  <a href="#modhttpbind"><span style="font-family:monospace">mod_http_bind</span></a></h3><!--SEC END --><p> <a id="modhttpbind"></a>
</p><p>This module implements XMPP over Bosh (formerly known as HTTP Binding)
as defined in <a href="http://xmpp.org/extensions/xep-0124.html">XEP-0124</a> and <a href="http://xmpp.org/extensions/xep-0206.html">XEP-0206</a>.
It extends ejabberd’s built in HTTP service with a configurable
max_inactivity: 50
...
</pre></dd></dl><p> <a id="modhttpfileserver"></a> </p>
-<!--TOC subsection id="sec67" <span style="font-family:monospace">mod_http_fileserver</span>-->
-<h3 id="sec
67" class="subsection">3.3.7  <a href="#modhttpfileserver"><span style="font-family:monospace">mod_http_fileserver</span></a></h3><!--SEC END --><p> <a id="modhttpfileserver"></a>
+<!--TOC subsection id="sec71" <span style="font-family:monospace">mod_http_fileserver</span>-->
+<h3 id="sec
71" class="subsection">3.3.7  <a href="#modhttpfileserver"><span style="font-family:monospace">mod_http_fileserver</span></a></h3><!--SEC END --><p> <a id="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">
<span style="font-weight:bold"><span style="font-family:monospace">docroot: Path</span></span></dt><dd class="dd-description">
...
...
</pre><p> <a id="modirc"></a> </p>
-<!--TOC subsection id="sec68" <span style="font-family:monospace">mod_irc</span>-->
-<h3 id="sec
68" class="subsection">3.3.8  <a href="#modirc"><span style="font-family:monospace">mod_irc</span></a></h3><!--SEC END --><p> <a id="modirc"></a>
+<!--TOC subsection id="sec72" <span style="font-family:monospace">mod_irc</span>-->
+<h3 id="sec
72" class="subsection">3.3.8  <a href="#modirc"><span style="font-family:monospace">mod_irc</span></a></h3><!--SEC END --><p> <a id="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:
host: "irc.example.net"
...
</pre></li></ul><p> <a id="modlast"></a> </p>
-<!--TOC subsection id="sec69" <span style="font-family:monospace">mod_last</span>-->
-<h3 id="sec
69" class="subsection">3.3.9  <a href="#modlast"><span style="font-family:monospace">mod_last</span></a></h3><!--SEC END --><p> <a id="modlast"></a>
+<!--TOC subsection id="sec73" <span style="font-family:monospace">mod_last</span>-->
+<h3 id="sec
73" class="subsection">3.3.9  <a href="#modlast"><span style="font-family:monospace">mod_last</span></a></h3><!--SEC END --><p> <a id="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
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modmuc"></a> </p>
-<!--TOC subsection id="sec70" <span style="font-family:monospace">mod_muc</span>-->
-<h3 id="sec7
0" class="subsection">3.3.10  <a href="#modmuc"><span style="font-family:monospace">mod_muc</span></a></h3><!--SEC END --><p> <a id="modmuc"></a>
+<!--TOC subsection id="sec74" <span style="font-family:monospace">mod_muc</span>-->
+<h3 id="sec7
4" class="subsection">3.3.10  <a href="#modmuc"><span style="font-family:monospace">mod_muc</span></a></h3><!--SEC END --><p> <a id="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:
access_admin: muc_admin
...
</pre></li></ul><p> <a id="modmuclog"></a> </p>
-<!--TOC subsection id="sec71" <span style="font-family:monospace">mod_muc_log</span>-->
-<h3 id="sec7
1" class="subsection">3.3.11  <a href="#modmuclog"><span style="font-family:monospace">mod_muc_log</span></a></h3><!--SEC END --><p> <a id="modmuclog"></a>
+<!--TOC subsection id="sec75" <span style="font-family:monospace">mod_muc_log</span>-->
+<h3 id="sec7
5" class="subsection">3.3.11  <a href="#modmuclog"><span style="font-family:monospace">mod_muc_log</span></a></h3><!--SEC END --><p> <a id="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
timezone: local
...
</pre></li></ul><p> <a id="modoffline"></a> </p>
-<!--TOC subsection id="sec72" <span style="font-family:monospace">mod_offline</span>-->
-<h3 id="sec7
2" class="subsection">3.3.12  <a href="#modoffline"><span style="font-family:monospace">mod_offline</span></a></h3><!--SEC END --><p> <a id="modoffline"></a>
+<!--TOC subsection id="sec76" <span style="font-family:monospace">mod_offline</span>-->
+<h3 id="sec7
6" class="subsection">3.3.12  <a href="#modoffline"><span style="font-family:monospace">mod_offline</span></a></h3><!--SEC END --><p> <a id="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
access_max_user_messages: max_user_offline_messages
...
</pre><p> <a id="modping"></a> </p>
-<!--TOC subsection id="sec73" <span style="font-family:monospace">mod_ping</span>-->
-<h3 id="sec7
3" class="subsection">3.3.13  <a href="#modping"><span style="font-family:monospace">mod_ping</span></a></h3><!--SEC END --><p> <a id="modping"></a>
+<!--TOC subsection id="sec77" <span style="font-family:monospace">mod_ping</span>-->
+<h3 id="sec7
7" class="subsection">3.3.13  <a href="#modping"><span style="font-family:monospace">mod_ping</span></a></h3><!--SEC END --><p> <a id="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:
timeout_action: kill
...
</pre><p> <a id="modprescounter"></a> </p>
-<!--TOC subsection id="sec74" <span style="font-family:monospace">mod_pres_counter</span>-->
-<h3 id="sec7
4" class="subsection">3.3.14  <a href="#modprescounter"><span style="font-family:monospace">mod_pres_counter</span></a></h3><!--SEC END --><p> <a id="modprescounter"></a>
+<!--TOC subsection id="sec78" <span style="font-family:monospace">mod_pres_counter</span>-->
+<h3 id="sec7
8" class="subsection">3.3.14  <a href="#modprescounter"><span style="font-family:monospace">mod_pres_counter</span></a></h3><!--SEC END --><p> <a id="modprescounter"></a>
</p><p>This module detects flood/spam in presence subscription stanza traffic.
If a user sends or receives more of those stanzas in a time interval,
the exceeding stanzas are silently dropped, and warning is logged.</p><p>Configuration options:
interval: 60
...
</pre><p> <a id="modprivacy"></a> </p>
-<!--TOC subsection id="sec75" <span style="font-family:monospace">mod_privacy</span>-->
-<h3 id="sec7
5" class="subsection">3.3.15  <a href="#modprivacy"><span style="font-family:monospace">mod_privacy</span></a></h3><!--SEC END --><p> <a id="modprivacy"></a>
+<!--TOC subsection id="sec79" <span style="font-family:monospace">mod_privacy</span>-->
+<h3 id="sec7
9" class="subsection">3.3.15  <a href="#modprivacy"><span style="font-family:monospace">mod_privacy</span></a></h3><!--SEC END --><p> <a id="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:
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modprivate"></a> </p>
-<!--TOC subsection id="sec76" <span style="font-family:monospace">mod_private</span>-->
-<h3 id="sec
76" class="subsection">3.3.16  <a href="#modprivate"><span style="font-family:monospace">mod_private</span></a></h3><!--SEC END --><p> <a id="modprivate"></a>
+<!--TOC subsection id="sec80" <span style="font-family:monospace">mod_private</span>-->
+<h3 id="sec
80" class="subsection">3.3.16  <a href="#modprivate"><span style="font-family:monospace">mod_private</span></a></h3><!--SEC END --><p> <a id="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
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modproxy"></a> </p>
-<!--TOC subsection id="sec77" <span style="font-family:monospace">mod_proxy65</span>-->
-<h3 id="sec
77" class="subsection">3.3.17  <a href="#modproxy"><span style="font-family:monospace">mod_proxy65</span></a></h3><!--SEC END --><p> <a id="modproxy"></a>
+<!--TOC subsection id="sec81" <span style="font-family:monospace">mod_proxy65</span>-->
+<h3 id="sec
81" class="subsection">3.3.17  <a href="#modproxy"><span style="font-family:monospace">mod_proxy65</span></a></h3><!--SEC END --><p> <a id="modproxy"></a>
</p><p>This module implements SOCKS5 Bytestreams (<a href="http://xmpp.org/extensions/xep-0065.html">XEP-0065</a>).
It allows <span style="font-family:monospace">ejabberd</span> to act as a file transfer proxy between two
XMPP clients.</p><p>Options:
shaper: proxy65_shaper
...
</pre></li></ul><p> <a id="modpubsub"></a> </p>
-<!--TOC subsection id="sec78" <span style="font-family:monospace">mod_pubsub</span>-->
-<h3 id="sec
78" class="subsection">3.3.18  <a href="#modpubsub"><span style="font-family:monospace">mod_pubsub</span></a></h3><!--SEC END --><p> <a id="modpubsub"></a>
+<!--TOC subsection id="sec82" <span style="font-family:monospace">mod_pubsub</span>-->
+<h3 id="sec
82" class="subsection">3.3.18  <a href="#modpubsub"><span style="font-family:monospace">mod_pubsub</span></a></h3><!--SEC END --><p> <a id="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 <span style="font-family:monospace">mod_pubsub</span> 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>)
- "pep"
...
</pre><p> <a id="modregister"></a> </p>
-<!--TOC subsection id="sec79" <span style="font-family:monospace">mod_register</span>-->
-<h3 id="sec
79" class="subsection">3.3.19  <a href="#modregister"><span style="font-family:monospace">mod_register</span></a></h3><!--SEC END --><p> <a id="modregister"></a>
+<!--TOC subsection id="sec83" <span style="font-family:monospace">mod_register</span>-->
+<h3 id="sec
83" class="subsection">3.3.19  <a href="#modregister"><span style="font-family:monospace">mod_register</span></a></h3><!--SEC END --><p> <a id="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">
- "boss@example.net"
...
</pre></li></ul><p> <a id="modregisterweb"></a> </p>
-<!--TOC subsection id="sec80" <span style="font-family:monospace">mod_register_web</span>-->
-<h3 id="sec8
0" class="subsection">3.3.20  <a href="#modregisterweb"><span style="font-family:monospace">mod_register_web</span></a></h3><!--SEC END --><p> <a id="modregisterweb"></a>
+<!--TOC subsection id="sec84" <span style="font-family:monospace">mod_register_web</span>-->
+<h3 id="sec8
4" class="subsection">3.3.20  <a href="#modregisterweb"><span style="font-family:monospace">mod_register_web</span></a></h3><!--SEC END --><p> <a id="modregisterweb"></a>
</p><p>This module provides a web page where people can:
</p><ul class="itemize"><li class="li-itemize">
Register a new account on the server.
<span style="font-family:monospace">https://example.org:5281/register/</span>
It is important to include the last / character in the URL,
otherwise the subpages URL will be incorrect.</p><p> <a id="modroster"></a> </p>
-<!--TOC subsection id="sec81" <span style="font-family:monospace">mod_roster</span>-->
-<h3 id="sec8
1" class="subsection">3.3.21  <a href="#modroster"><span style="font-family:monospace">mod_roster</span></a></h3><!--SEC END --><p> <a id="modroster"></a>
+<!--TOC subsection id="sec85" <span style="font-family:monospace">mod_roster</span>-->
+<h3 id="sec8
5" class="subsection">3.3.21  <a href="#modroster"><span style="font-family:monospace">mod_roster</span></a></h3><!--SEC END --><p> <a id="modroster"></a>
</p><p>This module implements roster management as defined in
<a href="http://xmpp.org/rfcs/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:
access: roster
...
</pre><p> <a id="modservicelog"></a> </p>
-<!--TOC subsection id="sec82" <span style="font-family:monospace">mod_service_log</span>-->
-<h3 id="sec8
2" class="subsection">3.3.22  <a href="#modservicelog"><span style="font-family:monospace">mod_service_log</span></a></h3><!--SEC END --><p> <a id="modservicelog"></a>
+<!--TOC subsection id="sec86" <span style="font-family:monospace">mod_service_log</span>-->
+<h3 id="sec8
6" class="subsection">3.3.22  <a href="#modservicelog"><span style="font-family:monospace">mod_service_log</span></a></h3><!--SEC END --><p> <a id="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
- "bandersnatch.example.org"
...
</pre></li></ul><p> <a id="modsharedroster"></a> </p>
-<!--TOC subsection id="sec83" <span style="font-family:monospace">mod_shared_roster</span>-->
-<h3 id="sec8
3" class="subsection">3.3.23  <a href="#modsharedroster"><span style="font-family:monospace">mod_shared_roster</span></a></h3><!--SEC END --><p> <a id="modsharedroster"></a>
+<!--TOC subsection id="sec87" <span style="font-family:monospace">mod_shared_roster</span>-->
+<h3 id="sec8
7" class="subsection">3.3.23  <a href="#modsharedroster"><span style="font-family:monospace">mod_shared_roster</span></a></h3><!--SEC END --><p> <a id="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
</table>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote>
</li></ul><p> <a id="modsharedrosterldap"></a> </p>
-<!--TOC subsection id="sec84" <span style="font-family:monospace">mod_shared_roster_ldap</span>-->
-<h3 id="sec8
4" class="subsection">3.3.24  <a href="#modsharedrosterldap"><span style="font-family:monospace">mod_shared_roster_ldap</span></a></h3><!--SEC END --><p> <a id="modsharedrosterldap"></a>
+<!--TOC subsection id="sec88" <span style="font-family:monospace">mod_shared_roster_ldap</span>-->
+<h3 id="sec8
8" class="subsection">3.3.24  <a href="#modsharedrosterldap"><span style="font-family:monospace">mod_shared_roster_ldap</span></a></h3><!--SEC END --><p> <a id="modsharedrosterldap"></a>
</p><p>This module lets the server administrator
automatically populate users’ rosters (contact lists) with entries based on
users and groups defined in an LDAP-based directory.</p><p> <a id="msrlconfigparams"></a> </p>
-<!--TOC subsubsection id="sec85" Configuration parameters-->
-<h4 id="sec8
5" class="subsubsection"><a href="#msrlconfigparams">Configuration parameters</a></h4><!--SEC END --><p> <a id="msrlconfigparams"></a> </p><p>The module accepts the following configuration parameters. Some of them, if
+<!--TOC subsubsection id="sec89" Configuration parameters-->
+<h4 id="sec8
9" class="subsubsection"><a href="#msrlconfigparams">Configuration parameters</a></h4><!--SEC END --><p> <a id="msrlconfigparams"></a> </p><p>The module accepts the following configuration parameters. Some of them, if
unspecified, default to the values specified for the top level of
configuration. This lets you avoid specifying, for example, the bind password,
in multiple places.</p><p> <a id="msrlfilters"></a> </p>
-<!--TOC paragraph id="sec86" Filters-->
-<h5 id="sec
86" class="paragraph"><a href="#msrlfilters">Filters</a></h5><!--SEC END --><p> <a id="msrlfilters"></a> </p><p>These parameters specify LDAP filters used to query for shared roster information.
+<!--TOC paragraph id="sec90" Filters-->
+<h5 id="sec
90" class="paragraph"><a href="#msrlfilters">Filters</a></h5><!--SEC END --><p> <a id="msrlfilters"></a> </p><p>These parameters specify LDAP filters used to query for shared roster information.
All of them are run against the <code>ldap_base</code>.</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_rfilter</span></span></dt><dd class="dd-description">
So called “Roster Filter”. Used to find names of all “shared roster” groups.
See also the <code>ldap_groupattr</code> parameter.
</p><pre class="verbatim">get_filter: unknown filter type=130
filter="(&(?=undefined)(?=undefined)(something=else))"
</pre><p> <a id="msrlattrs"></a> </p>
-<!--TOC subsubsection id="sec87" Attributes-->
-<h4 id="sec
87" class="subsubsection"><a href="#msrlattrs">Attributes</a></h4><!--SEC END --><p> <a id="msrlattrs"></a> </p><p>These parameters specify the names of the attributes which hold interesting data
+<!--TOC subsubsection id="sec91" Attributes-->
+<h4 id="sec
91" class="subsubsection"><a href="#msrlattrs">Attributes</a></h4><!--SEC END --><p> <a id="msrlattrs"></a> </p><p>These parameters specify the names of the attributes which hold interesting data
in the entries returned by running filters specified in
section <a href="#msrlfilters">3.3.24</a>.</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ldap_groupattr</span></span></dt><dd class="dd-description">
Retrieved from results of the “User Filter”.
Defaults to <span style="font-family:monospace">cn</span>.
</dd></dl><p> <a id="msrlcontrolparams"></a> </p>
-<!--TOC subsubsection id="sec88" Control parameters-->
-<h4 id="sec
88" class="subsubsection"><a href="#msrlcontrolparams">Control parameters</a></h4><!--SEC END --><p> <a id="msrlcontrolparams"></a> </p><p>These paramters control the behaviour of the module.</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_memberattr_format</span></span></dt><dd class="dd-description">
+<!--TOC subsubsection id="sec92" Control parameters-->
+<h4 id="sec
92" class="subsubsection"><a href="#msrlcontrolparams">Control parameters</a></h4><!--SEC END --><p> <a id="msrlcontrolparams"></a> </p><p>These paramters control the behaviour of the module.</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_memberattr_format</span></span></dt><dd class="dd-description">
A globbing format for extracting user ID from the value of the attribute named by
<code>ldap_memberattr</code>.
Defaults to <span style="font-family:monospace">%u</span>, which means that the whole value is the member ID. If
fresh after retrieval. 300 by default. See section <a href="#msrlconfigroster">3.3.24</a> on
how it is used during roster retrieval.
</dd></dl><p> <a id="msrlconnparams"></a> </p>
-<!--TOC subsubsection id="sec89" Connection parameters-->
-<h4 id="sec
89" class="subsubsection"><a href="#msrlconnparams">Connection parameters</a></h4><!--SEC END --><p> <a id="msrlconnparams"></a> </p><p>The module also accepts the connection parameters, all of which default to the
+<!--TOC subsubsection id="sec93" Connection parameters-->
+<h4 id="sec
93" class="subsubsection"><a href="#msrlconnparams">Connection parameters</a></h4><!--SEC END --><p> <a id="msrlconnparams"></a> </p><p>The module also accepts the connection parameters, all of which default to the
top-level parameter of the same name, if unspecified. See <a href="#ldapconnection">3.2.2</a>
for more information about them.</p><p> <a id="msrlconfigroster"></a> </p>
-<!--TOC subsubsection id="sec90" Retrieving the roster-->
-<h4 id="sec9
0" class="subsubsection"><a href="#msrlconfigroster">Retrieving the roster</a></h4><!--SEC END --><p> <a id="msrlconfigroster"></a> </p><p>When the module is called to retrieve the shared roster for a user, the
+<!--TOC subsubsection id="sec94" Retrieving the roster-->
+<h4 id="sec9
4" class="subsubsection"><a href="#msrlconfigroster">Retrieving the roster</a></h4><!--SEC END --><p> <a id="msrlconfigroster"></a> </p><p>When the module is called to retrieve the shared roster for a user, the
following algorithm is used:</p><ol class="enumerate" type=1><li class="li-enumerate">
<a id="step:rfilter"></a> A list of names of groups to display is created: the <span style="font-family:monospace">Roster Filter</span>
is run against the base DN, retrieving the values of the attribute named by
user name cache.
</li></ol>
</li></ol></li></ol></li></ol><p> <a id="msrlconfigexample"></a> </p>
-<!--TOC subsubsection id="sec91" Configuration examples-->
-<h4 id="sec9
1" class="subsubsection"><a href="#msrlconfigexample">Configuration examples</a></h4><!--SEC END --><p> <a id="msrlconfigexample"></a> </p><p>Since there are many possible
+<!--TOC subsubsection id="sec95" Configuration examples-->
+<h4 id="sec9
5" class="subsubsection"><a href="#msrlconfigexample">Configuration examples</a></h4><!--SEC END --><p> <a id="msrlconfigexample"></a> </p><p>Since there are many possible
<a href="http://en.wikipedia.org/wiki/Directory_Information_Tree">DIT</a>
layouts, it will probably be easiest to understand how to configure the module
by looking at an example for a given DIT (or one resembling it).</p><p> <a id="msrlconfigexampleflat"></a> </p>
-<!--TOC paragraph id="sec92" Flat DIT-->
-<h5 id="sec9
2" class="paragraph"><a href="#msrlconfigexampleflat">Flat DIT</a></h5><!--SEC END --><p> <a id="msrlconfigexampleflat"></a> </p><p>This seems to be the kind of DIT for which this module was initially designed.
+<!--TOC paragraph id="sec96" Flat DIT-->
+<h5 id="sec9
6" class="paragraph"><a href="#msrlconfigexampleflat">Flat DIT</a></h5><!--SEC END --><p> <a id="msrlconfigexampleflat"></a> </p><p>This seems to be the kind of DIT for which this module was initially designed.
Basically there are just user objects, and group membership is stored in an
attribute individually for each user. For example in a layout shown in
figure <a href="#fig%3Amsrl-dit-flat">3.1</a>, the group of each user is stored in its <span style="font-family:monospace">ou</span> attribute.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
</table></div>
<a id="fig:msrl-roster-flat"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="msrlconfigexampledeep"></a> </p>
-<!--TOC paragraph id="sec93" Deep DIT-->
-<h5 id="sec9
3" class="paragraph"><a href="#msrlconfigexampledeep">Deep DIT</a></h5><!--SEC END --><p> <a id="msrlconfigexampledeep"></a> </p><p>This type of DIT contains distinctly typed objects for users and groups – see figure <a href="#fig%3Amsrl-dit-deep">3.3</a>.
+<!--TOC paragraph id="sec97" Deep DIT-->
+<h5 id="sec9
7" class="paragraph"><a href="#msrlconfigexampledeep">Deep DIT</a></h5><!--SEC END --><p> <a id="msrlconfigexampledeep"></a> </p><p>This type of DIT contains distinctly typed objects for users and groups – see figure <a href="#fig%3Amsrl-dit-deep">3.3</a>.
They are shown separated into different subtrees, but it’s not a requirement.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="msrl-dit-deep.png" alt="msrl-dit-deep.png">
</table></div>
<a id="fig:msrl-roster-deep"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="modsic"></a> </p>
-<!--TOC subsection id="sec94" <span style="font-family:monospace">mod_sic</span>-->
-<h3 id="sec9
4" class="subsection">3.3.25  <a href="#modsic"><span style="font-family:monospace">mod_sic</span></a></h3><!--SEC END --><p> <a id="modsic"></a>
+<!--TOC subsection id="sec98" <span style="font-family:monospace">mod_sic</span>-->
+<h3 id="sec9
8" class="subsection">3.3.25  <a href="#modsic"><span style="font-family:monospace">mod_sic</span></a></h3><!--SEC END --><p> <a id="modsic"></a>
</p><p>This module adds support for Server IP Check (<a href="http://xmpp.org/extensions/xep-0279.html">XEP-0279</a>). This protocol
enables a client to discover its external IP address.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for <span style="font-family:monospace">urn:xmpp:sic:0</span> IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p> <a id="modsip"></a> </p>
-<!--TOC subsection id="sec95" <span style="font-family:monospace">mod_sip</span>-->
-<h3 id="sec9
5" class="subsection">3.3.26  <a href="#modsip"><span style="font-family:monospace">mod_sip</span></a></h3><!--SEC END --><p> <a id="modsip"></a>
+<!--TOC subsection id="sec99" <span style="font-family:monospace">mod_sip</span>-->
+<h3 id="sec9
9" class="subsection">3.3.26  <a href="#modsip"><span style="font-family:monospace">mod_sip</span></a></h3><!--SEC END --><p> <a id="modsip"></a>
This module adds SIP proxy/registrar support for the corresponding virtual host.
Note that it is not enough to just load this module only. You should also configure
...
</pre><p>Options:
</p><dl class="description"><dt class="dt-description">
-<span style="font-weight:bold"><span style="font-family:monospace">via: [{type: Type, host: Host, port: Port}]</span></span></dt><dd class="dd-description">With
+<span style="font-weight:bold"><span style="font-family:monospace">record_route: SIP_URI</span></span></dt><dd class="dd-description">When the option
+<span style="font-family:monospace">always_record_route</span> is set or when SIP outbound
+is utilized <a href="http://tools.ietf.org/html/rfc5626">RFC 5626</a>,
+<span style="font-family:monospace">ejabberd</span> inserts <span style="font-family:monospace">Record-Route</span> header field with this <span style="font-family:monospace">SIP_URI</span>
+into a SIP message. The default is SIP URI constructed from the virtual host.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">always_record_route: true|false</span></span></dt><dd class="dd-description">
+Always insert <span style="font-family:monospace">Record-Route</span> header into SIP messages. This approach allows
+to bypass NATs/firewalls a bit more easily. The default is <span style="font-family:monospace">true</span>.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">routes: [SIP_URI]</span></span></dt><dd class="dd-description">You can set a list of SIP URIs of routes
+pointing to this proxy server. The default is a list of a SIP URI constructed
+from the virtual host.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">flow_timeout_udp: Seconds</span></span></dt><dd class="dd-description">For SIP outbound UDP connections set a keep-alive
+timer to <span style="font-family:monospace">Seconds</span>. The default is 29.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">flow_timeout_tcp: Seconds</span></span></dt><dd class="dd-description">For SIP outbound TCP connections set a keep-alive
+timer to <span style="font-family:monospace">Seconds</span>. The default is 120.
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">via: [{type: Type, host: Host, port: Port}]</span></span></dt><dd class="dd-description">With
this option for every <span style="font-family:monospace">Type</span> you can specify <span style="font-family:monospace">Host</span> and <span style="font-family:monospace">Port</span>
to set in <span style="font-family:monospace">Via</span> header of outgoing SIP messages, where <span style="font-family:monospace">Type</span> can be
<span style="font-family:monospace">udp</span>, <span style="font-family:monospace">tcp</span> or <span style="font-family:monospace">tls</span>. <span style="font-family:monospace">Host</span> is a string and <span style="font-family:monospace">Port</span> is
a non negative integer. This is useful if you’re running your server in a non-standard
-network topology. Example configuration:
-<pre class="verbatim">modules:
+network topology.
+</dd></dl><p>
+Example complex configuration:
+</p><pre class="verbatim">modules:
...
mod_sip:
+ always_record_route: false
+ record_route: sip:example.com;lr
+ routes:
+ - sip:example.com;lr
+ - sip:sip.example.com;lr
+ flow_timeout_udp: 30
+ flow_timeout_tcp: 130
via:
-
type: tls
host: "sip-udp.example.com"
port: 5060
...
-</pre><
/dd></dl><p> <a id="modstats"></a> </p>
-<!--TOC subsection id="sec96" <span style="font-family:monospace">mod_stats</span>-->
-<h3 id="sec
96" class="subsection">3.3.27  <a href="#modstats"><span style="font-family:monospace">mod_stats</span></a></h3><!--SEC END --><p> <a id="modstats"></a>
+</pre><p> <a id="modstats"></a> </p>
+<!--TOC subsection id="sec100" <span style="font-family:monospace">mod_stats</span>-->
+<h3 id="sec
100" class="subsection">3.3.27  <a href="#modstats"><span style="font-family:monospace">mod_stats</span></a></h3><!--SEC END --><p> <a id="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 <span style="font-family:monospace">ejabberd</span> deployment:
</p><ul class="itemize"><li class="li-itemize">
</query>
</iq>
</pre></li></ul><p> <a id="modtime"></a> </p>
-<!--TOC subsection id="sec97" <span style="font-family:monospace">mod_time</span>-->
-<h3 id="sec
97" class="subsection">3.3.28  <a href="#modtime"><span style="font-family:monospace">mod_time</span></a></h3><!--SEC END --><p> <a id="modtime"></a>
+<!--TOC subsection id="sec101" <span style="font-family:monospace">mod_time</span>-->
+<h3 id="sec
101" class="subsection">3.3.28  <a href="#modtime"><span style="font-family:monospace">mod_time</span></a></h3><!--SEC END --><p> <a id="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">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Entity Time (<span style="font-family:monospace">jabber:iq:time</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p> <a id="modvcard"></a> </p>
-<!--TOC subsection id="sec98" <span style="font-family:monospace">mod_vcard</span>-->
-<h3 id="sec
98" class="subsection">3.3.29  <a href="#modvcard"><span style="font-family:monospace">mod_vcard</span></a></h3><!--SEC END --><p> <a id="modvcard"></a>
+<!--TOC subsection id="sec102" <span style="font-family:monospace">mod_vcard</span>-->
+<h3 id="sec
102" class="subsection">3.3.29  <a href="#modvcard"><span style="font-family:monospace">mod_vcard</span></a></h3><!--SEC END --><p> <a id="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
allow_return_all: true
...
</pre></li></ul><p> <a id="modvcardldap"></a> </p>
-<!--TOC subsection id="sec99" <span style="font-family:monospace">mod_vcard_ldap</span>-->
-<h3 id="sec
99" class="subsection">3.3.30  <a href="#modvcardldap"><span style="font-family:monospace">mod_vcard_ldap</span></a></h3><!--SEC END --><p> <a id="modvcardldap"></a>
+<!--TOC subsection id="sec103" <span style="font-family:monospace">mod_vcard_ldap</span>-->
+<h3 id="sec
103" class="subsection">3.3.30  <a href="#modvcardldap"><span style="font-family:monospace">mod_vcard_ldap</span></a></h3><!--SEC END --><p> <a id="modvcardldap"></a>
</p><p><span style="font-family:monospace">ejabberd</span> can map LDAP attributes to vCard fields. This behaviour is
implemented in the <span style="font-family:monospace">mod_vcard_ldap</span> module. This module does not depend on the
authentication method (see <a href="#ldapauth">3.2.2</a>).</p><p>Usually <span style="font-family:monospace">ejabberd</span> treats LDAP as a read-only storage:
{"Nickname", "NICKNAME"}
]},
</pre></li></ul><p> <a id="modvcardxupdate"></a> </p>
-<!--TOC subsection id="sec100" <span style="font-family:monospace">mod_vcard_xupdate</span>-->
-<h3 id="sec10
0" class="subsection">3.3.31  <a href="#modvcardxupdate"><span style="font-family:monospace">mod_vcard_xupdate</span></a></h3><!--SEC END --><p> <a id="modvcardxupdate"></a>
+<!--TOC subsection id="sec104" <span style="font-family:monospace">mod_vcard_xupdate</span>-->
+<h3 id="sec10
4" class="subsection">3.3.31  <a href="#modvcardxupdate"><span style="font-family:monospace">mod_vcard_xupdate</span></a></h3><!--SEC END --><p> <a id="modvcardxupdate"></a>
</p><p>The user’s client can store an avatar in the user vCard.
The vCard-Based Avatars protocol (<a href="http://xmpp.org/extensions/xep-0153.html">XEP-0153</a>)
provides a method for clients to inform the contacts what is the avatar hash value.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modversion"></a> </p>
-<!--TOC subsection id="sec101" <span style="font-family:monospace">mod_version</span>-->
-<h3 id="sec10
1" class="subsection">3.3.32  <a href="#modversion"><span style="font-family:monospace">mod_version</span></a></h3><!--SEC END --><p> <a id="modversion"></a>
+<!--TOC subsection id="sec105" <span style="font-family:monospace">mod_version</span>-->
+<h3 id="sec10
5" class="subsection">3.3.32  <a href="#modversion"><span style="font-family:monospace">mod_version</span></a></h3><!--SEC END --><p> <a id="modversion"></a>
</p><p>This module implements Software Version (<a href="http://xmpp.org/extensions/xep-0092.html">XEP-0092</a>). Consequently, it
answers <span style="font-family:monospace">ejabberd</span>’s version when queried.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Software Version (<span style="font-family:monospace">jabber:iq:version</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p> <a id="manage"></a> </p>
-<!--TOC chapter id="sec102" Managing an <span style="font-family:monospace">ejabberd</span> Server-->
-<h1 id="sec10
2" class="chapter">Chapter 4  <a href="#manage">Managing an <span style="font-family:monospace">ejabberd</span> Server</a></h1><!--SEC END --><p> <a id="manage"></a> </p><p> <a id="ejabberdctl"></a> </p>
-<!--TOC section id="sec103" <span style="font-family:monospace">ejabberdctl</span>-->
-<h2 id="sec10
3" class="section">4.1  <a href="#ejabberdctl"><span style="font-family:monospace">ejabberdctl</span></a></h2><!--SEC END --><p> <a id="ejabberdctl"></a> </p><p>With the <span style="font-family:monospace">ejabberdctl</span> command line administration script
+<!--TOC chapter id="sec106" Managing an <span style="font-family:monospace">ejabberd</span> Server-->
+<h1 id="sec10
6" class="chapter">Chapter 4  <a href="#manage">Managing an <span style="font-family:monospace">ejabberd</span> Server</a></h1><!--SEC END --><p> <a id="manage"></a> </p><p> <a id="ejabberdctl"></a> </p>
+<!--TOC section id="sec107" <span style="font-family:monospace">ejabberdctl</span>-->
+<h2 id="sec10
7" class="section">4.1  <a href="#ejabberdctl"><span style="font-family:monospace">ejabberdctl</span></a></h2><!--SEC END --><p> <a id="ejabberdctl"></a> </p><p>With the <span style="font-family:monospace">ejabberdctl</span> command line administration script
you can execute <span style="font-family:monospace">ejabberdctl commands</span> (described in the next section, <a href="#ectl-commands">4.1.1</a>)
and also many general <span style="font-family:monospace">ejabberd commands</span> (described in section <a href="#eja-commands">4.2</a>).
This means you can start, stop and perform many other administrative tasks
if a command succeeded or failed,
for example using: <span style="font-family:monospace">echo $?</span></p><p>If you use Bash, you can get Bash completion by copying the file <span style="font-family:monospace">tools/ejabberdctl.bc</span>
to the directory <span style="font-family:monospace">/etc/bash_completion.d/</span> (in Debian, Ubuntu, Fedora and maybe others).</p><p> <a id="ectl-commands"></a> </p>
-<!--TOC subsection id="sec104" ejabberdctl Commands-->
-<h3 id="sec10
4" class="subsection">4.1.1  <a href="#ectl-commands">ejabberdctl Commands</a></h3><!--SEC END --><p> <a id="ectl-commands"></a> </p><p>When <span style="font-family:monospace">ejabberdctl</span> is executed without any parameter,
+<!--TOC subsection id="sec108" ejabberdctl Commands-->
+<h3 id="sec10
8" class="subsection">4.1.1  <a href="#ectl-commands">ejabberdctl Commands</a></h3><!--SEC END --><p> <a id="ectl-commands"></a> </p><p>When <span style="font-family:monospace">ejabberdctl</span> is executed without any parameter,
it displays the available options. If there isn’t an <span style="font-family:monospace">ejabberd</span> server running,
the available parameters are:
</p><dl class="description"><dt class="dt-description">
testuser1
testuser2
</pre><p> <a id="erlangconfiguration"></a> </p>
-<!--TOC subsection id="sec105" Erlang Runtime System-->
-<h3 id="sec10
5" class="subsection">4.1.2  <a href="#erlangconfiguration">Erlang Runtime System</a></h3><!--SEC END --><p> <a id="erlangconfiguration"></a> </p><p><span style="font-family:monospace">ejabberd</span> is an Erlang/OTP application that runs inside an Erlang runtime system.
+<!--TOC subsection id="sec109" Erlang Runtime System-->
+<h3 id="sec10
9" class="subsection">4.1.2  <a href="#erlangconfiguration">Erlang Runtime System</a></h3><!--SEC END --><p> <a id="erlangconfiguration"></a> </p><p><span style="font-family:monospace">ejabberd</span> is an Erlang/OTP application that runs inside an Erlang runtime system.
This system is configured using environment variables and command line parameters.
The <span style="font-family:monospace">ejabberdctl</span> administration script uses many of those possibilities.
You can configure some of them with the file <span style="font-family:monospace">ejabberdctl.cfg</span>,
</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 (<span style="font-family:monospace">erl -man erl</span>).</p><p> <a id="eja-commands"></a> </p>
-<!--TOC section id="sec106" <span style="font-family:monospace">ejabberd</span> Commands-->
-<h2 id="sec1
06" class="section">4.2  <a href="#eja-commands"><span style="font-family:monospace">ejabberd</span> Commands</a></h2><!--SEC END --><p> <a id="eja-commands"></a> </p><p>An <span style="font-family:monospace">ejabberd command</span> is an abstract function identified by a name,
+<!--TOC section id="sec110" <span style="font-family:monospace">ejabberd</span> Commands-->
+<h2 id="sec1
10" class="section">4.2  <a href="#eja-commands"><span style="font-family:monospace">ejabberd</span> Commands</a></h2><!--SEC END --><p> <a id="eja-commands"></a> </p><p>An <span style="font-family:monospace">ejabberd command</span> 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 <span style="font-family:monospace">ejabberd_commands</span> service.
Those commands can be defined in any Erlang module and executed using any valid frontend.</p><p><span style="font-family:monospace">ejabberd</span> includes two frontends to execute <span style="font-family:monospace">ejabberd commands</span>: the script <span style="font-family:monospace">ejabberdctl</span> (<a href="#ejabberdctl">4.1</a>)
Other known frontends that can be installed to execute ejabberd commands in different ways are:
<span style="font-family:monospace">mod_rest</span> (HTTP POST service),
<span style="font-family:monospace">mod_shcommands</span> (ejabberd WebAdmin page).</p><p> <a id="list-eja-commands"></a> </p>
-<!--TOC subsection id="sec107" List of ejabberd Commands-->
-<h3 id="sec1
07" class="subsection">4.2.1  <a href="#list-eja-commands">List of ejabberd Commands</a></h3><!--SEC END --><p> <a id="list-eja-commands"></a> </p><p><span style="font-family:monospace">ejabberd</span> includes a few ejabberd Commands by default.
+<!--TOC subsection id="sec111" List of ejabberd Commands-->
+<h3 id="sec1
11" class="subsection">4.2.1  <a href="#list-eja-commands">List of ejabberd Commands</a></h3><!--SEC END --><p> <a id="list-eja-commands"></a> </p><p><span style="font-family:monospace">ejabberd</span> 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
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">register user host password</span></span></dt><dd class="dd-description"> Register an account in that domain with the given password.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">unregister user host</span></span></dt><dd class="dd-description"> Unregister the given account.
</dd></dl><p> <a id="accesscommands"></a> </p>
-<!--TOC subsection id="sec108" Restrict Execution with AccessCommands-->
-<h3 id="sec1
08" class="subsection">4.2.2  <a href="#accesscommands">Restrict Execution with AccessCommands</a></h3><!--SEC END --><p> <a id="accesscommands"></a> </p><p>The frontends can be configured to restrict access to certain commands.
+<!--TOC subsection id="sec112" Restrict Execution with AccessCommands-->
+<h3 id="sec1
12" class="subsection">4.2.2  <a href="#accesscommands">Restrict Execution with AccessCommands</a></h3><!--SEC END --><p> <a id="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 <span style="font-family:monospace">AccessCommands</span> option is defined
in a different place. But in all cases the option syntax is the same:
{_bot_reg_test, [register, unregister], [{host, "test.org"}]}
]
</pre><p> <a id="webadmin"></a> </p>
-<!--TOC section id="sec109" Web Admin-->
-<h2 id="sec1
09" class="section">4.3  <a href="#webadmin">Web Admin</a></h2><!--SEC END --><p> <a id="webadmin"></a>
+<!--TOC section id="sec113" Web Admin-->
+<h2 id="sec1
13" class="section">4.3  <a href="#webadmin">Web Admin</a></h2><!--SEC END --><p> <a id="webadmin"></a>
</p><p>The <span style="font-family:monospace">ejabberd</span> Web Admin allows to administer most of <span style="font-family:monospace">ejabberd</span> using a web browser.</p><p>This feature is enabled by default:
a <span style="font-family:monospace">ejabberd_http</span> listener with the option <span style="font-family:monospace">web_admin</span> (see
section <a href="#listened">3.1.4</a>) is included in the listening ports. Then you can open
The directory of the documentation can be specified in
the environment variable <span style="font-family:monospace">EJABBERD_DOC_PATH</span>.
See section <a href="#erlangconfiguration">4.1.2</a>.</p><p> <a id="adhoccommands"></a> </p>
-<!--TOC section id="sec110" Ad-hoc Commands-->
-<h2 id="sec11
0" class="section">4.4  <a href="#adhoccommands">Ad-hoc Commands</a></h2><!--SEC END --><p> <a id="adhoccommands"></a> </p><p>If you enable <span style="font-family:monospace">mod_configure</span> and <span style="font-family:monospace">mod_adhoc</span>,
+<!--TOC section id="sec114" Ad-hoc Commands-->
+<h2 id="sec11
4" class="section">4.4  <a href="#adhoccommands">Ad-hoc Commands</a></h2><!--SEC END --><p> <a id="adhoccommands"></a> </p><p>If you enable <span style="font-family:monospace">mod_configure</span> and <span style="font-family:monospace">mod_adhoc</span>,
you can perform several administrative tasks in <span style="font-family:monospace">ejabberd</span>
with an 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 id="changeerlangnodename"></a> </p>
-<!--TOC section id="sec111" Change Computer Hostname-->
-<h2 id="sec11
1" class="section">4.5  <a href="#changeerlangnodename">Change Computer Hostname</a></h2><!--SEC END --><p> <a id="changeerlangnodename"></a> </p><p><span style="font-family:monospace">ejabberd</span> uses the distributed Mnesia database.
+<!--TOC section id="sec115" Change Computer Hostname-->
+<h2 id="sec11
5" class="section">4.5  <a href="#changeerlangnodename">Change Computer Hostname</a></h2><!--SEC END --><p> <a id="changeerlangnodename"></a> </p><p><span style="font-family:monospace">ejabberd</span> 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.
</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 id="secure"></a> </p>
-<!--TOC chapter id="sec112" Securing <span style="font-family:monospace">ejabberd</span>-->
-<h1 id="sec11
2" class="chapter">Chapter 5  <a href="#secure">Securing <span style="font-family:monospace">ejabberd</span></a></h1><!--SEC END --><p> <a id="secure"></a> </p><p> <a id="firewall"></a> </p>
-<!--TOC section id="sec113" Firewall Settings-->
-<h2 id="sec11
3" class="section">5.1  <a href="#firewall">Firewall Settings</a></h2><!--SEC END --><p> <a id="firewall"></a>
+<!--TOC chapter id="sec116" Securing <span style="font-family:monospace">ejabberd</span>-->
+<h1 id="sec11
6" class="chapter">Chapter 5  <a href="#secure">Securing <span style="font-family:monospace">ejabberd</span></a></h1><!--SEC END --><p> <a id="secure"></a> </p><p> <a id="firewall"></a> </p>
+<!--TOC section id="sec117" Firewall Settings-->
+<h2 id="sec11
7" class="section">5.1  <a href="#firewall">Firewall Settings</a></h2><!--SEC END --><p> <a id="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 style="width:80%;height:2"></div>
<table border=1 style="border-spacing:0;" class="cellpadding1"><tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Port</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Description</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >port range</td><td style="text-align:left;border:solid 1px;white-space: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 style="width:80%;height:2"></div></div></blockquote><p> <a id="epmd"></a> </p>
-<!--TOC section id="sec114" epmd-->
-<h2 id="sec11
4" class="section">5.2  <a href="#epmd">epmd</a></h2><!--SEC END --><p> <a id="epmd"></a> </p><p><a href="http://www.erlang.org/doc/man/epmd.html">epmd (Erlang Port Mapper Daemon)</a>
+<!--TOC section id="sec118" epmd-->
+<h2 id="sec11
8" class="section">5.2  <a href="#epmd">epmd</a></h2><!--SEC END --><p> <a id="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.
<span style="font-family:monospace">ejabberd</span> needs <span style="font-family:monospace">epmd</span> to use <span style="font-family:monospace">ejabberdctl</span> and also when clustering <span style="font-family:monospace">ejabberd</span> nodes.
The Erlang command-line parameter used internally is, for example:
</p><pre class="verbatim">erl ... -kernel inet_dist_use_interface "{127,0,0,1}"
</pre><p> <a id="cookie"></a> </p>
-<!--TOC section id="sec115" Erlang Cookie-->
-<h2 id="sec11
5" class="section">5.3  <a href="#cookie">Erlang Cookie</a></h2><!--SEC END --><p> <a id="cookie"></a> </p><p>The Erlang cookie is a string with numbers and letters.
+<!--TOC section id="sec119" Erlang Cookie-->
+<h2 id="sec11
9" class="section">5.3  <a href="#cookie">Erlang Cookie</a></h2><!--SEC END --><p> <a id="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 <span style="font-family:monospace">-setcookie</span>.
If not indicated, the cookie is read from the cookie file <span style="font-family:monospace">$HOME/.erlang.cookie</span>.
If this file does not exist, it is created immediately with a random cookie.
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 id="nodename"></a> </p>
-<!--TOC section id="sec116" Erlang Node Name-->
-<h2 id="sec1
16" class="section">5.4  <a href="#nodename">Erlang Node Name</a></h2><!--SEC END --><p> <a id="nodename"></a> </p><p>An Erlang node may have a node name.
+<!--TOC section id="sec120" Erlang Node Name-->
+<h2 id="sec1
20" class="section">5.4  <a href="#nodename">Erlang Node Name</a></h2><!--SEC END --><p> <a id="nodename"></a> </p><p>An Erlang node may have a node name.
The name can be short (if indicated with the command-line parameter <span style="font-family:monospace">-sname</span>)
or long (if indicated with the parameter <span style="font-family:monospace">-name</span>).
Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.</p><p>Using the option <span style="font-family:monospace">-sname</span> instead of <span style="font-family:monospace">-name</span> is a simple method
because it may be possible to fake the fact that you are on another network
using a modified version of Erlang <span style="font-family:monospace">epmd</span>.
The recommended way to secure the Erlang node is to block the port 4369.</p><p> <a id="secure-files"></a> </p>
-<!--TOC section id="sec117" Securing Sensitive Files-->
-<h2 id="sec1
17" class="section">5.5  <a href="#secure-files">Securing Sensitive Files</a></h2><!--SEC END --><p> <a id="secure-files"></a> </p><p><span style="font-family:monospace">ejabberd</span> stores sensitive data in the file system either in plain text or binary files.
+<!--TOC section id="sec121" Securing Sensitive Files-->
+<h2 id="sec1
21" class="section">5.5  <a href="#secure-files">Securing Sensitive Files</a></h2><!--SEC END --><p> <a id="secure-files"></a> </p><p><span style="font-family:monospace">ejabberd</span> 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">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd configuration file: /etc/ejabberd/ejabberd.yml</span></span></dt><dd class="dd-description">
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</span></span></dt><dd class="dd-description">
See section <a href="#cookie">5.3</a>.
</dd></dl><p> <a id="clustering"></a> </p>
-<!--TOC chapter id="sec118" Clustering-->
-<h1 id="sec1
18" class="chapter">Chapter 6  <a href="#clustering">Clustering</a></h1><!--SEC END --><p> <a id="clustering"></a>
+<!--TOC chapter id="sec122" Clustering-->
+<h1 id="sec1
22" class="chapter">Chapter 6  <a href="#clustering">Clustering</a></h1><!--SEC END --><p> <a id="clustering"></a>
</p><p> <a id="howitworks"></a> </p>
-<!--TOC section id="sec119" How it Works-->
-<h2 id="sec1
19" class="section">6.1  <a href="#howitworks">How it Works</a></h2><!--SEC END --><p> <a id="howitworks"></a>
+<!--TOC section id="sec123" How it Works-->
+<h2 id="sec1
23" class="section">6.1  <a href="#howitworks">How it Works</a></h2><!--SEC END --><p> <a id="howitworks"></a>
</p><p>A XMPP domain is served by one or more <span style="font-family:monospace">ejabberd</span> 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
</li><li class="li-itemize">session manager,
</li><li class="li-itemize">s2s manager.
</li></ul><p> <a id="router"></a> </p>
-<!--TOC subsection id="sec120" Router-->
-<h3 id="sec12
0" class="subsection">6.1.1  <a href="#router">Router</a></h3><!--SEC END --><p> <a id="router"></a>
+<!--TOC subsection id="sec124" Router-->
+<h3 id="sec12
4" class="subsection">6.1.1  <a href="#router">Router</a></h3><!--SEC END --><p> <a id="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 id="localrouter"></a> </p>
-<!--TOC subsection id="sec121" Local Router-->
-<h3 id="sec12
1" class="subsection">6.1.2  <a href="#localrouter">Local Router</a></h3><!--SEC END --><p> <a id="localrouter"></a>
+<!--TOC subsection id="sec125" Local Router-->
+<h3 id="sec12
5" class="subsection">6.1.2  <a href="#localrouter">Local Router</a></h3><!--SEC END --><p> <a id="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 id="sessionmanager"></a> </p>
-<!--TOC subsection id="sec122" Session Manager-->
-<h3 id="sec12
2" class="subsection">6.1.3  <a href="#sessionmanager">Session Manager</a></h3><!--SEC END --><p> <a id="sessionmanager"></a>
+<!--TOC subsection id="sec126" Session Manager-->
+<h3 id="sec12
6" class="subsection">6.1.3  <a href="#sessionmanager">Session Manager</a></h3><!--SEC END --><p> <a id="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 id="s2smanager"></a> </p>
-<!--TOC subsection id="sec123" s2s Manager-->
-<h3 id="sec12
3" class="subsection">6.1.4  <a href="#s2smanager">s2s Manager</a></h3><!--SEC END --><p> <a id="s2smanager"></a>
+<!--TOC subsection id="sec127" s2s Manager-->
+<h3 id="sec12
7" class="subsection">6.1.4  <a href="#s2smanager">s2s Manager</a></h3><!--SEC END --><p> <a id="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 id="cluster"></a> </p>
-<!--TOC section id="sec124" Clustering Setup-->
-<h2 id="sec12
4" class="section">6.2  <a href="#cluster">Clustering Setup</a></h2><!--SEC END --><p> <a id="cluster"></a>
+<!--TOC section id="sec128" Clustering Setup-->
+<h2 id="sec12
8" class="section">6.2  <a href="#cluster">Clustering Setup</a></h2><!--SEC END --><p> <a id="cluster"></a>
</p><p>Suppose you already configured <span style="font-family:monospace">ejabberd</span> on one machine named (<span style="font-family:monospace">first</span>),
and you need to setup another one to make an <span style="font-family:monospace">ejabberd</span> cluster. Then do
following steps:</p><ol class="enumerate" type=1><li class="li-enumerate">
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 id="servicelb"></a> </p>
-<!--TOC section id="sec125" Service Load-Balancing-->
-<h2 id="sec12
5" class="section">6.3  <a href="#servicelb">Service Load-Balancing</a></h2><!--SEC END --><p> <a id="servicelb"></a>
+<!--TOC section id="sec129" Service Load-Balancing-->
+<h2 id="sec12
9" class="section">6.3  <a href="#servicelb">Service Load-Balancing</a></h2><!--SEC END --><p> <a id="servicelb"></a>
</p><p> <a id="domainlb"></a> </p>
-<!--TOC subsection id="sec126" Domain Load-Balancing Algorithm-->
-<h3 id="sec1
26" class="subsection">6.3.1  <a href="#domainlb">Domain Load-Balancing Algorithm</a></h3><!--SEC END --><p> <a id="domainlb"></a>
+<!--TOC subsection id="sec130" Domain Load-Balancing Algorithm-->
+<h3 id="sec1
30" class="subsection">6.3.1  <a href="#domainlb">Domain Load-Balancing Algorithm</a></h3><!--SEC END --><p> <a id="domainlb"></a>
</p><p><span style="font-family:monospace">ejabberd</span> includes an algorithm to load balance the components that are plugged on an <span style="font-family:monospace">ejabberd</span> cluster. It means that you can plug one or several instances of the same component on each <span style="font-family:monospace">ejabberd</span> 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 <span style="font-family:monospace">domain_balancing</span>. The syntax of the option is the following:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">domain_balancing: BalancingCriteria</span></span></dt></dl><p>Several balancing criteria are available:
</p><ul class="itemize"><li class="li-itemize">
</li><li class="li-itemize"><span style="font-family:monospace">bare_destination</span>: the bare JID (without resource) of the packet <span style="font-family:monospace">to</span> attribute is used.
</li><li class="li-itemize"><span style="font-family:monospace">bare_source</span>: the bare JID (without resource) of the packet <span style="font-family:monospace">from</span> 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 id="lbbuckets"></a> </p>
-<!--TOC subsection id="sec127" Load-Balancing Buckets-->
-<h3 id="sec1
27" class="subsection">6.3.2  <a href="#lbbuckets">Load-Balancing Buckets</a></h3><!--SEC END --><p> <a id="lbbuckets"></a>
+<!--TOC subsection id="sec131" Load-Balancing Buckets-->
+<h3 id="sec1
31" class="subsection">6.3.2  <a href="#lbbuckets">Load-Balancing Buckets</a></h3><!--SEC END --><p> <a id="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 <span style="font-family:monospace">domain_balancing_component_number</span> 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"><span style="font-weight:bold"><span style="font-family:monospace">domain_balancing_component_number: Number</span></span></dt></dl><p> <a id="debugging"></a> </p>
-<!--TOC chapter id="sec128" Debugging-->
-<h1 id="sec1
28" class="chapter">Chapter 7  <a href="#debugging">Debugging</a></h1><!--SEC END --><p> <a id="debugging"></a>
+<!--TOC chapter id="sec132" Debugging-->
+<h1 id="sec1
32" class="chapter">Chapter 7  <a href="#debugging">Debugging</a></h1><!--SEC END --><p> <a id="debugging"></a>
</p><p> <a id="logfiles"></a> </p>
-<!--TOC section id="sec129" Log Files-->
-<h2 id="sec129" class="section">7.1  <a href="#logfiles">Log Files</a></h2><!--SEC END --><p> <a id="logfiles"></a> </p><p>An <span style="font-family:monospace">ejabberd</span> node writes two log files:
+<!--TOC section id="sec133" Log Files-->
+<h2 id="sec133" class="section">7.1  <a href="#logfiles">Log Files</a></h2><!--SEC END --><p> <a id="logfiles"></a> </p><p>An <span style="font-family:monospace">ejabberd</span> node writes three log files:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd.log</span></span></dt><dd class="dd-description"> is the ejabberd service log, with the messages reported by <span style="font-family:monospace">ejabberd</span> code
- </dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">erlang.log</span></span></dt><dd class="dd-description"> is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries)
+</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">error.log</span></span></dt><dd class="dd-description"> is the file accumulating error messages from <span style="font-family:monospace">ejabberd.log</span>
+ </dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">crash.log</span></span></dt><dd class="dd-description"> is the Erlang/OTP log, with the crash messages reported by Erlang/OTP using SASL (System Architecture Support Libraries)
</dd></dl><p>The option <span style="font-family:monospace">loglevel</span> modifies the verbosity of the file ejabberd.log. The syntax:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">loglevel: Level</span></span></dt><dd class="dd-description"> The standard form to set a global log level.
</dd></dl><p>
For example, the default configuration is:
</p><pre class="verbatim">loglevel: 4
-</pre><p>The log files grow continually, so it is recommended to rotate them periodically.
-To rotate the log files, rename the files and then reopen them.
+</pre><p>Option <span style="font-family:monospace">log_rate_limit</span> is useful if you want to protect the logging
+mechanism from being overloaded by excessive amount of log messages.
+The syntax is:
+</p><dl class="description"><dt class="dt-description">
+<span style="font-weight:bold"><span style="font-family:monospace">log_rate_limit: N</span></span></dt><dd class="dd-description"> Where N is a maximum number of log messages per second.
+The default value is 100.
+</dd></dl><p>
+When the limit is reached the similar warning message is logged:
+</p><pre class="verbatim">lager_error_logger_h dropped 800 messages in the last second that exceeded the limit of 100 messages/sec
+</pre><p>By default <span style="font-family:monospace">ejabberd</span> rotates the log files when they get grown above a certain size.
+The exact value is controlled by <span style="font-family:monospace">log_rotate_size</span> option.
+The syntax is:
+</p><dl class="description"><dt class="dt-description">
+<span style="font-weight:bold"><span style="font-family:monospace">log_rotate_size: N</span></span></dt><dd class="dd-description"> Where N is the maximum size of a log file in bytes.
+The default value is 10485760 (10Mb).
+</dd></dl><p><span style="font-family:monospace">ejabberd</span> can also rotates the log files at given date interval.
+The exact value is controlled by <span style="font-family:monospace">log_rotate_date</span> option.
+The syntax is:
+</p><dl class="description"><dt class="dt-description">
+<span style="font-weight:bold"><span style="font-family:monospace">log_rotate_date: D</span></span></dt><dd class="dd-description"> Where D is a string with syntax is taken from the syntax newsyslog uses in newsyslog.conf.
+The default value is <span style="font-family:monospace">""</span> (no rotation triggered by date).
+</dd></dl><p>However, you can rotate the log files manually.
+For doing this, set <span style="font-family:monospace">log_rotate_size</span> option to 0 and <span style="font-family:monospace">log_rotate_date</span>
+to empty list, then, when you need to rotate the files, rename and then reopen them.
The ejabberdctl command <span style="font-family:monospace">reopen-log</span>
(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 id="debugconsole"></a> </p>
-<!--TOC section id="sec130" Debug Console-->
-<h2 id="sec130" class="section">7.2  <a href="#debugconsole">Debug Console</a></h2><!--SEC END --><p> <a id="debugconsole"></a> </p><p>The Debug Console is an Erlang shell attached to an already running <span style="font-family:monospace">ejabberd</span> server.
+and also renames the old ones if you didn’t rename them.</p><p>The option <span style="font-family:monospace">log_rotate_count</span> defines the number of rotated files to keep
+by <span style="font-family:monospace">reopen-log</span> command.
+Every such file has a numeric suffix. The exact format is:
+</p><dl class="description"><dt class="dt-description">
+<span style="font-weight:bold"><span style="font-family:monospace">log_rotate_count: N</span></span></dt><dd class="dd-description"> The default value is 1,
+which means only <span style="font-family:monospace">ejabberd.log.0</span>, <span style="font-family:monospace">error.log.0</span>
+and <span style="font-family:monospace">crash.log.0</span> will be kept.
+</dd></dl><p> <a id="debugconsole"></a> </p>
+<!--TOC section id="sec134" Debug Console-->
+<h2 id="sec134" class="section">7.2  <a href="#debugconsole">Debug Console</a></h2><!--SEC END --><p> <a id="debugconsole"></a> </p><p>The Debug Console is an Erlang shell attached to an already running <span style="font-family:monospace">ejabberd</span> server.
With this Erlang shell, an experienced administrator can perform complex tasks.</p><p>This shell gives complete control over the <span style="font-family:monospace">ejabberd</span> 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 id="watchdog"></a> </p>
-<!--TOC section id="sec131" Watchdog Alerts-->
-<h2 id="sec13
1" class="section">7.3  <a href="#watchdog">Watchdog Alerts</a></h2><!--SEC END --><p> <a id="watchdog"></a>
+<!--TOC section id="sec135" Watchdog Alerts-->
+<h2 id="sec13
5" class="section">7.3  <a href="#watchdog">Watchdog Alerts</a></h2><!--SEC END --><p> <a id="watchdog"></a>
</p><p><span style="font-family:monospace">ejabberd</span> includes a watchdog mechanism that may be useful to developers
when troubleshooting a problem related to memory usage.
If a process in the <span style="font-family:monospace">ejabberd</span> server consumes more memory than the configured threshold,
To remove all watchdog admins, set the option with an empty list:
</p><pre class="verbatim">watchdog_admins: []
</pre><p> <a id="i18ni10n"></a> </p>
-<!--TOC chapter id="sec132" Internationalization and Localization-->
-<h1 id="sec13
2" class="chapter">Appendix A  <a href="#i18ni10n">Internationalization and Localization</a></h1><!--SEC END --><p> <a id="i18ni10n"></a>
+<!--TOC chapter id="sec136" Internationalization and Localization-->
+<h1 id="sec13
6" class="chapter">Appendix A  <a href="#i18ni10n">Internationalization and Localization</a></h1><!--SEC END --><p> <a id="i18ni10n"></a>
</p><p>The source code of <span style="font-family:monospace">ejabberd</span> supports localization.
The translators can edit the
<a href="http://www.gnu.org/software/gettext/">gettext</a> .po files
</table></div>
<a id="fig:webadmmainru"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="releasenotes"></a> </p>
-<!--TOC chapter id="sec133" Release Notes-->
-<h1 id="sec13
3" class="chapter">Appendix B  <a href="#releasenotes">Release Notes</a></h1><!--SEC END --><p> <a id="releasenotes"></a>
+<!--TOC chapter id="sec137" Release Notes-->
+<h1 id="sec13
7" class="chapter">Appendix B  <a href="#releasenotes">Release Notes</a></h1><!--SEC END --><p> <a id="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 id="acknowledgements"></a> </p>
-<!--TOC chapter id="sec134" Acknowledgements-->
-<h1 id="sec13
4" class="chapter">Appendix C  <a href="#acknowledgements">Acknowledgements</a></h1><!--SEC END --><p> <a id="acknowledgements"></a> </p><p>Thanks to all people who contributed to this guide:
+<!--TOC chapter id="sec138" Acknowledgements-->
+<h1 id="sec13
8" class="chapter">Appendix C  <a href="#acknowledgements">Acknowledgements</a></h1><!--SEC END --><p> <a id="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"><span style="font-family:monospace">xmpp:aleksey@jabber.ru</span></a>)
</li><li class="li-itemize">Badlop (<a href="xmpp:badlop@jabberes.org"><span style="font-family:monospace">xmpp:badlop@jabberes.org</span></a>)
</li><li class="li-itemize">Sergei Golovan (<a href="xmpp:sgolovan@nes.ru"><span style="font-family:monospace">xmpp:sgolovan@nes.ru</span></a>)
</li><li class="li-itemize">Vsevolod Pelipas (<a href="xmpp:vsevoload@jabber.ru"><span style="font-family:monospace">xmpp:vsevoload@jabber.ru</span></a>)
</li></ul><p> <a id="copyright"></a> </p>
-<!--TOC chapter id="sec135" Copyright Information-->
-<h1 id="sec13
5" class="chapter">Appendix D  <a href="#copyright">Copyright Information</a></h1><!--SEC END --><p> <a id="copyright"></a> </p><p>Ejabberd Installation and Operation Guide.<br>
+<!--TOC chapter id="sec139" Copyright Information-->
+<h1 id="sec13
9" class="chapter">Appendix D  <a href="#copyright">Copyright Information</a></h1><!--SEC END --><p> <a id="copyright"></a> </p><p>Ejabberd Installation and Operation Guide.<br>
Copyright © 2003 — 2014 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
projects / ejabberd / commitdiff