2003-01-23 21:57:55 +01:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
|
|
|
<HTML>
|
|
|
|
|
<HEAD><TITLE>Ejabberd Installation and Operation Guide</TITLE>
|
2003-02-10 15:31:27 +01:00
|
|
|
|
2005-04-18 23:38:05 +02:00
|
|
|
<META http-equiv="Content-Type" content="text/html; charset=ISO8859-1">
|
2005-04-22 18:47:16 +02:00
|
|
|
<META name="GENERATOR" content="hevea 1.07">
|
2003-01-23 21:57:55 +01:00
|
|
|
</HEAD>
|
|
|
|
|
<BODY >
|
2005-04-18 23:38:05 +02:00
|
|
|
<!--HEVEA command line is: /usr/bin/hevea -charset ISO8859-1 guide.tex -->
|
2003-01-23 21:57:55 +01:00
|
|
|
<!--HTMLHEAD-->
|
|
|
|
|
<!--ENDHTML-->
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--PREFIX <ARG ></ARG>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
<!--CUT DEF section 1 -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<H1 ALIGN=center>Ejabberd Installation and Operation Guide</H1>
|
|
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<H3 ALIGN=center>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>
|
|
|
|
|
|
2005-04-18 20:16:01 +02:00
|
|
|
<H3 ALIGN=center>April 18, 2005</H3><DIV ALIGN=center>
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-03 21:23:08 +01:00
|
|
|
<IMG SRC="logo.png">
|
2003-01-24 21:18:33 +01:00
|
|
|
|
2003-02-03 21:23:08 +01:00
|
|
|
|
2003-01-24 21:18:33 +01:00
|
|
|
</DIV><BR>
|
|
|
|
|
<BR>
|
|
|
|
|
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-11 19:09:14 +01:00
|
|
|
<!--TOC section Table of Contents-->
|
|
|
|
|
|
|
|
|
|
<H2>Table of Contents</H2><!--SEC END -->
|
|
|
|
|
|
2005-04-18 23:38:05 +02:00
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc1">1 Introduction</A>
|
|
|
|
|
<LI><A HREF="#htoc2">2 Installation from Source</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc3">2.1 Installation Requirements</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc4">2.1.1 Unix</A>
|
|
|
|
|
<LI><A HREF="#htoc5">2.1.2 Windows</A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc6">2.2 Obtaining</A>
|
|
|
|
|
<LI><A HREF="#htoc7">2.3 Compilation</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc8">2.3.1 Unix</A>
|
|
|
|
|
<LI><A HREF="#htoc9">2.3.2 Windows</A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc10">2.4 Starting</A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc11">3 Configuration</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc12">3.1 Initial Configuration</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc13">3.1.1 Host Names</A>
|
|
|
|
|
<LI><A HREF="#htoc14">3.1.2 Default Language</A>
|
|
|
|
|
<LI><A HREF="#htoc15">3.1.3 Access Rules</A>
|
|
|
|
|
<LI><A HREF="#htoc16">3.1.4 Shapers Configuration</A>
|
|
|
|
|
<LI><A HREF="#htoc17">3.1.5 Listened Sockets</A>
|
|
|
|
|
<LI><A HREF="#htoc18">3.1.6 Modules</A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc19">3.2 Online Configuration and Monitoring</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc20">3.2.1 Web-based Administration Interface</A>
|
|
|
|
|
<LI><A HREF="#htoc21">3.2.2 <TT>ejabberdctl</TT> tool</A>
|
|
|
|
|
</UL>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc22">4 Clustering</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc23">4.1 How it works</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc24">4.1.1 Router</A>
|
|
|
|
|
<LI><A HREF="#htoc25">4.1.2 Local Router</A>
|
|
|
|
|
<LI><A HREF="#htoc26">4.1.3 Session Manager</A>
|
|
|
|
|
<LI><A HREF="#htoc27">4.1.4 S2S Manager</A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc28">4.2 How to setup ejabberd cluster</A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc29">A Built-in Modules</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc30">A.1 Common Options</A>
|
|
|
|
|
<UL><LI>
|
|
|
|
|
<A HREF="#htoc31">A.1.1 <TT>iqdisc</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc32">A.1.2 <TT>host</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc33">A.1.3 <TT>hosts</TT></A>
|
|
|
|
|
</UL>
|
|
|
|
|
<LI><A HREF="#htoc34">A.2 <TT>mod_announce</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc35">A.3 <TT>mod_configure</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc36">A.4 <TT>mod_disco</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc37">A.5 <TT>mod_echo</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc38">A.6 <TT>mod_irc</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc39">A.7 <TT>mod_last</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc40">A.8 <TT>mod_muc</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc41">A.9 <TT>mod_offline</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc42">A.10 <TT>mod_privacy</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc43">A.11 <TT>mod_private</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc44">A.12 <TT>mod_pubsub</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc45">A.13 <TT>mod_register</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc46">A.14 <TT>mod_roster</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc47">A.15 <TT>mod_service_log</TT></A>
|
2005-04-22 18:47:16 +02:00
|
|
|
<LI><A HREF="#htoc48">A.16 <TT>mod_shared_roster</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc49">A.17 <TT>mod_stats</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc50">A.18 <TT>mod_time</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc51">A.19 <TT>mod_vcard</TT></A>
|
|
|
|
|
<LI><A HREF="#htoc52">A.20 <TT>mod_version</TT></A>
|
2005-04-18 23:38:05 +02:00
|
|
|
</UL>
|
2005-04-22 18:47:16 +02:00
|
|
|
<LI><A HREF="#htoc53">B I18n/L10n</A>
|
2005-04-18 23:38:05 +02:00
|
|
|
</UL>
|
2003-02-11 19:09:14 +01:00
|
|
|
|
2003-01-23 21:57:55 +01:00
|
|
|
<!--TOC section Introduction-->
|
|
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<H2><A NAME="htoc1">1</A> Introduction</H2><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:intro"></A>
|
2003-02-11 19:09:14 +01:00
|
|
|
<TT>ejabberd</TT> is a Free and Open Source fault-tolerant distributed Jabber
|
2004-07-06 23:34:50 +02:00
|
|
|
server. It is written mostly in Erlang.<BR>
|
2003-01-23 21:57:55 +01:00
|
|
|
<BR>
|
2004-07-06 23:34:50 +02:00
|
|
|
The main features of <TT>ejabberd</TT> are:
|
2003-02-10 15:31:27 +01:00
|
|
|
<UL><LI>
|
2003-10-12 20:21:16 +02:00
|
|
|
Works on most of popular platforms: *nix (tested on Linux, FreeBSD and
|
|
|
|
|
NetBSD) and Win32
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Distributed: You can run <TT>ejabberd</TT> on a cluster of machines to let all of
|
|
|
|
|
them serve one Jabber domain.
|
2003-07-14 20:06:03 +02:00
|
|
|
<LI>Fault-tolerance: You can setup an <TT>ejabberd</TT> cluster so that all the
|
2003-02-10 15:31:27 +01:00
|
|
|
information required for a properly working service will be stored
|
2003-07-13 11:00:01 +02:00
|
|
|
permanently on more than one node. This means that if one of the nodes
|
2003-02-11 19:09:14 +01:00
|
|
|
crashes, then the others will continue working without disruption.
|
2004-07-06 23:34:50 +02:00
|
|
|
You can also add or replace nodes ``on the fly''.
|
2005-04-18 16:47:13 +02:00
|
|
|
<LI>Support for virtual hosting
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Built-in <A HREF="http://www.jabber.org/jeps/jep-0045.html">Multi-User Chat</A> service
|
2003-07-13 11:00:01 +02:00
|
|
|
<LI>Built-in IRC transport
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Built-in <A HREF="http://www.jabber.org/jeps/jep-0060.html">Publish-Subscribe</A> service
|
2003-07-13 11:00:01 +02:00
|
|
|
<LI>Built-in Jabber Users Directory service based on users vCards
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>Built-in web-based administration interface
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Built-in <A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> service
|
2003-11-23 21:11:21 +01:00
|
|
|
<LI>SSL support
|
2004-11-21 22:35:51 +01:00
|
|
|
<LI>Support for LDAP authentication
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Ability to interface with external components (JIT, MSN-t, Yahoo-t, etc.)
|
2003-11-23 21:11:21 +01:00
|
|
|
<LI>Migration from jabberd14 is possible
|
|
|
|
|
<LI>Mostly XMPP-compliant
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Support for <A HREF="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</A> (Service Discovery).
|
|
|
|
|
<LI>Support for <A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A> (Statistics Gathering).
|
2004-03-20 21:55:58 +01:00
|
|
|
<LI>Support for <TT>xml:lang</TT>
|
2003-02-10 15:31:27 +01:00
|
|
|
</UL>
|
2004-07-06 23:34:50 +02:00
|
|
|
The misfeatures of <TT>ejabberd</TT> are:
|
2003-11-23 21:11:21 +01:00
|
|
|
<UL><LI>
|
2005-04-18 16:47:13 +02:00
|
|
|
No support for authentication and STARTTLS in S2S connections
|
|
|
|
|
<LI>Access rules can be defined only for global conext, not for specific
|
|
|
|
|
virtual host
|
2003-11-23 21:11:21 +01:00
|
|
|
</UL>
|
2004-11-21 22:35:51 +01:00
|
|
|
<!--TOC section Installation from Source-->
|
2003-02-03 21:23:08 +01:00
|
|
|
|
2004-11-21 22:35:51 +01:00
|
|
|
<H2><A NAME="htoc2">2</A> Installation from Source</H2><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:installation"></A>
|
|
|
|
|
<!--TOC subsection Installation Requirements-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<H3><A NAME="htoc3">2.1</A> Installation Requirements</H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:installreq"></A>
|
2003-07-13 11:00:01 +02:00
|
|
|
<!--TOC subsubsection Unix-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc4">2.1.1</A> Unix</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:installrequnix"></A>
|
2003-02-11 19:09:14 +01:00
|
|
|
To compile <TT>ejabberd</TT>, you will need the following packages:
|
2003-02-10 15:31:27 +01:00
|
|
|
<UL><LI>
|
|
|
|
|
GNU Make;
|
|
|
|
|
<LI>GCC;
|
|
|
|
|
<LI>libexpat 1.95 or later;
|
2004-08-08 21:07:55 +02:00
|
|
|
<LI>Erlang/OTP R8B or later;
|
|
|
|
|
<LI>OpenSSL 0.9.6 or later (optional).
|
2003-02-10 15:31:27 +01:00
|
|
|
</UL>
|
2003-07-13 11:00:01 +02:00
|
|
|
<!--TOC subsubsection Windows-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc5">2.1.2</A> Windows</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:installreqwin"></A>
|
|
|
|
|
To compile <TT>ejabberd</TT> in MS Windows environment, you will need the following
|
|
|
|
|
packages:
|
|
|
|
|
<UL><LI>
|
2004-07-06 23:34:50 +02:00
|
|
|
MS Visual C++ 6.0 Compiler
|
2004-12-01 23:48:53 +01:00
|
|
|
<LI><A HREF="http://erlang.org/download/otp_win32_R10B-1a.exe">Erlang/OTP R10B-1a</A>
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI><A HREF="http://prdownloads.sourceforge.net/expat/expat_win32bin_1_95_7.exe?download">Expat 1.95.7</A>
|
|
|
|
|
<LI><A HREF="http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.9.1.tar.gz">Iconv 1.9.1</A>
|
2004-05-08 21:30:38 +02:00
|
|
|
(optional)
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL</A>
|
2004-05-08 21:30:38 +02:00
|
|
|
(to enable SSL connections)
|
2003-07-13 11:00:01 +02:00
|
|
|
</UL>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection Obtaining-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-07-13 11:00:01 +02:00
|
|
|
<H3><A NAME="htoc6">2.2</A> Obtaining</H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:obtaining"></A>
|
2004-07-06 23:34:50 +02:00
|
|
|
Stable <TT>ejabberd</TT> release can be obtained at
|
2005-04-18 23:38:05 +02:00
|
|
|
<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>
|
2003-01-23 21:57:55 +01:00
|
|
|
<BR>
|
2005-04-18 23:38:05 +02:00
|
|
|
The latest alpha version can be retrieved from Subversion repository.
|
2004-07-06 23:34:50 +02:00
|
|
|
<PRE>
|
2005-04-18 23:38:05 +02:00
|
|
|
svn co svn://svn.process-one.net/opt/data/svn/ejabberd/trunk ejabberd
|
2004-07-06 23:34:50 +02:00
|
|
|
</PRE>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection Compilation-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-07-13 11:00:01 +02:00
|
|
|
<H3><A NAME="htoc7">2.3</A> Compilation</H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:compilation"></A>
|
2003-07-13 11:00:01 +02:00
|
|
|
<!--TOC subsubsection Unix-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc8">2.3.1</A> Unix</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:compilationunix"></A>
|
2003-02-10 15:31:27 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
./configure
|
|
|
|
|
make
|
|
|
|
|
su
|
|
|
|
|
make install
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
This will install <TT>ejabberd</TT> to <CODE>/var/lib/ejabberd</CODE> directory,
|
|
|
|
|
<CODE>ejabberd.cfg</CODE> to <CODE>/etc/ejabberd</CODE> directory and create
|
|
|
|
|
<CODE>/var/log/ejabberd</CODE> directory for log files.<BR>
|
2003-01-28 20:45:13 +01:00
|
|
|
<BR>
|
2003-07-13 11:00:01 +02:00
|
|
|
<!--TOC subsubsection Windows-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc9">2.3.2</A> Windows</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:compilationwin"></A>
|
2004-07-06 23:34:50 +02:00
|
|
|
<UL><LI>
|
2004-05-08 21:30:38 +02:00
|
|
|
Install Erlang emulator (for example, into <CODE>C:\Program Files\erl5.3</CODE>).
|
|
|
|
|
<LI>Install Expat library into <CODE>C:\Program Files\Expat-1.95.7</CODE>
|
2004-07-06 23:34:50 +02:00
|
|
|
directory.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Copy file <CODE>C:\Program Files\Expat-1.95.7\Libs\libexpat.dll</CODE>
|
2003-07-14 20:06:03 +02:00
|
|
|
to your Windows system directory (for example, <CODE>C:\WINNT</CODE> or
|
|
|
|
|
<CODE>C:\WINNT\System32</CODE>)
|
2004-07-06 23:34:50 +02:00
|
|
|
<LI>Build and install Iconv library into <CODE>C:\Program Files\iconv-1.9.1</CODE> directory.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Copy file <CODE>C:\Program Files\iconv-1.9.1\bin\iconv.dll</CODE> to your
|
2003-07-13 11:00:01 +02:00
|
|
|
Windows system directory.<BR>
|
|
|
|
|
<BR>
|
2004-05-08 21:30:38 +02:00
|
|
|
Note: Instead of copying libexpat.dll and iconv.dll to Windows
|
2003-07-13 11:00:01 +02:00
|
|
|
directory, you can add directories
|
2004-05-08 21:30:38 +02:00
|
|
|
<CODE>C:\Program Files\Expat-1.95.7\Libs</CODE> and
|
|
|
|
|
<CODE>C:\Program Files\iconv-1.9.1\bin</CODE> to <CODE>PATH</CODE> environment
|
2003-07-13 11:00:01 +02:00
|
|
|
variable.
|
|
|
|
|
<LI>Being in <CODE>ejabberd\src</CODE> directory run:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
configure.bat
|
2003-07-13 11:00:01 +02:00
|
|
|
nmake -f Makefile.win32
|
2004-05-08 21:30:38 +02:00
|
|
|
</PRE><LI>Edit file <CODE>ejabberd\src\ejabberd.cfg</CODE> and run
|
2003-07-13 11:00:01 +02:00
|
|
|
<PRE>
|
|
|
|
|
werl -s ejabberd -name ejabberd
|
2004-07-06 23:34:50 +02:00
|
|
|
</PRE></UL>
|
2003-01-28 20:45:13 +01:00
|
|
|
<!--TOC subsection Starting-->
|
|
|
|
|
|
2003-07-13 11:00:01 +02:00
|
|
|
<H3><A NAME="htoc10">2.4</A> Starting</H3><!--SEC END -->
|
2003-01-28 20:45:13 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:starting"></A>
|
2003-10-12 20:21:16 +02:00
|
|
|
To start <TT>ejabberd</TT>, use the following command:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd
|
2003-10-12 20:21:16 +02:00
|
|
|
</PRE>or
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
|
|
|
|
|
</PRE>In the latter case Erlang node will be identified using only first part of host
|
|
|
|
|
name, i. e. other Erlang nodes outside this domain can't contact this node.<BR>
|
2003-10-12 20:21:16 +02:00
|
|
|
<BR>
|
2004-07-06 23:34:50 +02:00
|
|
|
Note that when using above command <TT>ejabberd</TT> will search for config file
|
|
|
|
|
in current directory and will use current directory for storing user database
|
|
|
|
|
and logging.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
To specify path to config file, log files and Mnesia database directory,
|
|
|
|
|
you may use the following command:
|
2003-10-12 20:21:16 +02:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
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\"
|
2003-10-12 20:21:16 +02:00
|
|
|
</PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
You can find other useful options in Erlang manual page (<TT>erl -man erl</TT>).<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
To use more than 1024 connections, you should set environment variable
|
2003-10-12 20:21:16 +02:00
|
|
|
<CODE>ERL_MAX_PORTS</CODE>:
|
2003-02-05 21:28:49 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
export ERL_MAX_PORTS=32000
|
2003-02-05 21:28:49 +01:00
|
|
|
</PRE>Note that with this value <TT>ejabberd</TT> will use more memory (approximately 6MB
|
2003-10-12 20:21:16 +02:00
|
|
|
more).<BR>
|
|
|
|
|
<BR>
|
2004-07-06 23:34:50 +02:00
|
|
|
To reduce memory usage, you may set environment variable
|
2003-10-12 20:21:16 +02:00
|
|
|
<CODE>ERL_FULLSWEEP_AFTER</CODE>:
|
2003-02-05 21:28:49 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
export ERL_FULLSWEEP_AFTER=0
|
2003-10-12 20:21:16 +02:00
|
|
|
</PRE>But in this case <TT>ejabberd</TT> can start to work slower.<BR>
|
2003-01-28 20:45:13 +01:00
|
|
|
<BR>
|
|
|
|
|
<!--TOC section Configuration-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-07-13 11:00:01 +02:00
|
|
|
<H2><A NAME="htoc11">3</A> Configuration</H2><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:configuration"></A>
|
|
|
|
|
<!--TOC subsection Initial Configuration-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-07-13 11:00:01 +02:00
|
|
|
<H3><A NAME="htoc12">3.1</A> Initial Configuration</H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:initconfig"></A>
|
2003-02-11 19:09:14 +01:00
|
|
|
The configuration file is initially loaded the first time <TT>ejabberd</TT> is
|
2004-07-06 23:34:50 +02:00
|
|
|
executed, when it is parsed and stored in a database. Subsequently the
|
2003-02-11 19:09:14 +01:00
|
|
|
configuration is loaded from the database and any commands in the configuration
|
|
|
|
|
file are appended to the entries in the database. The configuration file
|
|
|
|
|
consists of a sequence of Erlang terms. Parts of lines after <TT>`%'</TT> sign
|
|
|
|
|
are ignored. Each term is tuple, where first element is name of option, and
|
|
|
|
|
other are option values. E. g. if this file does not contain a ``host''
|
|
|
|
|
definition, then old value stored in the database will be used.<BR>
|
2003-01-23 21:57:55 +01:00
|
|
|
<BR>
|
2003-02-11 19:09:14 +01:00
|
|
|
To override old values stored in the database the following lines can be added
|
|
|
|
|
in config:
|
2003-02-01 21:21:28 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
override_global.
|
|
|
|
|
override_local.
|
|
|
|
|
override_acls.
|
2003-02-01 21:21:28 +01:00
|
|
|
</PRE>With this lines old global or local options or ACLs will be removed before
|
|
|
|
|
adding new ones.<BR>
|
|
|
|
|
<BR>
|
2005-04-18 16:47:13 +02:00
|
|
|
<!--TOC subsubsection Host Names-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H4><A NAME="htoc13">3.1.1</A> Host Names</H4><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:confighostname"></A>
|
2005-04-18 16:47:13 +02:00
|
|
|
Option <TT>hosts</TT> defines a list of Jabber domains that <TT>ejabberd</TT>
|
|
|
|
|
serves. E. g. to serve <TT>example.org</TT> and <TT>example.com</TT> domains add
|
|
|
|
|
the following line in the config:
|
2003-01-23 21:57:55 +01:00
|
|
|
<PRE>
|
2005-04-18 16:47:13 +02:00
|
|
|
{hosts, ["example.org", "example.com"]}.
|
|
|
|
|
</PRE>
|
|
|
|
|
Option <TT>host</TT> defines one Jabber domain that <TT>ejabberd</TT> serves.
|
|
|
|
|
E. g. to serve only <TT>example.org</TT> domain add the following line in the
|
|
|
|
|
config:
|
|
|
|
|
<PRE>
|
|
|
|
|
{host, "example.org"}.
|
|
|
|
|
</PRE>It have the same effect as
|
|
|
|
|
<PRE>
|
|
|
|
|
{hosts, ["example.org"]}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
2004-07-10 00:34:26 +02:00
|
|
|
<!--TOC subsubsection Default Language-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc14">3.1.2</A> Default Language</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:configlanguage"></A>
|
|
|
|
|
Option <TT>language</TT> defines default language of <TT>ejabberd</TT> messages, sent
|
|
|
|
|
to users. Default value is <TT>"en"</TT>. In order to take effect there must be a
|
|
|
|
|
translation file <TT><language>.msg</TT> in <TT>ejabberd</TT> <TT>msgs</TT> directory.
|
|
|
|
|
E. g. to use Russian as default language add the following line in the config:
|
|
|
|
|
<PRE>
|
|
|
|
|
{language, "ru"}.
|
|
|
|
|
</PRE>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsubsection Access Rules-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<H4><A NAME="htoc15">3.1.3</A> Access Rules</H4><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:configaccess"></A>
|
2003-02-11 19:09:14 +01:00
|
|
|
Access control in <TT>ejabberd</TT> is performed via Access Control Lists (ACL). The
|
|
|
|
|
declarations of ACL in config file have following syntax:
|
2003-01-25 21:13:36 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{acl, <aclname>, {<acltype>, ...}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
|
|
|
|
<TT><acltype></TT> can be one of following:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>all</TT></B><DD> Matches all JIDs. Example:
|
2003-01-25 21:13:36 +01:00
|
|
|
<PRE>
|
|
|
|
|
{acl, all, all}.
|
2005-04-18 16:47:13 +02:00
|
|
|
</PRE><DT><B><TT>{user, <username>}</TT></B><DD> Matches user with name
|
|
|
|
|
<TT><username></TT> at the first virtual host. Example:
|
2003-01-25 21:13:36 +01:00
|
|
|
<PRE>
|
|
|
|
|
{acl, admin, {user, "aleksey"}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{user, <username>, <server>}</TT></B><DD> Matches user with JID
|
2003-01-29 21:21:14 +01:00
|
|
|
<TT><username>@<server></TT> and any resource. Example:
|
2003-01-25 21:13:36 +01:00
|
|
|
<PRE>
|
|
|
|
|
{acl, admin, {user, "aleksey", "jabber.ru"}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{server, <server>}</TT></B><DD> Matches any JID from server
|
2003-01-25 21:13:36 +01:00
|
|
|
<TT><server></TT>. Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
{acl, jabberorg, {server, "jabber.org"}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{user_regexp, <regexp>}</TT></B><DD> Matches local user with name that
|
2005-04-18 16:47:13 +02:00
|
|
|
matches <TT><regexp></TT> at the first virtual host. Example:
|
2003-01-29 21:21:14 +01:00
|
|
|
<PRE>
|
2003-02-06 20:09:22 +01:00
|
|
|
{acl, tests, {user, "^test[0-9]*$"}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{user_regexp, <regexp>, <server>}</TT></B><DD> Matches user with name
|
2003-02-11 19:09:14 +01:00
|
|
|
that matches <TT><regexp></TT> and from server <TT><server></TT>. Example:
|
2003-01-29 21:21:14 +01:00
|
|
|
<PRE>
|
2003-02-06 20:09:22 +01:00
|
|
|
{acl, tests, {user, "^test", "localhost"}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{server_regexp, <regexp>}</TT></B><DD> Matches any JID from server that
|
2003-01-29 21:21:14 +01:00
|
|
|
matches <TT><regexp></TT>. Example:
|
|
|
|
|
<PRE>
|
2003-02-06 20:09:22 +01:00
|
|
|
{acl, icq, {server, "^icq\\."}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{node_regexp, <user_regexp>, <server_regexp>}</TT></B><DD> Matches user
|
2003-02-11 19:09:14 +01:00
|
|
|
with name that matches <TT><user_regexp></TT> and from server that matches
|
2003-01-29 21:21:14 +01:00
|
|
|
<TT><server_regexp></TT>. Example:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{acl, aleksey, {node_regexp, "^aleksey$", "^jabber.(ru|org)$"}}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE><DT><B><TT>{user_glob, <glob>}</TT></B><DD>
|
|
|
|
|
<DT><B><TT>{user_glob, <glob>, <server>}</TT></B><DD>
|
|
|
|
|
<DT><B><TT>{server_glob, <glob>}</TT></B><DD>
|
|
|
|
|
<DT><B><TT>{node_glob, <user_glob>, <server_glob>}</TT></B><DD> This is same as
|
2003-02-11 19:09:14 +01:00
|
|
|
above, but uses shell glob patterns instead of regexp. These patterns can
|
|
|
|
|
have following special characters:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>*</TT></B><DD> matches any string including the null string.
|
|
|
|
|
<DT><B><TT>?</TT></B><DD> matches any single character.
|
|
|
|
|
<DT><B><TT>[...]</TT></B><DD> matches any of the enclosed characters. Character
|
2003-01-29 21:21:14 +01:00
|
|
|
ranges are specified by a pair of characters separated by a <TT>`-'</TT>.
|
|
|
|
|
If the first character after <TT>`['</TT> is a <TT>`!'</TT>, then any
|
|
|
|
|
character not enclosed is matched.
|
|
|
|
|
</DL>
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
2005-04-18 16:47:13 +02:00
|
|
|
The following ACLs are pre-defined:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>all</TT></B><DD> Matches all JIDs.
|
|
|
|
|
<DT><B><TT>none</TT></B><DD> Matches none JIDs.
|
|
|
|
|
</DL>
|
2004-12-01 23:48:53 +01:00
|
|
|
An entry allowing or denying access to different services would look similar to
|
|
|
|
|
this:
|
2003-01-25 21:13:36 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{access, <accessname>, [{allow, <aclname>},
|
|
|
|
|
{deny, <aclname>},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
2003-02-11 19:09:14 +01:00
|
|
|
</PRE>When a JID is checked to have access to <TT><accessname></TT>, the server
|
|
|
|
|
sequentially checks if this JID mathes one of the ACLs that are second elements
|
|
|
|
|
in each tuple in list. If it is matched, then the first element of matched
|
|
|
|
|
tuple is returned else ``<TT>deny</TT>'' is returned.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{access, configure, [{allow, admin}]}.
|
|
|
|
|
{access, something, [{deny, badmans},
|
|
|
|
|
{allow, all}]}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
|
|
|
|
Following access rules pre-defined:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
<B><TT>all</TT></B><DD> Always returns ``<TT>allow</TT>''
|
|
|
|
|
<DT><B><TT>none</TT></B><DD> Always returns ``<TT>deny</TT>''
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
2003-02-11 21:45:35 +01:00
|
|
|
<!--TOC subsubsection Shapers Configuration-->
|
|
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<H4><A NAME="htoc16">3.1.4</A> Shapers Configuration</H4><!--SEC END -->
|
2003-02-11 21:45:35 +01:00
|
|
|
|
|
|
|
|
<A NAME="sec:configshaper"></A>
|
|
|
|
|
With shapers is possible to bound connection traffic. The declarations of
|
|
|
|
|
shapers in config file have following syntax:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{shaper, <shapername>, <kind>}.
|
2003-02-11 21:45:35 +01:00
|
|
|
</PRE>Currently implemented only one kind of shaper: <TT>maxrate</TT>. It have
|
|
|
|
|
following syntax:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{maxrate, <rate>}
|
2003-02-11 21:45:35 +01:00
|
|
|
</PRE>where <TT><rate></TT> means maximum allowed incomig rate in bytes/second.
|
|
|
|
|
E. g. to define shaper with name ``<TT>normal</TT>'' and maximum allowed rate
|
|
|
|
|
1000 bytes/s, add following line in config:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{shaper, normal, {maxrate, 1000}}.
|
2003-02-11 21:45:35 +01:00
|
|
|
</PRE>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsubsection Listened Sockets-->
|
2003-02-01 21:21:28 +01:00
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<H4><A NAME="htoc17">3.1.5</A> Listened Sockets</H4><!--SEC END -->
|
2003-02-01 21:21:28 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:configlistened"></A>
|
|
|
|
|
Option <TT>listen</TT> defines list of listened sockets and what services
|
2003-02-01 21:21:28 +01:00
|
|
|
runned on them. Each element of list is a tuple with following elements:
|
2003-02-10 15:31:27 +01:00
|
|
|
<UL><LI>
|
|
|
|
|
Port number;
|
|
|
|
|
<LI>Module that serves this port;
|
|
|
|
|
<LI>Options to this module.
|
|
|
|
|
</UL>
|
2004-07-06 23:34:50 +02:00
|
|
|
Currently these modules are implemented:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
2004-07-06 23:34:50 +02:00
|
|
|
<B><TT>ejabberd_c2s</TT></B><DD> This module serves C2S connections.<BR>
|
2003-02-01 21:21:28 +01:00
|
|
|
<BR>
|
2003-10-09 20:09:05 +02:00
|
|
|
The following options are defined:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
2004-07-06 23:34:50 +02:00
|
|
|
<B><TT>{access, <access rule>}</TT></B><DD> This option defines access of users
|
2003-02-01 21:21:28 +01:00
|
|
|
to this C2S port. Default value is ``<TT>all</TT>''.
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>{shaper, <access rule>}</TT></B><DD> This option is like previous, but
|
2003-02-11 21:45:35 +01:00
|
|
|
use shapers instead of ``<TT>allow</TT>'' and ``<TT>deny</TT>''. Default
|
|
|
|
|
value is ``<TT>none</TT>''.
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>{ip, IPAddress}</TT></B><DD> This option specifies which network interface to
|
|
|
|
|
listen on. For example <CODE>{ip, {192, 168, 1, 1}}</CODE>.
|
|
|
|
|
<DT><B><TT>inet6</TT></B><DD> Set up the socket for IPv6.
|
2004-08-13 00:34:19 +02:00
|
|
|
<DT><B><TT>starttls</TT></B><DD> This option specifies that STARTTLS extension is available
|
|
|
|
|
on connections to this port. You should also set ``<CODE>certfile</CODE>''
|
|
|
|
|
option.
|
|
|
|
|
<DT><B><TT>tls</TT></B><DD> This option specifies that traffic on this port will be
|
|
|
|
|
encrypted using SSL immediately after connecting. You should also set
|
|
|
|
|
``<CODE>certfile</CODE>'' option.
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>ssl</TT></B><DD> This option specifies that traffic on this port will be
|
2004-08-08 21:07:55 +02:00
|
|
|
encrypted using SSL. You should also set ``<CODE>certfile</CODE>'' option. It
|
2004-08-13 00:34:19 +02:00
|
|
|
is recommended to use <TT>tls</TT> option instead.
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>{certfile, Path}</TT></B><DD> Path to a file containing the SSL certificate.
|
|
|
|
|
</DL>
|
|
|
|
|
<DT><B><TT>ejabberd_s2s_in</TT></B><DD> This module serves incoming S2S connections.
|
|
|
|
|
<DT><B><TT>ejabberd_service</TT></B><DD> This module serves connections from Jabber
|
|
|
|
|
services (i. e. that use the <TT>jabber:component:accept</TT> namespace).<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
The following additional options are defined for <TT>ejabberd_service</TT>
|
|
|
|
|
(options <TT>access</TT>, <TT>shaper</TT>, <TT>ip</TT>, <TT>inet6</TT> are
|
|
|
|
|
still valid):
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>{host, Hostname, [HostOptions]}</TT></B><DD> This option defines hostname of connected
|
|
|
|
|
service and allows to specify additional options, e. g.
|
|
|
|
|
<TT>{password, Secret}</TT>.
|
|
|
|
|
<DT><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B><DD> The same as above, but allows to
|
|
|
|
|
specify several hostnames.
|
|
|
|
|
</DL>
|
|
|
|
|
<DT><B><TT>ejabberd_http</TT></B><DD> This module serves incoming HTTP connections.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
The following options are defined:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2004-08-08 21:07:55 +02:00
|
|
|
<B><TT>http_poll</TT></B><DD> This option enables <A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A>
|
2004-07-06 23:34:50 +02:00
|
|
|
support. It is available then at <CODE>http://server:port/http-poll/</CODE>.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<DT><B><TT>web_admin</TT></B><DD> This option enables web-based interface for <TT>ejabberd</TT>
|
|
|
|
|
administration which is available at <CODE>http://server:port/admin/</CODE>,
|
|
|
|
|
login and password should be equal to username and password of one of
|
|
|
|
|
registered users who have permission defined in ``configure'' access rule.
|
2003-02-01 21:21:28 +01:00
|
|
|
</DL>
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
2004-05-22 21:48:35 +02:00
|
|
|
For example, the following configuration defines that:
|
|
|
|
|
<UL><LI>
|
|
|
|
|
C2S connections are listened on port 5222 and 5223 (SSL) and denied for
|
|
|
|
|
user ``<TT>bad</TT>''
|
|
|
|
|
<LI>S2S connections are listened on port 5269
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>HTTP connections are listened on port 5280 and administration interface
|
|
|
|
|
and HTTP Polling support are enabled
|
2004-05-22 21:48:35 +02:00
|
|
|
<LI>All users except admins have traffic limit 1000 B/s
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>AIM transport <TT>aim.example.org</TT> is connected to port 5233 with
|
2004-05-22 21:48:35 +02:00
|
|
|
password ``<TT>aimsecret</TT>''
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>JIT transports <TT>icq.example.org</TT> and <TT>sms.example.org</TT> are
|
2004-05-22 21:48:35 +02:00
|
|
|
connected to port 5234 with password ``<TT>jitsecret</TT>''
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>MSN transport <TT>msn.example.org</TT> is connected to port 5235 with
|
2004-05-22 21:48:35 +02:00
|
|
|
password ``<TT>msnsecret</TT>''
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>Yahoo! transport <TT>yahoo.example.org</TT> is connected to port 5236 with
|
2004-05-22 21:48:35 +02:00
|
|
|
password ``<TT>yahoosecret</TT>''
|
2004-07-10 00:34:26 +02:00
|
|
|
<LI>Gadu-Gadu transport <TT>gg.example.org</TT> is connected to port 5237 with
|
|
|
|
|
password ``<TT>ggsecret</TT>''
|
|
|
|
|
<LI>ILE service <TT>ile.example.org</TT> is connected to port 5238 with
|
2004-05-22 21:48:35 +02:00
|
|
|
password ``<TT>ilesecret</TT>''
|
|
|
|
|
</UL>
|
2004-07-10 00:34:26 +02:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{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, []},
|
2004-07-10 00:34:26 +02:00
|
|
|
{5280, ejabberd_http, [http_poll, web_admin]},
|
2004-07-06 23:34:50 +02:00
|
|
|
{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, "ile.example.org",
|
|
|
|
|
[{password, "ilesecret"}]}]}
|
|
|
|
|
]
|
|
|
|
|
}.
|
|
|
|
|
</PRE>Note, that for jabberd14- or wpjabberd-based services you have to make the
|
|
|
|
|
transports log and do XDB by themselves:
|
2004-05-22 21:48:35 +02:00
|
|
|
<PRE>
|
|
|
|
|
<!--
|
2004-07-06 23:34:50 +02:00
|
|
|
You have to add elogger and rlogger entries here when using ejabberd.
|
2004-05-22 21:48:35 +02:00
|
|
|
In this case the transport will do the logging.
|
|
|
|
|
-->
|
|
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<log id='logger'>
|
2004-05-22 21:48:35 +02:00
|
|
|
<host/>
|
|
|
|
|
<logtype/>
|
|
|
|
|
<format>%d: [%t] (%h): %s</format>
|
2004-07-06 23:34:50 +02:00
|
|
|
<file>/var/log/jabber/service.log</file>
|
2004-05-22 21:48:35 +02:00
|
|
|
</log>
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
Some Jabber server implementations do not provide
|
|
|
|
|
XDB services (for example jabberd 2.0 and ejabberd).
|
2004-07-06 23:34:50 +02:00
|
|
|
xdb_file_so is loaded in to handle all XDB requests.
|
2004-05-22 21:48:35 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
<xdb id="xdb">
|
|
|
|
|
<host/>
|
|
|
|
|
<load>
|
2004-07-06 23:34:50 +02:00
|
|
|
<!-- this is a lib of wpjabber or jabberd -->
|
|
|
|
|
<xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file>
|
2004-05-22 21:48:35 +02:00
|
|
|
</load>
|
|
|
|
|
<xdb_file xmlns="jabber:config:xdb_file">
|
|
|
|
|
<spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
|
|
|
|
|
</xdb_file>
|
|
|
|
|
</xdb>
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
|
|
|
|
<!--TOC subsubsection Modules-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<H4><A NAME="htoc18">3.1.6</A> Modules</H4><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:configmodules"></A>
|
2003-02-11 19:09:14 +01:00
|
|
|
Option <TT>modules</TT> defines the list of modules that will be loaded after
|
2003-01-23 21:57:55 +01:00
|
|
|
<TT>ejabberd</TT> startup. Each list element is a tuple where first element is a
|
2003-02-11 19:09:14 +01:00
|
|
|
name of a module and second is list of options to this module. See
|
2005-04-18 23:38:05 +02:00
|
|
|
section <A HREF="#sec:modules">A</A> for detailed information on each module.<BR>
|
2003-01-23 21:57:55 +01:00
|
|
|
<BR>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{modules,
|
|
|
|
|
[{mod_register, []},
|
|
|
|
|
{mod_roster, []},
|
|
|
|
|
{mod_privacy, []},
|
|
|
|
|
{mod_configure, []},
|
|
|
|
|
{mod_disco, []},
|
|
|
|
|
{mod_stats, []},
|
|
|
|
|
{mod_vcard, []},
|
|
|
|
|
{mod_offline, []},
|
2005-04-18 16:47:13 +02:00
|
|
|
{mod_announce, [{access, announce}]},
|
2004-07-06 23:34:50 +02:00
|
|
|
{mod_echo, [{host, "echo.localhost"}]},
|
|
|
|
|
{mod_private, []},
|
|
|
|
|
{mod_irc, []},
|
|
|
|
|
{mod_muc, []},
|
|
|
|
|
{mod_pubsub, []},
|
|
|
|
|
{mod_time, [{iqdisc, no_queue}]},
|
|
|
|
|
{mod_last, []},
|
|
|
|
|
{mod_version, []}
|
|
|
|
|
]}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
|
|
|
|
<!--TOC subsection Online Configuration and Monitoring-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<H3><A NAME="htoc19">3.2</A> Online Configuration and Monitoring</H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:onlineconfig"></A>
|
2004-07-10 22:06:27 +02:00
|
|
|
<!--TOC subsubsection Web-based Administration Interface-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc20">3.2.1</A> Web-based Administration Interface</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:webadm"></A>
|
2004-07-10 00:34:26 +02:00
|
|
|
To perform online reconfiguration of <TT>ejabberd</TT> you need to enable
|
|
|
|
|
<TT>ejabberd_http</TT> listener with option <TT>web_admin</TT> (see
|
2005-04-18 23:38:05 +02:00
|
|
|
section <A HREF="#sec:configlistened">3.1.5</A>). After that you can open URL
|
2004-07-10 00:34:26 +02:00
|
|
|
<CODE>http://server:port/admin/</CODE> with you favorite web-browser and enter
|
2004-08-27 23:02:59 +02:00
|
|
|
username and password of an <TT>ejabberd</TT> user with administrator rights. E. g.
|
|
|
|
|
with such config:
|
2004-07-10 00:34:26 +02:00
|
|
|
<PRE>
|
|
|
|
|
...
|
|
|
|
|
{host, "example.org"}.
|
|
|
|
|
...
|
|
|
|
|
{listen,
|
|
|
|
|
[...
|
|
|
|
|
{5280, ejabberd_http, [web_admin]},
|
|
|
|
|
...
|
|
|
|
|
]
|
|
|
|
|
}.
|
|
|
|
|
</PRE>you should enter URL <CODE>http://example.org:5280/admin/</CODE>. After
|
2005-04-18 23:38:05 +02:00
|
|
|
authentication you should see something like in figure <A HREF="#fig:webadmmain">1</A>.
|
2003-02-08 19:21:05 +01:00
|
|
|
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
|
|
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<IMG SRC="webadmmain.png">
|
2003-02-08 19:21:05 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<BR>
|
2004-07-10 00:34:26 +02:00
|
|
|
<DIV ALIGN=center>Figure 1: Web-administration top page</DIV><BR>
|
2003-02-08 19:21:05 +01:00
|
|
|
|
2004-07-10 00:34:26 +02:00
|
|
|
<A NAME="fig:webadmmain"></A>
|
2003-02-10 15:31:27 +01:00
|
|
|
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
2004-07-10 00:34:26 +02:00
|
|
|
Here you can edit access restrictions, manage users, create backup files,
|
|
|
|
|
manage DB, enable/disable listened ports, and view statistics.<BR>
|
2003-01-24 21:18:33 +01:00
|
|
|
<BR>
|
2004-07-10 22:06:27 +02:00
|
|
|
<!--TOC subsubsection <TT>ejabberdctl</TT> tool-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc21">3.2.2</A> <TT>ejabberdctl</TT> tool</H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:ejabberdctl"></A>
|
|
|
|
|
It is possible to do some administration operations using <TT>ejabberdctl</TT>
|
|
|
|
|
command-line tool. You can check available options running this command
|
|
|
|
|
without arguments:
|
|
|
|
|
<PRE>
|
|
|
|
|
% ejabberdctl
|
|
|
|
|
Usage: ejabberdctl node command
|
|
|
|
|
|
|
|
|
|
Available commands:
|
|
|
|
|
stop stop ejabberd
|
|
|
|
|
restart restart ejabberd
|
|
|
|
|
reopen-log reopen log file
|
|
|
|
|
register user password register a user
|
|
|
|
|
unregister user unregister a user
|
|
|
|
|
backup file store a database backup in file
|
|
|
|
|
restore file restore a database backup from file
|
|
|
|
|
install-fallback file install a database fallback from file
|
|
|
|
|
dump file dump a database in a text file
|
|
|
|
|
load file restore a database from a text file
|
|
|
|
|
registered-users list all registered users
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
ejabberdctl ejabberd@host restart
|
|
|
|
|
</PRE>
|
2004-11-21 22:35:51 +01:00
|
|
|
<!--TOC section Clustering-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-11-21 22:35:51 +01:00
|
|
|
<H2><A NAME="htoc22">4</A> Clustering</H2><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-11-21 22:35:51 +01:00
|
|
|
<A NAME="sec:clustering"></A>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection How it works-->
|
2003-01-25 21:13:36 +01:00
|
|
|
|
2004-07-10 22:06:27 +02:00
|
|
|
<H3><A NAME="htoc23">4.1</A> How it works</H3><!--SEC END -->
|
2003-01-25 21:13:36 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:howitworks"></A>
|
2003-02-11 19:09:14 +01:00
|
|
|
A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
|
2004-07-10 00:34:26 +02:00
|
|
|
be runned 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
|
2003-01-25 21:13:36 +01:00
|
|
|
needed because all nodes exchange information about connected users, S2S
|
2003-02-01 21:21:28 +01:00
|
|
|
connections, registered services, etc...<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
2003-07-13 11:00:01 +02:00
|
|
|
Each <TT>ejabberd</TT> node have following modules:
|
2003-02-10 15:31:27 +01:00
|
|
|
<UL><LI>
|
|
|
|
|
router;
|
|
|
|
|
<LI>local router.
|
|
|
|
|
<LI>session manager;
|
|
|
|
|
<LI>S2S manager;
|
|
|
|
|
</UL>
|
|
|
|
|
<!--TOC subsubsection Router-->
|
2003-01-25 21:13:36 +01:00
|
|
|
|
2004-07-10 22:06:27 +02:00
|
|
|
<H4><A NAME="htoc24">4.1.1</A> Router</H4><!--SEC END -->
|
2003-01-25 21:13:36 +01:00
|
|
|
|
2004-10-06 17:07:21 +02:00
|
|
|
This module is the main router of Jabber packets on each node. It
|
|
|
|
|
routes them based on their destinations domains. It uses a global
|
|
|
|
|
routing table. A domain of packet destination is searched in the
|
|
|
|
|
routing table, and if it is found, then the packet is routed to
|
|
|
|
|
appropriate process. If no, then it is sent to the S2S manager.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
<!--TOC subsubsection Local Router-->
|
|
|
|
|
|
2004-07-10 22:06:27 +02:00
|
|
|
<H4><A NAME="htoc25">4.1.2</A> Local Router</H4><!--SEC END -->
|
2003-02-10 15:31:27 +01:00
|
|
|
|
2004-10-06 17:07:21 +02:00
|
|
|
This module routes packets which have a destination domain equal to
|
|
|
|
|
this server name. If destination JID has a non-empty user part, then
|
|
|
|
|
it is routed to the session manager, else it is processed depending on
|
|
|
|
|
its content.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
<!--TOC subsubsection Session Manager-->
|
|
|
|
|
|
2004-07-10 22:06:27 +02:00
|
|
|
<H4><A NAME="htoc26">4.1.3</A> Session Manager</H4><!--SEC END -->
|
2003-02-10 15:31:27 +01:00
|
|
|
|
2004-10-06 17:07:21 +02:00
|
|
|
This module routes packets to local users. It searches to what user
|
|
|
|
|
resource a packet must be sent via a presence table. Then packet is
|
|
|
|
|
either routed to appropriate C2S process, or stored in offline
|
|
|
|
|
storage, or bounced back.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
<!--TOC subsubsection S2S Manager-->
|
|
|
|
|
|
2004-07-10 22:06:27 +02:00
|
|
|
<H4><A NAME="htoc27">4.1.4</A> S2S Manager</H4><!--SEC END -->
|
2003-02-10 15:31:27 +01:00
|
|
|
|
2004-10-06 17:07:21 +02:00
|
|
|
This module routes packets to other Jabber servers. First, it
|
|
|
|
|
checks if an opened S2S connection from the domain of the packet
|
|
|
|
|
source to the domain of packet destination is existing. If it is
|
|
|
|
|
existing, then the S2S manager routes the packet to the process
|
|
|
|
|
serving this connection, else a new connection is opened.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<!--TOC subsection How to setup ejabberd cluster-->
|
|
|
|
|
|
|
|
|
|
<H3><A NAME="htoc28">4.2</A> How to setup ejabberd cluster</H3><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:cluster"></A>
|
|
|
|
|
Suppose you already setuped ejabberd on one of machines (<TT>first</TT>), and
|
|
|
|
|
you need to setup another one to make <TT>ejabberd</TT> cluster. Then do
|
|
|
|
|
following steps:
|
|
|
|
|
<OL type=1><LI>
|
|
|
|
|
Copy <CODE>~ejabberd/.erlang.cookie</CODE> file from <TT>first</TT> to
|
|
|
|
|
<TT>second</TT>.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
(alt) You can also add ``<CODE>-cookie content_of_.erlang.cookie</CODE>''
|
|
|
|
|
option to all ``<TT>erl</TT>'' commands below.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<LI>On <TT>second</TT> run under `<TT>ejabberd</TT>' user in a directory
|
|
|
|
|
where ejabberd will work later the following command:
|
|
|
|
|
<PRE>
|
|
|
|
|
erl -sname ejabberd \
|
|
|
|
|
-mnesia extra_db_nodes "['ejabberd@first']" \
|
|
|
|
|
-s mnesia
|
|
|
|
|
</PRE>This will start mnesia serving same DB as <TT>ejabberd@first</TT>.
|
|
|
|
|
You can check this running ``<CODE>mnesia:info().</CODE>'' command. You
|
|
|
|
|
should see a lot of remote tables and a line like the following:
|
|
|
|
|
<PRE>
|
|
|
|
|
running db nodes = [ejabberd@first, ejabberd@second]
|
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<LI>Now run the following in the same ``<TT>erl</TT>'' session:
|
|
|
|
|
<PRE>
|
|
|
|
|
mnesia:change_table_copy_type(schema, node(), disc_copies).
|
|
|
|
|
</PRE>
|
|
|
|
|
This will create local disc storage for DB.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
(alt) Change storage type of `<TT>scheme</TT>' table to ``RAM and disc
|
|
|
|
|
copy'' on second node via web interface.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<LI>Now you can add replicas of various tables to this node with
|
|
|
|
|
``<CODE>mnesia:add_table_copy</CODE>'' or
|
|
|
|
|
``<CODE>mnesia:change_table_copy_type</CODE>'' as above (just replace
|
|
|
|
|
``<CODE>schema</CODE>'' with another table name and ``<CODE>disc_copies</CODE>''
|
|
|
|
|
can be replaced with ``<CODE>ram_copies</CODE>'' or
|
|
|
|
|
``<CODE>disc_only_copies</CODE>'').<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
What tables to replicate is very depend on your needs, you can get
|
|
|
|
|
some hints from ``<CODE>mnesia:info().</CODE>'' command, by looking at
|
|
|
|
|
size of tables and default storage type for each table on 'first'.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Replicating of table makes lookup in this table faster on this node,
|
|
|
|
|
but writing will be slower. And of course if machine with one of
|
|
|
|
|
replicas is down, other replicas will be used.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Also section ``5.3 Table Fragmentation''
|
2004-12-01 23:48:53 +01:00
|
|
|
<A HREF="http://www.erlang.se/doc/doc-5.4/lib/mnesia-4.2/doc/html/index.html">here</A>
|
2004-10-06 17:07:21 +02:00
|
|
|
can be useful.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
(alt) Same as in previous item, but for other tables.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<LI>Run ``<CODE>init:stop().</CODE>'' or just ``<CODE>q().</CODE>'' to exit from
|
|
|
|
|
erlang shell. This probably can take some time if mnesia is not yet
|
|
|
|
|
transfer and process all data it needed from <TT>first</TT>.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<LI>Now run ejabberd on <TT>second</TT> with almost the same config as
|
|
|
|
|
on <TT>first</TT> (you probably don't need to duplicate ``<CODE>acl</CODE>''
|
|
|
|
|
and ``<CODE>access</CODE>'' options --- 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 cluster).
|
|
|
|
|
</OL>
|
|
|
|
|
You can repeat these steps for other machines supposed to serve this
|
|
|
|
|
domain.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
<!--TOC section Built-in Modules-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-10-06 17:07:21 +02:00
|
|
|
<H2><A NAME="htoc29">A</A> Built-in Modules</H2><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:modules"></A>
|
|
|
|
|
<!--TOC subsection Common Options-->
|
2003-01-24 21:18:33 +01:00
|
|
|
|
2004-10-06 17:07:21 +02:00
|
|
|
<H3><A NAME="htoc30">A.1</A> Common Options</H3><!--SEC END -->
|
2003-01-24 21:18:33 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:modcommonopts"></A>
|
2003-10-09 20:09:05 +02:00
|
|
|
The following options are used by many modules, so they are described in
|
|
|
|
|
separate section.<BR>
|
2003-01-24 21:18:33 +01:00
|
|
|
<BR>
|
2004-11-21 22:35:51 +01:00
|
|
|
<!--TOC subsubsection <TT>iqdisc</TT>-->
|
2003-01-24 21:18:33 +01:00
|
|
|
|
2004-11-21 22:35:51 +01:00
|
|
|
<H4><A NAME="htoc31">A.1.1</A> <TT>iqdisc</TT></H4><!--SEC END -->
|
2003-02-10 15:31:27 +01:00
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<A NAME="sec:modiqdiscoption"></A>
|
2003-01-24 21:18:33 +01:00
|
|
|
Many modules define handlers for processing IQ queries of different namespaces
|
2003-10-09 20:09:05 +02:00
|
|
|
to this server or to user (e. g. to <TT>example.org</TT> or to
|
|
|
|
|
<TT>user@example.org</TT>). This option defines processing discipline of
|
2003-02-11 19:09:14 +01:00
|
|
|
these queries. Possible values are:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>no_queue</TT></B><DD> All queries of namespace with this processing
|
2003-01-24 21:18:33 +01:00
|
|
|
discipline processed immediately. This also means that no other packets can
|
|
|
|
|
be processed until finished this. Hence this discipline is not recommended
|
2004-07-06 23:34:50 +02:00
|
|
|
if processing of query can take relatively long time.
|
2003-02-10 15:31:27 +01:00
|
|
|
<DT><B><TT>one_queue</TT></B><DD> In this case created separate queue for processing
|
2003-10-11 19:39:36 +02:00
|
|
|
of IQ queries of namespace with this discipline, and processing of this queue
|
|
|
|
|
is done in parallel with processing of other packets. This discipline is most
|
2003-01-24 21:18:33 +01:00
|
|
|
recommended.
|
2003-07-13 11:00:01 +02:00
|
|
|
<DT><B><TT>parallel</TT></B><DD> In this case for all packets with this discipline
|
|
|
|
|
spawned separate Erlang process, so all these packets processed in parallel.
|
2003-10-11 19:39:36 +02:00
|
|
|
Although spawning of Erlang process have relatively low cost, this can broke
|
|
|
|
|
server normal work, because Erlang emulator have limit on number of processes
|
|
|
|
|
(32000 by default).
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
|
|
|
|
Example:
|
2003-01-24 21:18:33 +01:00
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_time, [{iqdisc, no_queue}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
2004-11-21 22:35:51 +01:00
|
|
|
<!--TOC subsubsection <TT>host</TT>-->
|
2003-02-10 15:31:27 +01:00
|
|
|
|
2004-11-21 22:35:51 +01:00
|
|
|
<H4><A NAME="htoc32">A.1.2</A> <TT>host</TT></H4><!--SEC END -->
|
2003-01-25 21:13:36 +01:00
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<A NAME="sec:modhostoption"></A>
|
|
|
|
|
This option explicitly defines hostname for the module which acts as a service.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_echo, [{host, "echo.example.org"}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
2005-04-18 16:47:13 +02:00
|
|
|
<!--TOC subsubsection <TT>hosts</TT>-->
|
|
|
|
|
|
|
|
|
|
<H4><A NAME="htoc33">A.1.3</A> <TT>hosts</TT></H4><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:modhostsoption"></A>
|
|
|
|
|
This option explicitly defines a list of hostnames for the module which acts as
|
|
|
|
|
a service.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_echo, [{hosts, ["echo.example.org", "echo.example.com"]}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
2004-08-13 00:34:19 +02:00
|
|
|
<!--TOC subsection <TT>mod_announce</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc34">A.2</A> <TT>mod_announce</TT></H3><!--SEC END -->
|
2004-08-13 00:34:19 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modannounce"></A>
|
2004-08-22 23:54:14 +02:00
|
|
|
This module adds support for broadcast announce messages and MOTD.
|
|
|
|
|
When the module is loaded, it handles messages sent to the following JID's
|
|
|
|
|
(suppose that main server has address <TT>example.org</TT>):
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
<B><TT>example.org/announce/all</TT></B><DD> Message is sent to all registered users at
|
|
|
|
|
<TT>example.org</TT>. If the user is online and connected to several resources,
|
|
|
|
|
only resource with the highest priority will receive the message. If the
|
|
|
|
|
registered user is not connected, the message will be stored offline (if
|
|
|
|
|
oflline storage is available).
|
|
|
|
|
<DT><B><TT>example.org/announce/online</TT></B><DD> Message is sent to all connected users at
|
|
|
|
|
<TT>example.org</TT>. If the user is online and connected to several resources,
|
|
|
|
|
all resources will receive the message.
|
|
|
|
|
<DT><B><TT>example.org/announce/all-hosts/online</TT></B><DD> Message is sent to all connected
|
|
|
|
|
users at every virtual host. If the user is online and connected to several
|
|
|
|
|
resources, all resources will receive the message.
|
2004-08-22 23:54:14 +02:00
|
|
|
<DT><B><TT>example.org/announce/motd</TT></B><DD> Message is set as MOTD (Message of the Day)
|
2005-04-18 16:47:13 +02:00
|
|
|
and is sent to users at <TT>example.org</TT> as they login. In addition the
|
|
|
|
|
message is sent to all connected users (similar to <TT>announce/online</TT>
|
|
|
|
|
resource).
|
|
|
|
|
<DT><B><TT>example.org/announce/motd/update</TT></B><DD> Message is set as MOTD (Message of the
|
|
|
|
|
Day) and is sent to users at <TT>example.org</TT> as they login. The message
|
|
|
|
|
is <EM>not sent</EM> to all connected users.
|
2004-08-22 23:54:14 +02:00
|
|
|
<DT><B><TT>example.org/announce/motd/delete</TT></B><DD> Any message sent to this JID
|
|
|
|
|
removes existing MOTD.
|
|
|
|
|
</DL>
|
2004-08-13 00:34:19 +02:00
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>access</TT></B><DD> Specifies who is allowed to send announce messages
|
|
|
|
|
and set MOTD (default value is <TT>none</TT>).
|
|
|
|
|
</DL>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
% Only admins can send announcement messages:
|
|
|
|
|
{access, announce, [{allow, admin}]}.
|
|
|
|
|
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_announce, [{access, announce}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
<!--TOC subsection <TT>mod_configure</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc35">A.3</A> <TT>mod_configure</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<A NAME="sec:modconfigure"></A>
|
2003-10-11 19:39:36 +02:00
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2004-07-06 23:34:50 +02:00
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>ejabberd:config</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2003-10-11 19:39:36 +02:00
|
|
|
</DL>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection <TT>mod_disco</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc36">A.4</A> <TT>mod_disco</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:moddisco"></A>
|
2004-07-06 23:34:50 +02:00
|
|
|
This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</A> (Service Discovery).<BR>
|
2003-10-09 20:09:05 +02:00
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>http://jabber.org/protocol/disco#items</TT> and
|
2004-07-06 23:34:50 +02:00
|
|
|
<TT>http://jabber.org/protocol/disco#info</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2003-10-09 20:09:05 +02:00
|
|
|
<DT><B><TT>extra_domains</TT></B><DD> List of domains that will be added to server
|
|
|
|
|
items reply
|
|
|
|
|
</DL>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_disco, [{extra_domains, ["jit.example.com",
|
|
|
|
|
"etc.example.com"]}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
2003-10-09 20:09:05 +02:00
|
|
|
</PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
<!--TOC subsection <TT>mod_echo</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc37">A.5</A> <TT>mod_echo</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<A NAME="sec:modecho"></A>
|
2005-04-22 18:47:16 +02:00
|
|
|
This module acts as a service and simply returns to sender any Jabber
|
|
|
|
|
packet. Module may be useful for debugging.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
Options:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
|
|
|
|
|
<B><TT>host</TT></B><DD> Defines hostname of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostoption">A.1.2</A>).
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>hosts</TT></B><DD> Defines hostnames of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostsoption">A.1.3</A>). If neither <TT>host</TT> nor <TT>hosts</TT>
|
2005-04-18 16:47:13 +02:00
|
|
|
are not present, then prefix <TT>echo.</TT> is added to all <TT>ejabberd</TT> hostnames.
|
|
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
2004-07-06 23:34:50 +02:00
|
|
|
<!--TOC subsection <TT>mod_irc</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc38">A.6</A> <TT>mod_irc</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modirc"></A>
|
|
|
|
|
This module implements IRC transport.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
2004-07-06 23:34:50 +02:00
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
|
|
|
|
|
<B><TT>host</TT></B><DD> Defines hostname of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostoption">A.1.2</A>).
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>hosts</TT></B><DD> Defines hostnames of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostsoption">A.1.3</A>). If neither <TT>host</TT> nor <TT>hosts</TT>
|
2005-04-18 16:47:13 +02:00
|
|
|
are not present, then prefix <TT>irc.</TT> is added to all <TT>ejabberd</TT> hostnames.
|
|
|
|
|
|
2004-07-11 22:51:54 +02:00
|
|
|
<DT><B><TT>access</TT></B><DD> Specifies who is allowed to use IRC transport (default value is <TT>all</TT>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
2004-07-11 22:51:54 +02:00
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_irc, [{access, all}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
2004-07-06 23:34:50 +02:00
|
|
|
<!--TOC subsection <TT>mod_last</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc39">A.7</A> <TT>mod_last</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<A NAME="sec:modlast"></A>
|
|
|
|
|
This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0012.html">JEP-0012</A> (Last Activity)<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:last</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
|
|
|
|
<!--TOC subsection <TT>mod_muc</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc40">A.8</A> <TT>mod_muc</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modmuc"></A>
|
|
|
|
|
This module implements <A HREF="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</A> (Multi-User Chat) service.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
|
|
|
|
|
<B><TT>host</TT></B><DD> Defines hostname of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostoption">A.1.2</A>).
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>hosts</TT></B><DD> Defines hostnames of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostsoption">A.1.3</A>). If neither <TT>host</TT> nor <TT>hosts</TT>
|
2005-04-18 16:47:13 +02:00
|
|
|
are not present, then prefix <TT>conference.</TT> is added to all <TT>ejabberd</TT> hostnames.
|
|
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>access</TT></B><DD> Specifies who is allowed to use MUC service (default value is <TT>all</TT>).
|
|
|
|
|
<DT><B><TT>access_create</TT></B><DD> Specifies who is allowed to create new rooms at
|
|
|
|
|
MUC service (default value is <TT>all</TT>).
|
|
|
|
|
<DT><B><TT>access_admin</TT></B><DD> Specifies who is allowed to administrate MUC service
|
|
|
|
|
(default value is <TT>none</TT>, which means that only creator may administer her room).
|
|
|
|
|
</DL>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
% Define admin ACL
|
|
|
|
|
{acl, admin, {user, "admin"}}
|
|
|
|
|
|
|
|
|
|
% Define MUC admin access rule
|
|
|
|
|
{access, muc_admin, [{allow, admin}]}
|
|
|
|
|
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_muc, [{access, all},
|
|
|
|
|
{access_create, all},
|
|
|
|
|
{access_admin, muc_admin}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection <TT>mod_offline</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc41">A.9</A> <TT>mod_offline</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:modoffline"></A>
|
2004-07-06 23:34:50 +02:00
|
|
|
This module implements offline message storage.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
<!--TOC subsection <TT>mod_privacy</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc42">A.10</A> <TT>mod_privacy</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<A NAME="sec:modprivacy"></A>
|
|
|
|
|
This module implements Privacy Rules as defined in XMPP IM
|
|
|
|
|
(see <A HREF="http://www.jabber.org/ietf/"><TT>http://www.jabber.org/ietf/</TT></A>).<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:privacy</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection <TT>mod_private</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc43">A.11</A> <TT>mod_private</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:modprivate"></A>
|
2004-07-06 23:34:50 +02:00
|
|
|
This module adds support of <A HREF="http://www.jabber.org/jeps/jep-0049.html">JEP-0049</A> (Private XML Storage).<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:private</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
|
|
|
|
<!--TOC subsection <TT>mod_pubsub</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc44">A.12</A> <TT>mod_pubsub</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modpubsub"></A>
|
|
|
|
|
This module implements <A HREF="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</A> (Publish-Subscribe Service).<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
|
|
|
|
|
<B><TT>host</TT></B><DD> Defines hostname of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostoption">A.1.2</A>).
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>hosts</TT></B><DD> Defines hostnames of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostsoption">A.1.3</A>). If neither <TT>host</TT> nor <TT>hosts</TT>
|
2005-04-18 16:47:13 +02:00
|
|
|
are not present, then prefix <TT>pubsub.</TT> is added to all <TT>ejabberd</TT> hostnames.
|
|
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>served_hosts</TT></B><DD> Specifies which hosts are served by the service.
|
|
|
|
|
If absent then only main <TT>ejabberd</TT> host is served.
|
|
|
|
|
</DL>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_pubsub, [{served_hosts, ["example.com",
|
|
|
|
|
"example.org"]}]}
|
|
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
|
|
|
|
<!--TOC subsection <TT>mod_register</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc45">A.13</A> <TT>mod_register</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modregister"></A>
|
2004-07-11 22:51:54 +02:00
|
|
|
This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</A> (In-Band Registration).<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
Options:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
2004-07-11 22:51:54 +02:00
|
|
|
<B><TT>access</TT></B><DD> Specifies rule to restrict registration.
|
|
|
|
|
If this rule returns ``deny'' on requested user name, then
|
|
|
|
|
registration is not allowed for it. (default value is <TT>all</TT>, which means
|
|
|
|
|
no restrictions).
|
|
|
|
|
<DT><B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:register</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
% Deny registration for users with too short name
|
|
|
|
|
{acl, shortname, {user_glob, "?"}}.
|
|
|
|
|
{acl, shortname, {user_glob, "??"}}.
|
|
|
|
|
% Another variant: {acl, shortname, {user_regexp, "^..?$"}}.
|
|
|
|
|
|
|
|
|
|
{access, register, [{deny, shortname},
|
|
|
|
|
{allow, all}]}.
|
|
|
|
|
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
2004-07-11 22:51:54 +02:00
|
|
|
{mod_register, [{access, register}]},
|
2004-07-06 23:34:50 +02:00
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
|
|
|
|
<!--TOC subsection <TT>mod_roster</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc46">A.14</A> <TT>mod_roster</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modroster"></A>
|
|
|
|
|
This module implements roster management.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:roster</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
2004-08-24 22:11:01 +02:00
|
|
|
<!--TOC subsection <TT>mod_service_log</TT>-->
|
|
|
|
|
|
2005-04-18 16:47:13 +02:00
|
|
|
<H3><A NAME="htoc47">A.15</A> <TT>mod_service_log</TT></H3><!--SEC END -->
|
2004-08-24 22:11:01 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modservicelog"></A>
|
|
|
|
|
This module adds support for logging of user packets via any jabber service.
|
|
|
|
|
These packets encapsulated in <route/> element and sended to specified
|
|
|
|
|
services.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>loggers</TT></B><DD> Specifies a list of services which will receive users
|
|
|
|
|
packets.
|
|
|
|
|
</DL>
|
|
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
|
|
|
|
{mod_service_log, [{loggers, ["bandersnatch.example.com"]}]},
|
|
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
2005-04-22 18:47:16 +02:00
|
|
|
<!--TOC subsection <TT>mod_shared_roster</TT>-->
|
|
|
|
|
|
|
|
|
|
<H3><A NAME="htoc48">A.16</A> <TT>mod_shared_roster</TT></H3><!--SEC END -->
|
|
|
|
|
|
|
|
|
|
<A NAME="sec:modsharedroster"></A>
|
|
|
|
|
This module implements shared roster groups support.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
You can edit shared roster groups via web-interface. Each group has an unique
|
|
|
|
|
ID and the following parameters:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B>Name</B><DD> The name of the group, which will be displayed in roster.
|
|
|
|
|
<DT><B>Description</B><DD> Textual description of this group, doesn't affect anything.
|
|
|
|
|
<DT><B>Members</B><DD> List of full JIDs of group members, entered one per line in
|
|
|
|
|
web-interface.
|
|
|
|
|
<DT><B>Displayed groups</B><DD> List of IDs of groups which will be in rosters of this
|
|
|
|
|
group members.
|
|
|
|
|
</DL>
|
|
|
|
|
For example, to have a group of users which can see each other in roster,
|
|
|
|
|
create a group like on table <A HREF="#tab:srge1">1</A>.
|
|
|
|
|
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
|
|
|
|
|
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP> </TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Group `<TT>users</TT>'</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP>Name</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Users</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP>Members</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user1@example.org</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user2@example.org</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user3@example.org</TT></TD>
|
|
|
|
|
</TR></TABLE></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP>Displayed groups</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP><TT>users</TT></TD>
|
|
|
|
|
</TR></TABLE>
|
|
|
|
|
<BR>
|
|
|
|
|
<DIV ALIGN=center>Table 1: Shared group example N1</DIV><BR>
|
|
|
|
|
|
|
|
|
|
<A NAME="tab:srge1"></A>
|
|
|
|
|
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
|
|
|
|
To have 3 groups `<TT>managers</TT>', `<TT>workgroup1</TT>', and
|
|
|
|
|
`<TT>workgroup2</TT>', where group `<TT>managers</TT>' can see members of all
|
|
|
|
|
groups, and other two groups can see `<TT>managers</TT>' group and themselves,
|
|
|
|
|
create groups like on table <A HREF="#tab:srge2">2</A>.
|
|
|
|
|
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
|
|
|
|
|
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP> </TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Group `<TT>managers</TT>'</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Group `<TT>workgroup1</TT>'</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Group `<TT>workgroup2</TT>'</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP>Name</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Managers</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Workgroup1</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP>Workgroup2</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></TABLE>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user1@example.org</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user2@example.org</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user3@example.org</TT></TD>
|
|
|
|
|
</TR></TABLE>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user4@example.org</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user5@example.org</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>user6@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>managers</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>workgroup1</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>workgroup2</TT></TD>
|
|
|
|
|
</TR></TABLE>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>managers</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>workgroup1</TT></TD>
|
|
|
|
|
</TR></TABLE>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD ALIGN=left NOWRAP><TABLE CELLSPACING=2 CELLPADDING=0>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>managers</TT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR><TD ALIGN=left NOWRAP><TT>workgroup2</TT></TD>
|
|
|
|
|
</TR></TABLE></TD>
|
|
|
|
|
</TR></TABLE>
|
|
|
|
|
<BR>
|
|
|
|
|
<DIV ALIGN=center>Table 2: Shared group example N2</DIV><BR>
|
|
|
|
|
|
|
|
|
|
<A NAME="tab:srge2"></A>
|
|
|
|
|
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
2004-07-06 23:34:50 +02:00
|
|
|
<!--TOC subsection <TT>mod_stats</TT>-->
|
|
|
|
|
|
2005-04-22 18:47:16 +02:00
|
|
|
<H3><A NAME="htoc49">A.17</A> <TT>mod_stats</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modstats"></A>
|
|
|
|
|
This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A> (Statistics Gathering).<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
|
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>http://jabber.org/protocol/stats</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection <TT>mod_time</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-22 18:47:16 +02:00
|
|
|
<H3><A NAME="htoc50">A.18</A> <TT>mod_time</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:modtime"></A>
|
|
|
|
|
This module answers UTC time on <TT>jabber:iq:time</TT> queries.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
Options:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
2004-07-06 23:34:50 +02:00
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:time</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2004-07-06 23:34:50 +02:00
|
|
|
</DL>
|
|
|
|
|
<!--TOC subsection <TT>mod_vcard</TT>-->
|
|
|
|
|
|
2005-04-22 18:47:16 +02:00
|
|
|
<H3><A NAME="htoc51">A.19</A> <TT>mod_vcard</TT></H3><!--SEC END -->
|
2004-07-06 23:34:50 +02:00
|
|
|
|
|
|
|
|
<A NAME="sec:modvcard"></A>
|
|
|
|
|
This module implements simple Jabber User Directory (based on user vCards)
|
|
|
|
|
and answers server vCard on <TT>vcard-temp</TT> queries.<BR>
|
|
|
|
|
<BR>
|
|
|
|
|
Options:
|
|
|
|
|
<DL COMPACT=compact><DT>
|
2005-04-18 16:47:13 +02:00
|
|
|
|
|
|
|
|
<B><TT>host</TT></B><DD> Defines hostname of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostoption">A.1.2</A>).
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>hosts</TT></B><DD> Defines hostnames of the service
|
2005-04-18 23:38:05 +02:00
|
|
|
(see <A HREF="#sec:modhostsoption">A.1.3</A>). If neither <TT>host</TT> nor <TT>hosts</TT>
|
2005-04-18 16:47:13 +02:00
|
|
|
are not present, then prefix <TT>vjud.</TT> is added to all <TT>ejabberd</TT> hostnames.
|
|
|
|
|
|
2004-07-06 23:34:50 +02:00
|
|
|
<DT><B><TT>iqdisc</TT></B><DD> <TT>vcard-temp</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>search</TT></B><DD> Specifies whether search is enabled (value is <TT>true</TT>, default) or
|
2004-07-10 00:34:26 +02:00
|
|
|
disabled (value is <TT>false</TT>) by the service. If <TT>search</TT> is set to <TT>false</TT>,
|
|
|
|
|
option <TT>host</TT> is ignored and service does not appear in Jabber Discovery items.
|
2004-10-06 17:07:21 +02:00
|
|
|
<DT><B><TT>matches</TT></B><DD> Limits the number of reported search results. If value is set to
|
|
|
|
|
<TT>infinity</TT> then all search results are reported. Default value is <TT>30</TT>.
|
2005-04-18 16:47:13 +02:00
|
|
|
<DT><B><TT>allow_return_all</TT></B><DD> Specifies whether search with empty input fields can
|
|
|
|
|
return all known users. Default is <TT>false</TT>.
|
|
|
|
|
<DT><B><TT>search_all_hosts</TT></B><DD> If set in <TT>true</TT> then search returns matched
|
|
|
|
|
items at all virtual hosts. Otherwise only current host items are returned.
|
|
|
|
|
Default is <TT>true</TT>.
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
2004-07-10 00:34:26 +02:00
|
|
|
Example:
|
|
|
|
|
<PRE>
|
|
|
|
|
{modules,
|
|
|
|
|
[
|
|
|
|
|
...
|
2005-04-18 16:47:13 +02:00
|
|
|
{mod_vcard, [{search, true},
|
|
|
|
|
{matches, 20},
|
|
|
|
|
{allow_return_all, true},
|
|
|
|
|
{search_all_hosts, false}]}
|
2004-07-10 00:34:26 +02:00
|
|
|
...
|
|
|
|
|
]}.
|
|
|
|
|
</PRE>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--TOC subsection <TT>mod_version</TT>-->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2005-04-22 18:47:16 +02:00
|
|
|
<H3><A NAME="htoc52">A.20</A> <TT>mod_version</TT></H3><!--SEC END -->
|
2003-01-23 21:57:55 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:modversion"></A>
|
|
|
|
|
This module answers <TT>ejabberd</TT> version on <TT>jabber:iq:version</TT> queries.<BR>
|
2003-01-25 21:13:36 +01:00
|
|
|
<BR>
|
|
|
|
|
Options:
|
2003-02-10 15:31:27 +01:00
|
|
|
<DL COMPACT=compact><DT>
|
2004-07-06 23:34:50 +02:00
|
|
|
<B><TT>iqdisc</TT></B><DD> <TT>jabber:iq:version</TT> IQ queries processing
|
2005-04-18 23:38:05 +02:00
|
|
|
discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>).
|
2003-02-10 15:31:27 +01:00
|
|
|
</DL>
|
|
|
|
|
<!--TOC section I18n/L10n-->
|
2003-02-08 19:21:05 +01:00
|
|
|
|
2005-04-22 18:47:16 +02:00
|
|
|
<H2><A NAME="htoc53">B</A> I18n/L10n</H2><!--SEC END -->
|
2003-02-08 19:21:05 +01:00
|
|
|
|
2003-02-10 15:31:27 +01:00
|
|
|
<A NAME="sec:i18nl10n"></A>
|
2004-07-06 23:34:50 +02:00
|
|
|
All built-in modules support <TT>xml:lang</TT> attribute inside IQ queries.
|
2005-04-18 23:38:05 +02:00
|
|
|
E. g. on figure <A HREF="#fig:discorus">2</A> showed the reply on the following query:
|
2004-07-06 23:34:50 +02:00
|
|
|
<PRE>
|
|
|
|
|
<iq id='5'
|
|
|
|
|
to='e.localhost'
|
|
|
|
|
type='get'
|
|
|
|
|
xml:lang='ru'>
|
|
|
|
|
<query xmlns='http://jabber.org/protocol/disco#items'/>
|
|
|
|
|
</iq>
|
2003-02-10 15:31:27 +01:00
|
|
|
</PRE>
|
|
|
|
|
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
|
2003-02-08 19:21:05 +01:00
|
|
|
|
|
|
|
|
<IMG SRC="discorus.png">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<BR>
|
2004-07-10 00:34:26 +02:00
|
|
|
<DIV ALIGN=center>Figure 2: Discovery result when <TT>xml:lang='ru'</TT></DIV><BR>
|
2003-02-08 19:21:05 +01:00
|
|
|
|
|
|
|
|
<A NAME="fig:discorus"></A>
|
2003-02-10 15:31:27 +01:00
|
|
|
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
2004-07-10 00:34:26 +02:00
|
|
|
Also web-interface supports <CODE>Accept-Language</CODE> HTTP header (see
|
2005-04-18 23:38:05 +02:00
|
|
|
figure <A HREF="#fig:webadmmainru">3</A>, compare it with figure <A HREF="#fig:webadmmain">1</A>)
|
2004-07-10 00:34:26 +02:00
|
|
|
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
|
|
|
|
|
|
|
|
|
|
<IMG SRC="webadmmainru.png">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
<DIV ALIGN=center>Figure 3: Web-administration top page with HTTP header
|
|
|
|
|
``<CODE>Accept-Language: ru</CODE>''</DIV><BR>
|
|
|
|
|
|
|
|
|
|
<A NAME="fig:webadmmainru"></A>
|
|
|
|
|
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
2003-02-10 15:31:27 +01:00
|
|
|
<!--HTMLFOOT-->
|
2003-01-23 21:57:55 +01:00
|
|
|
<!--ENDHTML-->
|
|
|
|
|
<!--FOOTER-->
|
|
|
|
|
<HR SIZE=2>
|
|
|
|
|
<BLOCKQUOTE><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
|
2003-02-10 15:31:27 +01:00
|
|
|
</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>
|
2003-01-23 21:57:55 +01:00
|
|
|
</HTML>
|
