Chapril
/
xmpp.chapril.org-ejabberd
mirror of https://github.com/processone/ejabberd.git
24
1
Fork 0
Code Releases Activity
xmpp.chapril.org-ejabberd/doc/guide.html

2458 lines
103 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>Ejabberd 1.0.0 Installation and Operation Guide</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<META name="GENERATOR" content="hevea 1.08">
<STYLE type="text/css">
.toc{list-style:none;}
.title{margin:auto;text-align:center}
.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;}
.part{margin:auto;text-align:center}
</STYLE>
</HEAD>
<BODY >
<!--HEVEA command line is: hevea guide.tex -->
<!--HTMLHEAD-->
<!--ENDHTML-->
<!--PREFIX <ARG ></ARG>-->
<!--CUT DEF section 1 -->
<BR>
<BR>
<A NAME="sec:titlepage"></A>
<TABLE CLASS="title">
<TR><TD>
<H1 CLASS="titlemain">Ejabberd 1.0.0 Installation and Operation 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><BR>
<BR>
<DIV CLASS="center">
<IMG SRC="logo.png">
<BR>
<BR>
</DIV>
<BLOCKQUOTE CLASS="quotation"><I>I can thoroughly recommend ejabberd for ease of setup &ndash;
Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE>
<!--TOC section Contents-->
<H2 CLASS="section">Contents</H2><!--SEC END -->
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc1">1&nbsp;&nbsp;Introduction</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc2">1.1&nbsp;&nbsp;Key Features</A>
<LI CLASS="li-toc"><A HREF="#htoc3">1.2&nbsp;&nbsp;Additional Features</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc4">2&nbsp;&nbsp;Installation from Source</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc5">2.1&nbsp;&nbsp;Installation Requirements</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc6">2.1.1&nbsp;&nbsp;&#8220;Unix-like&#8221; operating systems</A>
<LI CLASS="li-toc"><A HREF="#htoc7">2.1.2&nbsp;&nbsp;Windows</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc8">2.2&nbsp;&nbsp;Obtaining <TT>ejabberd</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc9">2.3&nbsp;&nbsp;Compilation</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc10">2.3.1&nbsp;&nbsp;&#8220;Unix-like&#8221; operating systems</A>
<LI CLASS="li-toc"><A HREF="#htoc11">2.3.2&nbsp;&nbsp;Windows</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc12">2.4&nbsp;&nbsp;Starting</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc13">3&nbsp;&nbsp;Configuration</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc14">3.1&nbsp;&nbsp;Initial Configuration</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc15">3.1.1&nbsp;&nbsp;Host Names</A>
<LI CLASS="li-toc"><A HREF="#htoc16">3.1.2&nbsp;&nbsp;Default Language</A>
<LI CLASS="li-toc"><A HREF="#htoc17">3.1.3&nbsp;&nbsp;Access Rules</A>
<LI CLASS="li-toc"><A HREF="#htoc18">3.1.4&nbsp;&nbsp;Shapers</A>
<LI CLASS="li-toc"><A HREF="#htoc19">3.1.5&nbsp;&nbsp;Listened Sockets</A>
<LI CLASS="li-toc"><A HREF="#htoc20">3.1.6&nbsp;&nbsp;Modules</A>
<LI CLASS="li-toc"><A HREF="#htoc21">3.1.7&nbsp;&nbsp;Virtual Hosting</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc22">3.2&nbsp;&nbsp;Creating an Initial Administrator</A>
<LI CLASS="li-toc"><A HREF="#htoc23">3.3&nbsp;&nbsp;Online Configuration and Monitoring</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc24">3.3.1&nbsp;&nbsp;Web Interface</A>
<LI CLASS="li-toc"><A HREF="#htoc25">3.3.2&nbsp;&nbsp;<TT>ejabberdctl</TT></A>
</UL>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc26">4&nbsp;&nbsp;Firewall Settings</A>
<LI CLASS="li-toc"><A HREF="#htoc27">5&nbsp;&nbsp;SRV Records</A>
<LI CLASS="li-toc"><A HREF="#htoc28">6&nbsp;&nbsp;Clustering</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc29">6.1&nbsp;&nbsp;How it Works</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc30">6.1.1&nbsp;&nbsp;Router</A>
<LI CLASS="li-toc"><A HREF="#htoc31">6.1.2&nbsp;&nbsp;Local Router</A>
<LI CLASS="li-toc"><A HREF="#htoc32">6.1.3&nbsp;&nbsp;Session Manager</A>
<LI CLASS="li-toc"><A HREF="#htoc33">6.1.4&nbsp;&nbsp;s2s Manager</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc34">6.2&nbsp;&nbsp;Clustering Setup</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc35">A&nbsp;&nbsp;Built-in Modules</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc36">A.1&nbsp;&nbsp;Common Options</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc37">A.1.1&nbsp;&nbsp;<TT>iqdisc</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc38">A.1.2&nbsp;&nbsp;<TT>hosts</TT></A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc39">A.2&nbsp;&nbsp;<TT>mod_announce</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc40">A.3&nbsp;&nbsp;<TT>mod_disco</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc41">A.4&nbsp;&nbsp;<TT>mod_echo</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc42">A.5&nbsp;&nbsp;<TT>mod_irc</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc43">A.6&nbsp;&nbsp;<TT>mod_last</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc44">A.7&nbsp;&nbsp;<TT>mod_muc</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc45">A.8&nbsp;&nbsp;<TT>mod_offline</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc46">A.9&nbsp;&nbsp;<TT>mod_privacy</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc47">A.10&nbsp;&nbsp;<TT>mod_private</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc48">A.11&nbsp;&nbsp;<TT>mod_pubsub</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc49">A.12&nbsp;&nbsp;<TT>mod_register</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc50">A.13&nbsp;&nbsp;<TT>mod_roster</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc51">A.14&nbsp;&nbsp;<TT>mod_service_log</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc52">A.15&nbsp;&nbsp;<TT>mod_shared_roster</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc53">A.16&nbsp;&nbsp;<TT>mod_stats</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc54">A.17&nbsp;&nbsp;<TT>mod_time</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc55">A.18&nbsp;&nbsp;<TT>mod_vcard</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc56">A.19&nbsp;&nbsp;<TT>mod_version</TT></A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc57">B&nbsp;&nbsp;Internationalization and Localization</A>
<LI CLASS="li-toc"><A HREF="#htoc58">C&nbsp;&nbsp;Release Notes</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc59">C.1&nbsp;&nbsp;ejabberd 0.9</A>
<LI CLASS="li-toc"><A HREF="#htoc60">C.2&nbsp;&nbsp;ejabberd 0.9.1</A>
<LI CLASS="li-toc"><A HREF="#htoc61">C.3&nbsp;&nbsp;ejabberd 0.9.8</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc62">D&nbsp;&nbsp;Acknowledgements</A>
</UL>
<!--TOC section Introduction-->
<H2 CLASS="section"><A NAME="htoc1">1</A>&nbsp;&nbsp;Introduction</H2><!--SEC END -->
<A NAME="sec:intr"></A>
<TT>ejabberd</TT> is a free (GPL) distributed fault-tolerant Jabber/XMPP server and is mainly written in <A HREF="http://www.erlang.org/">Erlang</A>.<BR>
<BR>
<TT>ejabberd</TT> is designed to be a stable, standards compliant, and feature rich Jabber/XMPP server.<BR>
<BR>
<TT>ejabberd</TT> is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.<BR>
<BR>
<!--TOC subsection Key Features-->
<H3 CLASS="subsection"><A NAME="htoc2">1.1</A>&nbsp;&nbsp;Key Features</H3><!--SEC END -->
<A NAME="sec:keyfeatures"></A>
<TT>ejabberd</TT> is:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Multiplatform: <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.<BR>
<BR>
<LI CLASS="li-itemize">Distributed: You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve one Jabber domain. 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.<BR>
<BR>
<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 &#8220;on the fly&#8221;.<BR>
<BR>
<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">
Comprehensive documentation.
<LI CLASS="li-itemize">Straightforward installers for Windows and Linux.
<LI CLASS="li-itemize">Web interface for administration tasks.
<LI CLASS="li-itemize">Shared Roster groups.
<LI CLASS="li-itemize">Command line administration tool.
<LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
<LI CLASS="li-itemize">Capability to send announce messages.
</UL><BR>
<BR>
<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 in 11 languages.
<LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
</UL><BR>
<BR>
<LI CLASS="li-itemize">Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
<UL CLASS="itemize"><LI CLASS="li-itemize">
Fully XMPP compliant
<LI CLASS="li-itemize">XML-based protocol
<LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many JEPs supported</A>.
</UL></UL>
<!--TOC subsection Additional Features-->
<H3 CLASS="subsection"><A NAME="htoc3">1.2</A>&nbsp;&nbsp;Additional Features</H3><!--SEC END -->
<A NAME="sec:addfeatures"></A>
Besides common Jabber server features, <TT>ejabberd</TT> comes with a wide range of other features:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Modular: <TT>ejabberd</TT>'s modular architecture allows easy customization:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Load only the modules you want.
<LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
</UL>
<LI CLASS="li-itemize">Security
<UL CLASS="itemize"><LI CLASS="li-itemize">
SASL and STARTTLS for c2s and s2s connections.
<LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
<LI CLASS="li-itemize">Obsolete SSL for c2s connections also supported.
<LI CLASS="li-itemize">Web interface accessible via HTTPS secure access.
</UL>
<LI CLASS="li-itemize">Databases
<UL CLASS="itemize"><LI CLASS="li-itemize">
Native PostgreSQL support.
<LI CLASS="li-itemize">Mnesia.
<LI CLASS="li-itemize">ODBC data storage support.
</UL>
<LI CLASS="li-itemize">Authentication
<UL CLASS="itemize"><LI CLASS="li-itemize">
LDAP.
<LI CLASS="li-itemize">External Authentication script.
<LI CLASS="li-itemize">Internal Authentication.
</UL>
<LI CLASS="li-itemize">The ability to interface via external components with networks such as:
<UL CLASS="itemize"><LI CLASS="li-itemize">
AIM
<LI CLASS="li-itemize">ICQ
<LI CLASS="li-itemize">MSN
</UL>
<LI CLASS="li-itemize">Others
<UL CLASS="itemize"><LI CLASS="li-itemize">
IPv6 support both for c2s and s2s connections.
<LI CLASS="li-itemize">Support for virtual hosting.
<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> service
<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0045.html">Multi-User Chat</A> module.
<LI CLASS="li-itemize">IRC transport.
<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0060.html">Publish-Subscribe</A> component.
<LI CLASS="li-itemize">Users Directory based on users vCards.
<LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A>).
</UL>
</UL>
<!--TOC section Installation from Source-->
<H2 CLASS="section"><A NAME="htoc4">2</A>&nbsp;&nbsp;Installation from Source</H2><!--SEC END -->
<A NAME="sec:installation"></A>
<!--TOC subsection Installation Requirements-->
<H3 CLASS="subsection"><A NAME="htoc5">2.1</A>&nbsp;&nbsp;Installation Requirements</H3><!--SEC END -->
<A NAME="sec:installreq"></A>
<!--TOC subsubsection &#8220;Unix-like&#8221; operating systems-->
<H4 CLASS="subsubsection"><A NAME="htoc6">2.1.1</A>&nbsp;&nbsp;&#8220;Unix-like&#8221; operating systems</H4><!--SEC END -->
<A NAME="sec:installrequnix"></A>
To compile <TT>ejabberd</TT> on a &#8220;Unix-like&#8221; operating system, you need:
<UL CLASS="itemize"><LI CLASS="li-itemize">
GNU Make;
<LI CLASS="li-itemize">GCC;
<LI CLASS="li-itemize">libexpat 1.95 or higher;
<LI CLASS="li-itemize">Erlang/OTP R8B or higher;
<LI CLASS="li-itemize">OpenSSL 0.9.6 or higher (optional).
</UL>
<!--TOC subsubsection Windows-->
<H4 CLASS="subsubsection"><A NAME="htoc7">2.1.2</A>&nbsp;&nbsp;Windows</H4><!--SEC END -->
<A NAME="sec:installreqwin"></A>
To compile <TT>ejabberd</TT> on a Windows flavour, you need:
<UL CLASS="itemize"><LI CLASS="li-itemize">
MS Visual C++ 6.0 Compiler
<LI CLASS="li-itemize"><A HREF="http://erlang.org/download.html">Erlang/OTP R8B or higher</A>
<LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 1.95.7 or higher</A>
<LI CLASS="li-itemize"><A HREF="http://www.gnu.org/software/libiconv/">Iconv 1.9.1</A>
(optional)
<LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL</A>
(to enable SSL connections)
</UL>
<!--TOC subsection Obtaining <TT>ejabberd</TT>-->
<H3 CLASS="subsection"><A NAME="htoc8">2.2</A>&nbsp;&nbsp;Obtaining <TT>ejabberd</TT></H3><!--SEC END -->
<A NAME="sec:obtaining"></A>
Released versions of <TT>ejabberd</TT> can be obtained from <BR>
<A HREF="http://www.process-one.net/en/projects/ejabberd/download.html"><TT>http://www.process-one.net/en/projects/ejabberd/download.html</TT></A>.<BR>
<BR>
The latest development version can be retrieved from the Subversion repository.
<PRE CLASS="verbatim">
svn co http://svn.process-one.net/ejabberd/trunk ejabberd
</PRE>
<!--TOC subsection Compilation-->
<H3 CLASS="subsection"><A NAME="htoc9">2.3</A>&nbsp;&nbsp;Compilation</H3><!--SEC END -->
<A NAME="sec:compilation"></A>
<!--TOC subsubsection &#8220;Unix-like&#8221; operating systems-->
<H4 CLASS="subsubsection"><A NAME="htoc10">2.3.1</A>&nbsp;&nbsp;&#8220;Unix-like&#8221; operating systems</H4><!--SEC END -->
<A NAME="sec:compilationunix"></A>
Compile <TT>ejabberd</TT> on a &#8220;Unix-like&#8221; operating system by executing:
<PRE CLASS="verbatim">
./configure
make
su
make install
</PRE>
These commands will:
<UL CLASS="itemize"><LI CLASS="li-itemize">
install <TT>ejabberd</TT> into the directory <CODE>/var/lib/ejabberd</CODE>,
<LI CLASS="li-itemize">install the configuration file into <CODE>/etc/ejabberd</CODE>,
<LI CLASS="li-itemize">create a directory called <CODE>/var/log/ejabberd</CODE> to store log files.
</UL>
<!--TOC subsubsection Windows-->
<H4 CLASS="subsubsection"><A NAME="htoc11">2.3.2</A>&nbsp;&nbsp;Windows</H4><!--SEC END -->
<A NAME="sec:compilationwin"></A>
<UL CLASS="itemize"><LI CLASS="li-itemize">
Install Erlang emulator (for example, into <CODE>C:\Program Files\erl5.3</CODE>).
<LI CLASS="li-itemize">Install Expat library into <CODE>C:\Program Files\Expat-1.95.7</CODE>
directory.<BR>
<BR>
Copy file <CODE>C:\Program Files\Expat-1.95.7\Libs\libexpat.dll</CODE>
to your Windows system directory (for example, <CODE>C:\WINNT</CODE> or
<CODE>C:\WINNT\System32</CODE>)
<LI CLASS="li-itemize">Build and install the Iconv library into the directory
<CODE>C:\Program Files\iconv-1.9.1</CODE>.<BR>
<BR>
Copy file <CODE>C:\Program Files\iconv-1.9.1\bin\iconv.dll</CODE> to your
Windows system directory (more installation instructions can be found in the
file README.woe32 in the iconv distribution).<BR>
<BR>
Note: instead of copying libexpat.dll and iconv.dll to the Windows
directory, you can add the directories
<CODE>C:\Program Files\Expat-1.95.7\Libs</CODE> and
<CODE>C:\Program Files\iconv-1.9.1\bin</CODE> to the <CODE>PATH</CODE> environment
variable.
<LI CLASS="li-itemize">While in the directory <CODE>ejabberd\src</CODE> run:
<PRE CLASS="verbatim">
configure.bat
nmake -f Makefile.win32
</PRE><LI CLASS="li-itemize">Edit the file <CODE>ejabberd\src\ejabberd.cfg</CODE> and run
<PRE CLASS="verbatim">
werl -s ejabberd -name ejabberd
</PRE></UL>
<!--TOC subsection Starting-->
<H3 CLASS="subsection"><A NAME="htoc12">2.4</A>&nbsp;&nbsp;Starting</H3><!--SEC END -->
<A NAME="sec:starting"></A>
Execute the following command to start <TT>ejabberd</TT>:
<PRE CLASS="verbatim">
erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd
</PRE>or
<PRE CLASS="verbatim">
erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
</PRE>In the latter case the Erlang node will be identified using only the first part
of the host name, i.&nbsp;e. other Erlang nodes outside this domain can't contact
this node.<BR>
<BR>
Note that when using the above command, <TT>ejabberd</TT> will search for the
configuration file in the current directory and will use the current directory
for storing its user database and for logging.<BR>
<BR>
To specify the path to the configuration file, the log files and the Mnesia
database directory, you may use the following command:
<PRE CLASS="verbatim">
erl -pa /var/lib/ejabberd/ebin \
-sname ejabberd \
-s ejabberd \
-ejabberd config \"/etc/ejabberd/ejabberd.cfg\" \
log_path \"/var/log/ejabberd/ejabberd.log\" \
-sasl sasl_error_logger \{file,\"/var/log/ejabberd/sasl.log\"\} \
-mnesia dir \"/var/lib/ejabberd/spool\"
</PRE>
You can find other useful options in the Erlang manual page
(<TT>erl -man erl</TT>).<BR>
<BR>
To use more than 1024 connections, you should set the environment variable
<CODE>ERL_MAX_PORTS</CODE>:
<PRE CLASS="verbatim">
export ERL_MAX_PORTS=32000
</PRE>Note that with this value, <TT>ejabberd</TT> will use more memory (approximately 6&nbsp;MB
more).<BR>
<BR>
To reduce memory usage, you may set the environment variable
<CODE>ERL_FULLSWEEP_AFTER</CODE>:
<PRE CLASS="verbatim">
export ERL_FULLSWEEP_AFTER=0
</PRE>But in this case <TT>ejabberd</TT> can start to work slower.<BR>
<BR>
<!--TOC section Configuration-->
<H2 CLASS="section"><A NAME="htoc13">3</A>&nbsp;&nbsp;Configuration</H2><!--SEC END -->
<A NAME="sec:configuration"></A>
<!--TOC subsection Initial Configuration-->
<H3 CLASS="subsection"><A NAME="htoc14">3.1</A>&nbsp;&nbsp;Initial Configuration</H3><!--SEC END -->
<A NAME="sec:initconfig"></A>
The configuration file will be loaded the first time you start <TT>ejabberd</TT>. The
content from this file will be parsed and stored in a database. Subsequently the
configuration will be loaded from the database and any commands in the
configuration file are appended to the entries in the database. The
configuration file contains a sequence of Erlang terms. Lines beginning with a
<TT>`%'</TT> sign are ignored. Each term is a tuple of which the first element is
the name of an option, and any further elements are that option's values. If the
configuration file do not contain for instance the &#8220;hosts&#8221; option, the old
host name(s) stored in the database will be used.<BR>
<BR>
You can override the old values stored in the database by adding next lines to
the configuration file:
<PRE CLASS="verbatim">
override_global.
override_local.
override_acls.
</PRE>With these lines the old global options, local options and ACLs will be removed
before new ones are added.<BR>
<BR>
<!--TOC subsubsection Host Names-->
<H4 CLASS="subsubsection"><A NAME="htoc15">3.1.1</A>&nbsp;&nbsp;Host Names</H4><!--SEC END -->
<A NAME="sec:confighostname"></A>
The option <TT>hosts</TT> defines a list containing one or more domains that
<TT>ejabberd</TT> will serve.<BR>
<BR>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Serving one domain:
<UL CLASS="itemize"><LI CLASS="li-itemize">
<PRE CLASS="verbatim">
{hosts, ["example.org"]}.
</PRE><LI CLASS="li-itemize">Backwards compatibility with older <TT>ejabberd</TT> versions can be retained
with:
<PRE CLASS="verbatim">
{host, "example.org"}.
</PRE></UL>
<LI CLASS="li-itemize">Serving two domains:
<PRE CLASS="verbatim">
{hosts, ["one.org", "two.org"]}.
</PRE></UL>
<!--TOC subsubsection Default Language-->
<H4 CLASS="subsubsection"><A NAME="htoc16">3.1.2</A>&nbsp;&nbsp;Default Language</H4><!--SEC END -->
<A NAME="sec:configlanguage"></A>
The option <TT>language</TT> defines the default language of server strings that
can be seen by Jabber clients. If a Jabber client do not support
<TT>xml:lang</TT>, the specified language is used. The default value for the
option <TT>language</TT> is <TT>"en"</TT>. In order to take effect there must be a
translation file <TT>&lt;language&gt;.msg</TT> in <TT>ejabberd</TT>'s <TT>msgs</TT> directory.<BR>
<BR>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
To set Russian as default language:
<PRE CLASS="verbatim">
{language, "ru"}.
</PRE><LI CLASS="li-itemize">To set Spanish as default language:
<PRE CLASS="verbatim">
{language, "es"}.
</PRE></UL>
<!--TOC subsubsection Access Rules-->
<H4 CLASS="subsubsection"><A NAME="htoc17">3.1.3</A>&nbsp;&nbsp;Access Rules</H4><!--SEC END -->
<A NAME="sec:configaccess"></A>
Access control in <TT>ejabberd</TT> is performed via Access Control Lists (ACLs). The
declarations of ACLs in the configuration file have the following syntax:
<PRE CLASS="verbatim">
{acl, &lt;aclname&gt;, {&lt;acltype&gt;, ...}}.
</PRE>
<TT>&lt;acltype&gt;</TT> can be one of the following:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>all</TT></B><DD CLASS="dd-description"> Matches all JIDs. Example:
<PRE CLASS="verbatim">
{acl, all, all}.
</PRE><DT CLASS="dt-description"><B><TT>{user, &lt;username&gt;}</TT></B><DD CLASS="dd-description"> Matches the user with the name
<TT>&lt;username&gt;</TT> at the first virtual host. Example:
<PRE CLASS="verbatim">
{acl, admin, {user, "yozhik"}}.
</PRE><DT CLASS="dt-description"><B><TT>{user, &lt;username&gt;, &lt;server&gt;}</TT></B><DD CLASS="dd-description"> Matches the user with the JID
<TT>&lt;username&gt;@&lt;server&gt;</TT> and any resource. Example:
<PRE CLASS="verbatim">
{acl, admin, {user, "yozhik", "example.org"}}.
</PRE><DT CLASS="dt-description"><B><TT>{server, &lt;server&gt;}</TT></B><DD CLASS="dd-description"> Matches any JID from server
<TT>&lt;server&gt;</TT>. Example:
<PRE CLASS="verbatim">
{acl, exampleorg, {server, "example.org"}}.
</PRE><DT CLASS="dt-description"><B><TT>{user_regexp, &lt;regexp&gt;}</TT></B><DD CLASS="dd-description"> Matches any local user with a name that
matches <TT>&lt;regexp&gt;</TT> at the first virtual host. Example:
<PRE CLASS="verbatim">
{acl, tests, {user, "^test[0-9]*$"}}.
</PRE><DT CLASS="dt-description"><B><TT>{user_regexp, &lt;regexp&gt;, &lt;server&gt;}</TT></B><DD CLASS="dd-description"> Matches any user with a name
that matches <TT>&lt;regexp&gt;</TT> at server <TT>&lt;server&gt;</TT>. Example:
<PRE CLASS="verbatim">
{acl, tests, {user, "^test", "example.org"}}.
</PRE><DT CLASS="dt-description"><B><TT>{server_regexp, &lt;regexp&gt;}</TT></B><DD CLASS="dd-description"> Matches any JID from the server that
matches <TT>&lt;regexp&gt;</TT>. Example:
<PRE CLASS="verbatim">
{acl, icq, {server, "^icq\\."}}.
</PRE><DT CLASS="dt-description"><B><TT>{node_regexp, &lt;user_regexp&gt;, &lt;server_regexp&gt;}</TT></B><DD CLASS="dd-description"> Matches any user
with a name that matches <TT>&lt;user_regexp&gt;</TT> at any server that matches
<TT>&lt;server_regexp&gt;</TT>. Example:
<PRE CLASS="verbatim">
{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}.
</PRE><DT CLASS="dt-description"><B><TT>{user_glob, &lt;glob&gt;}</TT></B><DD CLASS="dd-description">
<DT CLASS="dt-description"><B><TT>{user_glob, &lt;glob&gt;, &lt;server&gt;}</TT></B><DD CLASS="dd-description">
<DT CLASS="dt-description"><B><TT>{server_glob, &lt;glob&gt;}</TT></B><DD CLASS="dd-description">
<DT CLASS="dt-description"><B><TT>{node_glob, &lt;user_glob&gt;, &lt;server_glob&gt;}</TT></B><DD CLASS="dd-description"> This is the same as
above. However, it uses shell glob patterns instead of regexp. These patterns
can have the following special characters:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>*</TT></B><DD CLASS="dd-description"> matches any string including the null string.
<DT CLASS="dt-description"><B><TT>?</TT></B><DD CLASS="dd-description"> matches any single character.
<DT CLASS="dt-description"><B><TT>[...]</TT></B><DD CLASS="dd-description"> matches any of the enclosed characters. Character
ranges are specified by a pair of characters separated by a <TT>`-'</TT>.
If the first character after <TT>`['</TT> is a <TT>`!'</TT>, any
character not enclosed is matched.
</DL>
</DL>
The following ACLs are pre-defined:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>all</TT></B><DD CLASS="dd-description"> Matches any JID.
<DT CLASS="dt-description"><B><TT>none</TT></B><DD CLASS="dd-description"> Matches no JID.
</DL>
An entry allowing or denying access to different services looks similar to
this:
<PRE CLASS="verbatim">
{access, &lt;accessname&gt;, [{allow, &lt;aclname&gt;},
{deny, &lt;aclname&gt;},
...
]}.
</PRE>When a JID is checked to have access to <TT>&lt;accessname&gt;</TT>, the server
sequentially checks if that JID mathes any of the ACLs that are named in the
second elements of the tuples in the list. If it matches, the first element of
the first matched tuple is returned, otherwise &#8220;<TT>deny</TT>&#8221; is returned.<BR>
<BR>
Example:
<PRE CLASS="verbatim">
{access, configure, [{allow, admin}]}.
{access, something, [{deny, badmans},
{allow, all}]}.
</PRE>
The following access rules are pre-defined:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>all</TT></B><DD CLASS="dd-description"> Always returns &#8220;<TT>allow</TT>&#8221;
<DT CLASS="dt-description"><B><TT>none</TT></B><DD CLASS="dd-description"> Always returns &#8220;<TT>deny</TT>&#8221;
</DL>
<!--TOC subsubsection Shapers-->
<H4 CLASS="subsubsection"><A NAME="htoc18">3.1.4</A>&nbsp;&nbsp;Shapers</H4><!--SEC END -->
<A NAME="sec:configshaper"></A>
Shapers enable you to limit connection traffic. The syntax of
shapers is like this:
<PRE CLASS="verbatim">
{shaper, &lt;shapername&gt;, &lt;kind&gt;}.
</PRE>Currently only one kind of shaper called <TT>maxrate</TT> is available. It has the
following syntax:
<PRE CLASS="verbatim">
{maxrate, &lt;rate&gt;}
</PRE>where <TT>&lt;rate&gt;</TT> stands for the maximum allowed incomig rate in bytes per
second.<BR>
<BR>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
To define a shaper named &#8220;<TT>normal</TT>&#8221; with traffic speed limited to
1,000&nbsp;bytes/second:
<PRE CLASS="verbatim">
{shaper, normal, {maxrate, 1000}}.
</PRE><LI CLASS="li-itemize">To define a shaper named &#8220;<TT>fast</TT>&#8221; with traffic speed limited to
50,000&nbsp;bytes/second:
<PRE CLASS="verbatim">
{shaper, fast, {maxrate, 50000}}.
</PRE></UL>
<!--TOC subsubsection Listened Sockets-->
<H4 CLASS="subsubsection"><A NAME="htoc19">3.1.5</A>&nbsp;&nbsp;Listened Sockets</H4><!--SEC END -->
<A NAME="sec:configlistened"></A>
The option <TT>listen</TT> defines for which addresses and ports <TT>ejabberd</TT>
will listen and what services will be run on them. Each element of the list is a
tuple with the following elements:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Port number.
<LI CLASS="li-itemize">Module that serves this port.
<LI CLASS="li-itemize">Options to this module.
</UL>
Currently next modules are implemented:
<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1>
<TR><TD ALIGN=left NOWRAP><TT>ejabberd_c2s</TT></TD>
<TD ALIGN=left NOWRAP>Description</TD>
<TD ALIGN=left NOWRAP>Handles c2s connections.</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>&nbsp;</TD>
<TD ALIGN=left NOWRAP>Options</TD>
<TD ALIGN=left NOWRAP><TT>access</TT>, <TT>certfile</TT>, <TT>inet6</TT>,
<TT>ip</TT>, <TT>shaper</TT>, <TT>ssl</TT>, <TT>tls</TT>,
<TT>starttls</TT>,</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>&nbsp;</TD>
<TD ALIGN=left NOWRAP>&nbsp;</TD>
<TD ALIGN=left NOWRAP><TT>starttls_required</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>ejabberd_s2s_in</TT></TD>
<TD ALIGN=left NOWRAP>Description</TD>
<TD ALIGN=left NOWRAP>Handles incoming s2s
connections.</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>&nbsp;</TD>
<TD ALIGN=left NOWRAP>Options</TD>
<TD ALIGN=left NOWRAP><TT>inet6</TT>, <TT>ip</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>ejabberd_service</TT></TD>
<TD ALIGN=left NOWRAP>Description</TD>
<TD ALIGN=left NOWRAP>Interacts with external
components (*).</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>&nbsp;</TD>
<TD ALIGN=left NOWRAP>Options</TD>
<TD ALIGN=left NOWRAP><TT>access</TT>, <TT>hosts</TT>, <TT>inet6</TT>,
<TT>ip</TT>, <TT>shaper</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>ejabberd_http</TT></TD>
<TD ALIGN=left NOWRAP>Description</TD>
<TD ALIGN=left NOWRAP>Handles incoming HTTP
connections.</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>&nbsp;</TD>
<TD ALIGN=left NOWRAP>Options</TD>
<TD ALIGN=left NOWRAP><TT>certfile</TT>, <TT>http_poll</TT>,
<TT>inet6</TT>, <TT>ip</TT>, <TT>tls</TT>, <TT>web_admin</TT></TD>
</TR></TABLE>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
(*) The mechanism for <A HREF="http://ejabberd.jabber.ru/tutorials-transports">external components</A> is defined in Jabber Component Protocol (<A HREF="http://www.jabber.org/jeps/jep-0114.html">JEP-0114</A>).<BR>
<BR>
The following options are available:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>{access, &lt;access rule&gt;}</TT></B><DD CLASS="dd-description"> This option defines
access to the port. The default value is &#8220;<TT>all</TT>&#8221;.
<DT CLASS="dt-description"><B><TT>{certfile, Path}</TT></B><DD CLASS="dd-description"> Path to a file containing the SSL certificate.
<DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B><DD CLASS="dd-description"> This option
defines one or more hostnames of connected services and enables you to
specify additional options including <TT>{password, Secret}</TT>.
<DT CLASS="dt-description"><B><TT>http_poll</TT></B><DD CLASS="dd-description">
This option enables HTTP Polling (<A HREF="http://www.jabber.org/jeps/jep-0025.html">JEP-0025</A>) support. HTTP Polling
enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
do not allow outgoing sockets on port 5222.<BR>
<BR>
If HTTP Polling is enabled, it will be available at
<CODE>http://server:port/http-poll/</CODE>. Be aware that support for HTTP Polling
is also needed in the Jabber client. Remark also that HTTP Polling can be
interesting to host a web-based Jabber client such as
<A HREF="http://jwchat.sourceforge.net/">JWChat</A> (there is a tutorial to
<A HREF="http://ejabberd.jabber.ru/jwchat">install JWChat</A> with
instructions for <TT>ejabberd</TT>).
<DT CLASS="dt-description"><B><TT>inet6</TT></B><DD CLASS="dd-description"> Set up the socket for IPv6.
<DT CLASS="dt-description"><B><TT>{ip, IPAddress}</TT></B><DD CLASS="dd-description"> This option specifies which network
interface to listen for. For example <CODE>{ip, {192, 168, 1, 1}}</CODE>.
<DT CLASS="dt-description"><B><TT>{shaper, &lt;access rule&gt;}</TT></B><DD CLASS="dd-description"> This option defines a
shaper for the port (see section&nbsp;<A HREF="#sec:configshaper">3.1.4</A>). The default value
is &#8220;<TT>none</TT>&#8221;.
<DT CLASS="dt-description"><B><TT>ssl</TT></B><DD CLASS="dd-description"> This option specifies that traffic on
the port will be encrypted using SSL. You should also set the
<TT>certfile</TT> option. It is recommended to use the <TT>tls</TT> option
instead.
<DT CLASS="dt-description"><B><TT>starttls</TT></B><DD CLASS="dd-description"> This option
specifies that STARTTLS encryption is available on connections to the port.
You should also set the <TT>certfile</TT> option.
<DT CLASS="dt-description"><B><TT>starttls_required</TT></B><DD CLASS="dd-description"> This option
specifies that STARTTLS encryption is required on connections to the port.
No unencrypted connections will be allowed. You should also set the
<TT>certfile</TT> option.
<DT CLASS="dt-description"><B><TT>tls</TT></B><DD CLASS="dd-description"> This option specifies that traffic on
the port will be encrypted using SSL immediately after connecting. You
should also set the <TT>certfile</TT> option.
<DT CLASS="dt-description"><B><TT>web_admin</TT></B><DD CLASS="dd-description"> This option
enables the web interface for <TT>ejabberd</TT> administration which is available
at <CODE>http://server:port/admin/</CODE>. Login and password are the username and
password of one of the registered users who are granted access by the
&#8220;configure&#8221; access rule.
</DL>
Also the following global options are available for s2s connections:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>{s2s_use_starttls, true|false}</TT></B><DD CLASS="dd-description">
This option defines whether to use STARTTLS
for s2s connections.
<DT CLASS="dt-description"><B><TT>{s2s_certfile, Path}</TT></B><DD CLASS="dd-description"> Path to the
file containing the SSL certificate.
<DT CLASS="dt-description"><B><TT>{domain_certfile, Domain, Path}</TT></B><DD CLASS="dd-description"> Path
to the file containing the SSL certificate for the specified domain.
</DL>
For instance, the following configuration defines that:
<UL CLASS="itemize"><LI CLASS="li-itemize">
c2s connections are listened for on port 5222 and 5223 (SSL) and denied
for the user &#8220;<TT>bad</TT>&#8221;
<LI CLASS="li-itemize">s2s connections are listened for on port 5269 with STARTTLS for secured
traffic enabled.
<LI CLASS="li-itemize">Port 5280 is serving the web interface and the HTTP Polling service. Note
that it is also possible to serve them on different ports. The second
example in section&nbsp;<A HREF="#sec:webadm">3.3.1</A> shows how exactly this can be done.
<LI CLASS="li-itemize">All users except for the administrators have a traffic of limit
1,000&nbsp;Bytes/second
<LI CLASS="li-itemize">The
<A HREF="http://ejabberd.jabber.ru/pyaimt">AIM transport</A>
<TT>aim.example.org</TT> is connected to port 5233 with password
&#8220;<TT>aimsecret</TT>&#8221;
<LI CLASS="li-itemize">The ICQ transport JIT (<TT>icq.example.org</TT> and
<TT>sms.example.org</TT>) is connected to port 5234 with password
&#8220;<TT>jitsecret</TT>&#8221;
<LI CLASS="li-itemize">The
<A HREF="http://ejabberd.jabber.ru/pymsnt">MSN transport</A>
<TT>msn.example.org</TT> is connected to port 5235 with password
&#8220;<TT>msnsecret</TT>&#8221;
<LI CLASS="li-itemize">The
<A HREF="http://ejabberd.jabber.ru/yahoo-transport-2">Yahoo! transport</A>
<TT>yahoo.example.org</TT> is connected to port 5236 with password
&#8220;<TT>yahoosecret</TT>&#8221;
<LI CLASS="li-itemize">The <A HREF="http://ejabberd.jabber.ru/jabber-gg-transport">Gadu-Gadu transport</A> <TT>gg.example.org</TT> is
connected to port 5237 with password &#8220;<TT>ggsecret</TT>&#8221;
<LI CLASS="li-itemize">The
<A HREF="http://ejabberd.jabber.ru/jmc">Jabber Mail Component</A>
<TT>jmc.example.org</TT> is connected to port 5238 with password
&#8220;<TT>jmcsecret</TT>&#8221;
</UL>
<PRE CLASS="verbatim">
{acl, blocked, {user, "bad"}}.
{access, c2s, [{deny, blocked},
{allow, all}]}.
{shaper, normal, {maxrate, 1000}}.
{access, c2s_shaper, [{none, admin},
{normal, all}]}.
{listen,
[{5222, ejabberd_c2s, [{access, c2s}, {shaper, c2s_shaper}]},
{5223, ejabberd_c2s, [{access, c2s},
ssl, {certfile, "/path/to/ssl.pem"}]},
{5269, ejabberd_s2s_in, []},
{5280, ejabberd_http, [http_poll, web_admin]},
{5233, ejabberd_service, [{host, "aim.example.org",
[{password, "aimsecret"}]}]},
{5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
[{password, "jitsecret"}]}]},
{5235, ejabberd_service, [{host, "msn.example.org",
[{password, "msnsecret"}]}]},
{5236, ejabberd_service, [{host, "yahoo.example.org",
[{password, "yahoosecret"}]}]},
{5237, ejabberd_service, [{host, "gg.example.org",
[{password, "ggsecret"}]}]},
{5238, ejabberd_service, [{host, "jmc.example.org",
[{password, "jmcsecret"}]}]}
]
}.
{s2s_use_starttls, true}.
{s2s_certfile, "/path/to/ssl.pem"}.
</PRE>Note, that for jabberd 1.4- or WPJabber-based
services you have to make the transports log and do XDB by themselves:
<PRE CLASS="verbatim">
&lt;!--
You have to add elogger and rlogger entries here when using ejabberd.
In this case the transport will do the logging.
--&gt;
&lt;log id='logger'&gt;
&lt;host/&gt;
&lt;logtype/&gt;
&lt;format&gt;%d: [%t] (%h): %s&lt;/format&gt;
&lt;file&gt;/var/log/jabber/service.log&lt;/file&gt;
&lt;/log&gt;
&lt;!--
Some Jabber server implementations do not provide
XDB services (for example, jabberd2 and ejabberd).
xdb_file.so is loaded in to handle all XDB requests.
--&gt;
&lt;xdb id="xdb"&gt;
&lt;host/&gt;
&lt;load&gt;
&lt;!-- this is a lib of wpjabber or jabberd --&gt;
&lt;xdb_file&gt;/usr/lib/jabber/xdb_file.so&lt;/xdb_file&gt;
&lt;/load&gt;
&lt;xdb_file xmlns="jabber:config:xdb_file"&gt;
&lt;spool&gt;&lt;jabberd:cmdline flag='s'&gt;/var/spool/jabber&lt;/jabberd:cmdline&gt;&lt;/spool&gt;
&lt;/xdb_file&gt;
&lt;/xdb&gt;
</PRE>
<!--TOC subsubsection Modules-->
<H4 CLASS="subsubsection"><A NAME="htoc20">3.1.6</A>&nbsp;&nbsp;Modules</H4><!--SEC END -->
<A NAME="sec:configmodules"></A>
The option <TT>modules</TT> defines the list of modules that will be loaded after
<TT>ejabberd</TT> 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
module. Read section&nbsp;<A HREF="#sec:modules">A</A> for detailed information about each
module.<BR>
<BR>
Example:
<PRE CLASS="verbatim">
{modules,
[{mod_register, []},
{mod_roster, []},
{mod_privacy, []},
{mod_configure, []},
{mod_disco, []},
{mod_stats, []},
{mod_vcard, []},
{mod_offline, []},
{mod_announce, [{access, announce}]},
{mod_echo, [{hosts, ["echo.example.org"]}]},
{mod_private, []},
{mod_irc, []},
{mod_muc, []},
{mod_pubsub, []},
{mod_time, [{iqdisc, no_queue}]},
{mod_last, []},
{mod_version, []}
]}.
</PRE>
<!--TOC subsubsection Virtual Hosting-->
<H4 CLASS="subsubsection"><A NAME="htoc21">3.1.7</A>&nbsp;&nbsp;Virtual Hosting</H4><!--SEC END -->
<A NAME="sec:configvirtualhost"></A>
Options can be defined separately for every virtual host using the
<TT>host_config</TT> option. It has the following
syntax:
<PRE CLASS="verbatim">
{host_config, &lt;hostname&gt;, [&lt;option&gt;, &lt;option&gt;, ...]}.
</PRE>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Domain <TT>one.org</TT> is using the internal authentication method while
domain <TT>two.org</TT> is using the LDAP server running on the domain
<TT>localhost</TT> to perform authentication:
<PRE CLASS="verbatim">
{host_config, "one.org", [{auth_method, internal}]}.
{host_config, "two.org", [{auth_method, ldap},
{ldap_servers, ["localhost"]},
{ldap_uidattr, "uid"},
{ldap_rootdn, "dc=localdomain"},
{ldap_rootdn, "dc=example,dc=com"},
{ldap_password, ""}]}.
</PRE><LI CLASS="li-itemize">Domain <TT>one.org</TT> is using ODBC to perform authentication
while domain <TT>two.org</TT> is using the LDAP servers running on the domains
<TT>localhost</TT> and <TT>otherhost</TT>:
<PRE CLASS="verbatim">
{host_config, "one.org", [{auth_method, odbc},
{odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}.
{host_config, "two.org", [{auth_method, ldap},
{ldap_servers, ["localhost", "otherhost"]},
{ldap_uidattr, "uid"},
{ldap_rootdn, "dc=localdomain"},
{ldap_rootdn, "dc=example,dc=com"},
{ldap_password, ""}]}.
</PRE></UL>
<!--TOC subsection Creating an Initial Administrator-->
<H3 CLASS="subsection"><A NAME="htoc22">3.2</A>&nbsp;&nbsp;Creating an Initial Administrator</H3><!--SEC END -->
<A NAME="sec:initialadmin"></A>
Before the web interface can be entered to perform administration tasks, an
account with administrator rights is needed on your <TT>ejabberd</TT> deployment.<BR>
<BR>
Instructions to create an initial administrator account:
<OL CLASS="enumerate" type=1><LI CLASS="li-enumerate">
Register an account on your <TT>ejabberd</TT> deployment. An account can be
created in two ways:
<OL CLASS="enumerate" type=a><LI CLASS="li-enumerate">
Using the tool <TT>ejabberdctl</TT> (see
section&nbsp;<A HREF="#sec:ejabberdctl">3.3.2</A>):
<PRE CLASS="verbatim">
% ejabberdctl node@host register admin example.org password
</PRE><LI CLASS="li-enumerate">Using In-Band Registration (see section&nbsp;<A HREF="#sec:modregister">A.12</A>): you can
use a Jabber client to register an account.
</OL>
<LI CLASS="li-enumerate">Edit the configuration file to promote the account created in the previous
step to an account with administrator rights. Note that if you want to add
more administrators, a seperate acl entry is needed for each administrator.
<PRE CLASS="verbatim">
{acl, admins, {user, "admin", "example.org"}}.
{access, configure, [{allow, admins}]}.
</PRE><LI CLASS="li-enumerate">Restart <TT>ejabberd</TT> to load the new configuration.
<LI CLASS="li-enumerate">Open the web interface (<CODE>http://server:port/admin/</CODE>) in your
favourite browser. Make sure to enter the <EM>full</EM> JID as username (in this
example: <TT>admin@example.org</TT>. The reason that you also need to enter the
suffix, is because <TT>ejabberd</TT>'s virtual hosting support.
</OL>
<!--TOC subsection Online Configuration and Monitoring-->
<H3 CLASS="subsection"><A NAME="htoc23">3.3</A>&nbsp;&nbsp;Online Configuration and Monitoring</H3><!--SEC END -->
<A NAME="sec:onlineconfig"></A>
<!--TOC subsubsection Web Interface-->
<H4 CLASS="subsubsection"><A NAME="htoc24">3.3.1</A>&nbsp;&nbsp;Web Interface</H4><!--SEC END -->
<A NAME="sec:webadm"></A>
To perform online configuration of <TT>ejabberd</TT> you need to enable the
<TT>ejabberd_http</TT> listener with the option <TT>web_admin</TT> (see
section&nbsp;<A HREF="#sec:configlistened">3.1.5</A>). Then you can open
<CODE>http://server:port/admin/</CODE> in your favourite web browser. You
will be asked to enter the username (the <EM>full</EM> Jabber ID) and password
of an <TT>ejabberd</TT> user with administrator rights. After authentication
you will see a page similar to figure&nbsp;<A HREF="#fig:webadmmain">1</A>.
<BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<IMG SRC="webadmmain.png">
<BR>
<BR>
<DIV CLASS="center">Figure 1: Top page from the web interface</DIV><BR>
<BR>
<A NAME="fig:webadmmain"></A>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
Here you can edit access restrictions, manage users, create backups,
manage the database, enable/disable ports listened for, view server
statistics,...<BR>
<BR>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
You can serve the web interface on the same port as the
HTTP Polling interface. In this example
you should point your web browser to <CODE>http://example.org:5280/admin/</CODE> to
administer all virtual hosts or to
<CODE>http://example.org:5280/admin/server/two.org/</CODE> to administer only the
virtual host <TT>two.org</TT>. Before you get access to the web interface you
need to enter as username, the JID and password from a registered user that is
allowed to configure <TT>ejabberd</TT>. In this example you can enter as username
&#8220;<TT>admin@one.org</TT>&#8221; to administer all virtual hosts (first URL). If you
log in with &#8220;<TT>admin@two.org</TT>&#8221; on<BR>
<CODE>http://example.org:5280/admin/server/two.org/</CODE> you can only administer
the virtual host <TT>two.org</TT>.
<PRE CLASS="verbatim">
...
{acl, admins, {user, "admin", "one.org"}}.
{host_config, "two.org", [{acl, admins, {user, "admin", "two.org"}}]}.
{access, configure, [{allow, admins}]}.
...
{hosts, ["example.org"]}.
...
{listen,
[...
{5280, ejabberd_http, [http_poll, web_admin]},
...
]
}.
</PRE><LI CLASS="li-itemize">For security reasons, you can serve the web interface on a secured
connection, on a port differing from the HTTP Polling interface, and bind it
to the internal LAN IP. The web interface will be accessible by pointing your
web browser to <CODE>https://192.168.1.1:5280/admin/</CODE>:
<PRE CLASS="verbatim">
...
{hosts, ["example.org"]}.
...
{listen,
[...
{5270, ejabberd_http, [http_poll]},
{5280, ejabberd_http, [web_admin, {ip, {192, 168, 1, 1}},
tls, {certfile, "/usr/local/etc/server.pem"}]},
...
]
}.
</PRE></UL>
<!--TOC subsubsection <TT>ejabberdctl</TT>-->
<H4 CLASS="subsubsection"><A NAME="htoc25">3.3.2</A>&nbsp;&nbsp;<TT>ejabberdctl</TT></H4><!--SEC END -->
<A NAME="sec:ejabberdctl"></A>
It is possible to do some administration operations using the command
line tool <TT>ejabberdctl</TT>. You can list all available options by
running <TT>ejabberdctl</TT> without arguments:
<PRE CLASS="verbatim">
% ejabberdctl
Usage: ejabberdctl node command
Available commands:
status get ejabberd status
stop stop ejabberd
restart restart ejabberd
reopen-log reopen log file
register user server password register a user
unregister user server unregister a user
backup file store a database backup to file
restore file restore a database backup from file
install-fallback file install a database fallback from file
dump file dump a database to a text file
load file restore a database from a text file
import-file file import user data from jabberd 1.4 spool file
import-dir dir import user data from jabberd 1.4 spool directory
registered-users list all registered users
delete-expired-messages delete expired offline messages from database
Example:
ejabberdctl ejabberd@host restart
</PRE>
Additional information:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>reopen-log </TT></B><DD CLASS="dd-description"> If you use a tool to rotate logs, you have to configure it
so that this command is executed after each rotation.
<DT CLASS="dt-description"><B><TT>backup, restore, install-fallback, dump, load</TT></B><DD CLASS="dd-description"> You can use these
commands to create and restore backups.
<DT CLASS="dt-description"><B><TT>import-file, import-dir</TT></B><DD CLASS="dd-description">
These options can be used to migrate from other Jabber/XMPP servers. There
exist tutorials to <A HREF="http://ejabberd.jabber.ru/jabberd1-to-ejabberd">migrate from jabberd 1.4</A>
and to <A HREF="http://ejabberd.jabber.ru/jabberd2-to-ejabberd">migrate from jabberd2</A>.
<DT CLASS="dt-description"><B><TT>delete-expired-messages</TT></B><DD CLASS="dd-description"> This option can be used to delete old messages
in offline storage. This might be useful when the number of offline messages
is very high.
</DL>
<!--TOC section Firewall Settings-->
<H2 CLASS="section"><A NAME="htoc26">4</A>&nbsp;&nbsp;Firewall Settings</H2><!--SEC END -->
<A NAME="sec:firewall"></A>
You need to take the following ports in mind when configuring your firewall:
<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1>
<TR><TD ALIGN=left NOWRAP>Port</TD>
<TD ALIGN=left NOWRAP>Description</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>5222</TD>
<TD ALIGN=left NOWRAP>SASL and unencrypted c2s connections.</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>5223</TD>
<TD ALIGN=left NOWRAP>Obsolete SSL c2s connections.</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>5269</TD>
<TD ALIGN=left NOWRAP>s2s connections.</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>4369</TD>
<TD ALIGN=left NOWRAP>Only for clustering (see&nbsp;<A HREF="#sec:clustering">6</A>).</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>port range</TD>
<TD ALIGN=left NOWRAP>Only for clustring (see&nbsp;<A HREF="#sec:clustering">6</A>). This range
is configurable (see&nbsp;<A HREF="#sec:starting">2.4</A>).</TD>
</TR></TABLE>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
<!--TOC section SRV Records-->
<H2 CLASS="section"><A NAME="htoc27">5</A>&nbsp;&nbsp;SRV Records</H2><!--SEC END -->
<A NAME="sec:srv"></A>
<UL CLASS="itemize"><LI CLASS="li-itemize">
General information:
<A HREF="http://en.wikipedia.org/wiki/SRV_record">SRV record</A>
<LI CLASS="li-itemize">Practical information:
<A HREF="http://jabberd.jabberstudio.org/2/docs/section05.html#5_7">Setting DNS SRV Records</A>
</UL>
<!--TOC section Clustering-->
<H2 CLASS="section"><A NAME="htoc28">6</A>&nbsp;&nbsp;Clustering</H2><!--SEC END -->
<A NAME="sec:clustering"></A>
<!--TOC subsection How it Works-->
<H3 CLASS="subsection"><A NAME="htoc29">6.1</A>&nbsp;&nbsp;How it Works</H3><!--SEC END -->
<A NAME="sec:howitworks"></A>
A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
be run on different machines that are connected via a network. They all
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
needed because all nodes exchange information about connected users, s2s
connections, registered services, etc...<BR>
<BR>
Each <TT>ejabberd</TT> node has the following modules:
<UL CLASS="itemize"><LI CLASS="li-itemize">
router,
<LI CLASS="li-itemize">local router,
<LI CLASS="li-itemize">session manager,
<LI CLASS="li-itemize">s2s manager.
</UL>
<!--TOC subsubsection Router-->
<H4 CLASS="subsubsection"><A NAME="htoc30">6.1.1</A>&nbsp;&nbsp;Router</H4><!--SEC END -->
This module is the main router of Jabber packets on each node. It
routes them based on their destination's domains. It uses a global
routing table. The domain of the packet's destination is searched in the
routing table, and if it is found, the packet is routed to the
appropriate process. If not, it is sent to the s2s manager.<BR>
<BR>
<!--TOC subsubsection Local Router-->
<H4 CLASS="subsubsection"><A NAME="htoc31">6.1.2</A>&nbsp;&nbsp;Local Router</H4><!--SEC END -->
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.<BR>
<BR>
<!--TOC subsubsection Session Manager-->
<H4 CLASS="subsubsection"><A NAME="htoc32">6.1.3</A>&nbsp;&nbsp;Session Manager</H4><!--SEC END -->
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.<BR>
<BR>
<!--TOC subsubsection s2s Manager-->
<H4 CLASS="subsubsection"><A NAME="htoc33">6.1.4</A>&nbsp;&nbsp;s2s Manager</H4><!--SEC END -->
This module routes packets to other Jabber servers. First, it
checks if an opened s2s connection from the domain of the packet's
source to the domain of the packet's destination exists. If that is the case,
the s2s manager routes the packet to the process
serving this connection, otherwise a new connection is opened.<BR>
<BR>
<!--TOC subsection Clustering Setup-->
<H3 CLASS="subsection"><A NAME="htoc34">6.2</A>&nbsp;&nbsp;Clustering Setup</H3><!--SEC END -->
<A NAME="sec:cluster"></A>
Suppose you already configured <TT>ejabberd</TT> on one machine named (<TT>first</TT>),
and you need to setup another one to make an <TT>ejabberd</TT> cluster. Then do
following steps:
<OL CLASS="enumerate" type=1><LI CLASS="li-enumerate">
Copy <CODE>~ejabberd/.erlang.cookie</CODE> file from <TT>first</TT> to
<TT>second</TT>.<BR>
<BR>
(alt) You can also add &#8220;<CODE>-cookie content_of_.erlang.cookie</CODE>&#8221;
option to all &#8220;<TT>erl</TT>&#8221; commands below.<BR>
<BR>
<LI CLASS="li-enumerate">On <TT>second</TT> run as the `<TT>ejabberd</TT>' user in the directory
where <TT>ejabberd</TT> will work later the following command:
<PRE CLASS="verbatim">
erl -sname ejabberd \
-mnesia extra_db_nodes "['ejabberd@first']" \
-s mnesia
</PRE>
This will start Mnesia serving the same database as <TT>ejabberd@first</TT>.
You can check this by running the command &#8220;<CODE>mnesia:info().</CODE>&#8221;. You
should see a lot of remote tables and a line like the following:
<PRE CLASS="verbatim">
running db nodes = [ejabberd@first, ejabberd@second]
</PRE><BR>
<BR>
<LI CLASS="li-enumerate">Now run the following in the same &#8220;<TT>erl</TT>&#8221; session:
<PRE CLASS="verbatim">
mnesia:change_table_copy_type(schema, node(), disc_copies).
</PRE>
This will create local disc storage for the database.<BR>
<BR>
(alt) Change storage type of `<TT>scheme</TT>' table to &#8220;RAM and disc
copy&#8221; on the second node via the web interface.<BR>
<BR>
<LI CLASS="li-enumerate">Now you can add replicas of various tables to this node with
&#8220;<CODE>mnesia:add_table_copy</CODE>&#8221; or
&#8220;<CODE>mnesia:change_table_copy_type</CODE>&#8221; as above (just replace
&#8220;<CODE>schema</CODE>&#8221; with another table name and &#8220;<CODE>disc_copies</CODE>&#8221;
can be replaced with &#8220;<CODE>ram_copies</CODE>&#8221; or
&#8220;<CODE>disc_only_copies</CODE>&#8221;).<BR>
<BR>
Which tables to replicate is very dependant on your needs, you can get
some hints from the command &#8220;<CODE>mnesia:info().</CODE>&#8221;, by looking at the
size of tables and the default storage type for each table on 'first'.<BR>
<BR>
Replicating a table makes lookups in this table faster on this node.
Writing, on the other hand, will be slower. And of course if machine with one
of the replicas is down, other replicas will be used.<BR>
<BR>
Also <A HREF="http://www.erlang.se/doc/doc-5.4.9/lib/mnesia-4.2.2/doc/html/Mnesia_chap5.html#5.3">section 5.3 (Table Fragmentation) of Mnesia User's Guide</A> can be helpful.
<BR>
<BR>
(alt) Same as in previous item, but for other tables.<BR>
<BR>
<LI CLASS="li-enumerate">Run &#8220;<CODE>init:stop().</CODE>&#8221; or just &#8220;<CODE>q().</CODE>&#8221; to exit from
the Erlang shell. This probably can take some time if Mnesia has not yet
transfered and processed all data it needed from <TT>first</TT>.<BR>
<BR>
<LI CLASS="li-enumerate">Now run <TT>ejabberd</TT> on <TT>second</TT> with almost the same config as
on <TT>first</TT> (you probably don't need to duplicate &#8220;<CODE>acl</CODE>&#8221;
and &#8220;<CODE>access</CODE>&#8221; options &mdash; they will be taken from
<TT>first</TT>, and <CODE>mod_muc</CODE> and <CODE>mod_irc</CODE> should be
enabled only on one machine in the cluster).
</OL>
You can repeat these steps for other machines supposed to serve this
domain.<BR>
<BR>
<!--TOC section Built-in Modules-->
<H2 CLASS="section"><A NAME="htoc35">A</A>&nbsp;&nbsp;Built-in Modules</H2><!--SEC END -->
<A NAME="sec:modules"></A>
<!--TOC subsection Common Options-->
<H3 CLASS="subsection"><A NAME="htoc36">A.1</A>&nbsp;&nbsp;Common Options</H3><!--SEC END -->
<A NAME="sec:modcommonopts"></A>
The following options are used by many modules. Therefore, they are described in
this separate section.<BR>
<BR>
<!--TOC subsubsection <TT>iqdisc</TT>-->
<H4 CLASS="subsubsection"><A NAME="htoc37">A.1.1</A>&nbsp;&nbsp;<TT>iqdisc</TT></H4><!--SEC END -->
<A NAME="sec:modiqdiscoption"></A>
Many modules define handlers for processing IQ queries of different namespaces
to this server or to a user (e.&nbsp;g. to <TT>example.org</TT> or to
<TT>user@example.org</TT>). This option defines processing discipline for
these queries. Possible values are:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>no_queue</TT></B><DD CLASS="dd-description"> All queries of a namespace with this processing discipline are
processed immediately. This also means that no other packets can be processed
until this one has been completely processed. Hence this discipline is not
recommended if the processing of a query can take a relatively long time.
<DT CLASS="dt-description"><B><TT>one_queue</TT></B><DD CLASS="dd-description"> In this case a separate queue is created for the processing
of IQ queries of a namespace with this discipline. In addition, the processing
of this queue is done in parallel with that of other packets. This discipline
is most recommended.
<DT CLASS="dt-description"><B><TT>parallel</TT></B><DD CLASS="dd-description"> For every packet with this discipline a separate Erlang process
is spawned. Consequently, all these packets are processed in parallel.
Although spawning of Erlang process has a relatively low cost, this can break
the server's normal work, because the Erlang emulator has a limit on the
number of processes (32000 by default).
</DL>
Example:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_time, [{iqdisc, no_queue}]},
...
]}.
</PRE>
<!--TOC subsubsection <TT>hosts</TT>-->
<H4 CLASS="subsubsection"><A NAME="htoc38">A.1.2</A>&nbsp;&nbsp;<TT>hosts</TT></H4><!--SEC END -->
<A NAME="sec:modhostsoption"></A>
A module acting as a service can have one or more hostnames. These hostnames
can be defined with the <TT>hosts</TT> option.<BR>
<BR>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Serving the echo module on one domain:
<UL CLASS="itemize"><LI CLASS="li-itemize">
<PRE CLASS="verbatim">
{modules,
[
...
{mod_echo, [{hosts, ["echo.example.org"]}]},
...
]}.
</PRE><LI CLASS="li-itemize">Backwards compatibility with older ejabberd versions can be retained
with:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_echo, [{host, "echo.example.org"}]},
...
]}.
</PRE></UL>
<LI CLASS="li-itemize">Serving the echo module on tho domains:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_echo, [{hosts, ["echo.one.org", "echo.two.org"]}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_announce</TT>-->
<H3 CLASS="subsection"><A NAME="htoc39">A.2</A>&nbsp;&nbsp;<TT>mod_announce</TT></H3><!--SEC END -->
<A NAME="sec:modannounce"></A>
This module enables configured users to broadcast announcements and to set
the message of the day (MOTD). Configured users can do these actions with their
Jabber client by sending messages to specific JIDs. These JIDs are listed in
next paragraph. The first JID in each entry will apply only to the virtual host
<TT>example.org</TT>, while the JID between brackets will apply to all virtual
hosts:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B><DD CLASS="dd-description"> The
message is sent to all registered users. If the user is online and connected
to several resources, only the resource with the highest priority will receive
the message. If the registered user is not connected, the message will be
stored offline in assumption that offline storage
(see section&nbsp;<A HREF="#sec:modoffline">A.8</A>) is enabled.
<DT CLASS="dt-description"><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B><DD CLASS="dd-description">The
message is sent to all connected users. If the user is online and connected
to several resources, all resources will receive the message.
<DT CLASS="dt-description"><B><TT>example.org/announce/motd (example.org/announce/all-hosts/motd)</TT></B><DD CLASS="dd-description">The
message is set as the message of the day (MOTD) and is sent to users when they
login. In addition the message is sent to all connected users (similar to
<TT>announce/online</TT>).
<DT CLASS="dt-description"><B><TT>example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)</TT></B><DD CLASS="dd-description">
The message is set as message of the day (MOTD) and is sent to users when they
login. The message is <EM>not sent</EM> to any currently connected user.
<DT CLASS="dt-description"><B><TT>example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)</TT></B><DD CLASS="dd-description">
Any message sent to this JID removes the existing message of the day (MOTD).
</DL>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>access</TT></B><DD CLASS="dd-description"> This option specifies who is allowed to
send announcements and to set the message of the day (by default, nobody is
able to send such messages).
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Only administrators can send announcements:
<PRE CLASS="verbatim">
{access, announce, [{allow, admins}]}.
{modules,
[
...
{mod_announce, [{access, announce}]},
...
]}.
</PRE><LI CLASS="li-itemize">Administrators as well as the direction can send announcements:
<PRE CLASS="verbatim">
{acl, direction, {user, "big_boss", "example.org"}}.
{acl, direction, {user, "assistant", "example.org"}}.
{acl, admins, {user, "admin", "example.org"}}.
...
{access, announce, [{allow, admins},
{allow, direction}]}.
...
{modules,
[
...
{mod_announce, [{access, announce}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_disco</TT>-->
<H3 CLASS="subsection"><A NAME="htoc40">A.3</A>&nbsp;&nbsp;<TT>mod_disco</TT></H3><!--SEC END -->
<A NAME="sec:moddisco"></A>
This module adds support for Service Discovery (<A HREF="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</A>). With
this module enabled, services on your server can be discovered by
Jabber clients. Note that <TT>ejabberd</TT> has no modules with support
for the superseded Jabber Browsing (<A HREF="http://www.jabber.org/jeps/jep-0011.html">JEP-0011</A>) and Agent Information
(<A HREF="http://www.jabber.org/jeps/jep-0094.html">JEP-0094</A>). Accordingly, Jabber clients need to have support for
the newer Service Discovery protocol if you want them be able to discover
the services you offer.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Service Discovery (<TT>http://jabber.org/protocol/disco#items</TT> and
<TT>http://jabber.org/protocol/disco#info</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
<DT CLASS="dt-description"><B><TT>extra_domains</TT></B><DD CLASS="dd-description"> With this option,
extra domains can be added to the Service Discovery item list.
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
To serve a link to the Jabber User Directory on <TT>jabber.org</TT>:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_disco, [{extra_domains, ["users.jabber.org"]}]},
...
]}.
</PRE><LI CLASS="li-itemize">To serve a link to the transports on another server:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_disco, [{extra_domains, ["icq.example.com",
"msn.example.com"]}]},
...
]}.
</PRE><LI CLASS="li-itemize">To serve a link to a few friendly servers:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_disco, [{extra_domains, ["example.org",
"example.com"]}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_echo</TT>-->
<H3 CLASS="subsection"><A NAME="htoc41">A.4</A>&nbsp;&nbsp;<TT>mod_echo</TT></H3><!--SEC END -->
<A NAME="sec:modecho"></A>
This module simply echoes any Jabber
packet back to the sender. This mirror can be of interest for
<TT>ejabberd</TT> and Jabber client debugging.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the
service (see section&nbsp;<A HREF="#sec:modhostsoption">A.1.2</A>). If neither <TT>hosts</TT> nor
the old <TT>host</TT> is present, the prefix &#8220;<TT>echo.</TT>&#8221; is added to all
<TT>ejabberd</TT> hostnames.
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Mirror, mirror, on the wall, who is the most beautiful
of them all?
<PRE CLASS="verbatim">
{modules,
[
...
{mod_echo, [{hosts, ["mirror.example.org"]}]},
...
]}.
</PRE><LI CLASS="li-itemize">If you still do not understand the inner workings of <TT>mod_echo</TT>,
you can find a few more examples in section&nbsp;<A HREF="#sec:modhostsoption">A.1.2</A>.
</UL>
<!--TOC subsection <TT>mod_irc</TT>-->
<H3 CLASS="subsection"><A NAME="htoc42">A.5</A>&nbsp;&nbsp;<TT>mod_irc</TT></H3><!--SEC END -->
<A NAME="sec:modirc"></A>
This module is an IRC transport that can be used to join channels on IRC
servers.<BR>
<BR>
End user information:
<UL CLASS="itemize"><LI CLASS="li-itemize">
A Jabber client with &#8220;groupchat 1.0&#8221; support or Multi-User
Chat support (<A HREF="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</A>) is necessary to join IRC channels.
<LI CLASS="li-itemize">An IRC channel can be joined in nearly the same way as joining a
Jabber Multi-User Chat room. The difference is that the room name will
be &#8220;channel%<TT>irc.example.org</TT>&#8221; in case <TT>irc.example.org</TT> is
the IRC server hosting &#8220;channel&#8221;. And of course the host should point
to the IRC transport instead of the Multi-User Chat service.
<LI CLASS="li-itemize">You can register your nickame by sending &#8220;IDENTIFY password&#8221; to<BR>
<TT>nickserver!irc.example.org@irc.jabberserver.org</TT>.
<LI CLASS="li-itemize">Entering your password is possible by sending &#8220;LOGIN nick password&#8221;<BR>
to <TT>nickserver!irc.example.org@irc.jabberserver.org</TT>.
<LI CLASS="li-itemize">When using a popular Jabber server, it can occur that no
connection can be achieved with some IRC servers because they limit the
number of conections from one IP.
</UL>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the
service (see section&nbsp;<A HREF="#sec:modhostsoption">A.1.2</A>). If neither <TT>hosts</TT> nor
the old <TT>host</TT> is present, the prefix &#8220;<TT>irc.</TT>&#8221; is added to all
<TT>ejabberd</TT> hostnames.
<DT CLASS="dt-description"><B><TT>access</TT></B><DD CLASS="dd-description"> This option can be used to specify who
may use the IRC transport (default value: <TT>all</TT>).
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
In the first example, the IRC transport is available on (all) your
virtual host(s) with the prefix &#8220;<TT>irc.</TT>&#8221;. Furthermore, anyone is
able to use the transport.
<PRE CLASS="verbatim">
{modules,
[
...
{mod_irc, [{access, all}]},
...
]}.
</PRE><LI CLASS="li-itemize">In next example the IRC transport is available on two virtual hosts
with different prefixes on each host. Moreover, the transport is only
accessible by paying customers registered on our domains and on other servers.
<PRE CLASS="verbatim">
{acl, paying_customers, {user, "customer1", "one.org"}}.
{acl, paying_customers, {user, "customer2", "two.org"}}.
{acl, paying_customers, {user, "customer3", "example.org"}}.
...
{access, paying_customers, [{allow, paying_customers},
{deny, all}]}.
...
{modules,
[
...
{mod_irc, [{access, paying_customers},
{hosts, ["irc.one.org", "irc-transport.two.org"]}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_last</TT>-->
<H3 CLASS="subsection"><A NAME="htoc43">A.6</A>&nbsp;&nbsp;<TT>mod_last</TT></H3><!--SEC END -->
<A NAME="sec:modlast"></A>
This module adds support for Last Activity (<A HREF="http://www.jabber.org/jeps/jep-0012.html">JEP-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
<TT>ejabberd</TT> server.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
<!--TOC subsection <TT>mod_muc</TT>-->
<H3 CLASS="subsection"><A NAME="htoc44">A.7</A>&nbsp;&nbsp;<TT>mod_muc</TT></H3><!--SEC END -->
<A NAME="sec:modmuc"></A>
With this module enabled, your server will support Multi-User Chat
(<A HREF="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</A>). End users will be able to join text conferences. Notice
that this module is not (yet) clusterable.<BR>
<BR>
Some of the features of Multi-User Chat:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Sending private messages to room participants.
<LI CLASS="li-itemize">Inviting users.
<LI CLASS="li-itemize">Setting a conference topic.
<LI CLASS="li-itemize">Creating password protected rooms.
<LI CLASS="li-itemize">Kicking and banning participants.
</UL>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the
service (see section&nbsp;<A HREF="#sec:modhostsoption">A.1.2</A>). If neither <TT>hosts</TT> nor
the old <TT>host</TT> is present, the prefix &#8220;<TT>conference.</TT>&#8221; is added to all
<TT>ejabberd</TT> hostnames.
<DT CLASS="dt-description"><B><TT>access</TT></B><DD CLASS="dd-description"> You can specify who is allowed to use
the Multi-User Chat service (by default, everyone is allowed to use it).
<DT CLASS="dt-description"><B><TT>access_create</TT></B><DD CLASS="dd-description"> To configure who is
allowed to create new rooms at the Multi-User Chat service, this option
can be used (by default, everybody is allowed to create rooms).
<DT CLASS="dt-description"><B><TT>access_admin</TT></B><DD CLASS="dd-description"> This option specifies
who is allowed to administrate the Multi-User Chat service (the default
value is <TT>none</TT>, which means that only the room creator can
administer his room).
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
In the first example everyone is allowed to use the Multi-User Chat
service. Everyone will also be able to create new rooms but only the user
<TT>admin@example.org</TT> is allowed to administrate any room. In this
example he is also a global administrator.
<PRE CLASS="verbatim">
{acl, admins, {user, "admin", "example.org"}}.
...
{access, muc_admins, [{allow, admins}]}.
...
{modules,
[
...
{mod_muc, [{access, all},
{access_create, all},
{access_admin, muc_admins}]},
...
]}.
</PRE><LI CLASS="li-itemize">In the second example the Multi-User Chat service is only accessible by
paying customers registered on our domains and on other servers. Of course
the administrator is also allowed to access rooms. In addition, he is the
only authority able to create and administer rooms.
<PRE CLASS="verbatim">
{acl, paying_customers, {user, "customer1", "one.org"}}.
{acl, paying_customers, {user, "customer2", "two.org"}}.
{acl, paying_customers, {user, "customer3", "example.org"}}.
{acl, admins, {user, "admin", "example.org"}}.
...
{access, muc_admins, [{allow, admins},
{deny, all}]}.
{access, muc_access, [{allow, paying_customers},
{allow, admins},
{deny, all}]}.
...
{modules,
[
...
{mod_muc, [{access, muc_access},
{access_create, muc_admins},
{access_admin, muc_admins}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_offline</TT>-->
<H3 CLASS="subsection"><A NAME="htoc45">A.8</A>&nbsp;&nbsp;<TT>mod_offline</TT></H3><!--SEC END -->
<A NAME="sec:modoffline"></A>
This module implements offline message storage. This means that all messages
sent to an offline user will be stored on the server until that user comes
online again. Thus it is very similar to how email works. Note that
<TT>ejabberdctl</TT> has a command to delete expired messages
(see section&nbsp;<A HREF="#sec:ejabberdctl">3.3.2</A>).<BR>
<BR>
<!--TOC subsection <TT>mod_privacy</TT>-->
<H3 CLASS="subsection"><A NAME="htoc46">A.9</A>&nbsp;&nbsp;<TT>mod_privacy</TT></H3><!--SEC END -->
<A NAME="sec:modprivacy"></A>
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 Jabber client, they will be able to:
<BLOCKQUOTE CLASS="quote">
<UL CLASS="itemize"><LI CLASS="li-itemize">
Retrieving one's privacy lists.
<LI CLASS="li-itemize">Adding, removing, and editing one's privacy lists.
<LI CLASS="li-itemize">Setting, changing, or declining active lists.
<LI CLASS="li-itemize">Setting, changing, or declining the default list (i.e., the list that
is active by default).
<LI CLASS="li-itemize">Allowing or blocking messages based on JID, group, or subscription type
(or globally).
<LI CLASS="li-itemize">Allowing or blocking inbound presence notifications based on JID, group,
or subscription type (or globally).
<LI CLASS="li-itemize">Allowing or blocking outbound presence notifications based on JID, group,
or subscription type (or globally).
<LI CLASS="li-itemize">Allowing or blocking IQ stanzas based on JID, group, or subscription type
(or globally).
<LI CLASS="li-itemize">Allowing or blocking all communications based on JID, group, or
subscription type (or globally).
</UL>
(from <A HREF="http://www.xmpp.org/specs/rfc3921.html#privacy"><TT>http://www.xmpp.org/specs/rfc3921.html#privacy</TT></A>)
</BLOCKQUOTE>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
<!--TOC subsection <TT>mod_private</TT>-->
<H3 CLASS="subsection"><A NAME="htoc47">A.10</A>&nbsp;&nbsp;<TT>mod_private</TT></H3><!--SEC END -->
<A NAME="sec:modprivate"></A>
This module adds support for Private XML Storage (<A HREF="http://www.jabber.org/jeps/jep-0049.html">JEP-0049</A>):
<BLOCKQUOTE CLASS="quote">
Using this method, Jabber entities can store private data on the server and
retrieve it whenever necessary. The data stored might be anything, as long as
it is valid XML. One typical usage for this namespace is the server-side storage
of client-specific preferences; another is Bookmark Storage (<A HREF="http://www.jabber.org/jeps/jep-0048.html">JEP-0048</A>).
</BLOCKQUOTE>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
<!--TOC subsection <TT>mod_pubsub</TT>-->
<H3 CLASS="subsection"><A NAME="htoc48">A.11</A>&nbsp;&nbsp;<TT>mod_pubsub</TT></H3><!--SEC END -->
<A NAME="sec:modpubsub"></A>
This module offers a Publish-Subscribe Service (<A HREF="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</A>).
Publish-Subscribe can be used to develop (examples are taken from the JEP):
<BLOCKQUOTE CLASS="quote">
<UL CLASS="itemize"><LI CLASS="li-itemize">
news feeds and content syndacation,
<LI CLASS="li-itemize">avatar management,
<LI CLASS="li-itemize">shared bookmarks,
<LI CLASS="li-itemize">auction and trading systems,
<LI CLASS="li-itemize">online catalogs,
<LI CLASS="li-itemize">workflow systems,
<LI CLASS="li-itemize">network management systems,
<LI CLASS="li-itemize">NNTP gateways,
<LI CLASS="li-itemize">vCard/profile management,
<LI CLASS="li-itemize">and weblogs.
</UL>
</BLOCKQUOTE>
Another example is <A HREF="http://www.process-one.net/en/projects/j-eai/">J-EAI</A>.
This is an XMPP-based Enterprise Application Integration (EAI) platform (also
known as ESB, the Enterprise Service Bus). The J-EAI project builts upon
<TT>ejabberd</TT>'s codebase and has contributed several features to <TT>mod_pubsub</TT>.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the
service (see section&nbsp;<A HREF="#sec:modhostsoption">A.1.2</A>). If neither <TT>hosts</TT> nor
the old <TT>host</TT> is present, the prefix &#8220;<TT>pubsub.</TT>&#8221; is added to all
<TT>ejabberd</TT> hostnames.
<DT CLASS="dt-description"><B><TT>served_hosts</TT></B><DD CLASS="dd-description"> To specify which hosts needs to
be served, you can use this option. If absent, only the main <TT>ejabberd</TT>
host is served. </DL>
Example:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_pubsub, [{served_hosts, ["example.com",
"example.org"]}]}
...
]}.
</PRE>
<!--TOC subsection <TT>mod_register</TT>-->
<H3 CLASS="subsection"><A NAME="htoc49">A.12</A>&nbsp;&nbsp;<TT>mod_register</TT></H3><!--SEC END -->
<A NAME="sec:modregister"></A>
This module adds support for In-Band Registration (<A HREF="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</A>). This protocol
enables end users to use a Jabber client to:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Register a new account on the server.
<LI CLASS="li-itemize">Change the password from an existing account on the server.
<LI CLASS="li-itemize">Delete an existing account on the server.
</UL>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>access</TT></B><DD CLASS="dd-description"> This option can be configured to specify
rules to restrict registration. If a rule returns &#8220;deny&#8221; on the requested
user name, registration for that user name is dennied. (there are no
restrictions by default).
<DT CLASS="dt-description"><B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for In-Band Registration (<TT>jabber:iq:register</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Next example prohibits the registration of too short account names and of
account names with exotic characters in it:
<PRE CLASS="verbatim">
{acl, shortname, {user_glob, "?"}}.
{acl, shortname, {user_glob, "??"}}.
{acl, strangename, {user_regexp, "^..?$"}}.
...
{access, register, [{deny, shortname},
{deny, strangename},
{allow, all}]}.
...
{modules,
[
...
{mod_register, [{access, register}]},
...
]}.
</PRE><LI CLASS="li-itemize">The in-band registration of new accounts can be prohibited by changing the
<TT>access</TT> option. If you really want to disable all In-Band Registration
functionality, that is changing passwords in-band and deleting accounts
in-band, you have to remove <TT>mod_register</TT> from the modules list. In this
example all In-Band Registration functionality is disabled:
<PRE CLASS="verbatim">
{access, register, [{deny, all}]}.
{modules,
[
...
% {mod_register, [{access, register}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_roster</TT>-->
<H3 CLASS="subsection"><A NAME="htoc50">A.13</A>&nbsp;&nbsp;<TT>mod_roster</TT></H3><!--SEC END -->
<A NAME="sec:modroster"></A>
This module implements roster management as defined in <A HREF="http://www.xmpp.org/specs/rfc3921.html#roster">RFC 3921: XMPP IM</A>.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
<!--TOC subsection <TT>mod_service_log</TT>-->
<H3 CLASS="subsection"><A NAME="htoc51">A.14</A>&nbsp;&nbsp;<TT>mod_service_log</TT></H3><!--SEC END -->
<A NAME="sec:modservicelog"></A>
This module adds support for logging end user packets via a Jabber message
auditing service such as
<A HREF="http://www.funkypenguin.co.za/bandersnatch/">Bandersnatch</A>. All user
packets are encapsulated in a <CODE>&lt;route/&gt;</CODE> element and sent to the specified
service(s).<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>loggers</TT></B><DD CLASS="dd-description"> With this option a (list of) service(s)
that will receive the packets can be specified.
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
To log all end user packets to the Bandersnatch service running on
<TT>bandersnatch.example.com</TT>:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_service_log, [{loggers, ["bandersnatch.example.com"]}]},
...
]}.
</PRE><LI CLASS="li-itemize">To log all end user packets to the Bandersnatch service running on
<TT>bandersnatch.example.com</TT> and the backup service on
<TT>bandersnatch.example.org</TT>:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_service_log, [{loggers, ["bandersnatch.example.com",
"bandersnatch.example.org"]}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_shared_roster</TT>-->
<H3 CLASS="subsection"><A NAME="htoc52">A.15</A>&nbsp;&nbsp;<TT>mod_shared_roster</TT></H3><!--SEC END -->
<A NAME="sec:modsharedroster"></A>
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
manually add all users to their rosters, and that they cannot permanently delete
users from the shared roster groups.<BR>
<BR>
Shared roster groups can be edited <EM>only</EM> via the web interface. Each group
has a unique identification and the following parameters:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B>Name</B><DD CLASS="dd-description"> The name of the group, which will be displayed in the roster.
<DT CLASS="dt-description"><B>Description</B><DD CLASS="dd-description"> The description of the group. This parameter doesn't affect
anything.
<DT CLASS="dt-description"><B>Members</B><DD CLASS="dd-description"> A list of full JIDs of group members, entered one per line in
the web interface.
<DT CLASS="dt-description"><B>Displayed groups</B><DD CLASS="dd-description"> A list of groups that will be in the rosters of this
group's members.
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Take the case of a computer club that wants all its members seeing each
other in their rosters. To achieve this, they need to create a shared roster
group similar to next table:
<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1>
<TR><TD ALIGN=left NOWRAP>Identification</TD>
<TD ALIGN=left NOWRAP>Group `<TT>club_members</TT>'</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Name</TD>
<TD ALIGN=left NOWRAP>Club Members</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Description</TD>
<TD ALIGN=left NOWRAP>Members from the computer club</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Members</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>member1@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>member2@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>member3@example.org</TT></TD>
</TR></TABLE></TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Displayed groups</TD>
<TD ALIGN=left NOWRAP><TT>club_members</TT></TD>
</TR></TABLE>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
<LI CLASS="li-itemize">In another case we have a company which has three divisions: Management,
Marketing and Sales. All group members should see all other members in their
rosters. Additonally, all managers should have all marketing and sales people
in their roster. Simultaneously, all marketeers and the whole sales team
should see all managers. This scenario can be achieved by creating shared
roster groups as shown in the following table:
<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1>
<TR><TD ALIGN=left NOWRAP>Identification</TD>
<TD ALIGN=left NOWRAP>Group `<TT>management</TT>'</TD>
<TD ALIGN=left NOWRAP>Group `<TT>marketing</TT>'</TD>
<TD ALIGN=left NOWRAP>Group `<TT>sales</TT>'</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Name</TD>
<TD ALIGN=left NOWRAP>Management</TD>
<TD ALIGN=left NOWRAP>Marketing</TD>
<TD ALIGN=left NOWRAP>Sales</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Description</TD>
<TD ALIGN=left NOWRAP>&nbsp;</TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Members</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>manager1@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>manager2@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>manager3@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>manager4@example.org</TT></TD>
</TR></TABLE>
</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>marketeer1@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>marketeer2@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>marketeer3@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>marketeer4@example.org</TT></TD>
</TR></TABLE>
</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>saleswoman1@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>salesman1@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>saleswoman2@example.org</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>salesman2@example.org</TT></TD>
</TR></TABLE></TD>
</TR>
<TR><TD ALIGN=left NOWRAP>Displayed groups</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>management</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>marketing</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>sales</TT></TD>
</TR></TABLE>
</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>management</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>marketing</TT></TD>
</TR></TABLE>
</TD>
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
<TR><TD ALIGN=left NOWRAP><TT>management</TT></TD>
</TR>
<TR><TD ALIGN=left NOWRAP><TT>sales</TT></TD>
</TR></TABLE></TD>
</TR></TABLE>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
</UL>
<!--TOC subsection <TT>mod_stats</TT>-->
<H3 CLASS="subsection"><A NAME="htoc53">A.16</A>&nbsp;&nbsp;<TT>mod_stats</TT></H3><!--SEC END -->
<A NAME="sec:modstats"></A>
This module adds support for Statistics Gathering (<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A>). This protocol
allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Total number of registered users on the current virtual host (users/total).
<LI CLASS="li-itemize">Total number of registered users on all virtual hosts (users/all-hosts/total).
<LI CLASS="li-itemize">Total number of online users on the current virtual host (users/online).
<LI CLASS="li-itemize">Total number of online users on all virtual hosts (users/all-hosts/online).
</UL>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Statistics Gathering (<TT>http://jabber.org/protocol/stats</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
As there are only a small amount of clients (for example
<A HREF="http://tkabber.jabber.ru/">Tkabber</A>) and software libraries with
support for this JEP, a few examples are given of the XML you need to send
in order to get the statistics. Here they are:
<UL CLASS="itemize"><LI CLASS="li-itemize">
You can request the number of online users on the current virtual host
(<TT>example.org</TT>) by sending:
<PRE CLASS="verbatim">
&lt;iq to='example.org' type='get'&gt;
&lt;query xmlns='http://jabber.org/protocol/stats'&gt;
&lt;stat name='users/online'/&gt;
&lt;/query&gt;
&lt;/iq&gt;
</PRE><LI CLASS="li-itemize">You can request the total number of registered users on all virtual hosts
by sending:
<PRE CLASS="verbatim">
&lt;iq to='example.org' type='get'&gt;
&lt;query xmlns='http://jabber.org/protocol/stats'&gt;
&lt;stat name='users/all-hosts/total'/&gt;
&lt;/query&gt;
&lt;/iq&gt;
</PRE></UL>
<!--TOC subsection <TT>mod_time</TT>-->
<H3 CLASS="subsection"><A NAME="htoc54">A.17</A>&nbsp;&nbsp;<TT>mod_time</TT></H3><!--SEC END -->
<A NAME="sec:modtime"></A>
This module features support for Entity Time (<A HREF="http://www.jabber.org/jeps/jep-0090.html">JEP-0090</A>). By using this JEP,
you are able to discover the time at another entity's location.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
<!--TOC subsection <TT>mod_vcard</TT>-->
<H3 CLASS="subsection"><A NAME="htoc55">A.18</A>&nbsp;&nbsp;<TT>mod_vcard</TT></H3><!--SEC END -->
<A NAME="sec:modvcard"></A>
This module allows end users to store and retrieve their vCard, and to retrieve
other users vCards, as defined in vcard-temp (<A HREF="http://www.jabber.org/jeps/jep-0054.html">JEP-0054</A>). The module also
implements an uncomplicated Jabber User Directory based on the vCards of
these users. Moreover, it enables the server to send its vCard when queried.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the
service (see section&nbsp;<A HREF="#sec:modhostsoption">A.1.2</A>). If neither <TT>hosts</TT> nor
the old <TT>host</TT> is present, the prefix &#8220;<TT>vjud.</TT>&#8221; is added to all
<TT>ejabberd</TT> hostnames.
<DT CLASS="dt-description"><B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for <TT>vcard-temp</TT> IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
<DT CLASS="dt-description"><B><TT>search</TT></B><DD CLASS="dd-description"> This option specifies whether the search
functionality is enabled (value: <TT>true</TT>) or disabled
(value: <TT>false</TT>). If disabled, the option <TT>hosts</TT> will be
ignored and the Jabber User Directory service will not appear in the
Service Discovery item list. The default value is <TT>true</TT>.
<DT CLASS="dt-description"><B><TT>matches</TT></B><DD CLASS="dd-description"> With this option, the number of reported
search results can be limited. If the option's value is set to <TT>infinity</TT>,
all search results are reported. The default value is <TT>30</TT>.
<DT CLASS="dt-description"><B><TT>allow_return_all</TT></B><DD CLASS="dd-description"> This option enables
you to specify if search operations with empty input fields should return
all users who added some information to their vCard. The default value is
<TT>false</TT>.
<DT CLASS="dt-description"><B><TT>search_all_hosts</TT></B><DD CLASS="dd-description"> If this option is
set to <TT>true</TT>, search operations will apply to all virtual hosts.
Otherwise only the current host will be searched. The default value is
<TT>true</TT>.
</DL>
Examples:
<UL CLASS="itemize"><LI CLASS="li-itemize">
In this first situation, search results are limited to twenty items,
every user who added information to their vCard will be listed when people
do an empty search, and only users from the current host will be returned:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_vcard, [{search, true},
{matches, 20},
{allow_return_all, true},
{search_all_hosts, false}]},
...
]}.
</PRE><LI CLASS="li-itemize">The second situation differs in a way that search results are not limited,
and that all virtual hosts will be searched instead of only the current one:
<PRE CLASS="verbatim">
{modules,
[
...
{mod_vcard, [{search, true},
{matches, infinity},
{allow_return_all, true}]},
...
]}.
</PRE></UL>
<!--TOC subsection <TT>mod_version</TT>-->
<H3 CLASS="subsection"><A NAME="htoc56">A.19</A>&nbsp;&nbsp;<TT>mod_version</TT></H3><!--SEC END -->
<A NAME="sec:modversion"></A>
This module implements Software Version (<A HREF="http://www.jabber.org/jeps/jep-0092.html">JEP-0092</A>). Consequently, it
answers <TT>ejabberd</TT>'s version when queried.<BR>
<BR>
Options:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description">
<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies
the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ queries
(see section&nbsp;<A HREF="#sec:modiqdiscoption">A.1.1</A>).
</DL>
<!--TOC section Internationalization and Localization-->
<H2 CLASS="section"><A NAME="htoc57">B</A>&nbsp;&nbsp;Internationalization and Localization</H2><!--SEC END -->
<A NAME="sec:i18nl10n"></A>
All built-in modules support the <TT>xml:lang</TT> attribute inside IQ queries.
Figure&nbsp;<A HREF="#fig:discorus">2</A>, for example, shows the reply to the following query:
<PRE CLASS="verbatim">
&lt;iq id='5'
to='example.org'
type='get'
xml:lang='ru'&gt;
&lt;query xmlns='http://jabber.org/protocol/disco#items'/&gt;
&lt;/iq&gt;
</PRE>
<BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<IMG SRC="discorus.png">
<BR>
<BR>
<DIV CLASS="center">Figure 2: Service Discovery when <TT>xml:lang='ru'</TT></DIV><BR>
<BR>
<A NAME="fig:discorus"></A>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
The web interface also supports the <CODE>Accept-Language</CODE> HTTP header (compare
figure&nbsp;<A HREF="#fig:webadmmainru">3</A> with figure&nbsp;<A HREF="#fig:webadmmain">1</A>)
<BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
<IMG SRC="webadmmainru.png">
<BR>
<BR>
<DIV CLASS="center">Figure 3: Top page from the web interface with HTTP header
&#8220;Accept-Language: ru&#8221;</DIV><BR>
<BR>
<A NAME="fig:webadmmainru"></A>
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
<!--TOC section Release Notes-->
<H2 CLASS="section"><A NAME="htoc58">C</A>&nbsp;&nbsp;Release Notes</H2><!--SEC END -->
<A NAME="sec:releasenotes"></A>
<!--TOC subsection ejabberd 0.9-->
<H3 CLASS="subsection"><A NAME="htoc59">C.1</A>&nbsp;&nbsp;ejabberd 0.9</H3><!--SEC END -->
<PRE CLASS="verbatim">
Release notes
ejabberd 0.9
This document describes the major new features of and changes to
ejabberd 0.9, compared to latest public release ejabber 0.7.5.
For more detailed information, please refer to ejabberd User
Guide.
Virtual Hosting
ejabberd now can host several domain on the same instance.
This option is enabled by using:
{hosts, ["erlang-projects.org", "erlang-fr.org"]}.
instead of the previous host directive.
Note that you are now using a list of hosts. The main one should
be the first listed. See migration section further in this release
note for details.
Shared Roster
Shared roster is a new feature that allow the ejabberd
administrator to add jabber user that will be present in the
roster of every users on the server.
Shared roster are enabled by adding:
{mod_shared_roster, []}
at the end of your module list in your ejabberd.cfg file.
PostgreSQL (ODBC) support
This feature is experimental and not yet properly documented. This
feature is released for testing purpose.
You need to have Erlang/OTP R10 to compile with ODBC on various
flavour of *nix. You should use Erlang/OTP R10B-4, as this task
has became easier with this release. It comes already build in
Erlang/OTP Microsoft Windows binary.
PostgreSQL support is enabled by using the following module in
ejabberd.cfg instead of their standard counterpart:
mod_last_odbc.erl
mod_offline_odbc.erl
mod_roster_odbc.erl
The database schema is located in the src/odbc/pq.sql file.
Look at the src/ejabberd.cfg.example file for more information on
how to configure ejabberd with odbc support. You can get support
on how to configure ejabberd with a relational database.
Migration from ejabberd 0.7.5
Migration is pretty straightforward as Mnesia database schema
conversions is handled automatically. Remember however that you
must backup your ejabberd database before migration.
Here are the following steps to proceed:
1. Stop your instance of ejabberd.
2. In ejabberd.cfg, define the host lists. Change the host
directive to the hosts one:
Before:
{host, "erlang-projects.org"}.
After:
{hosts, ["erlang-projects.org", "erlang-fr.org"]}.
Note that when you restart the server the existing users will be
affected to the first virtual host, so the order is important. You
should keep the previous hostname as the first virtual host.
3. Restart ejabberd.
Bugfixes
This release contains several bugfixes and architectural changes.
Please refer to the Changelog file supplied with this release for
details of all improvements in the ejabberd code.
</PRE>
<!--TOC subsection ejabberd 0.9.1-->
<H3 CLASS="subsection"><A NAME="htoc60">C.2</A>&nbsp;&nbsp;ejabberd 0.9.1</H3><!--SEC END -->
<PRE CLASS="verbatim">
Release notes
ejabberd 0.9.1
This document describes the main changes from [25]ejabberd 0.9.
The code can be downloaded from the [26]download page.
For more detailed information, please refer to ejabberd [27]User Guide.
Groupchat (Multi-user chat and IRC) improvements
The multi-user chat code has been improved to comply with the latest version
of Jabber Enhancement Proposal 0045.
The IRC (Internet Relay Chat) features now support WHOIS and USERINFO
requests.
Web interface
ejabberd modules management features have been added to the web interface.
They now allow to start or stop extension module without restarting the
ejabberd server.
Publish and subscribe
It is now possible to a subscribe node with a JabberID that includes a
resource.
Translations
A new script has been included to help translate ejabberd into new languages
and maintain existing translations.
As a result, ejabberd is now translating into 10 languages:
* Dutch
* English
* French
* German
* Polish
* Portuguese
* Russian
* Spanish
* Swedish
* Ukrainian
Migration
No changes have been made to the database. No particular conversion steps
are needed. However, you should backup your database before upgrading to a
new ejabberd version.
Bugfixes
This release contains several bugfixes and architectural changes. Please
refer to the Changelog file supplied with this release for details of all
improvements in the ejabberd code.
</PRE>
<!--TOC subsection ejabberd 0.9.8-->
<H3 CLASS="subsection"><A NAME="htoc61">C.3</A>&nbsp;&nbsp;ejabberd 0.9.8</H3><!--SEC END -->
<PRE CLASS="verbatim">
Release notes
ejabberd 0.9.8
2005-08-01
This document describes the main changes in ejabberd 0.9.8. This
version prepares the way for the release of ejabberd 1.0, which
is due later this year.
The code can be downloaded from the Process-one website:
http://www.process-one.net/en/projects/ejabberd/
For more detailed information, please refer to ejabberd User Guide
on the Process-one website:
http://www.process-one.net/en/projects/ejabberd/docs.html
Recent changes include....
Enhanced virtual hosting
Virtual hosting applies to many more setting options and
features and is transparent. Virtual hosting accepts different
parameters for different virtual hosts regarding the following
features: authentication method, access control lists and access
rules, users management, statistics, and shared roster. The web
interface gives access to each virtual host's parameters.
Enhanced Publish-Subscribe module
ejabberd's Publish-Subscribe module integrates enhancements
coming from J-EAI, an XMPP-based integration server built on
ejabberd. ejabberd thus supports Publish-Subscribe node
configuration. It is possible to define nodes that should be
persistent, and the number of items to persist. Besides that, it
is also possible to define various notification parameters, such
as the delivery of the payload with the notifications, and the
notification of subscribers when some changes occur on items.
Other examples are: the maximum size of the items payload, the
subscription approvers, the limitation of the notification to
online users only, etc.
Code reorganisation and update
- The mod_register module has been cleaned up.
- ODBC support has been updated and several bugs have been fixed.
Development API
To ease the work of Jabber/XMPP developers, a filter_packet hook
has been added. As a result it is possible to develop plugins to
filter or modify packets flowing through ejabberd.
Translations
- Translations have been updated to support the new Publish-Subscribe features.
- A new Brazilian Portuguese translation has been contributed.
Web interface
- The CSS stylesheet from the web interface is W3C compliant.
Installers
Installers are provided for Microsoft Windows and Linux/x86. The
Linux installer includes Erlang ASN.1 modules for LDAP
authentication support.
Bugfixes
- This release contains several bugfixes and architectural
changes. Among other bugfixes include improvements in LDAP
authentication. Please refer to the ChangeLog file supplied
with this release regarding all improvements in ejabberd.
References
The ejabberd feature sheet helps comparing with other Jabber/XMPP
servers:
http://www.process-one.net/en/projects/ejabberd/docs/features.pdf
Contributed tutorials of interest are:
- Migration from Jabberd1.4 to ejabberd:
http://ejabberd.jabber.ru/jabberd1-to-ejabberd
- Migration from Jabberd2 to ejabberd:
http://ejabberd.jabber.ru/jabberd2-to-ejabberd
- Transport configuration for connecting to other networks:
http://ejabberd.jabber.ru/tutorials-transports
END
</PRE>
<!--TOC section Acknowledgements-->
<H2 CLASS="section"><A NAME="htoc62">D</A>&nbsp;&nbsp;Acknowledgements</H2><!--SEC END -->
<A NAME="sec:acknowledgements"></A>
Thanks to all people who contributed to this guide:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A>)
<LI CLASS="li-itemize">Florian Zumbiehl (<A HREF="xmpp:florz@florz.de"><TT>xmpp:florz@florz.de</TT></A>)
<LI CLASS="li-itemize">Michael Grigutsch (<A HREF="xmpp:migri@jabber.i-pobox.net"><TT>xmpp:migri@jabber.i-pobox.net</TT></A>)
<LI CLASS="li-itemize">Micka<EFBFBD>l R<>mond (<A HREF="xmpp:mremond@erlang-projects.org"><TT>xmpp:mremond@erlang-projects.org</TT></A>)
<LI CLASS="li-itemize">Sander Devrieze (<A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A>)
<LI CLASS="li-itemize">Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>)
<LI CLASS="li-itemize">Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>)
</UL>
<!--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://pauillac.inria.fr/~maranget/hevea/index.html"><EM>H<FONT SIZE=2><sup>E</sup></FONT>V<FONT SIZE=2><sup>E</sup></FONT>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY>
</HTML>
View Git Blame Copy Permalink