Ejabberd 1.1.1 Installation and Operation Guide

@@ -49,117 +32,125 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}

I can thoroughly recommend ejabberd for ease of setup – +
I can thoroughly recommend ejabberd for ease of setup -- Kevin Smith, Current maintainer of the Psi project
- + -
Contents
+
Table of Contents
-
+
1  Introduction -
+
1.1  Key Features -
1.2  Additional Features +
1.2  Additional Features
-
2  Installation from Source -
+
2  Installation from Source +
2.1  Installation Requirements -
-2.1.1  “Unix-like” operating systems -
2.1.2  Windows +
+2.1.1  ``Unix-like'' operating systems +
2.1.2  Windows
-
2.2  Obtaining ejabberd -
2.3  Compilation -
-2.3.1  “Unix-like” operating systems -
2.3.2  Windows +
2.2  Obtaining ejabberd +
2.3  Compilation +
+2.3.1  ``Unix-like'' operating systems +
2.3.2  Windows
-
2.4  Starting +
2.4  Starting
-
3  Configuration -
+
3  Configuration +
3.1  Initial Configuration -
+
3.1.1  Host Names -
3.1.2  Default Language -
3.1.3  Access Rules -
3.1.4  Shapers -
3.1.5  Limitation of the number of opened sessions -
3.1.6  Listened Sockets -
3.1.7  Modules -
3.1.8  Virtual Hosting -
3.1.9  SASL anonymous and anonymous login +
3.1.2  Default Language +
3.1.3  Access Rules +
3.1.4  Shapers +
3.1.5  Limitation of the number of opened sessions +
3.1.6  Listened Sockets +
3.1.7  Modules +
3.1.8  Virtual Hosting +
3.1.9  SASL anonymous and anonymous login
-
3.2  Relational Database Support -
+
3.2  Relational Database Support +
3.2.1  Preliminary steps -
3.2.2  Authentication against a relational database -
3.2.3  Relational database for other modules +
3.2.2  Authentication against a relational database +
3.2.3  Relational database for other modules
-
3.3  Creating an Initial Administrator -
3.4  Online Configuration and Monitoring -
+
3.3  Creating an Initial Administrator +
3.4  Online Configuration and Monitoring +
3.4.1  Web Interface -
3.4.2  ejabberdctl +
3.4.2  ejabberdctl

-
4  Firewall Settings -
5  SRV Records -
6  Clustering -
+
4  Firewall Settings +
5  SRV Records +
6  Clustering +
6.1  How it Works -
+
6.1.1  Router -
6.1.2  Local Router -
6.1.3  Session Manager -
6.1.4  s2s Manager +
6.1.2  Local Router +
6.1.3  Session Manager +
6.1.4  s2s Manager
-
6.2  Clustering Setup +
6.2  Clustering Setup
-
A  Built-in Modules -
+
A  Built-in Modules +
A.1  Overview -
A.2  Common Options -
+
A.2  Common Options +
A.2.1  iqdisc -
A.2.2  hosts +
A.2.2  hosts +
+
A.3  mod_announce +
A.4  mod_disco +
A.5  mod_echo +
A.6  mod_irc +
A.7  mod_last +
A.8  mod_muc +
A.9  mod_muc_log +
A.10  mod_offline +
A.11  mod_privacy +
A.12  mod_private +
A.13  mod_pubsub +
A.14  mod_register +
A.15  mod_roster +
A.16  mod_service_log +
A.17  mod_shared_roster +
A.18  mod_stats +
A.19  mod_time +
A.20  mod_vcard +
A.21  LDAP and mod_vcard_ldap +
+A.21.1  Features +
A.21.2  Connection +
A.21.3  Authentication +
A.21.4  vCards and Search +
A.21.5  Examples
-
A.3  mod_announce -
A.4  mod_disco -
A.5  mod_echo -
A.6  mod_irc -
A.7  mod_last -
A.8  mod_muc -
A.9  mod_muc_log -
A.10  mod_offline -
A.11  mod_privacy -
A.12  mod_private -
A.13  mod_pubsub -
A.14  mod_register -
A.15  mod_roster -
A.16  mod_service_log -
A.17  mod_shared_roster -
A.18  mod_stats -
A.19  mod_time -
A.20  mod_vcard -
A.21  mod_version +
A.22  mod_version
-
B  Internationalization and Localization -
C  Release Notes -
-C.1  ejabberd 0.9 -
C.2  ejabberd 0.9.1 -
C.3  ejabberd 0.9.8 -
C.4  ejabberd 1.0.0 -
C.5  ejabberd 1.1.0 -
C.6  ejabberd 1.1.1 +
B  Internationalization and Localization +
C  Release Notes +
+C.1  ejabberd 0.9 +
C.2  ejabberd 0.9.1 +
C.3  ejabberd 0.9.8 +
C.4  ejabberd 1.0.0 +
C.5  ejabberd 1.1.0 +
C.6  ejabberd 1.1.1
-
D  Acknowledgements +
D  Acknowledgements
-
1  Introduction
+
1  Introduction
@@ -171,135 +162,135 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
-
1.1  Key Features
+
1.1  Key Features
ejabberd is: -
+
Multiplatform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.

-
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
+
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.

-
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced “on the fly”.
+
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.

-
Administrator Friendly: ejabberd 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: -
+
Administrator Friendly: ejabberd 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: +
Comprehensive documentation. -
Straightforward installers for Linux, Mac OS X, and Windows. -
Web interface for administration tasks. -
Shared Roster Groups. -
Command line administration tool. -
Can integrate with existing authentication mechanisms. -
Capability to send announce messages. +
Straightforward installers for Linux, Mac OS X, and Windows. +
Web interface for administration tasks. +
Shared Roster Groups. +
Command line administration tool. +
Can integrate with existing authentication mechanisms. +
Capability to send announce messages.

-
Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -
+
Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: +
Translated in 11 languages. -
Support for IDNA. +
Support for IDNA.

-
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -
+
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +
Fully XMPP compliant -
XML-based protocol -
Many JEPs supported. +
XML-based protocol +
Many JEPs supported.
-
1.2  Additional Features
+
1.2  Additional Features
Besides common Jabber server features, ejabberd comes with a wide range of other features: -
+
Modular -
+
Load only the modules you want. -
Extend ejabberd with your own custom modules. +
Extend ejabberd with your own custom modules.
-
Security -
+
Security +
SASL and STARTTLS for c2s and s2s connections. -
STARTTLS and Dialback s2s connections. -
Web interface accessible via HTTPS secure access. +
STARTTLS and Dialback s2s connections. +
Web interface accessible via HTTPS secure access.
-
Databases -
+
Databases +
Native MySQL support. -
Native PostgreSQL support. -
Mnesia. -
ODBC data storage support. -
Microsoft SQL Server support (via ODBC). +
Native PostgreSQL support. +
Mnesia. +
ODBC data storage support. +
Microsoft SQL Server support (via ODBC).
-
Authentication -
+
Authentication +
LDAP and ODBC. -
External Authentication script. -
Internal Authentication. +
External Authentication script. +
Internal Authentication.
-
Others -
+
Others +
Compressing XML streams with Stream Compression (JEP-0138). -
Interface with networks such as AIM, ICQ and MSN. -
Statistics via Statistics Gathering (JEP-0039). -
IPv6 support both for c2s and s2s connections. -
Multi-User Chat module with logging. -
Users Directory based on users vCards. -
Publish-Subscribe component. -
Support for virtual hosting. -
HTTP Polling service. -
IRC transport. +
Interface with networks such as AIM, ICQ and MSN. +
Statistics via Statistics Gathering (JEP-0039). +
IPv6 support both for c2s and s2s connections. +
Multi-User Chat module with logging. +
Users Directory based on users vCards. +
Publish-Subscribe component. +
Support for virtual hosting. +
HTTP Polling service. +
IRC transport.

-
2  Installation from Source
+
2  Installation from Source
-
2.1  Installation Requirements
+
2.1  Installation Requirements
- + -
2.1.1  “Unix-like” operating systems
+
2.1.1  ``Unix-like'' operating systems
-To compile ejabberd on a “Unix-like” operating system, you need: -
+To compile ejabberd on a ``Unix-like'' operating system, you need: +
GNU Make; -
GCC; -
libexpat 1.95 or higher; -
Erlang/OTP R9C-2 or higher; -
OpenSSL 0.9.6 or higher (optional). -
Zlib 1.2.3 or higher (optional). -
GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc). +
GCC; +
libexpat 1.95 or higher; +
Erlang/OTP R9C-2 or higher; +
OpenSSL 0.9.6 or higher (optional). +
Zlib 1.2.3 or higher (optional). +
GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc).
-
2.1.2  Windows
+
2.1.2  Windows
To compile ejabberd on a Windows flavour, you need: -
+
MS Visual C++ 6.0 Compiler -
Erlang/OTP R9C-2 or higher -
Expat 1.95.7 or higher -
GNU Iconv 1.9.1 +
Erlang/OTP R9C-2 or higher +
Expat 1.95.7 or higher +
GNU Iconv 1.9.1 (optional) -
Shining Light OpenSSL +
Shining Light OpenSSL (to enable SSL connections) -
Zlib 1.2.3 or higher +
Zlib 1.2.3 or higher
-
2.2  Obtaining ejabberd
+
2.2  Obtaining ejabberd
@@ -308,49 +299,49 @@ Released versions of ejabberd can be obtained from

The latest development version can be retrieved from the Subversion repository. -
+
svn co http://svn.process-one.net/ejabberd/trunk ejabberd
-
2.3  Compilation
+
2.3  Compilation
- + -
2.3.1  “Unix-like” operating systems
+
2.3.1  ``Unix-like'' operating systems
-Compile ejabberd on a “Unix-like” operating system by executing: -
+Compile ejabberd on a ``Unix-like'' operating system by executing: +
./configure make su make install
These commands will: -
+
install ejabberd into the directory /var/lib/ejabberd, -
install the configuration file into /etc/ejabberd, -
create a directory called /var/log/ejabberd to store log files. +
install the configuration file into /etc/ejabberd, +
create a directory called /var/log/ejabberd to store log files.
-
2.3.2  Windows
+
2.3.2  Windows
-
+
Install Erlang emulator (for example, into C:\Program Files\erl5.3). -
Install Expat library into C:\Program Files\Expat-1.95.7 +
Install Expat library into C:\Program Files\Expat-1.95.7 directory.

Copy file C:\Program Files\Expat-1.95.7\Libs\libexpat.dll to your Windows system directory (for example, C:\WINNT or C:\WINNT\System32) -
Build and install the Iconv library into the directory +
Build and install the Iconv library into the directory C:\Program Files\iconv-1.9.1.

Copy file C:\Program Files\iconv-1.9.1\bin\iconv.dll to your @@ -362,25 +353,25 @@ Note: instead of copying libexpat.dll and iconv.dll to the Windows C:\Program Files\Expat-1.95.7\Libs and C:\Program Files\iconv-1.9.1\bin to the PATH environment variable. -
While in the directory ejabberd\src run: -
+
While in the directory ejabberd\src run: +
configure.bat nmake -f Makefile.win32 -
Edit the file ejabberd\src\ejabberd.cfg and run -
+
Edit the file ejabberd\src\ejabberd.cfg and run +
werl -s ejabberd -name ejabberd
-
2.4  Starting
+
2.4  Starting
Execute the following command to start ejabberd: -
+
erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd
or -
+
erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
In the latter case the Erlang node will be identified using only the first part of the host name, i. e. other Erlang nodes outside this domain can't contact @@ -392,7 +383,7 @@ for storing its user database and for logging.

To specify the path to the configuration file, the log files and the Mnesia database directory, you may use the following command: -
+
erl -pa /var/lib/ejabberd/ebin \ -sname ejabberd \ -s ejabberd \ @@ -406,25 +397,25 @@ You can find other useful options in the Erlang manual page
To use more than 1024 connections, you should set the environment variable ERL_MAX_PORTS: -
+
export ERL_MAX_PORTS=32000
Note that with this value, ejabberd will use more memory (approximately 6 MB more).

To reduce memory usage, you may set the environment variable ERL_FULLSWEEP_AFTER: -
+
export ERL_FULLSWEEP_AFTER=0
But in this case ejabberd can start to work slower.

-
3  Configuration
+
3  Configuration
-
3.1  Initial Configuration
+
3.1  Initial Configuration
@@ -435,12 +426,12 @@ configuration file are appended to the entries in the database. The configuration file contains a sequence of Erlang terms. Lines beginning with a `%' 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 “hosts” option, the old +configuration file do not contain for instance the ``hosts'' option, the old host name(s) stored in the database will be used.

You can override the old values stored in the database by adding next lines to the configuration file: -
+
override_global. override_local. override_acls. @@ -449,7 +440,7 @@ before new ones are added.

-
3.1.1  Host Names
+
3.1.1  Host Names
@@ -457,23 +448,23 @@ The option hosts defines a list containing one or more domains that ejabberd will serve.

Examples: -
+
Serving one domain: -
-
+
+
{hosts, ["example.org"]}. -
Backwards compatibility with older ejabberd versions can be retained +
Backwards compatibility with older ejabberd versions can be retained with: -
+
{host, "example.org"}.
-
Serving two domains: -
+
Serving two domains: +
{hosts, ["example.net", "example.com"]}.
-
3.1.2  Default Language
+
3.1.2  Default Language
@@ -484,82 +475,82 @@ option language is "en". In order to take effect there must be translation file <language>.msg in ejabberd's msgs directory.

Examples: -
+
To set Russian as default language: -
+
{language, "ru"}. -
To set Spanish as default language: -
+
To set Spanish as default language: +
{language, "es"}.
-
3.1.3  Access Rules
+
3.1.3  Access Rules
Access control in ejabberd is performed via Access Control Lists (ACLs). The declarations of ACLs in the configuration file have the following syntax: -
+
{acl, <aclname>, {<acltype>, ...}}.
<acltype> can be one of the following: -
-all
Matches all JIDs. Example: -
+
+all
Matches all JIDs. Example: +
{acl, all, all}. -
{user, <username>}
Matches the user with the name +
{user, <username>}
Matches the user with the name <username> at the first virtual host. Example: -
+
{acl, admin, {user, "yozhik"}}. -
{user, <username>, <server>}
Matches the user with the JID +
{user, <username>, <server>}
Matches the user with the JID <username>@<server> and any resource. Example: -
+
{acl, admin, {user, "yozhik", "example.org"}}. -
{server, <server>}
Matches any JID from server +
{server, <server>}
Matches any JID from server <server>. Example: -
+
{acl, exampleorg, {server, "example.org"}}. -
{user_regexp, <regexp>}
Matches any local user with a name that +
{user_regexp, <regexp>}
Matches any local user with a name that matches <regexp> at the first virtual host. Example: -
+
{acl, tests, {user, "^test[0-9]*$"}}. -
{user_regexp, <regexp>, <server>}
Matches any user with a name +
{user_regexp, <regexp>, <server>}
Matches any user with a name that matches <regexp> at server <server>. Example: -
+
{acl, tests, {user, "^test", "example.org"}}. -
{server_regexp, <regexp>}
Matches any JID from the server that +
{server_regexp, <regexp>}
Matches any JID from the server that matches <regexp>. Example: -
+
{acl, icq, {server, "^icq\\."}}. -
{node_regexp, <user_regexp>, <server_regexp>}
Matches any user +
{node_regexp, <user_regexp>, <server_regexp>}
Matches any user with a name that matches <user_regexp> at any server that matches <server_regexp>. Example: -
+
{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. -
{user_glob, <glob>}
-
{user_glob, <glob>, <server>}
-
{server_glob, <glob>}
-
{node_glob, <user_glob>, <server_glob>}
This is the same as +
{user_glob, <glob>}
+
{user_glob, <glob>, <server>}
+
{server_glob, <glob>}
+
{node_glob, <user_glob>, <server_glob>}
This is the same as above. However, it uses shell glob patterns instead of regexp. These patterns can have the following special characters: -
- *
matches any string including the null string. -
?
matches any single character. -
[...]
matches any of the enclosed characters. Character +
+ *
matches any string including the null string. +
?
matches any single character. +
[...]
matches any of the enclosed characters. Character ranges are specified by a pair of characters separated by a `-'. If the first character after `[' is a `!', any character not enclosed is matched.

The following ACLs are pre-defined: -
-all
Matches any JID. -
none
Matches no JID. +
+all
Matches any JID. +
none
Matches no JID.
An entry allowing or denying access to different services looks similar to this: -
+
{access, <accessname>, [{allow, <aclname>}, {deny, <aclname>}, ... @@ -567,57 +558,57 @@ this:
When a JID is checked to have access to <accessname>, 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 “deny” is returned.
+the first matched tuple is returned, otherwise ``deny'' is returned.

Example: -
+
{access, configure, [{allow, admin}]}. {access, something, [{deny, badmans}, {allow, all}]}.
The following access rules are pre-defined: -
-all
Always returns “allow” -
none
Always returns “deny” +
+all
Always returns ``allow'' +
none
Always returns ``deny''
-
3.1.4  Shapers
+
3.1.4  Shapers
Shapers enable you to limit connection traffic. The syntax of shapers is like this: -
+
{shaper, <shapername>, <kind>}.
Currently only one kind of shaper called maxrate is available. It has the following syntax: -
+
{maxrate, <rate>}
where <rate> stands for the maximum allowed incomig rate in bytes per second.

Examples: -
-To define a shaper named “normal” with traffic speed limited to +
+To define a shaper named ``normal'' with traffic speed limited to 1,000 bytes/second: -
+
{shaper, normal, {maxrate, 1000}}. -
To define a shaper named “fast” with traffic speed limited to +
To define a shaper named ``fast'' with traffic speed limited to 50,000 bytes/second: -
+
{shaper, fast, {maxrate, 50000}}.
-
3.1.5  Limitation of the number of opened sessions
+
3.1.5  Limitation of the number of opened sessions
This option specifies the maximum number of sessions (authenticated connections) per user. If a user tries to open more than the maximum number of allowed sessions, with different resources, the first opened session will be -disconnected. The error “session replaced” is send to the +disconnected. The error ``session replaced'' is send to the disconnected session. This value is either a number or infinity. For example {max\_user\_sessions, 10}. The default value is 10.

@@ -625,21 +616,21 @@ This option can be define per virtual host. See section 3.1.6  Listened Sockets +
3.1.6  Listened Sockets
The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a tuple with the following elements: -
+
Port number. -
Module that serves this port. -
Options to this module. +
Module that serves this port. +
Options to this module.
Currently next modules are implemented: -
+
@@ -683,18 +674,18 @@ Currently next modules are implemented:

ejabberd_c2s certfile, http_poll, inet6, ip, tls, web_admin
-
+
(*) The mechanism for external components is defined in Jabber Component Protocol (JEP-0114).

The following options are available: -
- {access, <access rule>}
This option defines - access to the port. The default value is “all”. -
{certfile, Path}
Path to a file containing the SSL certificate. -
{hosts, [Hostnames], [HostOptions]}
This option +
+ {access, <access rule>}
This option defines + access to the port. The default value is ``all''. +
{certfile, Path}
Path to a file containing the SSL certificate. +
{hosts, [Hostnames], [HostOptions]}
This option defines one or more hostnames of connected services and enables you to specify additional options including {password, Secret}. -
http_poll
+
http_poll
This option enables HTTP Polling (JEP-0025) support. HTTP Polling enables access via HTTP requests to ejabberd from behind firewalls which do not allow outgoing sockets on port 5222.
@@ -706,85 +697,85 @@ If HTTP Polling is enabled, it will be available at JWChat (there is a tutorial to install JWChat with instructions for ejabberd). -
inet6
Set up the socket for IPv6. -
{ip, IPAddress}
This option specifies which network +
inet6
Set up the socket for IPv6. +
{ip, IPAddress}
This option specifies which network interface to listen for. For example {ip, {192, 168, 1, 1}}. -
{max_stanza_size, Size}
This +
{max_stanza_size, Size}
This option specifies an approximate maximal size in bytes of XML stanzas. For example {max\_stanza\_size, 65536}. The default value - is “infinity”. -
{shaper, <access rule>}
This option defines a + is ``infinity''. +
{shaper, <access rule>}
This option defines a shaper for the port (see section 3.1.4). The default value - is “none”. -
ssl
This option specifies that traffic on + is ``none''. +
ssl
This option specifies that traffic on the port will be encrypted using SSL. You should also set the certfile option. It is recommended to use the tls option instead. -
starttls
This option +
starttls
This option specifies that STARTTLS encryption is available on connections to the port. You should also set the certfile option. -
starttls_required
This option +
starttls_required
This option specifies that STARTTLS encryption is required on connections to the port. No unencrypted connections will be allowed. You should also set the certfile option. -
tls
This option specifies that traffic on +
tls
This option specifies that traffic on the port will be encrypted using SSL immediately after connecting. You should also set the certfile option. -
zlib
This +
zlib
This option specifies that Zlib stream compression (as defined in JEP-0138) is available on connections to the port. Client cannot use stream compression and stream encryption simultaneously, so if you specify both tls (or ssl) and zlib the latter option will not affect connection at all. -
web_admin
This option +
web_admin
This option enables the web interface for ejabberd administration which is available at http://server:port/admin/. Login and password are the username and password of one of the registered users who are granted access by the - “configure” access rule. + ``configure'' access rule.
Also the following global options are available for s2s connections: -
- {s2s_use_starttls, true|false}
+
+ {s2s_use_starttls, true|false}
This option defines whether to use STARTTLS for s2s connections. -
{s2s_certfile, Path}
Path to the +
{s2s_certfile, Path}
Path to the file containing the SSL certificate. -
{domain_certfile, Domain, Path}
Path +
{domain_certfile, Domain, Path}
Path to the file containing the SSL certificate for the specified domain.
For instance, the following configuration defines that: -
+
c2s connections are listened for on port 5222 and 5223 (SSL) and denied - for the user “bad” -
s2s connections are listened for on port 5269 with STARTTLS for secured + for the user ``bad'' +
s2s connections are listened for on port 5269 with STARTTLS for secured traffic enabled. -
Port 5280 is serving the web interface and the HTTP Polling service. Note +
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 3.4.1 shows how exactly this can be done. -
All users except for the administrators have a traffic of limit +
All users except for the administrators have a traffic of limit 1,000 Bytes/second -
The +
The AIM transport aim.example.org is connected to port 5233 with password - “aimsecret” -
The ICQ transport JIT (icq.example.org and + ``aimsecret'' +
The ICQ transport JIT (icq.example.org and sms.example.org) is connected to port 5234 with password - “jitsecret” -
The + ``jitsecret'' +
The MSN transport msn.example.org is connected to port 5235 with password - “msnsecret” -
The + ``msnsecret'' +
The Yahoo! transport yahoo.example.org is connected to port 5236 with password - “yahoosecret” -
The Gadu-Gadu transport gg.example.org is - connected to port 5237 with password “ggsecret” -
The + ``yahoosecret'' +
The Gadu-Gadu transport gg.example.org is + connected to port 5237 with password ``ggsecret'' +
The Jabber Mail Component jmc.example.org is connected to port 5238 with password - “jmcsecret” + ``jmcsecret''
-
+
{acl, blocked, {user, "bad"}}. {access, c2s, [{deny, blocked}, {allow, all}]}. @@ -815,7 +806,7 @@ c2s connections are listened for on port 5222 and 5223 (SSL) and denied {s2s_certfile, "/path/to/ssl.pem"}.
Note, that for jabberd 1.4- or WPJabber-based services you have to make the transports log and do XDB by themselves: -
+
<!-- You have to add elogger and rlogger entries here when using ejabberd. In this case the transport will do the logging. @@ -847,7 +838,7 @@ services you have to make the transports log and do XDB by themselves:
-
3.1.7  Modules
+
3.1.7  Modules
@@ -857,17 +848,17 @@ element is the name of a module and the second is a list of options for that module. Read section A for detailed information about modules.

Examples: -
+
In this simple example, only the module mod_echo is loaded and no options are specified between square brackets: -
+
{modules, [{mod_echo, []} ]}. -
The second example is also simple: the modules mod_echo, mod_time, and +
The second example is also simple: the modules mod_echo, mod_time, and mod_version are loaded without options. Remark that, besides the last entry, all entries end with a comma: -
+
{modules, [{mod_echo, []}, {mod_time, []}, @@ -876,22 +867,22 @@ In this simple example, only the module mod_echo is loaded and no
-
3.1.8  Virtual Hosting
+
3.1.8  Virtual Hosting
Options can be defined separately for every virtual host using the host_config option. It has the following syntax: -
+
{host_config, <hostname>, [<option>, <option>, ...]}.
Examples: -
+
Domain example.net is using the internal authentication method while domain example.com is using the LDAP server running on the domain localhost to perform authentication: -
+
{host_config, "example.net", [{auth_method, internal}]}. {host_config, "example.com", [{auth_method, ldap}, @@ -900,10 +891,10 @@ Domain example.net is using the internal authentication method while {ldap_rootdn, "dc=localdomain"}, {ldap_rootdn, "dc=example,dc=com"}, {ldap_password, ""}]}. -
Domain example.net is using ODBC to perform authentication +
Domain example.net is using ODBC to perform authentication while domain example.com is using the LDAP servers running on the domains localhost and otherhost: -
+
{host_config, "example.net", [{auth_method, odbc}, {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. @@ -916,24 +907,24 @@ Domain example.net is using the internal authentication method while
-
3.1.9  SASL anonymous and anonymous login
+
3.1.9  SASL anonymous and anonymous login
The configuration of the anonymous mode can be done with three host_config parameters: -
+
auth_method: This value is used for defining the authentication method: internal, odbc, ldap, external). You now have a special extra option to enable anonymous mode: anonymous.

-
allow_multiple_connections: This option can be either true or false and +
allow_multiple_connections: This option can be either true or false and is only used when the anonymous mode is enabled. Setting it to true means that the same username will be able to be taken several time in anonymous login mode if different resource are used to connect. This option is only useful in very special cases. It defaults to false.

-
anonymous_protocol: This option can take three values: +
anonymous_protocol: This option can take three values: sasl_anon, login_anon or both. sasl_anon means that SASL anonymous mode is enabled. login_anon means that anonymous login mode is enabled. both means that SASL anonymous and login anonymous are @@ -943,26 +934,26 @@ Those options are defined for each virtual host with the host_config parameter (see section 3.1.8).

Examples: -
+
To enable anonymous login on a virtual host: -
+
{host_config, "public.example.org", [{auth_method, anonymous}, {anonymous_protocol, login_anon}]}. -
To enable anonymous login and internal authentication on a virtual host: -
+
To enable anonymous login and internal authentication on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, login_anon}]}. -
To enable SASL anonymous on a virtual host: -
+
To enable SASL anonymous on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, sasl_anon}]}. -
To enable SASL anonymous and anonymous login on a virtual host: -
+
To enable SASL anonymous and anonymous login on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, both}]}. -
To enable SASL anonymous, anonymous login and internal authentication on +
To enable SASL anonymous, anonymous login and internal authentication on a virtual host: -
+
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, both}]}.
@@ -972,12 +963,12 @@ available from:
-
3.2  Relational Database Support
+
3.2  Relational Database Support
-
3.2.1  Preliminary steps
+
3.2.1  Preliminary steps
If you have installed ejabberd using a binary version, the compilation steps @@ -987,17 +978,17 @@ Otherwise, to be able to use ejabberd with a relational database you need to enable ODBC modules during compilation, even if you want to use ejabberd with MySQL or PostgreSQL in native mode. The following configure command can be used to enable the relational modules: -
+
./configure --enable-odbc
If you are planning to use Microsoft SQL Server with ODBC, you need to specify it from the configure command before compilation: -
+
./configure --enable-odbc --enable-mssql
-
3.2.2  Authentication against a relational database
+
3.2.2  Authentication against a relational database
ejabberd use its internal Mnesia database as a default. It is however possible @@ -1010,7 +1001,7 @@ system.
The option value name be misleading, as the method name is use both for access to relational database through ODBC or through the native interface. In any case, the first step is to define the odbc auth_method. For example: -
+
{host_config, "public.example.org", [{auth_method, [odbc]}]}.
The actual database access is defined in the option odbc_server. Its @@ -1019,16 +1010,16 @@ interface available, PostgreSQL or MySQL.

To use a relational database through ODBC, you can pass the ODBC connection string as odbc_server parameter. For example: -
+
{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.
To use the native PostgreSQL interface, you can pass a tuple of the following form as parameter: -
+
{pgsql, "Server", "Database", "Username", "Password"}
pgsql is a keyword that should be kept as is. For example: -
+
{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.
Note that you need to install the Erlang PgSQL library first. This library is @@ -1037,11 +1028,11 @@ available from Sourceforge: +
{mysql, "Server", "Database", "Username", "Password"}
mysql is a keyword that should be kept as is. For example: -
+
{odbc_server, {mysql, "localhost", "test", "root", "password"}}.
Note that you need to install the Erlang MySQL library first. This library is @@ -1052,61 +1043,61 @@ available from: 3.2.3  Relational database for other modules +
3.2.3  Relational database for other modules
It is possible to use a relational database to store pieces of information. You can do this by changing the module name to a name with an _odbc suffix in ejabberd config file. You can use a relational database for the following data: -
+
Last connection date and time: Use mod_last_odbc instead of mod_last. -
Offline messages: Use mod_offline_odbc instead of +
Offline messages: Use mod_offline_odbc instead of mod_offline. -
Rosters: Use mod_roster_odbc instead of mod_roster. -
Users' VCARD: Use mod_vcard_odbc instead of mod_vcard. +
Rosters: Use mod_roster_odbc instead of mod_roster. +
Users' VCARD: Use mod_vcard_odbc instead of mod_vcard.
-
3.3  Creating an Initial Administrator
+
3.3  Creating an Initial Administrator
Before the web interface can be entered to perform administration tasks, an account with administrator rights is needed on your ejabberd deployment.

Instructions to create an initial administrator account: -
+
Register an account on your ejabberd deployment. An account can be created in two ways: -
+
Using the tool ejabberdctl (see section 3.4.2): -
+
% ejabberdctl node@host register admin example.org password -
Using In-Band Registration (see section A.14): you can +
Using In-Band Registration (see section A.14): you can use a Jabber client to register an account.
-
Edit the configuration file to promote the account created in the previous +
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. -
+
{acl, admins, {user, "admin", "example.org"}}. {access, configure, [{allow, admins}]}. -
Restart ejabberd to load the new configuration. -
Open the web interface (http://server:port/admin/) in your +
Restart ejabberd to load the new configuration. +
Open the web interface (http://server:port/admin/) in your favourite browser. Make sure to enter the full JID as username (in this example: admin@example.org. The reason that you also need to enter the suffix, is because ejabberd's virtual hosting support.
-
3.4  Online Configuration and Monitoring
+
3.4  Online Configuration and Monitoring
-
3.4.1  Web Interface
+
3.4.1  Web Interface
@@ -1117,24 +1108,22 @@ section 3.1.6). Then you can open will be asked to enter the username (the full Jabber ID) and password of an ejabberd user with administrator rights. After authentication you will see a page similar to figure 1. -
+

-
-
Figure 1: Top page from the web interface

-
+
Figure 1: Top page from the web interface

-
+
Here you can edit access restrictions, manage users, create backups, manage the database, enable/disable ports listened for, view server statistics,...

Examples: -
+
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 http://example.org:5280/admin/ to @@ -1143,11 +1132,11 @@ You can serve the web interface on the same port as the the virtual host example.com. 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 ejabberd. In this example you can enter as - username “admin@example.net” to administer all virtual hosts (first - URL). If you log in with “admin@example.com” on
+ username ``admin@example.net'' to administer all virtual hosts (first + URL). If you log in with ``admin@example.com'' on
http://example.org:5280/admin/server/example.com/ you can only administer the virtual host example.com. -
+
... {acl, admins, {user, "admin", "example.net"}}. {host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}. @@ -1161,11 +1150,11 @@ You can serve the web interface on the same port as the ... ] }. -
For security reasons, you can serve the web interface on a secured +
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 https://192.168.1.1:5280/admin/: -
+
... {hosts, ["example.org"]}. ... @@ -1180,13 +1169,13 @@ You can serve the web interface on the same port as the
-
3.4.2  ejabberdctl
+
3.4.2  ejabberdctl
It is possible to do some administration operations using the command line tool ejabberdctl. You can list all available options by running ejabberdctl without arguments: -
+
% ejabberdctl Usage: ejabberdctl node command @@ -1211,27 +1200,27 @@ Example: ejabberdctl ejabberd@host restart
Additional information: -
-reopen-log
If you use a tool to rotate logs, you have to configure it +
+reopen-log
If you use a tool to rotate logs, you have to configure it so that this command is executed after each rotation. -
backup, restore, install-fallback, dump, load
You can use these +
backup, restore, install-fallback, dump, load
You can use these commands to create and restore backups. -
import-file, import-dir
+
import-file, import-dir
These options can be used to migrate from other Jabber/XMPP servers. There exist tutorials to migrate from jabberd 1.4 and to migrate from jabberd2. -
delete-expired-messages
This option can be used to delete old messages +
delete-expired-messages
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.
-
4  Firewall Settings
+
4  Firewall Settings
You need to take the following TCP ports in mind when configuring your firewall: -
+
@@ -1252,28 +1241,28 @@ You need to take the following TCP ports in mind when configuring your firewall:

Port Description Only for clustring (see 6). This range is configurable (see 2.4).
-
+
-
5  SRV Records
+
5  SRV Records
-
+
General information: SRV record -
Practical information: +
Practical information: Setting DNS SRV Records
-
6  Clustering
+
6  Clustering
-
6.1  How it Works
+
6.1  How it Works
@@ -1286,15 +1275,15 @@ needed because all nodes exchange information about connected users, s2s connections, registered services, etc...

Each ejabberd node has the following modules: -
+
router, -
local router, -
session manager, -
s2s manager. +
local router, +
session manager, +
s2s manager.
-
6.1.1  Router
+
6.1.1  Router
This module is the main router of Jabber packets on each node. It @@ -1305,7 +1294,7 @@ appropriate process. If not, it is sent to the s2s manager.

-
6.1.2  Local Router
+
6.1.2  Local Router
This module routes packets which have a destination domain equal to @@ -1315,7 +1304,7 @@ on its content.

-
6.1.3  Session Manager
+
6.1.3  Session Manager
This module routes packets to local users. It looks up to which user @@ -1325,7 +1314,7 @@ storage, or bounced back.

-
6.1.4  s2s Manager
+
6.1.4  s2s Manager
This module routes packets to other Jabber servers. First, it @@ -1336,52 +1325,52 @@ serving this connection, otherwise a new connection is opened.

-
6.2  Clustering Setup
+
6.2  Clustering Setup
Suppose you already configured ejabberd on one machine named (first), and you need to setup another one to make an ejabberd cluster. Then do following steps: -
+
Copy ~ejabberd/.erlang.cookie file from first to second.

-(alt) You can also add “-cookie content_of_.erlang.cookie” - option to all “erl” commands below.
+(alt) You can also add ``-cookie content_of_.erlang.cookie'' + option to all ``erl'' commands below.

-
On second run as the `ejabberd' user in the directory +
On second run as the `ejabberd' user in the directory where ejabberd will work later the following command: -
+
erl -sname ejabberd \ -mnesia extra_db_nodes "['ejabberd@first']" \ -s mnesia
This will start Mnesia serving the same database as ejabberd@first. - You can check this by running the command “mnesia:info().”. You + You can check this by running the command ``mnesia:info().''. You should see a lot of remote tables and a line like the following: -
+
running db nodes = [ejabberd@first, ejabberd@second]

-
Now run the following in the same “erl” session: -
+
Now run the following in the same ``erl'' session: +
mnesia:change_table_copy_type(schema, node(), disc_copies).
This will create local disc storage for the database.

-(alt) Change storage type of `scheme' table to “RAM and disc - copy” on the second node via the web interface.
+(alt) Change storage type of `scheme' table to ``RAM and disc + copy'' on the second node via the web interface.

-
Now you can add replicas of various tables to this node with - “mnesia:add_table_copy” or - “mnesia:change_table_copy_type” as above (just replace - “schema” with another table name and “disc_copies” - can be replaced with “ram_copies” or - “disc_only_copies”).
+
Now you can add replicas of various tables to this node with + ``mnesia:add_table_copy'' or + ``mnesia:change_table_copy_type'' as above (just replace + ``schema'' with another table name and ``disc_copies'' + can be replaced with ``ram_copies'' or + ``disc_only_copies'').

Which tables to replicate is very dependant on your needs, you can get - some hints from the command “mnesia:info().”, by looking at the + some hints from the command ``mnesia:info().'', by looking at the size of tables and the default storage type for each table on 'first'.

Replicating a table makes lookups in this table faster on this node. @@ -1393,13 +1382,13 @@ Also Run “init:stop().” or just “q().” to exit from +
Run ``init:stop().'' or just ``q().'' 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 first.

-
Now run ejabberd on second with almost the same config as - on first (you probably don't need to duplicate “acl” - and “access” options — they will be taken from +
Now run ejabberd on second with almost the same config as + on first (you probably don't need to duplicate ``acl'' + and ``access'' options --- they will be taken from first, and mod_muc and mod_irc should be enabled only on one machine in the cluster).
@@ -1409,13 +1398,13 @@ domain.
-
A  Built-in Modules
+
A  Built-in Modules
-
A.1  Overview
+
A.1  Overview
@@ -1427,14 +1416,14 @@ that they can contain severe bugs and security leaks. Therefore, use them at your own risk!

You can see which database backend each module needs by looking at the suffix: -
-“_ldap”, this means that the module needs an LDAP server as backend. -
“_odbc”, this means that the module needs an ODBC compatible database, +
+``_ldap'', this means that the module needs an LDAP server as backend. +
``_odbc'', this means that the module needs an ODBC compatible database, a MySQL database, or a PostgreSQL database as backend. -
Nothing, this means that the modules uses Erlang's built-in database +
Nothing, this means that the modules uses Erlang's built-in database Mnesia as backend.
-
+
@@ -1621,13 +1610,13 @@ You can see which database backend each module needs by looking at the suffix:

Module Feature No
-
+
(*) This module or a similar one with another database backend is needed for XMPP compliancy.

-
A.2  Common Options
+
A.2  Common Options
The following options are used by many modules. Therefore, they are described in @@ -1635,7 +1624,7 @@ this separate section.

-
A.2.1  iqdisc
+
A.2.1  iqdisc
@@ -1643,23 +1632,23 @@ Many modules define handlers for processing IQ queries of different namespaces to this server or to a user (e. g. to example.org or to user@example.org). This option defines processing discipline for these queries. Possible values are: -
-no_queue
All queries of a namespace with this processing discipline are +
+no_queue
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. -
one_queue
In this case a separate queue is created for the processing +
one_queue
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. -
parallel
For every packet with this discipline a separate Erlang process +
parallel
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).
Example: -
+
{modules, [ ... @@ -1669,7 +1658,7 @@ Example:
-
A.2.2  hosts
+
A.2.2  hosts
@@ -1677,19 +1666,19 @@ A module acting as a service can have one or more hostnames. These hostnames can be defined with the hosts option.

Examples: -
+
Serving the echo module on one domain: -
-
+
+
{modules, [ ... {mod_echo, [{hosts, ["echo.example.org"]}]}, ... ]}. -
Backwards compatibility with older ejabberd versions can be retained +
Backwards compatibility with older ejabberd versions can be retained with: -
+
{modules, [ ... @@ -1697,8 +1686,8 @@ Serving the echo module on one domain: ... ]}.
-
Serving the echo module on two domains: -
+
Serving the echo module on two domains: +
{modules, [ ... @@ -1708,7 +1697,7 @@ Serving the echo module on one domain:
-
A.3  mod_announce
+
A.3  mod_announce
@@ -1718,36 +1707,36 @@ 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 example.org, while the JID between brackets will apply to all virtual hosts: -
-example.org/announce/all (example.org/announce/all-hosts/all)
The +
+example.org/announce/all (example.org/announce/all-hosts/all)
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 A.10) is enabled. -
example.org/announce/online (example.org/announce/all-hosts/online)
The +
example.org/announce/online (example.org/announce/all-hosts/online)
The message is sent to all connected users. If the user is online and connected to several resources, all resources will receive the message. -
example.org/announce/motd (example.org/announce/all-hosts/motd)
The +
example.org/announce/motd (example.org/announce/all-hosts/motd)
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 announce/online). -
example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
+
example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
The message is set as message of the day (MOTD) and is sent to users when they login. The message is not sent to any currently connected user. -
example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
+
example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
Any message sent to this JID removes the existing message of the day (MOTD).
Options: -
-access
This option specifies who is allowed to +
+access
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).
Examples: -
+
Only administrators can send announcements: -
+
{access, announce, [{allow, admins}]}. {modules, @@ -1756,8 +1745,8 @@ Only administrators can send announcements: {mod_announce, [{access, announce}]}, ... ]}. -
Administrators as well as the direction can send announcements: -
+
Administrators as well as the direction can send announcements: +
{acl, direction, {user, "big_boss", "example.org"}}. {acl, direction, {user, "assistant", "example.org"}}. {acl, admins, {user, "admin", "example.org"}}. @@ -1774,7 +1763,7 @@ Only administrators can send announcements:
-
A.4  mod_disco
+
A.4  mod_disco
@@ -1787,26 +1776,26 @@ the newer Service Discovery protocol if you want them be able to discover the services you offer.

Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Service Discovery (http://jabber.org/protocol/disco#items and http://jabber.org/protocol/disco#info) IQ queries (see section A.2.1). -
extra_domains
With this option, +
extra_domains
With this option, extra domains can be added to the Service Discovery item list.
Examples: -
+
To serve a link to the Jabber User Directory on jabber.org: -
+
{modules, [ ... {mod_disco, [{extra_domains, ["users.jabber.org"]}]}, ... ]}. -
To serve a link to the transports on another server: -
+
To serve a link to the transports on another server: +
{modules, [ ... @@ -1814,8 +1803,8 @@ To serve a link to the Jabber User Directory on jabber.org: "msn.example.com"]}]}, ... ]}. -
To serve a link to a few friendly servers: -
+
To serve a link to a few friendly servers: +
{modules, [ ... @@ -1826,7 +1815,7 @@ To serve a link to the Jabber User Directory on jabber.org:
-
A.5  mod_echo
+
A.5  mod_echo
@@ -1835,31 +1824,31 @@ packet back to the sender. This mirror can be of interest for ejabberd and Jabber client debugging.

Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix “echo.” is added to all + the old host is present, the prefix ``echo.'' is added to all ejabberd hostnames.
Examples: -
+
Mirror, mirror, on the wall, who is the most beautiful of them all? -
+
{modules, [ ... {mod_echo, [{hosts, ["mirror.example.org"]}]}, ... ]}. -
If you still do not understand the inner workings of mod_echo, +
If you still do not understand the inner workings of mod_echo, you can find a few more examples in section A.2.2.
-
A.6  mod_irc
+
A.6  mod_irc
@@ -1868,50 +1857,50 @@ servers.

End user information: -
-A Jabber client with “groupchat 1.0” support or Multi-User +
+A Jabber client with ``groupchat 1.0'' support or Multi-User Chat support (JEP-0045) is necessary to join IRC channels. -
An IRC channel can be joined in nearly the same way as joining a +
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 “channel%irc.example.org” in case irc.example.org is - the IRC server hosting “channel”. And of course the host should point + be ``channel%irc.example.org'' in case irc.example.org is + the IRC server hosting ``channel''. And of course the host should point to the IRC transport instead of the Multi-User Chat service. -
You can register your nickame by sending “IDENTIFY password” to
+
You can register your nickame by sending ``IDENTIFY password'' to
nickserver!irc.example.org@irc.jabberserver.org. -
Entering your password is possible by sending “LOGIN nick password”
+
Entering your password is possible by sending ``LOGIN nick password''
to nickserver!irc.example.org@irc.jabberserver.org. -
When using a popular Jabber server, it can occur that no +
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.
Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix “irc.” is added to all + the old host is present, the prefix ``irc.'' is added to all ejabberd hostnames. -
access
This option can be used to specify who +
access
This option can be used to specify who may use the IRC transport (default value: all).
Examples: -
+
In the first example, the IRC transport is available on (all) your - virtual host(s) with the prefix “irc.”. Furthermore, anyone is + virtual host(s) with the prefix ``irc.''. Furthermore, anyone is able to use the transport. -
+
{modules, [ ... {mod_irc, [{access, all}]}, ... ]}. -
In next example the IRC transport is available on the two virtual hosts +
In next example the IRC transport is available on the two virtual hosts example.net and example.com with different prefixes on each host. Moreover, the transport is only accessible by paying customers registered on our domains and on other servers. -
+
{acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -1929,7 +1918,7 @@ In the first example, the IRC transport is available on (all) your
-
A.7  mod_last
+
A.7  mod_last
@@ -1939,14 +1928,14 @@ connected user was last active on the server, or to query the uptime of the ejabberd server.

Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Last activity (jabber:iq:last) IQ queries (see section A.2.1).
-
A.8  mod_muc
+
A.8  mod_muc
@@ -1955,34 +1944,34 @@ With this module enabled, your server will support Multi-User Chat that this module is not (yet) clusterable.

Some of the features of Multi-User Chat: -
+
Sending private messages to room participants. -
Inviting users. -
Setting a conference topic. -
Creating password protected rooms. -
Kicking and banning participants. +
Inviting users. +
Setting a conference topic. +
Creating password protected rooms. +
Kicking and banning participants.
Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix “conference.” is added to all + the old host is present, the prefix ``conference.'' is added to all ejabberd hostnames. -
access
You can specify who is allowed to use +
access
You can specify who is allowed to use the Multi-User Chat service (by default, everyone is allowed to use it). -
access_create
To configure who is +
access_create
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). -
access_admin
This option specifies +
access_admin
This option specifies who is allowed to administrate the Multi-User Chat service (the default value is none, which means that only the room creator can administer his room). By sending a message to the service JID, administrators can send service messages that will be displayed in every active room.

-
history_size
a small history of the +
history_size
a small history of the current discussion is send to users when they enter the room. This option make it possible to define the number of history messages to keep and send to the user joining the room. The value is a integer. Setting the value to 0 @@ -1990,17 +1979,17 @@ Options: is 20. This value is global and affects all MUC rooms on the server.
Examples: -
+
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 admin@example.org is allowed to administrate any room. In this example he is also a global administrator. When admin@example.org - sends a message such as “Tomorrow, the Jabber server will be moved + sends a message such as ``Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns around 23:00 UMT. - We apologise for this inconvenience.” to conference.example.org, + We apologise for this inconvenience.'' to conference.example.org, it will be displayed in all active rooms. In this example the history feature is disabled. -
+
{acl, admins, {user, "admin", "example.org"}}. ... {access, muc_admins, [{allow, admins}]}. @@ -2014,17 +2003,17 @@ In the first example everyone is allowed to use the Multi-User Chat {history_size, 0}]}, ... ]}. -
In the second example the Multi-User Chat service is only accessible by +
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. When - admin@example.org sends a message such as “Tomorrow, the Jabber + admin@example.org sends a message such as ``Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns - around 23:00 UMT. We apologise for this inconvenience.” to + around 23:00 UMT. We apologise for this inconvenience.'' to conference.example.org, it will be displayed in all active rooms. No history_size option is used, this means that the feature is enabled and the default value of 20 history messages will be send to the users. -
+
{acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -2047,7 +2036,7 @@ In the first example everyone is allowed to use the Multi-User Chat
-
A.9  mod_muc_log
+
A.9  mod_muc_log
@@ -2056,53 +2045,53 @@ Once you enable this module, join a chatroom with enought privileges using a MUC request the configuration form and there you will have an option to enable chatroom logging.

Some of the features of generated logs: -
+
A lot of information about chatroom is added on top of the page: Room title, JID, subject author, subject and configuration. -
Room title and JID are links to join the chatroom (using XMPP-IRI). -
Subject and chatroom configuration changes are tracked and displayed. -
Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. -
Generated HTML files are XHTML 1.0 Transitional and CSS compliant. -
Timestamps are self-referencing links. -
Links on top for quicker navigation: Previous day, Next day, Up. -
CSS is used for style definition, and a custom CSS file can be used. -
URLs on messages and subjects are converted to hyperlinks. -
Timezone used on timestamps is shown on the log files. -
A custom link can be added on top of page. +
Room title and JID are links to join the chatroom (using XMPP-IRI). +
Subject and chatroom configuration changes are tracked and displayed. +
Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. +
Generated HTML files are XHTML 1.0 Transitional and CSS compliant. +
Timestamps are self-referencing links. +
Links on top for quicker navigation: Previous day, Next day, Up. +
CSS is used for style definition, and a custom CSS file can be used. +
URLs on messages and subjects are converted to hyperlinks. +
Timezone used on timestamps is shown on the log files. +
A custom link can be added on top of page.
Options: -
-access_log
+
+access_log
Restricts which users are allowed to enable or disable chatroom logging using ACL and ACCESS. Default: muc_admin. If you want to allow any chatroom owner put: muc. -
cssfile
+
cssfile
If HTMLs will use a custom CSS file or the embedded one. Allowed values: false: HTMLs will include the standard CSS code; "CSS-URL": the URL of the CSS file (for example: "http://example.com/my.css"). Default: false. -
dirtype
+
dirtype
Type of directory that will be created. Allowed values: subdirs: creates subdirectories for year and month; plain: the filename contains the full date, no subdirs. Default: subdirs. -
outdir
+
outdir
Full path to the directory where html will be generated. Make sure the system user has write access on that directory. Default: "www/muc". -
timezone
+
timezone
What timezone should be used. Allowed values: local: use local time, as reported to Erlang by the operating system; universal: use GMT/UTC time. Default: local. -
top_link
+
top_link
Customizable link on top right corner. Syntax of this option: {"URL", "Text"}. Default: {"/", "Home"}.
Example configuration: -
+
{modules, [ ... @@ -2119,7 +2108,7 @@ Example configuration:
-
A.10  mod_offline
+
A.10  mod_offline
@@ -2131,78 +2120,78 @@ online again. Thus it is very similar to how email works. Note that
-
A.11  mod_privacy
+
A.11  mod_privacy
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: -
-
+
+
Retrieving one's privacy lists. -
Adding, removing, and editing one's privacy lists. -
Setting, changing, or declining active lists. -
Setting, changing, or declining the default list (i.e., the list that +
Adding, removing, and editing one's privacy lists. +
Setting, changing, or declining active lists. +
Setting, changing, or declining the default list (i.e., the list that is active by default). -
Allowing or blocking messages based on JID, group, or subscription type +
Allowing or blocking messages based on JID, group, or subscription type (or globally). -
Allowing or blocking inbound presence notifications based on JID, group, +
Allowing or blocking inbound presence notifications based on JID, group, or subscription type (or globally). -
Allowing or blocking outbound presence notifications based on JID, group, +
Allowing or blocking outbound presence notifications based on JID, group, or subscription type (or globally). -
Allowing or blocking IQ stanzas based on JID, group, or subscription type +
Allowing or blocking IQ stanzas based on JID, group, or subscription type (or globally). -
Allowing or blocking all communications based on JID, group, or +
Allowing or blocking all communications based on JID, group, or subscription type (or globally).
(from http://www.xmpp.org/specs/rfc3921.html#privacy)
Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section A.2.1).
-
A.12  mod_private
+
A.12  mod_private
This module adds support for Private XML Storage (JEP-0049): -
+
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 (JEP-0048).
Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section A.2.1).
-
A.13  mod_pubsub
+
A.13  mod_pubsub
This module offers a Publish-Subscribe Service (JEP-0060). Publish-Subscribe can be used to develop (examples are taken from the JEP): -
-
+
+
news feeds and content syndacation, -
avatar management, -
shared bookmarks, -
auction and trading systems, -
online catalogs, -
workflow systems, -
network management systems, -
NNTP gateways, -
vCard/profile management, -
and weblogs. +
avatar management, +
shared bookmarks, +
auction and trading systems, +
online catalogs, +
workflow systems, +
network management systems, +
NNTP gateways, +
vCard/profile management, +
and weblogs.

@@ -2212,21 +2201,21 @@ known as ESB, the Enterprise Service Bus). The J-EAI project builts upon ejabberd's codebase and has contributed several features to mod_pubsub.

Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix “pubsub.” is added to all + the old host is present, the prefix ``pubsub.'' is added to all ejabberd hostnames. -
served_hosts
To specify which hosts needs to +
served_hosts
To specify which hosts needs to be served, you can use this option. If absent, only the main ejabberd - host is served.
access_createnode
+ host is served.
access_createnode
Restricts which users are allowed to create pubsub nodes using ACL and ACCESS. Default: pubsub_createnode.
Example: -
+
{modules, [ ... @@ -2238,38 +2227,37 @@ Example:
-
A.14  mod_register
+
A.14  mod_register
This module adds support for In-Band Registration (JEP-0077). This protocol enables end users to use a Jabber client to: -
+
Register a new account on the server. -
Change the password from an existing account on the server. -
Delete an existing account on the server. +
Change the password from an existing account on the server. +
Delete an existing account on the server.
Options: -
-access
This option can be configured to specify - rules to restrict registration. If a rule returns “deny” on the requested +
+access
This option can be configured to specify + rules to restrict registration. If a rule returns ``deny'' on the requested user name, registration for that user name is dennied. (there are no restrictions by default). -
iqdisc
This specifies +
iqdisc
This specifies the processing discipline for In-Band Registration (jabber:iq:register) IQ queries (see section A.2.1).
Examples: -
-Next example prohibits the registration of too short account names and of - account names with exotic characters in it: -
+
+Next example prohibits the registration of too short account names: +
{acl, shortname, {user_glob, "?"}}. {acl, shortname, {user_glob, "??"}}. - {acl, strangename, {user_regexp, "^..?$"}}. + % The same using regexp: + %{acl, shortname, {user_regexp, "^..?$"}}. ... {access, register, [{deny, shortname}, - {deny, strangename}, {allow, all}]}. ... {modules, @@ -2278,12 +2266,12 @@ Next example prohibits the registration of too short account names and of {mod_register, [{access, register}]}, ... ]}. -
The in-band registration of new accounts can be prohibited by changing the +
The in-band registration of new accounts can be prohibited by changing the access 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 mod_register from the modules list. In this example all In-Band Registration functionality is disabled: -
+
{access, register, [{deny, all}]}. {modules, @@ -2295,21 +2283,21 @@ Next example prohibits the registration of too short account names and of
-
A.15  mod_roster
+
A.15  mod_roster
This module implements roster management as defined in RFC 3921: XMPP IM.

Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section A.2.1).
-
A.16  mod_service_log
+
A.16  mod_service_log
@@ -2320,25 +2308,25 @@ packets are encapsulated in a <route/> element and sent to th service(s).

Options: -
-loggers
With this option a (list of) service(s) +
+loggers
With this option a (list of) service(s) that will receive the packets can be specified.
Examples: -
+
To log all end user packets to the Bandersnatch service running on bandersnatch.example.com: -
+
{modules, [ ... {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]}, ... ]}. -
To log all end user packets to the Bandersnatch service running on +
To log all end user packets to the Bandersnatch service running on bandersnatch.example.com and the backup service on bandersnatch.example.org: -
+
{modules, [ ... @@ -2349,7 +2337,7 @@ To log all end user packets to the Bandersnatch service running on
-
A.17  mod_shared_roster
+
A.17  mod_shared_roster
@@ -2361,21 +2349,21 @@ users from the shared roster groups.

Shared roster groups can be edited only via the web interface. Each group has a unique identification and the following parameters: -
-Name
The name of the group, which will be displayed in the roster. -
Description
The description of the group. This parameter doesn't affect +
+Name
The name of the group, which will be displayed in the roster. +
Description
The description of the group. This parameter doesn't affect anything. -
Members
A list of full JIDs of group members, entered one per line in +
Members
A list of full JIDs of group members, entered one per line in the web interface. -
Displayed groups
A list of groups that will be in the rosters of this +
Displayed groups
A list of groups that will be in the rosters of this group's members.
Examples: -
+
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: -
+
@@ -2398,14 +2386,14 @@ Take the case of a computer club that wants all its members seeing each

Identification Group `club_members'
Displayed groups club_members
-
-
In another case we have a company which has three divisions: Management, +
+
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: -
+
@@ -2472,25 +2460,25 @@ Take the case of a computer club that wants all its members seeing each

Identification Group `management'
sales
-
+

-
A.18  mod_stats
+
A.18  mod_stats
This module adds support for Statistics Gathering (JEP-0039). This protocol allows you to retrieve next statistics from your ejabberd deployment: -
+
Total number of registered users on the current virtual host (users/total). -
Total number of registered users on all virtual hosts (users/all-hosts/total). -
Total number of online users on the current virtual host (users/online). -
Total number of online users on all virtual hosts (users/all-hosts/online). +
Total number of registered users on all virtual hosts (users/all-hosts/total). +
Total number of online users on the current virtual host (users/online). +
Total number of online users on all virtual hosts (users/all-hosts/online).
Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Statistics Gathering (http://jabber.org/protocol/stats) IQ queries (see section A.2.1).
@@ -2498,18 +2486,18 @@ As there are only a small amount of clients (for example Tkabber) 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: -
+
You can request the number of online users on the current virtual host (example.org) by sending: -
+
<iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/online'/> </query> </iq> -
You can request the total number of registered users on all virtual hosts +
You can request the total number of registered users on all virtual hosts by sending: -
+
<iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/all-hosts/total'/> @@ -2518,7 +2506,7 @@ You can request the number of online users on the current virtual host
-
A.19  mod_time
+
A.19  mod_time
@@ -2526,14 +2514,14 @@ This module features support for Entity Time (
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section A.2.1).
-
A.20  mod_vcard
+
A.20  mod_vcard
@@ -2543,39 +2531,39 @@ implements an uncomplicated Jabber User Directory based on the vCards of these users. Moreover, it enables the server to send its vCard when queried.

Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix “vjud.” is added to all + the old host is present, the prefix ``vjud.'' is added to all ejabberd hostnames. -
iqdisc
This specifies +
iqdisc
This specifies the processing discipline for vcard-temp IQ queries (see section A.2.1). -
search
This option specifies whether the search +
search
This option specifies whether the search functionality is enabled (value: true) or disabled (value: false). If disabled, the option hosts will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true. -
matches
With this option, the number of reported +
matches
With this option, the number of reported search results can be limited. If the option's value is set to infinity, all search results are reported. The default value is 30. -
allow_return_all
This option enables +
allow_return_all
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 false. -
search_all_hosts
If this option is +
search_all_hosts
If this option is set to true, search operations will apply to all virtual hosts. Otherwise only the current host will be searched. The default value is true.
Examples: -
+
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: -
+
{modules, [ ... @@ -2585,9 +2573,9 @@ In this first situation, search results are limited to twenty items, {search_all_hosts, false}]}, ... ]}. -
The second situation differs in a way that search results are not limited, +
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: -
+
{modules, [ ... @@ -2597,9 +2585,338 @@ In this first situation, search results are limited to twenty items, ... ]}.
+ + +
A.21  LDAP and mod_vcard_ldap
+ + + + + +
A.21.1  Features
+ + +ejabberd has built-in LDAP support. You can authenticate users against LDAP +server and use LDAP directory as vCard storage. Shared rosters are not +supported yet.
+
+ + +
A.21.2  Connection
+ + +Parameters: +
+ldap_server
IP address or dns name of your +LDAP server. This option is required. +
ldap_port
Port to connect to LDAP server. +Default is 389. +
ldap_rootdn
Bind DN. Default is "" +which means anonymous connection. +
ldap_password
Bind password. Default +is "". +
+Example: +
+ {auth_method, ldap}. + {ldap_servers, ["ldap.mydomain.org"]}. + {ldap_port, 389}. + {ldap_rootdn, "cn=Manager,dc=domain,dc=org"}. + {ldap_password, "secret"}. +
+Note that current LDAP implementation doesn't support SSL connection and SASL +authentication.
+
+ + +
A.21.3  Authentication
+ + +You can authenticate users against LDAP directory. Available parameters are +listed below: +
+ldap_base
LDAP base directory which stores users +accounts. This option is required. +
ldap_uidattr
LDAP attribute which holds +user's part of JID. Default is "uid". +
ldap_uidattr_format
Format of the +ldap_uidattr variable. Format MUST contain one and only one pattern +variable "%u" which will be replaced by user's part of JID. For example, +"%u@mydomain.org". Default value is "%u". +
ldap_filter
RFC 2254 LDAP filter. Default is +none. Example: "(&(objectClass=shadowAccount)(memberOf=Jabber + Users))". Please, don't forget closing brackets and don't use superfluous +whitespaces. Also you MUST NOT use ldap_uidattr attribute in filter +because this attribute will be substituted in LDAP filter automatically. +
+ + +
A.21.4  vCards and Search
+ + +ejabberd can map LDAP attributes to vCard fields. This behaviour is +implemented in mod_vcard_ldap module. This module doesn't depend on +authentication method. mod_vcard_ldap module has it's own optional +parameters. The first group of parameters has the same meaning as top-level +LDAP parameters: ldap_servers, ldap_port, +ldap_rootdn, ldap_password, ldap_base, +ldap_uidattr, ldap_uidattr_format and +ldap_filter. If one of this option is not set ejabberd will look +for top-level option with the same name. The second group of parameters +consists of the following options: +
+ + hosts
This option defines the hostnames of the + service (see section A.2.2). If neither hosts nor + the old host is present, the prefix ``vjud.'' is added to all + ejabberd hostnames. + +
iqdisc
This specifies +the processing discipline for vcard-temp IQ queries +(see section A.2.1). +
search
This option specifies whether the search + functionality is enabled (value: true) or disabled + (value: false). If disabled, the option hosts will be + ignored and the Jabber User Directory service will not appear in the + Service Discovery item list. The default value is true. +
ldap_vcard_map
the table which defines +reflection of LDAP attributes to vCard fields. + Format is: + [Name_of_vcard_field, Pattern, List_of_LDAP_attributes, ...] + where + Name_of_vcard_field is the type name of vCard as defined + in RFC 2426, + Pattern is a string which contains pattern variables "%u", "%d" or "%s", + List_of_LDAP_attributes is the list which contains of LDAP attributes. + Pattern variables "%s" will be sequentially replaced with the values of + LDAP attributes from List_of_LDAP_attributes; "%u" will be replaced with + user's part of JID and "%d" will be replaced with domain part of JID. + Example: +
+ {ldap_vcard_map, + [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"CTRY", "Russia", []}, + {"EMAIL", "%u@%d", []}, + {"DESC", "%s\n%s", ["title", "description"]} + ]}, +
+Default is: +
+ [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"FAMILY", "%s", ["sn"]}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"ORGNAME", "%s", ["o"]}, + {"ORGUNIT", "%s", ["ou"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["street"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["labeleduri"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}, + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}, + {"ROLE", "%s", ["employeeType"]}, + {"PHOTO", "%s", ["jpegPhoto"]}] +
ldap_search_fields
This option defines +search form and LDAP attributes to search. + Format: + [Name, Attribute, ...] + where + Name is the name of field in the search form. Will be automatically + translated according to definitions in translation files (see + msgs/*.msg for available words). + Attribute is the LDAP attribute or the pattern "%u" + Example: +
+ {ldap_search_fields, + [{"User", "uid"}, + {"Full Name", "displayName"}, + {"Email", "mail"} + ]}, +
+Default is: +
+ [{"User", "%u"}, + {"Full Name", "displayName"}, + {"Given Name", "givenName"}, + {"Middle Name", "initials"}, + {"Family Name", "sn"}, + {"Nickname", "%u"}, + {"Birthday", "birthDay"}, + {"Country", "c"}, + {"City", "l"}, + {"Email", "mail"}, + {"Organization Name", "o"}, + {"Organization Unit", "ou"}] +
ldap_search_reported
This option defines search fields to be reported. + Format: + [Name, VCard_Name, ...] + where + Name is the name of field in the search form. Will be automatically + translated according to definitions in translation files (see + msgs/*.msg for available words). + VCard_Name is the name of vCard field defined in ldap_vcard_map option. + Example: +
+ {ldap_search_reported, + [{"Full Name", "FN"}, + {"Email", "EMAIL"}, + {"Birthday", "BDAY"}, + {"Nickname", "NICKNAME"} + ]}, +
+Default is: +
+ [{"Full Name", "FN"}, + {"Given Name", "GIVEN"}, + {"Middle Name", "MIDDLE"}, + {"Family Name", "FAMILY"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}, + {"Country", "CTRY"}, + {"City", "LOCALITY"}, + {"Email", "EMAIL"}, + {"Organization Name", "ORGNAME"}, + {"Organization Unit", "ORGUNIT"}] +
+ + +
A.21.5  Examples
+ + + + +
Common example
+ +Let's say ldap.mydomain.org is the name of our LDAP server. We have +users with their passwords in "ou=Users,dc=mydomain,dc=org" directory. +Also we have addressbook, which contains users emails and their additional +infos in "ou=AddressBook,dc=mydomain,dc=org" directory. Corresponding +authentication section should looks like this: +
+ %% authentication method + {auth_method, ldap}. + %% DNS name of our LDAP server + {ldap_servers, ["ldap.mydomain.org"]}. + %% Bind to LDAP server as "cn=Manager,dc=mydomain,dc=org" with password "secret" + {ldap_rootdn, "cn=Manager,dc=mydomain,dc=org"}. + {ldap_password, "secret"}. + %% define the user's base + {ldap_base, "ou=Users,dc=mydomain,dc=org"}. + %% We want to authorize users from 'shadowAccount' object class only + {ldap_filter, "(objectClass=shadowAccount)"}. +
+Now we want to use users LDAP-info as their vCards. We have four attributes +defined in our LDAP schema: "mail" --- email address, "givenName" +--- first name, "sn" --- second name, "birthDay" --- birthday. +Also we want users to search each other. Let's see how we can set it up: +
+ {modules, + ... + {mod_vcard_ldap, + [ + %% We use the same server and port, but want to bind anonymously because + %% our LDAP server accepts anonymous requests to + %% "ou=AddressBook,dc=mydomain,dc=org" subtree. + {ldap_rootdn, ""}, + {ldap_password, ""}, + %% define the addressbook's base + {ldap_base, "ou=AddressBook,dc=mydomain,dc=org"}, + %% user's part of JID is located in the "mail" attribute + {ldap_uidattr, "mail"}, + %% common format for our emails + {ldap_uidattr_format, "%u@mail.mydomain.org"}, + %% We have to define empty filter here, because entries in addressbook doesn't + %% belong to shadowAccount object class + {ldap_filter, ""}, + %% Now we want to define vCard pattern + {ldap_vcard_map, + [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname + {"GIVEN", "%s", ["givenName"]}, + {"FAMILY", "%s", ["sn"]}, + {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John" + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}]}, + %% Search form + {ldap_search_fields, + [{"User", "%u"}, + {"Name", "givenName"}, + {"Family Name", "sn"}, + {"Email", "mail"}, + {"Birthday", "birthDay"}]}, + %% vCard fields to be reported + %% Note that JID is always returned with search results + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}]} + ]} + ... + }. +
+Note that mod_vcard_ldap module checks an existence of the user before +searching his info in LDAP.
+
+ + +
Active Directory
+ +Active Directory is just an LDAP-server with predefined attributes. Sample +config file is listed below: +
+ {auth_method, ldap}. + {ldap_servers, ["office.org"]}. % List of LDAP servers + {ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory + {ldap_rootdn, "CN=Administrator,CN=Users,DC=office,DC=org"}. % LDAP manager + {ldap_password, "*******"}. % Password to LDAP manager + {ldap_uidattr, "sAMAccountName"}. + {ldap_filter, "(memberOf=*)"}. + + {mod_vcard_ldap, + [{ldap_vcard_map, + [{"NICKNAME", "%u", []}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"FAMILY", "%s", ["sn"]}, + {"FN", "%s", ["displayName"]}, + {"EMAIL", "%s", ["mail"]}, + {"ORGNAME", "%s", ["company"]}, + {"ORGUNIT", "%s", ["department"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["streetAddress"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["wWWHomePage"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}]}, + {ldap_search_fields, + [{"User", "%u"}, + {"Name", "givenName"}, + {"Family Name", "sn"}, + {"Email", "mail"}, + {"Company", "company"}, + {"Department", "department"}, + {"Role", "title"}, + {"Description", "description"}, + {"Phone", "telephoneNumber"}]}, + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Nickname", "NICKNAME"}, + {"Email", "EMAIL"}]} + ] + }. +
-
A.21  mod_version
+
A.22  mod_version
@@ -2607,20 +2924,20 @@ This module implements Software Version (
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Software Version (jabber:iq:version) IQ queries (see section A.2.1).
-
B  Internationalization and Localization
+
B  Internationalization and Localization
All built-in modules support the xml:lang attribute inside IQ queries. Figure 2, for example, shows the reply to the following query: -
+
<iq id='5' to='example.org' type='get' @@ -2628,44 +2945,40 @@ Figure 2, for example, shows the reply to the f <query xmlns='http://jabber.org/protocol/disco#items'/> </iq>
-
+

-
-
Figure 2: Service Discovery when xml:lang='ru'

-
+
Figure 2: Service Discovery when xml:lang='ru'

-
+
The web interface also supports the Accept-Language HTTP header (compare figure 3 with figure 1) -
+

-
-
Figure 3: Top page from the web interface with HTTP header - “Accept-Language: ru”

-
+
Figure 3: Top page from the web interface with HTTP header + ``Accept-Language: ru''

-
+
-
C  Release Notes
+
C  Release Notes
-
C.1  ejabberd 0.9
+
C.1  ejabberd 0.9
-
+
Release notes ejabberd 0.9 @@ -2757,9 +3070,9 @@ Bugfixes
-
C.2  ejabberd 0.9.1
+
C.2  ejabberd 0.9.1
-
+
Release notes ejabberd 0.9.1 @@ -2825,9 +3138,9 @@ Bugfixes
-
C.3  ejabberd 0.9.8
+
C.3  ejabberd 0.9.8
-
+
Release notes ejabberd 0.9.8 2005-08-01 @@ -2930,9 +3243,9 @@ END
-
C.4  ejabberd 1.0.0
+
C.4  ejabberd 1.0.0
-
+
Release Notes ejabberd 1.0.0 14 December 2005 @@ -3056,9 +3369,9 @@ END
-
C.5  ejabberd 1.1.0
+
C.5  ejabberd 1.1.0
-
+
Release Notes ejabberd 1.1.0 24 April 2006 @@ -3177,9 +3490,9 @@ END
-
C.6  ejabberd 1.1.1
+
C.6  ejabberd 1.1.1
-
+
Release Notes ejabberd 1.1.1 28 April 2006 @@ -3302,23 +3615,26 @@ END
-
D  Acknowledgements
+
D  Acknowledgements
Thanks to all people who contributed to this guide: -
+
Alexey Shchepin (xmpp:aleksey@jabber.ru) -
Florian Zumbiehl (xmpp:florz@florz.de) -
Michael Grigutsch (xmpp:migri@jabber.i-pobox.net) -
Mickael Remond (xmpp:mremond@erlang-projects.org) -
Sander Devrieze (xmpp:sander@devrieze.dyndns.org) -
Sergei Golovan (xmpp:sgolovan@nes.ru) -
Vsevolod Pelipas (xmpp:vsevoload@jabber.ru) +
Florian Zumbiehl (xmpp:florz@florz.de) +
Michael Grigutsch (xmpp:migri@jabber.i-pobox.net) +
Mickael Remond (xmpp:mremond@erlang-projects.org) +
Sander Devrieze (xmpp:sander@devrieze.dyndns.org) +
Sergei Golovan (xmpp:sgolovan@nes.ru) +
Vsevolod Pelipas (xmpp:vsevoload@jabber.ru)
-
This document was translated from L^AT_EX by -H^EV^EA.
+
+
This document was translated from L^AT_EX by +H^EV^EA. +
+ -- cgit v1.2.3 From 8583e3f9be0ef2f7b7c66550b3028241a7574670 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= Date: Fri, 22 Sep 2006 08:42:41 +0000 Subject: Bugfixes coming from trunk (SVN #607): * doc/guide.tex: Minor fix on index generation. SVN Revision: 616 --- doc/guide.html | 1404 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 712 insertions(+), 692 deletions(-) (limited to 'doc/guide.html') diff --git a/doc/guide.html b/doc/guide.html index 3c8a473e0..cf4f4382f 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1,29 +1,46 @@ -Ejabberd 1.1.1 Installation and Operation Guide - - + + +Ejabberd 1.1.1 Installation and Operation Guide + + + + + - + +

- -
Ejabberd 1.1.1 Installation and Operation Guide
- -
Alexey Shchepin
+ + +
+
Ejabberd 1.1.1 Installation and Operation Guide
+
Alexey Shchepin
mailto:alexey@sevcom.net
-xmpp:aleksey@jabber.ru
+xmpp:aleksey@jabber.ru

-
+
@@ -32,125 +49,125 @@

-
I can thoroughly recommend ejabberd for ease of setup -- +
I can thoroughly recommend ejabberd for ease of setup – Kevin Smith, Current maintainer of the Psi project
- + -
Table of Contents
+
Contents
-
+
1  Introduction -
+
1.1  Key Features -
1.2  Additional Features +
1.2  Additional Features
-
2  Installation from Source -
+
2  Installation from Source +
2.1  Installation Requirements -
-2.1.1  ``Unix-like'' operating systems -
2.1.2  Windows +
+2.1.1  “Unix-like” operating systems +
2.1.2  Windows
-
2.2  Obtaining ejabberd -
2.3  Compilation -
-2.3.1  ``Unix-like'' operating systems -
2.3.2  Windows +
2.2  Obtaining ejabberd +
2.3  Compilation +
+2.3.1  “Unix-like” operating systems +
2.3.2  Windows
-
2.4  Starting +
2.4  Starting
-
3  Configuration -
+
3  Configuration +
3.1  Initial Configuration -
+
3.1.1  Host Names -
3.1.2  Default Language -
3.1.3  Access Rules -
3.1.4  Shapers -
3.1.5  Limitation of the number of opened sessions -
3.1.6  Listened Sockets -
3.1.7  Modules -
3.1.8  Virtual Hosting -
3.1.9  SASL anonymous and anonymous login +
3.1.2  Default Language +
3.1.3  Access Rules +
3.1.4  Shapers +
3.1.5  Limitation of the number of opened sessions +
3.1.6  Listened Sockets +
3.1.7  Modules +
3.1.8  Virtual Hosting +
3.1.9  SASL anonymous and anonymous login
-
3.2  Relational Database Support -
+
3.2  Relational Database Support +
3.2.1  Preliminary steps -
3.2.2  Authentication against a relational database -
3.2.3  Relational database for other modules +
3.2.2  Authentication against a relational database +
3.2.3  Relational database for other modules
-
3.3  Creating an Initial Administrator -
3.4  Online Configuration and Monitoring -
+
3.3  Creating an Initial Administrator +
3.4  Online Configuration and Monitoring +
3.4.1  Web Interface -
3.4.2  ejabberdctl +
3.4.2  ejabberdctl

-
4  Firewall Settings -
5  SRV Records -
6  Clustering -
+
4  Firewall Settings +
5  SRV Records +
6  Clustering +
6.1  How it Works -
+
6.1.1  Router -
6.1.2  Local Router -
6.1.3  Session Manager -
6.1.4  s2s Manager +
6.1.2  Local Router +
6.1.3  Session Manager +
6.1.4  s2s Manager
-
6.2  Clustering Setup +
6.2  Clustering Setup
-
A  Built-in Modules -
+
A  Built-in Modules +
A.1  Overview -
A.2  Common Options -
+
A.2  Common Options +
A.2.1  iqdisc -
A.2.2  hosts +
A.2.2  hosts
-
A.3  mod_announce -
A.4  mod_disco -
A.5  mod_echo -
A.6  mod_irc -
A.7  mod_last -
A.8  mod_muc -
A.9  mod_muc_log -
A.10  mod_offline -
A.11  mod_privacy -
A.12  mod_private -
A.13  mod_pubsub -
A.14  mod_register -
A.15  mod_roster -
A.16  mod_service_log -
A.17  mod_shared_roster -
A.18  mod_stats -
A.19  mod_time -
A.20  mod_vcard -
A.21  LDAP and mod_vcard_ldap -
+
A.3  mod_announce +
A.4  mod_disco +
A.5  mod_echo +
A.6  mod_irc +
A.7  mod_last +
A.8  mod_muc +
A.9  mod_muc_log +
A.10  mod_offline +
A.11  mod_privacy +
A.12  mod_private +
A.13  mod_pubsub +
A.14  mod_register +
A.15  mod_roster +
A.16  mod_service_log +
A.17  mod_shared_roster +
A.18  mod_stats +
A.19  mod_time +
A.20  mod_vcard +
A.21  LDAP and mod_vcard_ldap +
A.21.1  Features -
A.21.2  Connection -
A.21.3  Authentication -
A.21.4  vCards and Search -
A.21.5  Examples +
A.21.2  Connection +
A.21.3  Authentication +
A.21.4  vCards and Search +
A.21.5  Examples
-
A.22  mod_version +
A.22  mod_version
-
B  Internationalization and Localization -
C  Release Notes -
+
B  Internationalization and Localization +
C  Release Notes +
C.1  ejabberd 0.9 -
C.2  ejabberd 0.9.1 -
C.3  ejabberd 0.9.8 -
C.4  ejabberd 1.0.0 -
C.5  ejabberd 1.1.0 -
C.6  ejabberd 1.1.1 +
C.2  ejabberd 0.9.1 +
C.3  ejabberd 0.9.8 +
C.4  ejabberd 1.0.0 +
C.5  ejabberd 1.1.0 +
C.6  ejabberd 1.1.1
-
D  Acknowledgements +
D  Acknowledgements
-
1  Introduction
+
1  Introduction
@@ -162,135 +179,135 @@
-
1.1  Key Features
+
1.1  Key Features
ejabberd is: -
+
Multiplatform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.

-
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
+
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.

-
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.
+
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced “on the fly”.

-
Administrator Friendly: ejabberd 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: -
+
Administrator Friendly: ejabberd 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: +
Comprehensive documentation. -
Straightforward installers for Linux, Mac OS X, and Windows. -
Web interface for administration tasks. -
Shared Roster Groups. -
Command line administration tool. -
Can integrate with existing authentication mechanisms. -
Capability to send announce messages. +
Straightforward installers for Linux, Mac OS X, and Windows. +
Web interface for administration tasks. +
Shared Roster Groups. +
Command line administration tool. +
Can integrate with existing authentication mechanisms. +
Capability to send announce messages.

-
Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -
+
Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: +
Translated in 11 languages. -
Support for IDNA. +
Support for IDNA.

-
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -
+
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +
Fully XMPP compliant -
XML-based protocol -
Many JEPs supported. +
XML-based protocol +
Many JEPs supported.
-
1.2  Additional Features
+
1.2  Additional Features
Besides common Jabber server features, ejabberd comes with a wide range of other features: -
+
Modular -
+
Load only the modules you want. -
Extend ejabberd with your own custom modules. +
Extend ejabberd with your own custom modules.
-
Security -
+
Security +
SASL and STARTTLS for c2s and s2s connections. -
STARTTLS and Dialback s2s connections. -
Web interface accessible via HTTPS secure access. +
STARTTLS and Dialback s2s connections. +
Web interface accessible via HTTPS secure access.
-
Databases -
+
Databases +
Native MySQL support. -
Native PostgreSQL support. -
Mnesia. -
ODBC data storage support. -
Microsoft SQL Server support (via ODBC). +
Native PostgreSQL support. +
Mnesia. +
ODBC data storage support. +
Microsoft SQL Server support (via ODBC).
-
Authentication -
+
Authentication +
LDAP and ODBC. -
External Authentication script. -
Internal Authentication. +
External Authentication script. +
Internal Authentication.
-
Others -
+
Others +
Compressing XML streams with Stream Compression (JEP-0138). -
Interface with networks such as AIM, ICQ and MSN. -
Statistics via Statistics Gathering (JEP-0039). -
IPv6 support both for c2s and s2s connections. -
Multi-User Chat module with logging. -
Users Directory based on users vCards. -
Publish-Subscribe component. -
Support for virtual hosting. -
HTTP Polling service. -
IRC transport. +
Interface with networks such as AIM, ICQ and MSN. +
Statistics via Statistics Gathering (JEP-0039). +
IPv6 support both for c2s and s2s connections. +
Multi-User Chat module with logging. +
Users Directory based on users vCards. +
Publish-Subscribe component. +
Support for virtual hosting. +
HTTP Polling service. +
IRC transport.

-
2  Installation from Source
+
2  Installation from Source
-
2.1  Installation Requirements
+
2.1  Installation Requirements
- + -
2.1.1  ``Unix-like'' operating systems
+
2.1.1  “Unix-like” operating systems
-To compile ejabberd on a ``Unix-like'' operating system, you need: -
+To compile ejabberd on a “Unix-like” operating system, you need: +
GNU Make; -
GCC; -
libexpat 1.95 or higher; -
Erlang/OTP R9C-2 or higher; -
OpenSSL 0.9.6 or higher (optional). -
Zlib 1.2.3 or higher (optional). -
GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc). +
GCC; +
libexpat 1.95 or higher; +
Erlang/OTP R9C-2 or higher; +
OpenSSL 0.9.6 or higher (optional). +
Zlib 1.2.3 or higher (optional). +
GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc).
-
2.1.2  Windows
+
2.1.2  Windows
To compile ejabberd on a Windows flavour, you need: -
+
MS Visual C++ 6.0 Compiler -
Erlang/OTP R9C-2 or higher -
Expat 1.95.7 or higher -
GNU Iconv 1.9.1 +
Erlang/OTP R9C-2 or higher +
Expat 1.95.7 or higher +
GNU Iconv 1.9.1 (optional) -
Shining Light OpenSSL +
Shining Light OpenSSL (to enable SSL connections) -
Zlib 1.2.3 or higher +
Zlib 1.2.3 or higher
-
2.2  Obtaining ejabberd
+
2.2  Obtaining ejabberd
@@ -299,49 +316,49 @@ Released versions of ejabberd can be obtained from

The latest development version can be retrieved from the Subversion repository. -
+
svn co http://svn.process-one.net/ejabberd/trunk ejabberd
-
2.3  Compilation
+
2.3  Compilation
- + -
2.3.1  ``Unix-like'' operating systems
+
2.3.1  “Unix-like” operating systems
-Compile ejabberd on a ``Unix-like'' operating system by executing: -
+Compile ejabberd on a “Unix-like” operating system by executing: +
./configure make su make install
These commands will: -
+
install ejabberd into the directory /var/lib/ejabberd, -
install the configuration file into /etc/ejabberd, -
create a directory called /var/log/ejabberd to store log files. +
install the configuration file into /etc/ejabberd, +
create a directory called /var/log/ejabberd to store log files.
-
2.3.2  Windows
+
2.3.2  Windows
-
+
Install Erlang emulator (for example, into C:\Program Files\erl5.3). -
Install Expat library into C:\Program Files\Expat-1.95.7 +
Install Expat library into C:\Program Files\Expat-1.95.7 directory.

Copy file C:\Program Files\Expat-1.95.7\Libs\libexpat.dll to your Windows system directory (for example, C:\WINNT or C:\WINNT\System32) -
Build and install the Iconv library into the directory +
Build and install the Iconv library into the directory C:\Program Files\iconv-1.9.1.

Copy file C:\Program Files\iconv-1.9.1\bin\iconv.dll to your @@ -353,25 +370,25 @@ Note: instead of copying libexpat.dll and iconv.dll to the Windows C:\Program Files\Expat-1.95.7\Libs and C:\Program Files\iconv-1.9.1\bin to the PATH environment variable. -
While in the directory ejabberd\src run: -
+
While in the directory ejabberd\src run: +
configure.bat nmake -f Makefile.win32 -
Edit the file ejabberd\src\ejabberd.cfg and run -
+
Edit the file ejabberd\src\ejabberd.cfg and run +
werl -s ejabberd -name ejabberd
-
2.4  Starting
+
2.4  Starting
Execute the following command to start ejabberd: -
+
erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd
or -
+
erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
In the latter case the Erlang node will be identified using only the first part of the host name, i. e. other Erlang nodes outside this domain can't contact @@ -383,7 +400,7 @@ for storing its user database and for logging.

To specify the path to the configuration file, the log files and the Mnesia database directory, you may use the following command: -
+
erl -pa /var/lib/ejabberd/ebin \ -sname ejabberd \ -s ejabberd \ @@ -397,25 +414,25 @@ You can find other useful options in the Erlang manual page
To use more than 1024 connections, you should set the environment variable ERL_MAX_PORTS: -
+
export ERL_MAX_PORTS=32000
Note that with this value, ejabberd will use more memory (approximately 6 MB more).

To reduce memory usage, you may set the environment variable ERL_FULLSWEEP_AFTER: -
+
export ERL_FULLSWEEP_AFTER=0
But in this case ejabberd can start to work slower.

-
3  Configuration
+
3  Configuration
-
3.1  Initial Configuration
+
3.1  Initial Configuration
@@ -426,12 +443,12 @@ configuration file are appended to the entries in the database. The configuration file contains a sequence of Erlang terms. Lines beginning with a `%' 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 ``hosts'' option, the old +configuration file do not contain for instance the “hosts” option, the old host name(s) stored in the database will be used.

You can override the old values stored in the database by adding next lines to the configuration file: -
+
override_global. override_local. override_acls. @@ -440,7 +457,7 @@ before new ones are added.

-
3.1.1  Host Names
+
3.1.1  Host Names
@@ -448,23 +465,23 @@ The option hosts defines a list containing one or more domains that ejabberd will serve.

Examples: -
+
Serving one domain: -
-
+
+
{hosts, ["example.org"]}. -
Backwards compatibility with older ejabberd versions can be retained +
Backwards compatibility with older ejabberd versions can be retained with: -
+
{host, "example.org"}.
-
Serving two domains: -
+
Serving two domains: +
{hosts, ["example.net", "example.com"]}.
-
3.1.2  Default Language
+
3.1.2  Default Language
@@ -475,82 +492,82 @@ option language is "en". In order to take effect there must be translation file <language>.msg in ejabberd's msgs directory.

Examples: -
+
To set Russian as default language: -
+
{language, "ru"}. -
To set Spanish as default language: -
+
To set Spanish as default language: +
{language, "es"}.
-
3.1.3  Access Rules
+
3.1.3  Access Rules
Access control in ejabberd is performed via Access Control Lists (ACLs). The declarations of ACLs in the configuration file have the following syntax: -
+
{acl, <aclname>, {<acltype>, ...}}.
<acltype> can be one of the following: -
-all
Matches all JIDs. Example: -
+
+all
Matches all JIDs. Example: +
{acl, all, all}. -
{user, <username>}
Matches the user with the name +
{user, <username>}
Matches the user with the name <username> at the first virtual host. Example: -
+
{acl, admin, {user, "yozhik"}}. -
{user, <username>, <server>}
Matches the user with the JID +
{user, <username>, <server>}
Matches the user with the JID <username>@<server> and any resource. Example: -
+
{acl, admin, {user, "yozhik", "example.org"}}. -
{server, <server>}
Matches any JID from server +
{server, <server>}
Matches any JID from server <server>. Example: -
+
{acl, exampleorg, {server, "example.org"}}. -
{user_regexp, <regexp>}
Matches any local user with a name that +
{user_regexp, <regexp>}
Matches any local user with a name that matches <regexp> at the first virtual host. Example: -
+
{acl, tests, {user, "^test[0-9]*$"}}. -
{user_regexp, <regexp>, <server>}
Matches any user with a name +
{user_regexp, <regexp>, <server>}
Matches any user with a name that matches <regexp> at server <server>. Example: -
+
{acl, tests, {user, "^test", "example.org"}}. -
{server_regexp, <regexp>}
Matches any JID from the server that +
{server_regexp, <regexp>}
Matches any JID from the server that matches <regexp>. Example: -
+
{acl, icq, {server, "^icq\\."}}. -
{node_regexp, <user_regexp>, <server_regexp>}
Matches any user +
{node_regexp, <user_regexp>, <server_regexp>}
Matches any user with a name that matches <user_regexp> at any server that matches <server_regexp>. Example: -
+
{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. -
{user_glob, <glob>}
-
{user_glob, <glob>, <server>}
-
{server_glob, <glob>}
-
{node_glob, <user_glob>, <server_glob>}
This is the same as +
{user_glob, <glob>}
+
{user_glob, <glob>, <server>}
+
{server_glob, <glob>}
+
{node_glob, <user_glob>, <server_glob>}
This is the same as above. However, it uses shell glob patterns instead of regexp. These patterns can have the following special characters: -
- *
matches any string including the null string. -
?
matches any single character. -
[...]
matches any of the enclosed characters. Character +
+ *
matches any string including the null string. +
?
matches any single character. +
[...]
matches any of the enclosed characters. Character ranges are specified by a pair of characters separated by a `-'. If the first character after `[' is a `!', any character not enclosed is matched.

The following ACLs are pre-defined: -
-all
Matches any JID. -
none
Matches no JID. +
+all
Matches any JID. +
none
Matches no JID.
An entry allowing or denying access to different services looks similar to this: -
+
{access, <accessname>, [{allow, <aclname>}, {deny, <aclname>}, ... @@ -558,57 +575,57 @@ this:
When a JID is checked to have access to <accessname>, 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 ``deny'' is returned.
+the first matched tuple is returned, otherwise “deny” is returned.

Example: -
+
{access, configure, [{allow, admin}]}. {access, something, [{deny, badmans}, {allow, all}]}.
The following access rules are pre-defined: -
-all
Always returns ``allow'' -
none
Always returns ``deny'' +
+all
Always returns “allow” +
none
Always returns “deny”
-
3.1.4  Shapers
+
3.1.4  Shapers
Shapers enable you to limit connection traffic. The syntax of shapers is like this: -
+
{shaper, <shapername>, <kind>}.
Currently only one kind of shaper called maxrate is available. It has the following syntax: -
+
{maxrate, <rate>}
where <rate> stands for the maximum allowed incomig rate in bytes per second.

Examples: -
-To define a shaper named ``normal'' with traffic speed limited to +
+To define a shaper named “normal” with traffic speed limited to 1,000 bytes/second: -
+
{shaper, normal, {maxrate, 1000}}. -
To define a shaper named ``fast'' with traffic speed limited to +
To define a shaper named “fast” with traffic speed limited to 50,000 bytes/second: -
+
{shaper, fast, {maxrate, 50000}}.
-
3.1.5  Limitation of the number of opened sessions
+
3.1.5  Limitation of the number of opened sessions
This option specifies the maximum number of sessions (authenticated connections) per user. If a user tries to open more than the maximum number of allowed sessions, with different resources, the first opened session will be -disconnected. The error ``session replaced'' is send to the +disconnected. The error “session replaced” is send to the disconnected session. This value is either a number or infinity. For example {max\_user\_sessions, 10}. The default value is 10.

@@ -616,21 +633,21 @@ This option can be define per virtual host. See section 3.1.6  Listened Sockets
+
3.1.6  Listened Sockets
The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a tuple with the following elements: -
+
Port number. -
Module that serves this port. -
Options to this module. +
Module that serves this port. +
Options to this module.
Currently next modules are implemented: -
+
@@ -674,18 +691,18 @@ Currently next modules are implemented:

ejabberd_c2s certfile, http_poll, inet6, ip, tls, web_admin
-
+
(*) The mechanism for external components is defined in Jabber Component Protocol (JEP-0114).

The following options are available: -
- {access, <access rule>}
This option defines - access to the port. The default value is ``all''. -
{certfile, Path}
Path to a file containing the SSL certificate. -
{hosts, [Hostnames], [HostOptions]}
This option +
+ {access, <access rule>}
This option defines + access to the port. The default value is “all”. +
{certfile, Path}
Path to a file containing the SSL certificate. +
{hosts, [Hostnames], [HostOptions]}
This option defines one or more hostnames of connected services and enables you to specify additional options including {password, Secret}. -
http_poll
+
http_poll
This option enables HTTP Polling (JEP-0025) support. HTTP Polling enables access via HTTP requests to ejabberd from behind firewalls which do not allow outgoing sockets on port 5222.
@@ -697,85 +714,85 @@ If HTTP Polling is enabled, it will be available at JWChat (there is a tutorial to install JWChat with instructions for ejabberd). -
inet6
Set up the socket for IPv6. -
{ip, IPAddress}
This option specifies which network +
inet6
Set up the socket for IPv6. +
{ip, IPAddress}
This option specifies which network interface to listen for. For example {ip, {192, 168, 1, 1}}. -
{max_stanza_size, Size}
This +
{max_stanza_size, Size}
This option specifies an approximate maximal size in bytes of XML stanzas. For example {max\_stanza\_size, 65536}. The default value - is ``infinity''. -
{shaper, <access rule>}
This option defines a + is “infinity”. +
{shaper, <access rule>}
This option defines a shaper for the port (see section 3.1.4). The default value - is ``none''. -
ssl
This option specifies that traffic on + is “none”. +
ssl
This option specifies that traffic on the port will be encrypted using SSL. You should also set the certfile option. It is recommended to use the tls option instead. -
starttls
This option +
starttls
This option specifies that STARTTLS encryption is available on connections to the port. You should also set the certfile option. -
starttls_required
This option +
starttls_required
This option specifies that STARTTLS encryption is required on connections to the port. No unencrypted connections will be allowed. You should also set the certfile option. -
tls
This option specifies that traffic on +
tls
This option specifies that traffic on the port will be encrypted using SSL immediately after connecting. You should also set the certfile option. -
zlib
This +
zlib
This option specifies that Zlib stream compression (as defined in JEP-0138) is available on connections to the port. Client cannot use stream compression and stream encryption simultaneously, so if you specify both tls (or ssl) and zlib the latter option will not affect connection at all. -
web_admin
This option +
web_admin
This option enables the web interface for ejabberd administration which is available at http://server:port/admin/. Login and password are the username and password of one of the registered users who are granted access by the - ``configure'' access rule. + “configure” access rule.
Also the following global options are available for s2s connections: -
- {s2s_use_starttls, true|false}
+
+ {s2s_use_starttls, true|false}
This option defines whether to use STARTTLS for s2s connections. -
{s2s_certfile, Path}
Path to the +
{s2s_certfile, Path}
Path to the file containing the SSL certificate. -
{domain_certfile, Domain, Path}
Path +
{domain_certfile, Domain, Path}
Path to the file containing the SSL certificate for the specified domain.
For instance, the following configuration defines that: -
+
c2s connections are listened for on port 5222 and 5223 (SSL) and denied - for the user ``bad'' -
s2s connections are listened for on port 5269 with STARTTLS for secured + for the user “bad” +
s2s connections are listened for on port 5269 with STARTTLS for secured traffic enabled. -
Port 5280 is serving the web interface and the HTTP Polling service. Note +
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 3.4.1 shows how exactly this can be done. -
All users except for the administrators have a traffic of limit +
All users except for the administrators have a traffic of limit 1,000 Bytes/second -
The +
The AIM transport aim.example.org is connected to port 5233 with password - ``aimsecret'' -
The ICQ transport JIT (icq.example.org and + “aimsecret” +
The ICQ transport JIT (icq.example.org and sms.example.org) is connected to port 5234 with password - ``jitsecret'' -
The + “jitsecret” +
The MSN transport msn.example.org is connected to port 5235 with password - ``msnsecret'' -
The + “msnsecret” +
The Yahoo! transport yahoo.example.org is connected to port 5236 with password - ``yahoosecret'' -
The Gadu-Gadu transport gg.example.org is - connected to port 5237 with password ``ggsecret'' -
The + “yahoosecret” +
The Gadu-Gadu transport gg.example.org is + connected to port 5237 with password “ggsecret” +
The Jabber Mail Component jmc.example.org is connected to port 5238 with password - ``jmcsecret'' + “jmcsecret”
-
+
{acl, blocked, {user, "bad"}}. {access, c2s, [{deny, blocked}, {allow, all}]}. @@ -806,7 +823,7 @@ c2s connections are listened for on port 5222 and 5223 (SSL) and denied {s2s_certfile, "/path/to/ssl.pem"}.
Note, that for jabberd 1.4- or WPJabber-based services you have to make the transports log and do XDB by themselves: -
+
<!-- You have to add elogger and rlogger entries here when using ejabberd. In this case the transport will do the logging. @@ -838,7 +855,7 @@ services you have to make the transports log and do XDB by themselves:
-
3.1.7  Modules
+
3.1.7  Modules
@@ -848,17 +865,17 @@ element is the name of a module and the second is a list of options for that module. Read section A for detailed information about modules.

Examples: -
+
In this simple example, only the module mod_echo is loaded and no options are specified between square brackets: -
+
{modules, [{mod_echo, []} ]}. -
The second example is also simple: the modules mod_echo, mod_time, and +
The second example is also simple: the modules mod_echo, mod_time, and mod_version are loaded without options. Remark that, besides the last entry, all entries end with a comma: -
+
{modules, [{mod_echo, []}, {mod_time, []}, @@ -867,22 +884,22 @@ In this simple example, only the module mod_echo is loaded and no
-
3.1.8  Virtual Hosting
+
3.1.8  Virtual Hosting
Options can be defined separately for every virtual host using the host_config option. It has the following syntax: -
+
{host_config, <hostname>, [<option>, <option>, ...]}.
Examples: -
+
Domain example.net is using the internal authentication method while domain example.com is using the LDAP server running on the domain localhost to perform authentication: -
+
{host_config, "example.net", [{auth_method, internal}]}. {host_config, "example.com", [{auth_method, ldap}, @@ -891,10 +908,10 @@ Domain example.net is using the internal authentication method while {ldap_rootdn, "dc=localdomain"}, {ldap_rootdn, "dc=example,dc=com"}, {ldap_password, ""}]}. -
Domain example.net is using ODBC to perform authentication +
Domain example.net is using ODBC to perform authentication while domain example.com is using the LDAP servers running on the domains localhost and otherhost: -
+
{host_config, "example.net", [{auth_method, odbc}, {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. @@ -907,24 +924,24 @@ Domain example.net is using the internal authentication method while
-
3.1.9  SASL anonymous and anonymous login
+
3.1.9  SASL anonymous and anonymous login
The configuration of the anonymous mode can be done with three host_config parameters: -
+
auth_method: This value is used for defining the authentication method: internal, odbc, ldap, external). You now have a special extra option to enable anonymous mode: anonymous.

-
allow_multiple_connections: This option can be either true or false and +
allow_multiple_connections: This option can be either true or false and is only used when the anonymous mode is enabled. Setting it to true means that the same username will be able to be taken several time in anonymous login mode if different resource are used to connect. This option is only useful in very special cases. It defaults to false.

-
anonymous_protocol: This option can take three values: +
anonymous_protocol: This option can take three values: sasl_anon, login_anon or both. sasl_anon means that SASL anonymous mode is enabled. login_anon means that anonymous login mode is enabled. both means that SASL anonymous and login anonymous are @@ -934,26 +951,26 @@ Those options are defined for each virtual host with the host_config parameter (see section 3.1.8).

Examples: -
+
To enable anonymous login on a virtual host: -
+
{host_config, "public.example.org", [{auth_method, anonymous}, {anonymous_protocol, login_anon}]}. -
To enable anonymous login and internal authentication on a virtual host: -
+
To enable anonymous login and internal authentication on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, login_anon}]}. -
To enable SASL anonymous on a virtual host: -
+
To enable SASL anonymous on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, sasl_anon}]}. -
To enable SASL anonymous and anonymous login on a virtual host: -
+
To enable SASL anonymous and anonymous login on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, both}]}. -
To enable SASL anonymous, anonymous login and internal authentication on +
To enable SASL anonymous, anonymous login and internal authentication on a virtual host: -
+
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, both}]}.
@@ -963,12 +980,12 @@ available from:
-
3.2  Relational Database Support
+
3.2  Relational Database Support
-
3.2.1  Preliminary steps
+
3.2.1  Preliminary steps
If you have installed ejabberd using a binary version, the compilation steps @@ -978,17 +995,17 @@ Otherwise, to be able to use ejabberd with a relational database you need to enable ODBC modules during compilation, even if you want to use ejabberd with MySQL or PostgreSQL in native mode. The following configure command can be used to enable the relational modules: -
+
./configure --enable-odbc
If you are planning to use Microsoft SQL Server with ODBC, you need to specify it from the configure command before compilation: -
+
./configure --enable-odbc --enable-mssql
-
3.2.2  Authentication against a relational database
+
3.2.2  Authentication against a relational database
ejabberd use its internal Mnesia database as a default. It is however possible @@ -1001,7 +1018,7 @@ system.
The option value name be misleading, as the method name is use both for access to relational database through ODBC or through the native interface. In any case, the first step is to define the odbc auth_method. For example: -
+
{host_config, "public.example.org", [{auth_method, [odbc]}]}.
The actual database access is defined in the option odbc_server. Its @@ -1010,16 +1027,16 @@ interface available, PostgreSQL or MySQL.

To use a relational database through ODBC, you can pass the ODBC connection string as odbc_server parameter. For example: -
+
{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.
To use the native PostgreSQL interface, you can pass a tuple of the following form as parameter: -
+
{pgsql, "Server", "Database", "Username", "Password"}
pgsql is a keyword that should be kept as is. For example: -
+
{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.
Note that you need to install the Erlang PgSQL library first. This library is @@ -1028,11 +1045,11 @@ available from Sourceforge: {mysql, "Server", "Database", "Username", "Password"}
mysql is a keyword that should be kept as is. For example: -
+
{odbc_server, {mysql, "localhost", "test", "root", "password"}}.
Note that you need to install the Erlang MySQL library first. This library is @@ -1043,61 +1060,61 @@ available from: 3.2.3  Relational database for other modules +
3.2.3  Relational database for other modules
It is possible to use a relational database to store pieces of information. You can do this by changing the module name to a name with an _odbc suffix in ejabberd config file. You can use a relational database for the following data: -
+
Last connection date and time: Use mod_last_odbc instead of mod_last. -
Offline messages: Use mod_offline_odbc instead of +
Offline messages: Use mod_offline_odbc instead of mod_offline. -
Rosters: Use mod_roster_odbc instead of mod_roster. -
Users' VCARD: Use mod_vcard_odbc instead of mod_vcard. +
Rosters: Use mod_roster_odbc instead of mod_roster. +
Users' VCARD: Use mod_vcard_odbc instead of mod_vcard.
-
3.3  Creating an Initial Administrator
+
3.3  Creating an Initial Administrator
Before the web interface can be entered to perform administration tasks, an account with administrator rights is needed on your ejabberd deployment.

Instructions to create an initial administrator account: -
+
Register an account on your ejabberd deployment. An account can be created in two ways: -
+
Using the tool ejabberdctl (see section 3.4.2): -
+
% ejabberdctl node@host register admin example.org password -
Using In-Band Registration (see section A.14): you can +
Using In-Band Registration (see section A.14): you can use a Jabber client to register an account.
-
Edit the configuration file to promote the account created in the previous +
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. -
+
{acl, admins, {user, "admin", "example.org"}}. {access, configure, [{allow, admins}]}. -
Restart ejabberd to load the new configuration. -
Open the web interface (http://server:port/admin/) in your +
Restart ejabberd to load the new configuration. +
Open the web interface (http://server:port/admin/) in your favourite browser. Make sure to enter the full JID as username (in this example: admin@example.org. The reason that you also need to enter the suffix, is because ejabberd's virtual hosting support.
-
3.4  Online Configuration and Monitoring
+
3.4  Online Configuration and Monitoring
-
3.4.1  Web Interface
+
3.4.1  Web Interface
@@ -1108,22 +1125,24 @@ section 3.1.6). Then you can open will be asked to enter the username (the full Jabber ID) and password of an ejabberd user with administrator rights. After authentication you will see a page similar to figure 1. -
+

-
Figure 1: Top page from the web interface

+
+
Figure 1: Top page from the web interface

+
-
+
Here you can edit access restrictions, manage users, create backups, manage the database, enable/disable ports listened for, view server statistics,...

Examples: -
+
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 http://example.org:5280/admin/ to @@ -1132,11 +1151,11 @@ You can serve the web interface on the same port as the the virtual host example.com. 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 ejabberd. In this example you can enter as - username ``admin@example.net'' to administer all virtual hosts (first - URL). If you log in with ``admin@example.com'' on
+ username “admin@example.net” to administer all virtual hosts (first + URL). If you log in with “admin@example.com” on
http://example.org:5280/admin/server/example.com/ you can only administer the virtual host example.com. -
+
... {acl, admins, {user, "admin", "example.net"}}. {host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}. @@ -1150,11 +1169,11 @@ You can serve the web interface on the same port as the ... ] }. -
For security reasons, you can serve the web interface on a secured +
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 https://192.168.1.1:5280/admin/: -
+
... {hosts, ["example.org"]}. ... @@ -1169,13 +1188,13 @@ You can serve the web interface on the same port as the
-
3.4.2  ejabberdctl
+
3.4.2  ejabberdctl
It is possible to do some administration operations using the command line tool ejabberdctl. You can list all available options by running ejabberdctl without arguments: -
+
% ejabberdctl Usage: ejabberdctl node command @@ -1200,27 +1219,27 @@ Example: ejabberdctl ejabberd@host restart
Additional information: -
-reopen-log
If you use a tool to rotate logs, you have to configure it +
+reopen-log
If you use a tool to rotate logs, you have to configure it so that this command is executed after each rotation. -
backup, restore, install-fallback, dump, load
You can use these +
backup, restore, install-fallback, dump, load
You can use these commands to create and restore backups. -
import-file, import-dir
+
import-file, import-dir
These options can be used to migrate from other Jabber/XMPP servers. There exist tutorials to migrate from jabberd 1.4 and to migrate from jabberd2. -
delete-expired-messages
This option can be used to delete old messages +
delete-expired-messages
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.
-
4  Firewall Settings
+
4  Firewall Settings
You need to take the following TCP ports in mind when configuring your firewall: -
+
@@ -1241,28 +1260,28 @@ You need to take the following TCP ports in mind when configuring your firewall:

Port Description Only for clustring (see 6). This range is configurable (see 2.4).
-
+
-
5  SRV Records
+
5  SRV Records
-
+
General information: SRV record -
Practical information: +
Practical information: Setting DNS SRV Records
-
6  Clustering
+
6  Clustering
-
6.1  How it Works
+
6.1  How it Works
@@ -1275,15 +1294,15 @@ needed because all nodes exchange information about connected users, s2s connections, registered services, etc...

Each ejabberd node has the following modules: -
+
router, -
local router, -
session manager, -
s2s manager. +
local router, +
session manager, +
s2s manager.
-
6.1.1  Router
+
6.1.1  Router
This module is the main router of Jabber packets on each node. It @@ -1294,7 +1313,7 @@ appropriate process. If not, it is sent to the s2s manager.

-
6.1.2  Local Router
+
6.1.2  Local Router
This module routes packets which have a destination domain equal to @@ -1304,7 +1323,7 @@ on its content.

-
6.1.3  Session Manager
+
6.1.3  Session Manager
This module routes packets to local users. It looks up to which user @@ -1314,7 +1333,7 @@ storage, or bounced back.

-
6.1.4  s2s Manager
+
6.1.4  s2s Manager
This module routes packets to other Jabber servers. First, it @@ -1325,52 +1344,52 @@ serving this connection, otherwise a new connection is opened.

-
6.2  Clustering Setup
+
6.2  Clustering Setup
Suppose you already configured ejabberd on one machine named (first), and you need to setup another one to make an ejabberd cluster. Then do following steps: -
+
Copy ~ejabberd/.erlang.cookie file from first to second.

-(alt) You can also add ``-cookie content_of_.erlang.cookie'' - option to all ``erl'' commands below.
+(alt) You can also add “-cookie content_of_.erlang.cookie” + option to all “erl” commands below.

-
On second run as the `ejabberd' user in the directory +
On second run as the `ejabberd' user in the directory where ejabberd will work later the following command: -
+
erl -sname ejabberd \ -mnesia extra_db_nodes "['ejabberd@first']" \ -s mnesia
This will start Mnesia serving the same database as ejabberd@first. - You can check this by running the command ``mnesia:info().''. You + You can check this by running the command “mnesia:info().”. You should see a lot of remote tables and a line like the following: -
+
running db nodes = [ejabberd@first, ejabberd@second]

-
Now run the following in the same ``erl'' session: -
+
Now run the following in the same “erl” session: +
mnesia:change_table_copy_type(schema, node(), disc_copies).
This will create local disc storage for the database.

-(alt) Change storage type of `scheme' table to ``RAM and disc - copy'' on the second node via the web interface.
+(alt) Change storage type of `scheme' table to “RAM and disc + copy” on the second node via the web interface.

-
Now you can add replicas of various tables to this node with - ``mnesia:add_table_copy'' or - ``mnesia:change_table_copy_type'' as above (just replace - ``schema'' with another table name and ``disc_copies'' - can be replaced with ``ram_copies'' or - ``disc_only_copies'').
+
Now you can add replicas of various tables to this node with + “mnesia:add_table_copy” or + “mnesia:change_table_copy_type” as above (just replace + “schema” with another table name and “disc_copies” + can be replaced with “ram_copies” or + “disc_only_copies”).

Which tables to replicate is very dependant on your needs, you can get - some hints from the command ``mnesia:info().'', by looking at the + some hints from the command “mnesia:info().”, by looking at the size of tables and the default storage type for each table on 'first'.

Replicating a table makes lookups in this table faster on this node. @@ -1382,13 +1401,13 @@ Also Run “init:stop().” or just “q().” 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 first.

-
Now run ejabberd on second with almost the same config as - on first (you probably don't need to duplicate ``acl'' - and ``access'' options --- they will be taken from +
Now run ejabberd on second with almost the same config as + on first (you probably don't need to duplicate “acl” + and “access” options — they will be taken from first, and mod_muc and mod_irc should be enabled only on one machine in the cluster).
@@ -1398,13 +1417,13 @@ domain.
-
A  Built-in Modules
+
A  Built-in Modules
-
A.1  Overview
+
A.1  Overview
@@ -1416,14 +1435,14 @@ that they can contain severe bugs and security leaks. Therefore, use them at your own risk!

You can see which database backend each module needs by looking at the suffix: -
-``_ldap'', this means that the module needs an LDAP server as backend. -
``_odbc'', this means that the module needs an ODBC compatible database, +
+“_ldap”, this means that the module needs an LDAP server as backend. +
“_odbc”, this means that the module needs an ODBC compatible database, a MySQL database, or a PostgreSQL database as backend. -
Nothing, this means that the modules uses Erlang's built-in database +
Nothing, this means that the modules uses Erlang's built-in database Mnesia as backend.
-
+
@@ -1610,13 +1629,13 @@ You can see which database backend each module needs by looking at the suffix:

Module Feature No
-
+
(*) This module or a similar one with another database backend is needed for XMPP compliancy.

-
A.2  Common Options
+
A.2  Common Options
The following options are used by many modules. Therefore, they are described in @@ -1624,7 +1643,7 @@ this separate section.

-
A.2.1  iqdisc
+
A.2.1  iqdisc
@@ -1632,23 +1651,23 @@ Many modules define handlers for processing IQ queries of different namespaces to this server or to a user (e. g. to example.org or to user@example.org). This option defines processing discipline for these queries. Possible values are: -
-no_queue
All queries of a namespace with this processing discipline are +
+no_queue
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. -
one_queue
In this case a separate queue is created for the processing +
one_queue
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. -
parallel
For every packet with this discipline a separate Erlang process +
parallel
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).
Example: -
+
{modules, [ ... @@ -1658,7 +1677,7 @@ Example:
-
A.2.2  hosts
+
A.2.2  hosts
@@ -1666,19 +1685,19 @@ A module acting as a service can have one or more hostnames. These hostnames can be defined with the hosts option.

Examples: -
+
Serving the echo module on one domain: -
-
+
+
{modules, [ ... {mod_echo, [{hosts, ["echo.example.org"]}]}, ... ]}. -
Backwards compatibility with older ejabberd versions can be retained +
Backwards compatibility with older ejabberd versions can be retained with: -
+
{modules, [ ... @@ -1686,8 +1705,8 @@ Serving the echo module on one domain: ... ]}.
-
Serving the echo module on two domains: -
+
Serving the echo module on two domains: +
{modules, [ ... @@ -1697,7 +1716,7 @@ Serving the echo module on one domain:
-
A.3  mod_announce
+
A.3  mod_announce
@@ -1707,36 +1726,36 @@ 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 example.org, while the JID between brackets will apply to all virtual hosts: -
-example.org/announce/all (example.org/announce/all-hosts/all)
The +
+example.org/announce/all (example.org/announce/all-hosts/all)
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 A.10) is enabled. -
example.org/announce/online (example.org/announce/all-hosts/online)
The +
example.org/announce/online (example.org/announce/all-hosts/online)
The message is sent to all connected users. If the user is online and connected to several resources, all resources will receive the message. -
example.org/announce/motd (example.org/announce/all-hosts/motd)
The +
example.org/announce/motd (example.org/announce/all-hosts/motd)
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 announce/online). -
example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
+
example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
The message is set as message of the day (MOTD) and is sent to users when they login. The message is not sent to any currently connected user. -
example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
+
example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
Any message sent to this JID removes the existing message of the day (MOTD).
Options: -
-access
This option specifies who is allowed to +
+access
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).
Examples: -
+
Only administrators can send announcements: -
+
{access, announce, [{allow, admins}]}. {modules, @@ -1745,8 +1764,8 @@ Only administrators can send announcements: {mod_announce, [{access, announce}]}, ... ]}. -
Administrators as well as the direction can send announcements: -
+
Administrators as well as the direction can send announcements: +
{acl, direction, {user, "big_boss", "example.org"}}. {acl, direction, {user, "assistant", "example.org"}}. {acl, admins, {user, "admin", "example.org"}}. @@ -1763,7 +1782,7 @@ Only administrators can send announcements:
-
A.4  mod_disco
+
A.4  mod_disco
@@ -1776,26 +1795,26 @@ the newer Service Discovery protocol if you want them be able to discover the services you offer.

Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Service Discovery (http://jabber.org/protocol/disco#items and http://jabber.org/protocol/disco#info) IQ queries (see section A.2.1). -
extra_domains
With this option, +
extra_domains
With this option, extra domains can be added to the Service Discovery item list.
Examples: -
+
To serve a link to the Jabber User Directory on jabber.org: -
+
{modules, [ ... {mod_disco, [{extra_domains, ["users.jabber.org"]}]}, ... ]}. -
To serve a link to the transports on another server: -
+
To serve a link to the transports on another server: +
{modules, [ ... @@ -1803,8 +1822,8 @@ To serve a link to the Jabber User Directory on jabber.org: "msn.example.com"]}]}, ... ]}. -
To serve a link to a few friendly servers: -
+
To serve a link to a few friendly servers: +
{modules, [ ... @@ -1815,7 +1834,7 @@ To serve a link to the Jabber User Directory on jabber.org:
-
A.5  mod_echo
+
A.5  mod_echo
@@ -1824,31 +1843,31 @@ packet back to the sender. This mirror can be of interest for ejabberd and Jabber client debugging.

Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``echo.'' is added to all + the old host is present, the prefix “echo.” is added to all ejabberd hostnames.
Examples: -
+
Mirror, mirror, on the wall, who is the most beautiful of them all? -
+
{modules, [ ... {mod_echo, [{hosts, ["mirror.example.org"]}]}, ... ]}. -
If you still do not understand the inner workings of mod_echo, +
If you still do not understand the inner workings of mod_echo, you can find a few more examples in section A.2.2.
-
A.6  mod_irc
+
A.6  mod_irc
@@ -1857,50 +1876,50 @@ servers.

End user information: -
-A Jabber client with ``groupchat 1.0'' support or Multi-User +
+A Jabber client with “groupchat 1.0” support or Multi-User Chat support (JEP-0045) is necessary to join IRC channels. -
An IRC channel can be joined in nearly the same way as joining a +
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 ``channel%irc.example.org'' in case irc.example.org is - the IRC server hosting ``channel''. And of course the host should point + be “channel%irc.example.org” in case irc.example.org is + the IRC server hosting “channel”. And of course the host should point to the IRC transport instead of the Multi-User Chat service. -
You can register your nickame by sending ``IDENTIFY password'' to
+
You can register your nickame by sending “IDENTIFY password” to
nickserver!irc.example.org@irc.jabberserver.org. -
Entering your password is possible by sending ``LOGIN nick password''
+
Entering your password is possible by sending “LOGIN nick password”
to nickserver!irc.example.org@irc.jabberserver.org. -
When using a popular Jabber server, it can occur that no +
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.
Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``irc.'' is added to all + the old host is present, the prefix “irc.” is added to all ejabberd hostnames. -
access
This option can be used to specify who +
access
This option can be used to specify who may use the IRC transport (default value: all).
Examples: -
+
In the first example, the IRC transport is available on (all) your - virtual host(s) with the prefix ``irc.''. Furthermore, anyone is + virtual host(s) with the prefix “irc.”. Furthermore, anyone is able to use the transport. -
+
{modules, [ ... {mod_irc, [{access, all}]}, ... ]}. -
In next example the IRC transport is available on the two virtual hosts +
In next example the IRC transport is available on the two virtual hosts example.net and example.com with different prefixes on each host. Moreover, the transport is only accessible by paying customers registered on our domains and on other servers. -
+
{acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -1918,7 +1937,7 @@ In the first example, the IRC transport is available on (all) your
-
A.7  mod_last
+
A.7  mod_last
@@ -1928,14 +1947,14 @@ connected user was last active on the server, or to query the uptime of the ejabberd server.

Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Last activity (jabber:iq:last) IQ queries (see section A.2.1).
-
A.8  mod_muc
+
A.8  mod_muc
@@ -1944,34 +1963,34 @@ With this module enabled, your server will support Multi-User Chat that this module is not (yet) clusterable.

Some of the features of Multi-User Chat: -
+
Sending private messages to room participants. -
Inviting users. -
Setting a conference topic. -
Creating password protected rooms. -
Kicking and banning participants. +
Inviting users. +
Setting a conference topic. +
Creating password protected rooms. +
Kicking and banning participants.
Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``conference.'' is added to all + the old host is present, the prefix “conference.” is added to all ejabberd hostnames. -
access
You can specify who is allowed to use +
access
You can specify who is allowed to use the Multi-User Chat service (by default, everyone is allowed to use it). -
access_create
To configure who is +
access_create
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). -
access_admin
This option specifies +
access_admin
This option specifies who is allowed to administrate the Multi-User Chat service (the default value is none, which means that only the room creator can administer his room). By sending a message to the service JID, administrators can send service messages that will be displayed in every active room.

-
history_size
a small history of the +
history_size
a small history of the current discussion is send to users when they enter the room. This option make it possible to define the number of history messages to keep and send to the user joining the room. The value is a integer. Setting the value to 0 @@ -1979,17 +1998,17 @@ Options: is 20. This value is global and affects all MUC rooms on the server.
Examples: -
+
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 admin@example.org is allowed to administrate any room. In this example he is also a global administrator. When admin@example.org - sends a message such as ``Tomorrow, the Jabber server will be moved + sends a message such as “Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns around 23:00 UMT. - We apologise for this inconvenience.'' to conference.example.org, + We apologise for this inconvenience.” to conference.example.org, it will be displayed in all active rooms. In this example the history feature is disabled. -
+
{acl, admins, {user, "admin", "example.org"}}. ... {access, muc_admins, [{allow, admins}]}. @@ -2003,17 +2022,17 @@ In the first example everyone is allowed to use the Multi-User Chat {history_size, 0}]}, ... ]}. -
In the second example the Multi-User Chat service is only accessible by +
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. When - admin@example.org sends a message such as ``Tomorrow, the Jabber + admin@example.org sends a message such as “Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns - around 23:00 UMT. We apologise for this inconvenience.'' to + around 23:00 UMT. We apologise for this inconvenience.” to conference.example.org, it will be displayed in all active rooms. No history_size option is used, this means that the feature is enabled and the default value of 20 history messages will be send to the users. -
+
{acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -2036,7 +2055,7 @@ In the first example everyone is allowed to use the Multi-User Chat
-
A.9  mod_muc_log
+
A.9  mod_muc_log
@@ -2045,53 +2064,53 @@ Once you enable this module, join a chatroom with enought privileges using a MUC request the configuration form and there you will have an option to enable chatroom logging.

Some of the features of generated logs: -
+
A lot of information about chatroom is added on top of the page: Room title, JID, subject author, subject and configuration. -
Room title and JID are links to join the chatroom (using XMPP-IRI). -
Subject and chatroom configuration changes are tracked and displayed. -
Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. -
Generated HTML files are XHTML 1.0 Transitional and CSS compliant. -
Timestamps are self-referencing links. -
Links on top for quicker navigation: Previous day, Next day, Up. -
CSS is used for style definition, and a custom CSS file can be used. -
URLs on messages and subjects are converted to hyperlinks. -
Timezone used on timestamps is shown on the log files. -
A custom link can be added on top of page. +
Room title and JID are links to join the chatroom (using XMPP-IRI). +
Subject and chatroom configuration changes are tracked and displayed. +
Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. +
Generated HTML files are XHTML 1.0 Transitional and CSS compliant. +
Timestamps are self-referencing links. +
Links on top for quicker navigation: Previous day, Next day, Up. +
CSS is used for style definition, and a custom CSS file can be used. +
URLs on messages and subjects are converted to hyperlinks. +
Timezone used on timestamps is shown on the log files. +
A custom link can be added on top of page.
Options: -
-access_log
+
+access_log
Restricts which users are allowed to enable or disable chatroom logging using ACL and ACCESS. Default: muc_admin. If you want to allow any chatroom owner put: muc. -
cssfile
+
cssfile
If HTMLs will use a custom CSS file or the embedded one. Allowed values: false: HTMLs will include the standard CSS code; "CSS-URL": the URL of the CSS file (for example: "http://example.com/my.css"). Default: false. -
dirtype
+
dirtype
Type of directory that will be created. Allowed values: subdirs: creates subdirectories for year and month; plain: the filename contains the full date, no subdirs. Default: subdirs. -
outdir
+
outdir
Full path to the directory where html will be generated. Make sure the system user has write access on that directory. Default: "www/muc". -
timezone
+
timezone
What timezone should be used. Allowed values: local: use local time, as reported to Erlang by the operating system; universal: use GMT/UTC time. Default: local. -
top_link
+
top_link
Customizable link on top right corner. Syntax of this option: {"URL", "Text"}. Default: {"/", "Home"}.
Example configuration: -
+
{modules, [ ... @@ -2108,7 +2127,7 @@ Example configuration:
-
A.10  mod_offline
+
A.10  mod_offline
@@ -2120,78 +2139,78 @@ online again. Thus it is very similar to how email works. Note that
-
A.11  mod_privacy
+
A.11  mod_privacy
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: -
-
+
+
Retrieving one's privacy lists. -
Adding, removing, and editing one's privacy lists. -
Setting, changing, or declining active lists. -
Setting, changing, or declining the default list (i.e., the list that +
Adding, removing, and editing one's privacy lists. +
Setting, changing, or declining active lists. +
Setting, changing, or declining the default list (i.e., the list that is active by default). -
Allowing or blocking messages based on JID, group, or subscription type +
Allowing or blocking messages based on JID, group, or subscription type (or globally). -
Allowing or blocking inbound presence notifications based on JID, group, +
Allowing or blocking inbound presence notifications based on JID, group, or subscription type (or globally). -
Allowing or blocking outbound presence notifications based on JID, group, +
Allowing or blocking outbound presence notifications based on JID, group, or subscription type (or globally). -
Allowing or blocking IQ stanzas based on JID, group, or subscription type +
Allowing or blocking IQ stanzas based on JID, group, or subscription type (or globally). -
Allowing or blocking all communications based on JID, group, or +
Allowing or blocking all communications based on JID, group, or subscription type (or globally).
(from http://www.xmpp.org/specs/rfc3921.html#privacy)
Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section A.2.1).
-
A.12  mod_private
+
A.12  mod_private
This module adds support for Private XML Storage (JEP-0049): -
+
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 (JEP-0048).
Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section A.2.1).
-
A.13  mod_pubsub
+
A.13  mod_pubsub
This module offers a Publish-Subscribe Service (JEP-0060). Publish-Subscribe can be used to develop (examples are taken from the JEP): -
-
+
+
news feeds and content syndacation, -
avatar management, -
shared bookmarks, -
auction and trading systems, -
online catalogs, -
workflow systems, -
network management systems, -
NNTP gateways, -
vCard/profile management, -
and weblogs. +
avatar management, +
shared bookmarks, +
auction and trading systems, +
online catalogs, +
workflow systems, +
network management systems, +
NNTP gateways, +
vCard/profile management, +
and weblogs.

@@ -2201,21 +2220,21 @@ known as ESB, the Enterprise Service Bus). The J-EAI project builts upon ejabberd's codebase and has contributed several features to mod_pubsub.

Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``pubsub.'' is added to all + the old host is present, the prefix “pubsub.” is added to all ejabberd hostnames. -
served_hosts
To specify which hosts needs to +
served_hosts
To specify which hosts needs to be served, you can use this option. If absent, only the main ejabberd - host is served.
access_createnode
+ host is served.
access_createnode
Restricts which users are allowed to create pubsub nodes using ACL and ACCESS. Default: pubsub_createnode.
Example: -
+
{modules, [ ... @@ -2227,31 +2246,31 @@ Example:
-
A.14  mod_register
+
A.14  mod_register
This module adds support for In-Band Registration (JEP-0077). This protocol enables end users to use a Jabber client to: -
+
Register a new account on the server. -
Change the password from an existing account on the server. -
Delete an existing account on the server. +
Change the password from an existing account on the server. +
Delete an existing account on the server.
Options: -
-access
This option can be configured to specify - rules to restrict registration. If a rule returns ``deny'' on the requested +
+access
This option can be configured to specify + rules to restrict registration. If a rule returns “deny” on the requested user name, registration for that user name is dennied. (there are no restrictions by default). -
iqdisc
This specifies +
iqdisc
This specifies the processing discipline for In-Band Registration (jabber:iq:register) IQ queries (see section A.2.1).
Examples: -
+
Next example prohibits the registration of too short account names: -
+
{acl, shortname, {user_glob, "?"}}. {acl, shortname, {user_glob, "??"}}. % The same using regexp: @@ -2266,12 +2285,12 @@ Next example prohibits the registration of too short account names: {mod_register, [{access, register}]}, ... ]}. -
The in-band registration of new accounts can be prohibited by changing the +
The in-band registration of new accounts can be prohibited by changing the access 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 mod_register from the modules list. In this example all In-Band Registration functionality is disabled: -
+
{access, register, [{deny, all}]}. {modules, @@ -2283,21 +2302,21 @@ Next example prohibits the registration of too short account names:
-
A.15  mod_roster
+
A.15  mod_roster
This module implements roster management as defined in RFC 3921: XMPP IM.

Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section A.2.1).
-
A.16  mod_service_log
+
A.16  mod_service_log
@@ -2308,25 +2327,25 @@ packets are encapsulated in a <route/> element and sent to th service(s).

Options: -
-loggers
With this option a (list of) service(s) +
+loggers
With this option a (list of) service(s) that will receive the packets can be specified.
Examples: -
+
To log all end user packets to the Bandersnatch service running on bandersnatch.example.com: -
+
{modules, [ ... {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]}, ... ]}. -
To log all end user packets to the Bandersnatch service running on +
To log all end user packets to the Bandersnatch service running on bandersnatch.example.com and the backup service on bandersnatch.example.org: -
+
{modules, [ ... @@ -2337,7 +2356,7 @@ To log all end user packets to the Bandersnatch service running on
-
A.17  mod_shared_roster
+
A.17  mod_shared_roster
@@ -2349,21 +2368,21 @@ users from the shared roster groups.

Shared roster groups can be edited only via the web interface. Each group has a unique identification and the following parameters: -
-Name
The name of the group, which will be displayed in the roster. -
Description
The description of the group. This parameter doesn't affect +
+Name
The name of the group, which will be displayed in the roster. +
Description
The description of the group. This parameter doesn't affect anything. -
Members
A list of full JIDs of group members, entered one per line in +
Members
A list of full JIDs of group members, entered one per line in the web interface. -
Displayed groups
A list of groups that will be in the rosters of this +
Displayed groups
A list of groups that will be in the rosters of this group's members.
Examples: -
+
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: -
+
@@ -2386,14 +2405,14 @@ Take the case of a computer club that wants all its members seeing each

Identification Group `club_members'
Displayed groups club_members
-
-
In another case we have a company which has three divisions: Management, +
+
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: -
+
@@ -2460,25 +2479,25 @@ Take the case of a computer club that wants all its members seeing each

Identification Group `management'
sales
-
+

-
A.18  mod_stats
+
A.18  mod_stats
This module adds support for Statistics Gathering (JEP-0039). This protocol allows you to retrieve next statistics from your ejabberd deployment: -
+
Total number of registered users on the current virtual host (users/total). -
Total number of registered users on all virtual hosts (users/all-hosts/total). -
Total number of online users on the current virtual host (users/online). -
Total number of online users on all virtual hosts (users/all-hosts/online). +
Total number of registered users on all virtual hosts (users/all-hosts/total). +
Total number of online users on the current virtual host (users/online). +
Total number of online users on all virtual hosts (users/all-hosts/online).
Options: -
-iqdisc
This specifies +
+iqdisc
This specifies the processing discipline for Statistics Gathering (http://jabber.org/protocol/stats) IQ queries (see section A.2.1).
@@ -2486,18 +2505,18 @@ As there are only a small amount of clients (for example Tkabber) 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: -
+
You can request the number of online users on the current virtual host (example.org) by sending: -
+
<iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/online'/> </query> </iq> -
You can request the total number of registered users on all virtual hosts +
You can request the total number of registered users on all virtual hosts by sending: -
+
<iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/all-hosts/total'/> @@ -2506,7 +2525,7 @@ You can request the number of online users on the current virtual host
-
A.19  mod_time
+
A.19  mod_time
@@ -2514,14 +2533,14 @@ This module features support for Entity Time (
+iqdisc
This specifies the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section A.2.1).
-
A.20  mod_vcard
+
A.20  mod_vcard
@@ -2531,39 +2550,39 @@ implements an uncomplicated Jabber User Directory based on the vCards of these users. Moreover, it enables the server to send its vCard when queried.

Options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``vjud.'' is added to all + the old host is present, the prefix “vjud.” is added to all ejabberd hostnames. -
iqdisc
This specifies +
iqdisc
This specifies the processing discipline for vcard-temp IQ queries (see section A.2.1). -
search
This option specifies whether the search +
search
This option specifies whether the search functionality is enabled (value: true) or disabled (value: false). If disabled, the option hosts will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true. -
matches
With this option, the number of reported +
matches
With this option, the number of reported search results can be limited. If the option's value is set to infinity, all search results are reported. The default value is 30. -
allow_return_all
This option enables +
allow_return_all
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 false. -
search_all_hosts
If this option is +
search_all_hosts
If this option is set to true, search operations will apply to all virtual hosts. Otherwise only the current host will be searched. The default value is true.
Examples: -
+
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: -
+
{modules, [ ... @@ -2573,9 +2592,9 @@ In this first situation, search results are limited to twenty items, {search_all_hosts, false}]}, ... ]}. -
The second situation differs in a way that search results are not limited, +
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: -
+
{modules, [ ... @@ -2587,13 +2606,13 @@ In this first situation, search results are limited to twenty items,
-
A.21  LDAP and mod_vcard_ldap
+
A.21  LDAP and mod_vcard_ldap
-
A.21.1  Features
+
A.21.1  Features
ejabberd has built-in LDAP support. You can authenticate users against LDAP @@ -2602,22 +2621,22 @@ supported yet.

-
A.21.2  Connection
+
A.21.2  Connection
Parameters: -
-ldap_server
IP address or dns name of your +
+ldap_server
IP address or dns name of your LDAP server. This option is required. -
ldap_port
Port to connect to LDAP server. +
ldap_port
Port to connect to LDAP server. Default is 389. -
ldap_rootdn
Bind DN. Default is "" +
ldap_rootdn
Bind DN. Default is "" which means anonymous connection. -
ldap_password
Bind password. Default +
ldap_password
Bind password. Default is "".
Example: -
+
{auth_method, ldap}. {ldap_servers, ["ldap.mydomain.org"]}. {ldap_port, 389}. @@ -2629,21 +2648,21 @@ authentication.

-
A.21.3  Authentication
+
A.21.3  Authentication
You can authenticate users against LDAP directory. Available parameters are listed below: -
-ldap_base
LDAP base directory which stores users +
+ldap_base
LDAP base directory which stores users accounts. This option is required. -
ldap_uidattr
LDAP attribute which holds +
ldap_uidattr
LDAP attribute which holds user's part of JID. Default is "uid". -
ldap_uidattr_format
Format of the +
ldap_uidattr_format
Format of the ldap_uidattr variable. Format MUST contain one and only one pattern variable "%u" which will be replaced by user's part of JID. For example, "%u@mydomain.org". Default value is "%u". -
ldap_filter
RFC 2254 LDAP filter. Default is +
ldap_filter
RFC 2254 LDAP filter. Default is none. Example: "(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, don't forget closing brackets and don't use superfluous whitespaces. Also you MUST NOT use ldap_uidattr attribute in filter @@ -2651,7 +2670,7 @@ because this attribute will be substituted in LDAP filter automatically.
-
A.21.4  vCards and Search
+
A.21.4  vCards and Search
ejabberd can map LDAP attributes to vCard fields. This behaviour is @@ -2664,22 +2683,22 @@ LDAP parameters: ldap_servers, ldap_port, ldap_filter. If one of this option is not set ejabberd will look for top-level option with the same name. The second group of parameters consists of the following options: -
+
- hosts
This option defines the hostnames of the + hosts
This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``vjud.'' is added to all + the old host is present, the prefix “vjud.” is added to all ejabberd hostnames. -
iqdisc
This specifies +
iqdisc
This specifies the processing discipline for vcard-temp IQ queries (see section A.2.1). -
search
This option specifies whether the search +
search
This option specifies whether the search functionality is enabled (value: true) or disabled (value: false). If disabled, the option hosts will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true. -
ldap_vcard_map
the table which defines +
ldap_vcard_map
the table which defines reflection of LDAP attributes to vCard fields. Format is: [Name_of_vcard_field, Pattern, List_of_LDAP_attributes, ...] @@ -2692,7 +2711,7 @@ reflection of LDAP attributes to vCard fields. LDAP attributes from List_of_LDAP_attributes; "%u" will be replaced with user's part of JID and "%d" will be replaced with domain part of JID. Example: -
+
{ldap_vcard_map, [{"NICKNAME", "%u", []}, {"FN", "%s", ["displayName"]}, @@ -2702,7 +2721,7 @@ reflection of LDAP attributes to vCard fields. ]},
Default is: -
+
[{"NICKNAME", "%u", []}, {"FN", "%s", ["displayName"]}, {"FAMILY", "%s", ["sn"]}, @@ -2723,7 +2742,7 @@ Default is: {"BDAY", "%s", ["birthDay"]}, {"ROLE", "%s", ["employeeType"]}, {"PHOTO", "%s", ["jpegPhoto"]}] -
ldap_search_fields
This option defines +
ldap_search_fields
This option defines search form and LDAP attributes to search. Format: [Name, Attribute, ...] @@ -2733,7 +2752,7 @@ search form and LDAP attributes to search. msgs/*.msg for available words). Attribute is the LDAP attribute or the pattern "%u" Example: -
+
{ldap_search_fields, [{"User", "uid"}, {"Full Name", "displayName"}, @@ -2741,7 +2760,7 @@ search form and LDAP attributes to search. ]},
Default is: -
+
[{"User", "%u"}, {"Full Name", "displayName"}, {"Given Name", "givenName"}, @@ -2754,7 +2773,7 @@ Default is: {"Email", "mail"}, {"Organization Name", "o"}, {"Organization Unit", "ou"}] -
ldap_search_reported
This option defines search fields to be reported. +
ldap_search_reported
This option defines search fields to be reported. Format: [Name, VCard_Name, ...] where @@ -2763,7 +2782,7 @@ Default is: msgs/*.msg for available words). VCard_Name is the name of vCard field defined in ldap_vcard_map option. Example: -
+
{ldap_search_reported, [{"Full Name", "FN"}, {"Email", "EMAIL"}, @@ -2772,7 +2791,7 @@ Default is: ]},
Default is: -
+
[{"Full Name", "FN"}, {"Given Name", "GIVEN"}, {"Middle Name", "MIDDLE"}, @@ -2787,19 +2806,19 @@ Default is:
-
A.21.5  Examples
+
A.21.5  Examples
-
Common example
+
Common example
Let's say ldap.mydomain.org is the name of our LDAP server. We have users with their passwords in "ou=Users,dc=mydomain,dc=org" directory. Also we have addressbook, which contains users emails and their additional infos in "ou=AddressBook,dc=mydomain,dc=org" directory. Corresponding authentication section should looks like this: -
+
%% authentication method {auth_method, ldap}. %% DNS name of our LDAP server @@ -2813,10 +2832,10 @@ authentication section should looks like this: {ldap_filter, "(objectClass=shadowAccount)"}.
Now we want to use users LDAP-info as their vCards. We have four attributes -defined in our LDAP schema: "mail" --- email address, "givenName" ---- first name, "sn" --- second name, "birthDay" --- birthday. +defined in our LDAP schema: "mail" — email address, "givenName" +— first name, "sn" — second name, "birthDay" — birthday. Also we want users to search each other. Let's see how we can set it up: -
+
{modules, ... {mod_vcard_ldap, @@ -2865,11 +2884,11 @@ searching his info in LDAP.

-
Active Directory
+
Active Directory
Active Directory is just an LDAP-server with predefined attributes. Sample config file is listed below: -
+
{auth_method, ldap}. {ldap_servers, ["office.org"]}. % List of LDAP servers {ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory @@ -2916,7 +2935,7 @@ config file is listed below:
-
A.22  mod_version
+
A.22  mod_version
@@ -2924,20 +2943,20 @@ This module implements Software Version (
+iqdisc
This specifies the processing discipline for Software Version (jabber:iq:version) IQ queries (see section A.2.1).
-
B  Internationalization and Localization
+
B  Internationalization and Localization
All built-in modules support the xml:lang attribute inside IQ queries. Figure 2, for example, shows the reply to the following query: -
+
<iq id='5' to='example.org' type='get' @@ -2945,40 +2964,44 @@ Figure 2, for example, shows the reply to the f <query xmlns='http://jabber.org/protocol/disco#items'/> </iq>
-
+

-
Figure 2: Service Discovery when xml:lang='ru'

+
+
Figure 2: Service Discovery when xml:lang='ru'

+
-
+
The web interface also supports the Accept-Language HTTP header (compare figure 3 with figure 1) -
+

-
Figure 3: Top page from the web interface with HTTP header - ``Accept-Language: ru''

+
+
Figure 3: Top page from the web interface with HTTP header + “Accept-Language: ru”

+
-
+
-
C  Release Notes
+
C  Release Notes
-
C.1  ejabberd 0.9
+
C.1  ejabberd 0.9
-
+
Release notes ejabberd 0.9 @@ -3070,9 +3093,9 @@ Bugfixes
-
C.2  ejabberd 0.9.1
+
C.2  ejabberd 0.9.1
-
+
Release notes ejabberd 0.9.1 @@ -3138,9 +3161,9 @@ Bugfixes
-
C.3  ejabberd 0.9.8
+
C.3  ejabberd 0.9.8
-
+
Release notes ejabberd 0.9.8 2005-08-01 @@ -3243,9 +3266,9 @@ END
-
C.4  ejabberd 1.0.0
+
C.4  ejabberd 1.0.0
-
+
Release Notes ejabberd 1.0.0 14 December 2005 @@ -3369,9 +3392,9 @@ END
-
C.5  ejabberd 1.1.0
+
C.5  ejabberd 1.1.0
-
+
Release Notes ejabberd 1.1.0 24 April 2006 @@ -3490,9 +3513,9 @@ END
-
C.6  ejabberd 1.1.1
+
C.6  ejabberd 1.1.1
-
+
Release Notes ejabberd 1.1.1 28 April 2006 @@ -3615,26 +3638,23 @@ END
-
D  Acknowledgements
+
D  Acknowledgements
Thanks to all people who contributed to this guide: -
+
Alexey Shchepin (xmpp:aleksey@jabber.ru) -
Florian Zumbiehl (xmpp:florz@florz.de) -
Michael Grigutsch (xmpp:migri@jabber.i-pobox.net) -
Mickael Remond (xmpp:mremond@erlang-projects.org) -
Sander Devrieze (xmpp:sander@devrieze.dyndns.org) -
Sergei Golovan (xmpp:sgolovan@nes.ru) -
Vsevolod Pelipas (xmpp:vsevoload@jabber.ru) +
Florian Zumbiehl (xmpp:florz@florz.de) +
Michael Grigutsch (xmpp:migri@jabber.i-pobox.net) +
Mickael Remond (xmpp:mremond@erlang-projects.org) +
Sander Devrieze (xmpp:sander@devrieze.dyndns.org) +
Sergei Golovan (xmpp:sgolovan@nes.ru) +
Vsevolod Pelipas (xmpp:vsevoload@jabber.ru)
-
-
This document was translated from L^AT_EX by -H^EV^EA. -
- +
This document was translated from L^AT_EX by +H^EV^EA.
-- cgit v1.2.3 From 1632aec61e84630085268d26f5bc39e34c2465fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= Date: Fri, 22 Sep 2006 09:16:31 +0000 Subject: Improvement coming from trunk (SVN #617): * doc/guide.tex: Large improvements for ejabberd 1.1.2 (thanks to Sander Devrieze) * doc/version.tex: Likewise. * doc/features.tex: Likewise. * doc/Makefile: Likewise. * doc/dev.tex: Likewise. SVN Revision: 618 --- doc/guide.html | 3116 +++++++++++++++++++++++++++++++------------------------- 1 file changed, 1745 insertions(+), 1371 deletions(-) (limited to 'doc/guide.html') diff --git a/doc/guide.html b/doc/guide.html index cf4f4382f..130a9c128 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -4,7 +4,7 @@ -Ejabberd 1.1.1 Installation and Operation Guide +Ejabberd 1.1.2 Installation and Operation Guide @@ -18,11 +18,12 @@ 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} +SPAN{width:20%; float:right; text-align:left; margin-left:auto;} - + @@ -30,11 +31,11 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}

- + @@ -42,14 +43,14 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
- +

-
I can thoroughly recommend ejabberd for ease of setup – +
I can thoroughly recommend ejabberd for ease of setup — Kevin Smith, Current maintainer of the Psi project
@@ -65,136 +66,159 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
2.1  Installation Requirements
-2.1.1  “Unix-like” operating systems +2.1.1  `Unix-like' operating systems
2.1.2  Windows

2.2  Obtaining ejabberd
2.3  Compilation
-2.3.1  “Unix-like” operating systems +2.3.1  `Unix-like' operating systems
2.3.2  Windows

2.4  Starting
-
3  Configuration +
3  Basic Configuration
-3.1  Initial Configuration +3.1  Host Names +
3.2  Virtual Hosting +
3.3  Listened Sockets +
3.4  Authentication
-3.1.1  Host Names -
3.1.2  Default Language -
3.1.3  Access Rules -
3.1.4  Shapers -
3.1.5  Limitation of the number of opened sessions -
3.1.6  Listened Sockets -
3.1.7  Modules -
3.1.8  Virtual Hosting -
3.1.9  SASL anonymous and anonymous login +3.4.1  Internal +
3.4.2  SASL Anonymous and Anonymous Login
-
3.2  Relational Database Support +
3.5  Access Rules +
3.6  Shapers +
3.7  Limiting Opened Sessions +
3.8  Default Language +
+
4  Database Configuration +
+4.1  MySQL
-3.2.1  Preliminary steps -
3.2.2  Authentication against a relational database -
3.2.3  Relational database for other modules +4.1.1  Driver Compilation +
4.1.2  Authentication +
4.1.3  Storage
-
3.3  Creating an Initial Administrator -
3.4  Online Configuration and Monitoring +
4.2  Microsoft SQL Server
-3.4.1  Web Interface -
3.4.2  ejabberdctl +4.2.1  Driver Compilation +
4.2.2  Authentication +
4.2.3  Storage
+
4.3  PostgreSQL +
+4.3.1  Driver Compilation +
4.3.2  Authentication +
4.3.3  Storage
-
4  Firewall Settings -
5  SRV Records -
6  Clustering +
4.4  ODBC Compatible
-6.1  How it Works +4.4.1  Compilation +
4.4.2  Authentication +
4.4.3  Storage +
+
4.5  LDAP
-6.1.1  Router -
6.1.2  Local Router -
6.1.3  Session Manager -
6.1.4  s2s Manager +4.5.1  Connection +
4.5.2  Authentication +
4.5.3  Examples
-
6.2  Clustering Setup
-
A  Built-in Modules +
5  Modules Configuration
-A.1  Overview -
A.2  Common Options +5.1  Overview +
5.2  Common Options
-A.2.1  iqdisc -
A.2.2  hosts +5.2.1  iqdisc +
5.2.2  hosts
-
A.3  mod_announce -
A.4  mod_disco -
A.5  mod_echo -
A.6  mod_irc -
A.7  mod_last -
A.8  mod_muc -
A.9  mod_muc_log -
A.10  mod_offline -
A.11  mod_privacy -
A.12  mod_private -
A.13  mod_pubsub -
A.14  mod_register -
A.15  mod_roster -
A.16  mod_service_log -
A.17  mod_shared_roster -
A.18  mod_stats -
A.19  mod_time -
A.20  mod_vcard -
A.21  LDAP and mod_vcard_ldap +
5.3  mod_announce +
5.4  mod_disco +
5.5  mod_echo +
5.6  mod_irc +
5.7  mod_last +
5.8  mod_muc +
5.9  mod_muc_log +
5.10  mod_offline +
5.11  mod_privacy +
5.12  mod_private +
5.13  mod_pubsub +
5.14  mod_register +
5.15  mod_roster +
5.16  mod_service_log +
5.17  mod_shared_roster +
5.18  mod_stats +
5.19  mod_time +
5.20  mod_vcard +
5.21  mod_vcard_ldap +
5.22  mod_version +
+
6  Creating an Initial Administrator +
7  Online Configuration and Monitoring +
+7.1  Web Interface +
7.2  ejabberdctl +
+
8  Firewall Settings +
9  SRV Records +
10  Clustering +
+10.1  How it Works
-A.21.1  Features -
A.21.2  Connection -
A.21.3  Authentication -
A.21.4  vCards and Search -
A.21.5  Examples +10.1.1  Router +
10.1.2  Local Router +
10.1.3  Session Manager +
10.1.4  s2s Manager
-
A.22  mod_version +
10.2  Clustering Setup
-
B  Internationalization and Localization -
C  Release Notes +
A  Internationalization and Localization +
B  Release Notes
-C.1  ejabberd 0.9 -
C.2  ejabberd 0.9.1 -
C.3  ejabberd 0.9.8 -
C.4  ejabberd 1.0.0 -
C.5  ejabberd 1.1.0 -
C.6  ejabberd 1.1.1 +B.1  ejabberd 0.9 +
B.2  ejabberd 0.9.1 +
B.3  ejabberd 0.9.8 +
B.4  ejabberd 1.0.0 +
B.5  ejabberd 1.1.0 +
B.6  ejabberd 1.1.1
-
D  Acknowledgements +
C  Acknowledgements +
D  Copyright Information -
1  Introduction
+
1  Introduction
- + -ejabberd is a free (GPL) distributed fault-tolerant Jabber/XMPP server and is mainly written in Erlang.
+ejabberd is a free and open source instant messaging server written in Erlang.

-ejabberd is designed to be a stable, standards compliant, and feature rich Jabber/XMPP server.
+ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

-ejabberd is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.
+ejabberd is designed to be a rock-solid and feature rich XMPP server.
+
+ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.

-
1.1  Key Features
+
1.1  Key Features
ejabberd is:
-Multiplatform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
+Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.

Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.

-
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced “on the fly”.
+
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.

Administrator Friendly: ejabberd 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:
Comprehensive documentation. -
Straightforward installers for Linux, Mac OS X, and Windows. +
Straightforward installers for Linux, Mac OS X, and Windows.improved
Web interface for administration tasks.
Shared Roster Groups.
Command line administration tool. @@ -210,17 +234,17 @@ Translated in 11 languages.

Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
-Fully XMPP compliant -
XML-based protocol +Fully XMPP compliant. +
XML-based protocol.
Many JEPs supported.
-
1.2  Additional Features
+
1.2  Additional Features
-Besides common Jabber server features, ejabberd comes with a wide range of other features: +Moreover, ejabberd comes with a wide range of other state-of-the-art features:
Modular
@@ -238,12 +262,12 @@ SASL and STARTTLS for c2s and s2s connections. Native MySQL support.
Native PostgreSQL support.
Mnesia. -
ODBC data storage support. -
Microsoft SQL Server support (via ODBC). +
ODBC data storage support. +
Microsoft SQL Server support.new

Authentication
-LDAP and ODBC. +LDAP and ODBC.
External Authentication script.
Internal Authentication.
@@ -253,47 +277,46 @@ Compressing XML streams with Stream Compression (Interface with networks such as AIM, ICQ and MSN.
Statistics via Statistics Gathering (JEP-0039).
IPv6 support both for c2s and s2s connections. -
Multi-User Chat module with logging. +
Multi-User Chat module with logging.improved
Users Directory based on users vCards.
Publish-Subscribe component. -
Support for virtual hosting. +
Support for virtual hosting.
HTTP Polling service.
IRC transport.

-
2  Installation from Source
+
2  Installation from Source
- + -
2.1  Installation Requirements
+
2.1  Installation Requirements
- -
2.1.1  “Unix-like” operating systems
+ - +
2.1.1  `Unix-like' operating systems
-To compile ejabberd on a “Unix-like” operating system, you need: + +To compile ejabberd on a `Unix-like' operating system, you need:
-GNU Make; -
GCC; -
libexpat 1.95 or higher; -
Erlang/OTP R9C-2 or higher; -
OpenSSL 0.9.6 or higher (optional). -
Zlib 1.2.3 or higher (optional). -
GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc). +GNU Make +
GCC +
libexpat 1.95 or higher +
Erlang/OTP R9C-2 or higher +
OpenSSL 0.9.6 or higher (optional) +
Zlib 1.2.3 or higher (optional) +
GNU Iconv 1.8 or higher (optional, not needed on systems with GNU libc)
-
2.1.2  Windows
+
2.1.2  Windows
- To compile ejabberd on a Windows flavour, you need:
MS Visual C++ 6.0 Compiler @@ -307,7 +330,7 @@ MS Visual C++ 6.0 Compiler
-
2.2  Obtaining ejabberd
+
2.2  Obtaining ejabberd
@@ -321,17 +344,16 @@ The latest development version can be retrieved from the Subversion repository. -
2.3  Compilation
+
2.3  Compilation
- + - + -
2.3.1  “Unix-like” operating systems
+
2.3.1  `Unix-like' operating systems
- - -Compile ejabberd on a “Unix-like” operating system by executing: + +Compile ejabberd on a `Unix-like' operating system by executing:
./configure make @@ -344,12 +366,15 @@ install ejabberd into the directory /var/lib/ejabberd,
install the configuration file into /etc/ejabberd,
create a directory called /var/log/ejabberd to store log files. +Note: if you want to use an external database, you need to execute the configure +script with the option(s) –enable-odbc or –enable-odbc +–enable-mssql. See section 4 for more information.
+
-
2.3.2  Windows
- - +
2.3.2  Windows
+
Install Erlang emulator (for example, into C:\Program Files\erl5.3).
Install Expat library into C:\Program Files\Expat-1.95.7 @@ -380,9 +405,10 @@ werl -s ejabberd -name ejabberd
-
2.4  Starting
+
2.4  Starting
+ + - Execute the following command to start ejabberd:
@@ -391,7 +417,7 @@ Execute the following command to start ejabberd:
erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
In the latter case the Erlang node will be identified using only the first part -of the host name, i. e. other Erlang nodes outside this domain can't contact +of the host name, i. e. other Erlang nodes outside this domain cannot contact this node.

Note that when using the above command, ejabberd will search for the @@ -425,16 +451,11 @@ To reduce memory usage, you may set the environment variable export ERL_FULLSWEEP_AFTER=0
But in this case ejabberd can start to work slower.

- + -
3  Configuration
+
3  Basic Configuration
- - - -
3.1  Initial Configuration
- - + The configuration file will be loaded the first time you start ejabberd. The content from this file will be parsed and stored in a database. Subsequently the @@ -443,7 +464,7 @@ configuration file are appended to the entries in the database. The configuration file contains a sequence of Erlang terms. Lines beginning with a `%' 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 “hosts” option, the old +configuration file do not contain for instance the `hosts' option, the old host name(s) stored in the database will be used.

You can override the old values stored in the database by adding next lines to @@ -455,11 +476,11 @@ the configuration file: With these lines the old global options, local options and ACLs will be removed before new ones are added.

- + -
3.1.1  Host Names
+
3.1  Host Names
- + The option hosts defines a list containing one or more domains that ejabberd will serve.
@@ -467,175 +488,61 @@ The option hosts defines a list containing one or more domains that Examples:
Serving one domain: -
-
+
{hosts, ["example.org"]}. -
Backwards compatibility with older ejabberd versions can be retained - with: +
Serving one domain, and backwards compatible with older ejabberd + versions:
{host, "example.org"}. -
-
Serving two domains: +
Serving two domains:
{hosts, ["example.net", "example.com"]}.
- - -
3.1.2  Default Language
- - - -The option language defines the default language of server strings that -can be seen by Jabber clients. If a Jabber client do not support -xml:lang, the specified language is used. The default value for the -option language is "en". In order to take effect there must be a -translation file <language>.msg in ejabberd's msgs directory.
-
-Examples: -
-To set Russian as default language: -
- {language, "ru"}. -
To set Spanish as default language: -
- {language, "es"}. -
- + -
3.1.3  Access Rules
+
3.2  Virtual Hosting
- + -Access control in ejabberd is performed via Access Control Lists (ACLs). The -declarations of ACLs in the configuration file have the following syntax: -
- {acl, <aclname>, {<acltype>, ...}}. -
-<acltype> can be one of the following: -
-all
Matches all JIDs. Example: -
-{acl, all, all}. -
{user, <username>}
Matches the user with the name - <username> at the first virtual host. Example: -
-{acl, admin, {user, "yozhik"}}. -
{user, <username>, <server>}
Matches the user with the JID - <username>@<server> and any resource. Example: -
-{acl, admin, {user, "yozhik", "example.org"}}. -
{server, <server>}
Matches any JID from server - <server>. Example: -
-{acl, exampleorg, {server, "example.org"}}. -
{user_regexp, <regexp>}
Matches any local user with a name that - matches <regexp> at the first virtual host. Example: -
-{acl, tests, {user, "^test[0-9]*$"}}. -
{user_regexp, <regexp>, <server>}
Matches any user with a name - that matches <regexp> at server <server>. Example: -
-{acl, tests, {user, "^test", "example.org"}}. -
{server_regexp, <regexp>}
Matches any JID from the server that - matches <regexp>. Example: -
-{acl, icq, {server, "^icq\\."}}. -
{node_regexp, <user_regexp>, <server_regexp>}
Matches any user - with a name that matches <user_regexp> at any server that matches - <server_regexp>. Example: -
-{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. -
{user_glob, <glob>}
-
{user_glob, <glob>, <server>}
-
{server_glob, <glob>}
-
{node_glob, <user_glob>, <server_glob>}
This is the same as - above. However, it uses shell glob patterns instead of regexp. These patterns - can have the following special characters: -
- *
matches any string including the null string. -
?
matches any single character. -
[...]
matches any of the enclosed characters. Character - ranges are specified by a pair of characters separated by a `-'. - If the first character after `[' is a `!', any - character not enclosed is matched. -
-
-The following ACLs are pre-defined: -
-all
Matches any JID. -
none
Matches no JID. -
-An entry allowing or denying access to different services looks similar to -this: -
- {access, <accessname>, [{allow, <aclname>}, - {deny, <aclname>}, - ... - ]}. -
When a JID is checked to have access to <accessname>, 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 “deny” is returned.
-
-Example: +Options can be defined separately for every virtual host using the +host_config option. It has the following +syntax:
- {access, configure, [{allow, admin}]}. - {access, something, [{deny, badmans}, - {allow, all}]}. + {host_config, <hostname>, [<option>, <option>, ...]}.
-The following access rules are pre-defined: -
-all
Always returns “allow” -
none
Always returns “deny” -
- - -
3.1.4  Shapers
- - - -Shapers enable you to limit connection traffic. The syntax of -shapers is like this: -
- {shaper, <shapername>, <kind>}. -
Currently only one kind of shaper called maxrate is available. It has the -following syntax: -
- {maxrate, <rate>} -
where <rate> stands for the maximum allowed incomig rate in bytes per -second.
-
Examples:
-To define a shaper named “normal” with traffic speed limited to -1,000 bytes/second: -
- {shaper, normal, {maxrate, 1000}}. -
To define a shaper named “fast” with traffic speed limited to -50,000 bytes/second: +Domain example.net is using the internal authentication method while + domain example.com is using the LDAP server running on the + domain localhost to perform authentication:
- {shaper, fast, {maxrate, 50000}}. -
- - -
3.1.5  Limitation of the number of opened sessions
+{host_config, "example.net", [{auth_method, internal}]}. - +{host_config, "example.com", [{auth_method, ldap}, + {ldap_servers, ["localhost"]}, + {ldap_uidattr, "uid"}, + {ldap_rootdn, "dc=localdomain"}, + {ldap_rootdn, "dc=example,dc=com"}, + {ldap_password, ""}]}. +
Domain example.net is using ODBC to perform authentication + while domain example.com is using the LDAP servers running on the domains + localhost and otherhost: +
+{host_config, "example.net", [{auth_method, odbc}, + {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. -This option specifies the maximum number of sessions (authenticated -connections) per user. If a user tries to open more than the maximum number of -allowed sessions, with different resources, the first opened session will be -disconnected. The error “session replaced” is send to the -disconnected session. This value is either a number or infinity. For -example {max\_user\_sessions, 10}. The default value is 10.
-
-This option can be define per virtual host. See section 3.1.8.
-
- +{host_config, "example.com", [{auth_method, ldap}, + {ldap_servers, ["localhost", "otherhost"]}, + {ldap_uidattr, "uid"}, + {ldap_rootdn, "dc=localdomain"}, + {ldap_rootdn, "dc=example,dc=com"}, + {ldap_password, ""}]}. +
+ -
3.1.6  Listened Sockets
+
3.3  Listened Sockets
- + The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a @@ -697,7 +604,7 @@ Currently next modules are implemented: The following options are available:
{access, <access rule>}
This option defines - access to the port. The default value is “all”. + access to the port. The default value is all.
{certfile, Path}
Path to a file containing the SSL certificate.
{hosts, [Hostnames], [HostOptions]}
This option defines one or more hostnames of connected services and enables you to @@ -718,12 +625,13 @@ If HTTP Polling is enabled, it will be available at
{ip, IPAddress}
This option specifies which network interface to listen for. For example {ip, {192, 168, 1, 1}}.
{max_stanza_size, Size}
This - option specifies an approximate maximal size in bytes of XML stanzas. - For example {max\_stanza\_size, 65536}. The default value - is “infinity”. + option specifies an approximate maximum size in bytes of XML stanzas. + Approximate, because it is calculated with the precision of one block of + readed data. For example {max\_stanza\_size, 65536}. The default + value is infinity.
{shaper, <access rule>}
This option defines a - shaper for the port (see section 3.1.4). The default value - is “none”. + shaper for the port (see section 3.6). The default value + is none.
ssl
This option specifies that traffic on the port will be encrypted using SSL. You should also set the certfile option. It is recommended to use the tls option @@ -740,57 +648,58 @@ If HTTP Polling is enabled, it will be available at should also set the certfile option.
zlib
This option specifies that Zlib stream compression (as defined in JEP-0138) - is available on connections to the port. Client cannot use stream compression and - stream encryption simultaneously, so if you specify both tls (or ssl) - and zlib the latter option will not affect connection at all. + is available on connections to the port. Client connections cannot use + stream compression and stream encryption simultaneously. Hence, if you + specify both tls (or ssl) and zlib, the latter + option will not affect connections (there will be no stream compression).
web_admin
This option enables the web interface for ejabberd administration which is available at http://server:port/admin/. Login and password are the username and password of one of the registered users who are granted access by the - “configure” access rule. + `configure' access rule.
-Also the following global options are available for s2s connections: +In addition, the following options are available for s2s connections:
{s2s_use_starttls, true|false}
- This option defines whether to use STARTTLS - for s2s connections. -
{s2s_certfile, Path}
Path to the - file containing the SSL certificate. + This option defines whether to + use STARTTLS for s2s connections. +
{s2s_certfile, Path}
Path to a + file containing a SSL certificate.
{domain_certfile, Domain, Path}
Path to the file containing the SSL certificate for the specified domain.
For instance, the following configuration defines that:
c2s connections are listened for on port 5222 and 5223 (SSL) and denied - for the user “bad” + for the user called `bad'.
s2s connections are listened for on port 5269 with STARTTLS for secured traffic enabled.
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 3.4.1 shows how exactly this can be done. + example in section 7.1 shows how exactly this can be done.
All users except for the administrators have a traffic of limit 1,000 Bytes/second
The AIM transport aim.example.org is connected to port 5233 with password - “aimsecret” + `aimsecret'.
The ICQ transport JIT (icq.example.org and sms.example.org) is connected to port 5234 with password - “jitsecret” + `jitsecret'.
The MSN transport msn.example.org is connected to port 5235 with password - “msnsecret” + `msnsecret'.
The Yahoo! transport yahoo.example.org is connected to port 5236 with password - “yahoosecret” + `yahoosecret'.
The Gadu-Gadu transport gg.example.org is - connected to port 5237 with password “ggsecret” + connected to port 5237 with password `ggsecret'.
The Jabber Mail Component jmc.example.org is connected to port 5238 with password - “jmcsecret” + `jmcsecret'.

{acl, blocked, {user, "bad"}}. @@ -853,198 +762,354 @@ services you have to make the transports log and do XDB by themselves: </xdb_file> </xdb>
- + -
3.1.7  Modules
+
3.4  Authentication
- + -The option modules defines the list of modules that will be loaded after -ejabberd's startup. Each entry in the list is a tuple in which the first -element is the name of a module and the second is a list of options for that -module. Read section A for detailed information about modules.
-
-Examples: +The option auth_method defines the authentication method that is used +for user authentication: +
+ {auth_method, [<method>]}. +
+The following authentication methods are supported by ejabberd:
-In this simple example, only the module mod_echo is loaded and no - options are specified between square brackets: -
- {modules, - [{mod_echo, []} - ]}. -
The second example is also simple: the modules mod_echo, mod_time, and - mod_version are loaded without options. Remark that, besides the last entry, - all entries end with a comma: -
- {modules, - [{mod_echo, []}, - {mod_time, []}, - {mod_version, []} - ]}. -
- +internal (default) — See section 3.4.1. +
external — There are some + example authentication scripts. +
ldap — See section 4.5. +
odbc — See section 4.1, 4.3, + 4.2 and 4.4. +
anonymous — See section 3.4.2. + + -
3.1.8  Virtual Hosting
+
3.4.1  Internal
- + -Options can be defined separately for every virtual host using the -host_config option. It has the following -syntax: -
- {host_config, <hostname>, [<option>, <option>, ...]}. -
+ejabberd uses its internal Mnesia database as the default authentication method. +
+auth_method: The value internal will enable the internal + authentication method. +
Examples:
-Domain example.net is using the internal authentication method while - domain example.com is using the LDAP server running on the domain - localhost to perform authentication: -
-{host_config, "example.net", [{auth_method, internal}]}. - -{host_config, "example.com", [{auth_method, ldap}, - {ldap_servers, ["localhost"]}, - {ldap_uidattr, "uid"}, - {ldap_rootdn, "dc=localdomain"}, - {ldap_rootdn, "dc=example,dc=com"}, - {ldap_password, ""}]}. -
Domain example.net is using ODBC to perform authentication - while domain example.com is using the LDAP servers running on the domains - localhost and otherhost: -
-{host_config, "example.net", [{auth_method, odbc}, - {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. - -{host_config, "example.com", [{auth_method, ldap}, - {ldap_servers, ["localhost", "otherhost"]}, - {ldap_uidattr, "uid"}, - {ldap_rootdn, "dc=localdomain"}, - {ldap_rootdn, "dc=example,dc=com"}, - {ldap_password, ""}]}. +To use internal authentication on example.org and LDAP + authentication on example.net: +
+{host_config, "example.org", [{auth_method, [internal]}]}. +{host_config, "example.net", [{auth_method, [ldap]}]}. +
To use internal authentication on all virtual hosts: +
+{auth_method, internal}.
- + -
3.1.9  SASL anonymous and anonymous login
+
3.4.2  SASL Anonymous and Anonymous Login
- + -The configuration of the anonymous mode can be done with three -host_config parameters: -
-auth_method: This value is used for defining the authentication method: -internal, odbc, ldap, external). You now have a special extra option to enable -anonymous mode: anonymous.
-
-
allow_multiple_connections: This option can be either true or false and -is only used when the anonymous mode is enabled. Setting it to true means that -the same username will be able to be taken several time in anonymous login -mode if different resource are used to connect. This option is only useful in -very special cases. It defaults to false.
-
+The anonymous authentication method can be configured with the following +options. Remember that you can use the host_config option to set virtual +host specific options (see section 3.2). Note that there also +is a detailed tutorial regarding SASL +Anonymous and anonymous login configuration. +
+auth_method: The value anonymous will enable the anonymous + authentication method. +
allow_multiple_connections: This value for this option can be + either true or false and is only used when the anonymous mode is + enabled. Setting it to true means that the same username can be taken + multiple times in anonymous login mode if different resource are used to + connect. This option is only useful in very special occasions. The default + value is false.
anonymous_protocol: This option can take three values: - sasl_anon, login_anon or both. sasl_anon means that - SASL anonymous mode is enabled. login_anon means that anonymous - login mode is enabled. both means that SASL anonymous and login anonymous are - enabled. + sasl_anon, login_anon or both. sasl_anon means + that the SASL Anonymous method will be used. login_anon means that the + anonymous login method will be used. both means that SASL Anonymous and + login anonymous are both enabled.
Those options are defined for each virtual host with the host_config -parameter (see section 3.1.8).
+parameter (see section 3.2).

Examples:
-To enable anonymous login on a virtual host: -
-{host_config, "public.example.org", [{auth_method, anonymous}, +To enable anonymous login on all virtual hosts: +
+{auth_method, [anonymous]}. +{anonymous_protocol, login_anon}. +
Similar as previous example, but limited to public.example.org: +
+{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, login_anon}]}.
To enable anonymous login and internal authentication on a virtual host: -
+
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, login_anon}]}. -
To enable SASL anonymous on a virtual host: -
+
To enable SASL Anonymous on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, sasl_anon}]}. -
To enable SASL anonymous and anonymous login on a virtual host: -
+
To enable SASL Anonymous and anonymous login on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, both}]}. -
To enable SASL anonymous, anonymous login and internal authentication on +
To enable SASL Anonymous, anonymous login, and internal authentication on a virtual host: -
+
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, both}]}.
-A detailled tutorial on SASL anonymous and anonymous login support is -available from: -http://support.process-one.net/doc/display/MESSENGER/Anonymous+users+support
-
- + -
3.2  Relational Database Support
+
3.5  Access Rules
- - + -
3.2.1  Preliminary steps
- - -If you have installed ejabberd using a binary version, the compilation steps -are not needed as they have already been done correctly.
-
-Otherwise, to be able to use ejabberd with a relational database you need to -enable ODBC modules during compilation, even if you want to use ejabberd with -MySQL or PostgreSQL in native mode. The following configure command can -be used to enable the relational modules: +Access control in ejabberd is performed via Access Control Lists (ACLs). The +declarations of ACLs in the configuration file have the following syntax:
-./configure --enable-odbc + {acl, <aclname>, {<acltype>, ...}}.
-If you are planning to use Microsoft SQL Server with ODBC, you need to specify -it from the configure command before compilation: +<acltype> can be one of the following: +
+all
Matches all JIDs. Example:
-./configure --enable-odbc --enable-mssql -
- - -
3.2.2  Authentication against a relational database
- - -ejabberd use its internal Mnesia database as a default. It is however possible -to use relational database to store persistant, long-living data. When -switching the auth_method from internal to odbc, you are -telling ejabberd to use a relational database for authentication. Different -auth_method values can be used for different virtual hosts in the -system.
-
-The option value name be misleading, as the method name is use both for access -to relational database through ODBC or through the native interface. In any -case, the first step is to define the odbc auth_method. For example: +{acl, all, all}. +
{user, <username>}
Matches the user with the name + <username> at the first virtual host. Example:
-{host_config, "public.example.org", [{auth_method, [odbc]}]}. -
-The actual database access is defined in the option odbc_server. Its -value is use to defined if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.
-
-To use a relational database through ODBC, you can pass the ODBC connection -string as odbc_server parameter. For example: +{acl, admin, {user, "yozhik"}}. +
{user, <username>, <server>}
Matches the user with the JID + <username>@<server> and any resource. Example:
-{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}. -
-To use the native PostgreSQL interface, you can pass a tuple of the following form as -parameter: +{acl, admin, {user, "yozhik", "example.org"}}. +
{server, <server>}
Matches any JID from server + <server>. Example:
-{pgsql, "Server", "Database", "Username", "Password"} +{acl, exampleorg, {server, "example.org"}}. +
{user_regexp, <regexp>}
Matches any local user with a name that + matches <regexp> at the first virtual host. Example: +
+{acl, tests, {user, "^test[0-9]*$"}}. +
{user_regexp, <regexp>, <server>}
Matches any user with a name + that matches <regexp> at server <server>. Example: +
+{acl, tests, {user, "^test", "example.org"}}. +
{server_regexp, <regexp>}
Matches any JID from the server that + matches <regexp>. Example: +
+{acl, icq, {server, "^icq\\."}}. +
{node_regexp, <user_regexp>, <server_regexp>}
Matches any user + with a name that matches <user_regexp> at any server that matches + <server_regexp>. Example: +
+{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. +
{user_glob, <glob>}
+
{user_glob, <glob>, <server>}
+
{server_glob, <glob>}
+
{node_glob, <user_glob>, <server_glob>}
This is the same as + above. However, it uses shell glob patterns instead of regexp. These patterns + can have the following special characters: +
+ *
matches any string including the null string. +
?
matches any single character. +
[...]
matches any of the enclosed characters. Character + ranges are specified by a pair of characters separated by a `-'. + If the first character after `[' is a `!', any + character not enclosed is matched. +
+
+The following ACLs are pre-defined: +
+all
Matches any JID. +
none
Matches no JID. +
+An entry allowing or denying access to different services looks similar to +this: +
+ {access, <accessname>, [{allow, <aclname>}, + {deny, <aclname>}, + ... + ]}. +
When a JID is checked to have access to <accessname>, 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 the value `deny' is +returned.
+
+Example: +
+ {access, configure, [{allow, admin}]}. + {access, something, [{deny, badmans}, + {allow, all}]}.
-pgsql is a keyword that should be kept as is. For example: +The following access rules are pre-defined: +
+all
Always returns the value `allow'. +
none
Always returns the value `deny'. +
+ + +
3.6  Shapers
+ + + +Shapers enable you to limit connection traffic. The syntax of +shapers is like this:
-{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}. + {shaper, <shapername>, <kind>}. +
Currently only one kind of shaper called maxrate is available. It has the +following syntax: +
+ {maxrate, <rate>} +
where <rate> stands for the maximum allowed incomig rate in bytes per +second.
+
+Examples: +
+To define a shaper named `normal' with traffic speed limited to +1,000 bytes/second: +
+ {shaper, normal, {maxrate, 1000}}. +
To define a shaper named `fast' with traffic speed limited to +50,000 bytes/second: +
+ {shaper, fast, {maxrate, 50000}}. +
+ + +
3.7  Limiting Opened Sessions
+ + + +This option specifies the maximum number of sessions (authenticated +connections) per user. If a user tries to open more sessions by using different +resources, the first opened session will be disconnected. The error +session replaced will be sent to the disconnected session. The value +for this option can be either a number, or infinity. The default +value is 10.
+
+Examples: +
+To limit the number of sessions per user to 10 on all virtual +hosts: +
+ {max\_user\_sessions, 10}. +
This option can be defined per virtual host (see +section 3.2). In next example the number of +sessions per user on the first host is six, while there is no limit on the +second host: +
+ {host_config, "example.net", [{max\_user\_sessions, 6}]}. + {host_config, "example.com", [{max\_user\_sessions, infinity}]}. +
+ + +
3.8  Default Language
+ + + +The option language defines the default language of server strings that +can be seen by Jabber clients. If a Jabber client do not support +xml:lang, the specified language is used. The default value is +en. In order to take effect there must be a translation file +<language>.msg in ejabberd's msgs directory.
+
+Examples: +
+To set Russian as default language: +
+ {language, "ru"}. +
To set Spanish as default language: +
+ {language, "es"}. +
+ + +
4  Database Configuration
+ + + + +ejabberd uses its internal Mnesia database by default. However, it is +possible to use a relational database or an LDAP server to store persistant, +long-living data. ejabberd is very flexible: you can configure different +authentication methods for different virtual hosts, you can configure different +authentication mechanisms for the same virtual host (fallback), you can set +different storage systems for modules, and so forth.
+
+The following databases are supported by ejabberd: +
+Microsoft SQL Server +
Mnesia +
MySQL +
Any ODBC compatible database +
PostgreSQL +
+The following LDAP servers are tested with ejabberd: +
+Active Directory + (see section 4.5.3) +
OpenLDAP +
Normally any LDAP compatible server should work; inform us about your + success with a not-listed server so that we can list it here. +
+ + +
4.1  MySQL
+ + + +Although this section will describe ejabberd's configuration when you want to +use the native MySQL driver, it does not describe MySQL's installation and +database creation. Check the MySQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. +Note that the tutorial contains information about ejabberd's configuration +which is duplicate to this section.
+
+Moreover, the file mysql.sql in the directory src/odbc might be interesting for +you. This file contains the ejabberd schema for MySQL. At the end of the file +you can find information to update your database schema.
+
+ + +
4.1.1  Driver Compilation
+ + + +You can skip this step if you installed ejabberd using a binary installer or +if the binary packages of ejabberd you are using include support for MySQL. +
+First, install the Erlang + MySQL library. Make sure the compiled files are in your Erlang path; you can + put them for example in the same directory as your ejabberd .beam files. +
Then, configure and install ejabberd with ODBC support enabled (this is + also needed for native MySQL support!). This can be done, by using next + commands: +
+./configure --enable-odbc && make install +
+ + +
4.1.2  Authentication
+ + + +The option value name may be misleading, as the auth_method name is used +for access to a relational database through ODBC, as well as through the native +MySQL interface. Anyway, the first configuration step is to define the odbc +auth_method. For example: +
+{host_config, "public.example.org", [{auth_method, [odbc]}]}.
-Note that you need to install the Erlang PgSQL library first. This library is -available from Sourceforge: http://cvs.sourceforge.net/viewcvs.py/jungerl/jungerl/lib/pgsql/
+The actual database access is defined in the option odbc_server. Its +value is used to define if we want to use ODBC, or one of the two native +interface available, PostgreSQL or MySQL.

-To use the native MySQL interface, the same tuple should be passed, except -that you now have to use the mysql keyword instead of the pgsql -keyword: +To use the native MySQL interface, you can pass a tuple of the following form as +parameter:
{mysql, "Server", "Database", "Username", "Password"}
@@ -1052,396 +1117,470 @@ keyword:
{odbc_server, {mysql, "localhost", "test", "root", "password"}}.
-Note that you need to install the Erlang MySQL library first. This library is -directly available from Process-one website: http://support.process-one.net/doc/display/CONTRIBS/Yxa
+ + +
4.1.3  Storage
+ + + +MySQL also can be used to store information into from several ejabberd +modules. See section 5.1 to see which modules have a version +with the `_odbc'. This suffix indicates that the module can be used with +relational databases like MySQL. To enable storage to your database, just make +sure that your database is running well (see previous sections), and replace the +suffix-less or ldap module variant with the odbc module variant. Keep in mind +that you cannot have several variants of the same module loaded!
+
+ + +
4.2  Microsoft SQL Server
+ + + +Although this section will describe ejabberd's configuration when you want to +use Microsoft SQL Server, it does not describe Microsoft SQL Server's +installation and database creation. Check the MySQL documentation and the +tutorial Using ejabberd with MySQL native driver for information regarding these topics. +Note that the tutorial contains information about ejabberd's configuration +which is duplicate to this section.

-A detailled tutorial to set-up ejabberd using the native MySQL interface is -available from: http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver
+Moreover, the file mssql.sql in the directory src/odbc might be interesting for +you. This file contains the ejabberd schema for Microsoft SQL Server. At the end +of the file you can find information to update your database schema.

- + -
3.2.3  Relational database for other modules
+
4.2.1  Driver Compilation
- -It is possible to use a relational database to store pieces of -information. You can do this by changing the module name to a name with an -_odbc suffix in ejabberd config file. You can use a relational -database for the following data: -
-Last connection date and time: Use mod_last_odbc instead of - mod_last. -
Offline messages: Use mod_offline_odbc instead of - mod_offline. -
Rosters: Use mod_roster_odbc instead of mod_roster. -
Users' VCARD: Use mod_vcard_odbc instead of mod_vcard. -
- + + +You can skip this step if you installed ejabberd using a binary installer or +if the binary packages of ejabberd you are using include support for ODBC.
+
+If you want to use Microsoft SQL Server with ODBC, you need to configure, +compile and install ejabberd with support for ODBC and Microsoft SQL Server +enabled. This can be done, by using next commands: +
+./configure --enable-odbc --enable-mssql && make install +
+ -
3.3  Creating an Initial Administrator
+
4.2.2  Authentication
- -Before the web interface can be entered to perform administration tasks, an -account with administrator rights is needed on your ejabberd deployment.
+ + +The configuration of Microsoft SQL Server is the same as the configuration of +ODBC compatible serers (see section 4.4.2).

-Instructions to create an initial administrator account: + + +
4.2.3  Storage
+ + + +Microsoft SQL Server also can be used to store information into from several +ejabberd modules. See section 5.1 to see which modules have +a version with the `_odbc'. This suffix indicates that the module can be used +with relational databases like Microsoft SQL Server. To enable storage to your +database, just make sure that your database is running well (see previous +sections), and replace the suffix-less or ldap module variant with the odbc +module variant. Keep in mind that you cannot have several variants of the same +module loaded!
+
+ + +
4.3  PostgreSQL
+ + + +Although this section will describe ejabberd's configuration when you want to +use the native PostgreSQL driver, it does not describe PostgreSQL's installation +and database creation. Check the PostgreSQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. +Note that the tutorial contains information about ejabberd's configuration +which is duplicate to this section.
+
+Also the file pg.sql in the directory src/odbc might be interesting for you. +This file contains the ejabberd schema for PostgreSQL. At the end of the file +you can find information to update your database schema.
+
+ + +
4.3.1  Driver Compilation
+ + + +You can skip this step if you installed ejabberd using a binary installer or +if the binary packages of ejabberd you are using include support for +PostgreSQL.
-Register an account on your ejabberd deployment. An account can be - created in two ways: -
- Using the tool ejabberdctl (see - section 3.4.2): -
-% ejabberdctl node@host register admin example.org password -
Using In-Band Registration (see section A.14): you can - use a Jabber client to register an account. -
-
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. +First, install the Erlang PgSQL library from + Jungerl. Make sure the compiled + files are in your Erlang path; you can put them for example in the same + directory as your ejabberd .beam files. +
Then, configure, compile and install ejabberd with ODBC support enabled + (this is also needed for native PostgreSQL support!). This can be done, by + using next commands:
- {acl, admins, {user, "admin", "example.org"}}. - {access, configure, [{allow, admins}]}. -
Restart ejabberd to load the new configuration. -
Open the web interface (http://server:port/admin/) in your - favourite browser. Make sure to enter the full JID as username (in this - example: admin@example.org. The reason that you also need to enter the - suffix, is because ejabberd's virtual hosting support. -
- +./configure --enable-odbc && make install + + -
3.4  Online Configuration and Monitoring
+
4.3.2  Authentication
- - + -
3.4.1  Web Interface
+The option value name may be misleading, as the auth_method name is used +for access to a relational database through ODBC, as well as through the native +PostgreSQL interface. Anyway, the first configuration step is to define the odbc +auth_method. For example: +
+{host_config, "public.example.org", [{auth_method, [odbc]}]}. +
+The actual database access is defined in the option odbc_server. Its +value is used to define if we want to use ODBC, or one of the two native +interface available, PostgreSQL or MySQL.
+
+To use the native PostgreSQL interface, you can pass a tuple of the following +form as parameter: +
+{pgsql, "Server", "Database", "Username", "Password"} +
+pgsql is a keyword that should be kept as is. For example: +
+{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}. +
+ - +
4.3.3  Storage
-To perform online configuration of ejabberd you need to enable the -ejabberd_http listener with the option web_admin (see -section 3.1.6). Then you can open -http://server:port/admin/ in your favourite web browser. You -will be asked to enter the username (the full Jabber ID) and password -of an ejabberd user with administrator rights. After authentication -you will see a page similar to figure 1. -
- - - + -
+PostgreSQL also can be used to store information into from several ejabberd +modules. See section 5.1 to see which modules have a version +with the `_odbc'. This suffix indicates that the module can be used with +relational databases like PostgreSQL. To enable storage to your database, just +make sure that your database is running well (see previous sections), and +replace the suffix-less or ldap module variant with the odbc module variant. +Keep in mind that you cannot have several variants of the same module loaded!

-
Figure 1: Top page from the web interface

+ + +
4.4  ODBC Compatible
+ + + +Although this section will describe ejabberd's configuration when you want to +use the ODBC driver, it does not describe the installation and database creation +of your database. Check the documentation of your database. The tutorial Using ejabberd with MySQL native driver also can help you. Note that the tutorial +contains information about ejabberd's configuration which is duplicate to +this section.

+ - -
-Here you can edit access restrictions, manage users, create backups, -manage the database, enable/disable ports listened for, view server -statistics,...
+
4.4.1  Compilation
+ + +You can skip this step if you installed ejabberd using a binary installer or +if the binary packages of ejabberd you are using include support for +ODBC. +
+First, install the Erlang + MySQL library. Make sure the compiled files are in your Erlang path; you can + put them for example in the same directory as your ejabberd .beam files. +
Then, configure, compile and install ejabberd with ODBC support + enabled. This can be done, by using next commands: +
+./configure --enable-odbc && make install +
+ + +
4.4.2  Authentication
+ + + +The first configuration step is to define the odbc auth_method. For +example: +
+{host_config, "public.example.org", [{auth_method, [odbc]}]}. +
+The actual database access is defined in the option odbc_server. Its +value is used to defined if we want to use ODBC, or one of the two native +interface available, PostgreSQL or MySQL.

-Examples: -
-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 http://example.org:5280/admin/ to - administer all virtual hosts or to - http://example.org:5280/admin/server/example.com/ to administer only - the virtual host example.com. 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 ejabberd. In this example you can enter as - username “admin@example.net” to administer all virtual hosts (first - URL). If you log in with “admin@example.com” on
-http://example.org:5280/admin/server/example.com/ you can only - administer the virtual host example.com. -
- ... - {acl, admins, {user, "admin", "example.net"}}. - {host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}. - {access, configure, [{allow, admins}]}. - ... - {hosts, ["example.org"]}. - ... - {listen, - [... - {5280, ejabberd_http, [http_poll, web_admin]}, - ... - ] - }. -
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 https://192.168.1.1:5280/admin/: -
- ... - {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"}]}, - ... - ] - }. -
- - -
3.4.2  ejabberdctl
- - -It is possible to do some administration operations using the command -line tool ejabberdctl. You can list all available options by -running ejabberdctl without arguments: +To use a relational database through ODBC, you can pass the ODBC connection +string as odbc_server parameter. For example:
-% 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 +{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.
-Additional information: -
-reopen-log
If you use a tool to rotate logs, you have to configure it - so that this command is executed after each rotation. -
backup, restore, install-fallback, dump, load
You can use these - commands to create and restore backups. -
import-file, import-dir
- These options can be used to migrate from other Jabber/XMPP servers. There - exist tutorials to migrate from jabberd 1.4 - and to migrate from jabberd2. -
delete-expired-messages
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. -
- - -
4  Firewall Settings
- - - -You need to take the following TCP ports in mind when configuring your firewall: -
-

-
Ejabberd 1.1.1 Installation and Operation Guide
+
Ejabberd 1.1.2 Installation and Operation Guide

Alexey Shchepin
mailto:alexey@sevcom.net
xmpp:aleksey@jabber.ru

- - - - - - - - - - - - - - - - - -
Port Description
5222 SASL and unencrypted c2s connections.
5223 Obsolete SSL c2s connections.
5269 s2s connections.
4369 Only for clustering (see 6).
port range Only for clustring (see 6). This range - is configurable (see 2.4).
-

Identification	Group ``club_members`'
Displayed groups	`club_members`

Port	Description
5222	SASL and unencrypted c2s connections.
5223	Obsolete SSL c2s connections.
5269	s2s connections.
4369	Only for clustering (see 6).
port range	Only for clustring (see 6). This range - is configurable (see 2.4).

Module	No
	configuration of ejabberd	configuration of `ejabberd`
`mod_last_odbc`	Last Activity (JEP-0012)	ODBC compatible	supported database (*)	No
		database, MySQL
		or PostgreSQL
`mod_muc`	Multi-User Chat (JEP-0045)
`mod_offline_odbc`	Offline message storage	ODBC compatible	supported database (*)	No
		database, MySQL
		or PostgreSQL
`mod_privacy`	Blocking Communication
`mod_roster`	Roster management		Yes (*)	Yes (**)
`mod_roster_odbc`	Roster management	ODBC compatible	Yes (*)
		database, MySQL
		or PostgreSQL		supported database (*)	Yes (**)
`mod_service_log`	Copy user messages to logger service
`mod_vcard_odbc`	vcard-temp (JEP-0054)	ODBC compatible	supported database (*)	No
		database, MySQL
		or PostgreSQL
`mod_version`	Software Version (JEP-0092)		No

Ejabberd 1.1.1 Installation and Operation Guide

Alexey Shchepin + +

Ejabberd 1.1.1 Installation and Operation Guide

Alexey Shchepin mailto:alexey@sevcom.net -xmpp:aleksey@jabber.ru

Contents

Table of Contents

1 Introduction

1 Introduction

1.1 Key Features

1.1 Key Features

1.2 Additional Features

1.2 Additional Features

2 Installation from Source

2 Installation from Source

2.1 Installation Requirements

2.1 Installation Requirements

2.1.1 “Unix-like” operating systems

2.1.1 ``Unix-like'' operating systems

2.1.2 Windows

2.1.2 Windows

2.2 Obtaining ejabberd

2.2 Obtaining ejabberd

2.3 Compilation

2.3 Compilation

2.3.1 “Unix-like” operating systems

2.3.1 ``Unix-like'' operating systems

2.3.2 Windows

2.3.2 Windows

2.4 Starting

2.4 Starting

3 Configuration

3 Configuration

3.1 Initial Configuration

3.1 Initial Configuration

3.1.1 Host Names

3.1.1 Host Names

3.1.2 Default Language

3.1.2 Default Language

3.1.3 Access Rules

3.1.3 Access Rules

3.1.4 Shapers

3.1.4 Shapers

3.1.5 Limitation of the number of opened sessions

3.1.5 Limitation of the number of opened sessions

3.1.6 Listened Sockets

3.1.7 Modules

3.1.7 Modules

3.1.8 Virtual Hosting

3.1.8 Virtual Hosting

3.1.9 SASL anonymous and anonymous login

3.1.9 SASL anonymous and anonymous login

3.2 Relational Database Support

3.2 Relational Database Support

3.2.1 Preliminary steps

3.2.1 Preliminary steps

3.2.2 Authentication against a relational database

3.2.2 Authentication against a relational database

3.2.3 Relational database for other modules

3.3 Creating an Initial Administrator

3.3 Creating an Initial Administrator

3.4 Online Configuration and Monitoring

3.4 Online Configuration and Monitoring

3.4.1 Web Interface

3.4.1 Web Interface

3.4.2 ejabberdctl

3.4.2 ejabberdctl

4 Firewall Settings

4 Firewall Settings

5 SRV Records

5 SRV Records

6 Clustering

6 Clustering

6.1 How it Works

6.1 How it Works

6.1.1 Router

6.1.1 Router

6.1.2 Local Router

6.1.2 Local Router

6.1.3 Session Manager

6.1.3 Session Manager

Alexey Shchepin
+ +

Alexey Shchepin
`mailto:alexey@sevcom.net`
-`xmpp:aleksey@jabber.ru`

2.2 Obtaining `ejabberd`

2.2 Obtaining `ejabberd`

3.4.2 `ejabberdctl`

3.4.2 `ejabberdctl`

A.2.1 `iqdisc`

A.2.1 `iqdisc`

A.2.2 `hosts`

A.2.2 `hosts`

A.3 `mod_announce`

A.3 `mod_announce`

A.4 `mod_disco`

A.4 `mod_disco`

A.5 `mod_echo`

A.5 `mod_echo`

A.6 `mod_irc`

A.6 `mod_irc`

A.7 `mod_last`

A.7 `mod_last`

A.8 `mod_muc`

A.8 `mod_muc`

A.9 `mod_muc_log`

A.9 `mod_muc_log`

A.10 `mod_offline`

A.10 `mod_offline`

A.11 `mod_privacy`

A.11 `mod_privacy`

A.12 `mod_private`

A.12 `mod_private`

A.13 `mod_pubsub`

A.13 `mod_pubsub`

A.14 `mod_register`

A.14 `mod_register`

A.15 `mod_roster`

A.15 `mod_roster`

A.16 `mod_service_log`

A.16 `mod_service_log`

A.17 `mod_shared_roster`

A.17 `mod_shared_roster`

A.18 `mod_stats`

A.18 `mod_stats`

A.19 `mod_time`

A.19 `mod_time`

A.20 `mod_vcard`

A.20 `mod_vcard`

A.21 LDAP and `mod_vcard_ldap`

A.21 `mod_version`

A.22 `mod_version`