Ejabberd 1.1.1 Installation and Operation Guide

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

I can thoroughly recommend ejabberd for ease of setup – Kevin Smith, Current maintainer of the Psi project

1 Introduction
- 1.1 Key Features
- 1.2 Additional Features
2 Installation from Source
3 Configuration
4 Firewall Settings
5 SRV Records
6 Clustering
- 6.1 How it Works
- 6.2 Clustering Setup
A Built-in Modules
B Internationalization and Localization
C Release Notes
D Acknowledgements

1 Introduction

ejabberd is a free (GPL) distributed fault-tolerant Jabber/XMPP server and is mainly written in Erlang.

ejabberd is designed to be a stable, standards compliant, and feature rich Jabber/XMPP server.

ejabberd is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.

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.
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.
- 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:
- Translated in 11 languages.
- Support for IDNA.
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.

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.
Security
- SASL and STARTTLS for c2s and s2s connections.
- STARTTLS and Dialback s2s connections.
- Web interface accessible via HTTPS secure access.
Databases
- Native MySQL support.
- Native PostgreSQL support.
- Mnesia.
- ODBC data storage support.
Authentication
- LDAP and ODBC.
- External Authentication script.
- Internal Authentication.
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.

2 Installation from Source

2.1 Installation Requirements

2.1.1 “Unix-like” operating systems

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).

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 (optional)
Shining Light OpenSSL (to enable SSL connections)
Zlib 1.2.3 or higher

2.2 Obtaining `ejabberd`

Released versions of ejabberd can be obtained from
http://www.process-one.net/en/projects/ejabberd/download.html.

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.1 “Unix-like” operating systems

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.

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 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 C:\Program Files\iconv-1.9.1.

Copy file C:\Program Files\iconv-1.9.1\bin\iconv.dll to your Windows system directory (more installation instructions can be found in the file README.woe32 in the iconv distribution).

Note: instead of copying libexpat.dll and iconv.dll to the Windows directory, you can add the directories 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:
```
configure.bat
nmake -f Makefile.win32
```
Edit the file ejabberd\src\ejabberd.cfg and run
```
werl -s ejabberd -name ejabberd
```

2.4 Starting

Execute the following command to start ejabberd:

  erl -pa /var/lib/ejabberd/ebin -name ejabberd -s 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 this node.

Note that when using the above command, ejabberd will search for the configuration file in the current directory and will use the current directory 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 \
      -ejabberd config \"/etc/ejabberd/ejabberd.cfg\" \
                log_path \"/var/log/ejabberd/ejabberd.log\" \
      -sasl sasl_error_logger \{file,\"/var/log/ejabberd/sasl.log\"\} \
      -mnesia dir \"/var/lib/ejabberd/spool\"

You can find other useful options in the Erlang manual page (erl -man erl).

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.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 configuration will be loaded from the database and any commands in the configuration file are appended to the entries in the database. The configuration file contains a sequence of Erlang terms. Lines beginning with a `%' 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 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.

With these lines the old global options, local options and ACLs will be removed before new ones are added.

3.1.1 Host Names

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 with:
```
  {host, "example.org"}.
```

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

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:

  {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”

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:
```
  {shaper, fast, {maxrate, 50000}}.
```

3.1.5 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.

Currently next modules are implemented:

ejabberd_c2s Description Handles c2s connections.

Options access, certfile, inet6, ip, max_stanza_size, shaper, ssl, tls, starttls, starttls_required, zlib

ejabberd_s2s_in Description Handles incoming s2s connections.

Options inet6, ip, max_stanza_size

ejabberd_service Description Interacts with external components (*).

Options access, hosts, inet6, ip, shaper

ejabberd_http Description Handles incoming HTTP connections.

Options 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 defines one or more hostnames of connected services and enables you to specify additional options including {password, Secret}.
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.

If HTTP Polling is enabled, it will be available at http://server:port/http-poll/. Be aware that support for HTTP Polling is also needed in the Jabber client. Remark also that HTTP Polling can be interesting to host a web-based Jabber client such as 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 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”.
{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 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 specifies that STARTTLS encryption is available on connections to the port. You should also set the certfile 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 the port will be encrypted using SSL immediately after connecting. You 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.
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.

Also the following global 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.
{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 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.
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”
The ICQ transport JIT (icq.example.org and sms.example.org) is connected to port 5234 with password “jitsecret”
The MSN transport msn.example.org is connected to port 5235 with password “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 Jabber Mail Component jmc.example.org is connected to port 5238 with password “jmcsecret”

  {acl, blocked, {user, "bad"}}.
  {access, c2s, [{deny, blocked},
                 {allow, all}]}.
  {shaper, normal, {maxrate, 1000}}.
  {access, c2s_shaper, [{none, admin},
                        {normal, all}]}.
  {listen,
   [{5222, ejabberd_c2s,     [{access, c2s}, {shaper, c2s_shaper}]},
    {5223, ejabberd_c2s,     [{access, c2s},
                              ssl, {certfile, "/path/to/ssl.pem"}]},
    {5269, ejabberd_s2s_in,  []},
    {5280, ejabberd_http,    [http_poll, web_admin]},
    {5233, ejabberd_service, [{host, "aim.example.org",
                               [{password, "aimsecret"}]}]},
    {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
                               [{password, "jitsecret"}]}]},
    {5235, ejabberd_service, [{host, "msn.example.org",
                               [{password, "msnsecret"}]}]},
    {5236, ejabberd_service, [{host, "yahoo.example.org",
                               [{password, "yahoosecret"}]}]},
    {5237, ejabberd_service, [{host, "gg.example.org",
                               [{password, "ggsecret"}]}]},
    {5238, ejabberd_service, [{host, "jmc.example.org",
                               [{password, "jmcsecret"}]}]}
   ]
  }.
  {s2s_use_starttls, true}.
  {s2s_certfile, "/path/to/ssl.pem"}.

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.
  -->

  <log id='logger'>
    <host/>
    <logtype/>
    <format>%d: [%t] (%h): %s</format>
    <file>/var/log/jabber/service.log</file>
  </log>

  <!--
     Some Jabber server implementations do not provide
     XDB services (for example, jabberd2 and ejabberd).
     xdb_file.so is loaded in to handle all XDB requests.
  -->

  <xdb id="xdb">
    <host/>
    <load>
      <!-- this is a lib of wpjabber or jabberd -->
      <xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file>
      </load>
    <xdb_file xmlns="jabber:config:xdb_file">
      <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
    </xdb_file>
  </xdb>

3.1.6 Modules

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:

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,   []}
   ]}.
```

3.1.7 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},
                              {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, ""}]}.

3.1.8 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.
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.

Those options are defined for each virtual host with the host_config parameter (see section 3.1.7).

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:

{host_config, "public.example.org", [{auth_method, [anonymous,internal]},
                                     {anonymous_protocol, login_anon}]}.

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:

{host_config, "public.example.org", [{auth_method, [anonymous]},
                                     {anonymous_protocol, both}]}.

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.2.1 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:

{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:

{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 available from Sourceforge: http://cvs.sourceforge.net/viewcvs.py/jungerl/jungerl/lib/pgsql/

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:

{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 directly available from Process-one website: http://support.process-one.net/doc/display/CONTRIBS/Yxa

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

3.2.2 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 mod_offline.
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

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:
1. Using the tool ejabberdctl (see section 3.4.2):
```
% ejabberdctl node@host register admin example.org password
```
2. 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.
```
  {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.

3.4 Online Configuration and Monitoring

3.4.1 Web Interface

To perform online configuration of ejabberd you need to enable the ejabberd_http listener with the option web_admin (see section 3.1.5). 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.

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 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:

% 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

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:

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).

5 SRV Records

General information: SRV record
Practical information: Setting DNS SRV Records

6 Clustering

6.1 How it Works

A Jabber domain is served by one or more ejabberd nodes. These nodes can be run on different machines that are connected via a network. They all must have the ability to connect to port 4369 of all another nodes, and must have the same magic cookie (see Erlang/OTP documentation, in other words the file ~ejabberd/.erlang.cookie must be the same on all nodes). This is 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.

6.1.1 Router

This module is the main router of Jabber packets on each node. It routes them based on their destination's domains. It uses a global routing table. The domain of the packet's destination is searched in the routing table, and if it is found, the packet is routed to the appropriate process. If not, it is sent to the s2s manager.

6.1.2 Local Router

This module routes packets which have a destination domain equal to one of this server's host names. If the destination JID has a non-empty user part, it is routed to the session manager, otherwise it is processed depending on its content.

6.1.3 Session Manager

This module routes packets to local users. It looks up to which user resource a packet must be sent via a presence table. Then the packet is either routed to the appropriate c2s process, or stored in offline storage, or bounced back.

6.1.4 s2s Manager

This module routes packets to other Jabber servers. First, it checks if an opened s2s connection from the domain of the packet's source to the domain of the packet's destination exists. If that is the case, the s2s manager routes the packet to the process serving this connection, otherwise a new connection is opened.

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.
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 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:
```
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.
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 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. Writing, on the other hand, will be slower. And of course if machine with one of the replicas is down, other replicas will be used.

Also section 5.3 (Table Fragmentation) of Mnesia User's Guide can be helpful.

(alt) Same as in previous item, but for other tables.
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 first, and mod_muc and mod_irc should be enabled only on one machine in the cluster).

You can repeat these steps for other machines supposed to serve this domain.

A Built-in Modules

A.1 Overview

The following table lists all modules available in the official ejabberd distribution. You can find more contributed modules on the ejabberd website. Please remember that these contributions might not work or that they can contain severe bugs and security leaks. Therefore, use them at your own risk!

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, a MySQL database, or a PostgreSQL database as backend.
Nothing, this means that the modules uses Erlang's built-in database Mnesia as backend.

Module Feature Dependencies Needed for XMPP?

mod_adhoc Ad-Hoc Commands (JEP-0050) No

mod_announce Manage announcements mod_adhoc No

mod_configure Support for online mod_adhoc No

configuration of ejabberd

mod_disco Service Discovery (JEP-0030) No

mod_echo Echoes Jabber packets No

mod_irc IRC transport No

mod_last Last Activity (JEP-0012) No

mod_last_odbc Last Activity (JEP-0012) ODBC compatible No

database, MySQL

or PostgreSQL

mod_muc Multi-User Chat (JEP-0045) No

mod_muc_log Multi-User Chat room logging mod_muc No

mod_offline Offline message storage No

mod_offline_odbc Offline message storage ODBC compatible No

database, MySQL

or PostgreSQL

mod_privacy Blocking Communication Yes

mod_private Private XML Storage (JEP-0049) No

mod_pubsub Publish-Subscribe (JEP-0060) No

mod_register In-Band Registration (JEP-0077) No

mod_roster Roster management Yes (*)

mod_roster_odbc Roster management ODBC compatible Yes (*)

database, MySQL

or PostgreSQL

mod_service_log Copy user messages to logger service No

mod_shared_roster Shared roster management mod_roster or No

mod_roster_odbc

mod_stats Statistics Gathering (JEP-0039) No

mod_time Entity Time (JEP-0090) No

mod_vcard vcard-temp (JEP-0054) No

mod_vcard_ldap vcard-temp (JEP-0054) LDAP server No

mod_vcard_odbc vcard-temp (JEP-0054) ODBC compatible No

database, MySQL

or PostgreSQL

mod_version Software Version (JEP-0092) No

(*) This module or a similar one with another database backend is needed for XMPP compliancy.

A.2 Common Options

The following options are used by many modules. Therefore, they are described in this separate section.

A.2.1 `iqdisc`

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 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 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 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,
   [
    ...
    {mod_time, [{iqdisc, no_queue}]},
    ...
   ]}.

A.2.2 `hosts`

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 with:

  {modules,
   [
    ...
    {mod_echo, [{host, "echo.example.org"}]},
    ...
   ]}.

Serving the echo module on two domains:

  {modules,
   [
    ...
    {mod_echo, [{hosts, ["echo.example.net", "echo.example.com"]}]},
    ...
   ]}.

A.3 `mod_announce`

This module enables configured users to broadcast announcements and to set the message of the day (MOTD). Configured users can do these actions with their Jabber client by sending messages to specific JIDs. These JIDs are listed in next paragraph. The first JID in each entry will apply only to the virtual host example.org, while the JID between brackets will apply to all virtual hosts:

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 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 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): 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): Any message sent to this JID removes the existing message of the day (MOTD).

Options:

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,
   [
    ...
    {mod_announce, [{access, announce}]},
    ...
   ]}.

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"}}.
  ...
  {access, announce, [{allow, admins},
                      {allow, direction}]}.
  ...
  {modules,
   [
    ...
    {mod_announce, [{access, announce}]},
    ...
   ]}.

A.4 `mod_disco`

This module adds support for Service Discovery (JEP-0030). With this module enabled, services on your server can be discovered by Jabber clients. Note that ejabberd has no modules with support for the superseded Jabber Browsing (JEP-0011) and Agent Information (JEP-0094). Accordingly, Jabber clients need to have support for the newer Service Discovery protocol if you want them be able to discover the services you offer.

Options:

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 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:

  {modules,
   [
    ...
    {mod_disco, [{extra_domains, ["icq.example.com",
                                  "msn.example.com"]}]},
    ...
   ]}.

To serve a link to a few friendly servers:

  {modules,
   [
    ...
    {mod_disco, [{extra_domains, ["example.org",
                                  "example.com"]}]},
    ...
   ]}.

A.5 `mod_echo`

This module simply echoes any Jabber 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 service (see section A.2.2). If neither hosts nor 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, you can find a few more examples in section A.2.2.

A.6 `mod_irc`

This module is an IRC transport that can be used to join channels on IRC servers.

End user information:

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 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 to the IRC transport instead of the Multi-User Chat service.
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”
to nickserver!irc.example.org@irc.jabberserver.org.
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 service (see section A.2.2). If neither hosts nor the old host is present, the prefix “irc.” is added to all ejabberd hostnames.
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 able to use the transport.
```
  {modules,
   [
    ...
    {mod_irc, [{access, all}]},
    ...
   ]}.
```

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"}}.
  ...
  {access, paying_customers, [{allow, paying_customers},
                              {deny, all}]}.
  ...
  {modules,
   [
    ...
    {mod_irc, [{access, paying_customers},
               {hosts, ["irc.example.net", "irc-transport.example.com"]}]},
    ...
   ]}.

A.7 `mod_last`

This module adds support for Last Activity (JEP-0012). It can be used to discover when a disconnected user last accessed the server, to know when a connected user was last active on the server, or to query the uptime of the ejabberd server.

Options:

iqdisc: This specifies the processing discipline for Last activity (jabber:iq:last) IQ queries (see section A.2.1).

A.8 `mod_muc`

With this module enabled, your server will support Multi-User Chat (JEP-0045). End users will be able to join text conferences. Notice 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.

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 “conference.” is added to all ejabberd hostnames.
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 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 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.

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 to new hardware. This will involve service breakdowns around 23:00 UMT. We apologise for this inconvenience.” to conference.example.org, it will be displayed in all active rooms.
```
  {acl, admins, {user, "admin", "example.org"}}.
  ...
  {access, muc_admins, [{allow, admins}]}.
  ...
  {modules,
   [
    ...
    {mod_muc, [{access, all},
               {access_create, all},
               {access_admin, muc_admins}]},
    ...
   ]}.
```

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 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, it will be displayed in all active rooms.

  {acl, paying_customers, {user, "customer1", "example.net"}}.
  {acl, paying_customers, {user, "customer2", "example.com"}}.
  {acl, paying_customers, {user, "customer3", "example.org"}}.
  {acl, admins, {user, "admin", "example.org"}}.
  ...
  {access, muc_admins, [{allow, admins},
                        {deny, all}]}.
  {access, muc_access, [{allow, paying_customers},
                        {allow, admins},
                        {deny, all}]}.
  ...
  {modules,
   [
    ...
    {mod_muc, [{access, muc_access},
               {access_create, muc_admins},
               {access_admin, muc_admins}]},
    ...
   ]}.

A.9 `mod_muc_log`

This module enables optional logging of Multi-User Chat conversations to HTML. Once you enable this module, join a chatroom with enought privileges using a MUC capable Jabber client, 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.

Options:

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: 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: 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: 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: 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: Customizable link on top right corner. Syntax of this option: {"URL", "Text"}. Default: {"/", "Home"}.

Example configuration:

  {modules,
   [
    ...
    {mod_muc_log, [
               {access_log, muc},
               {cssfile, "http://example.com/my.css"},
               {dirtype, plain},
               {outdir, "/var/www/muclogs"},
               {timezone, universal},
               {top_link, {"http://www.jabber.ru", "Jabber.ru"}}
    ]},
    ...
   ]}.

A.10 `mod_offline`

This module implements offline message storage. This means that all messages sent to an offline user will be stored on the server until that user comes online again. Thus it is very similar to how email works. Note that ejabberdctl has a command to delete expired messages (see section 3.4.2).

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 is active by default).
Allowing or blocking messages based on JID, group, or subscription type (or globally).
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, or subscription type (or globally).
Allowing or blocking IQ stanzas based on JID, group, or subscription type (or globally).
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 the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section A.2.1).

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 the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section A.2.1).

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.

Another example is J-EAI. This is an XMPP-based Enterprise Application Integration (EAI) platform (also 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 service (see section A.2.2). If neither hosts nor the old host is present, the prefix “pubsub.” is added to all ejabberd hostnames.
served_hosts: To specify which hosts needs to be served, you can use this option. If absent, only the main ejabberd host is served.

Example:

  {modules,
   [
    ...
    {mod_pubsub, [{served_hosts, ["example.com",
                                  "example.org"]}]}
    ...
   ]}.

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.

Options:

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 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:

  {acl, shortname, {user_glob, "?"}}.
  {acl, shortname, {user_glob, "??"}}.
  {acl, strangename, {user_regexp, "^..?$"}}.
  ...
  {access, register, [{deny, shortname},
                      {deny, strangename},
                      {allow, all}]}.
  ...
  {modules,
   [
    ...
    {mod_register, [{access, register}]},
    ...
   ]}.

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,
   [
    ...
%    {mod_register, [{access, register}]},
    ...
   ]}.
```

A.15 `mod_roster`

This module implements roster management as defined in RFC 3921: XMPP IM.

Options:

iqdisc: This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section A.2.1).

A.16 `mod_service_log`

This module adds support for logging end user packets via a Jabber message auditing service such as Bandersnatch. All user packets are encapsulated in a <route/> element and sent to the specified service(s).

Options:

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 bandersnatch.example.com and the backup service on bandersnatch.example.org:

  {modules,
   [
    ...
    {mod_service_log, [{loggers, ["bandersnatch.example.com",
                                  "bandersnatch.example.org"]}]},
    ...
   ]}.

A.17 `mod_shared_roster`

This module enables you to create shared roster groups. This means that you can create groups of people that can see members from (other) groups in their rosters. The big advantages of this feature are that end users do not need to manually add all users to their rosters, and that they cannot permanently delete users from the shared roster groups.

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 anything.
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 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:

Identification Group `club_members'

Name Club Members

Description Members from the computer club

Members

member1@example.org

member2@example.org

member3@example.org

Displayed groups club_members

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:

Identification Group `management' Group `marketing' Group `sales'

Name Management Marketing Sales

Description

Members

manager1@example.org

manager2@example.org

manager3@example.org

manager4@example.org

marketeer1@example.org

marketeer2@example.org

marketeer3@example.org

marketeer4@example.org

saleswoman1@example.org

salesman1@example.org

saleswoman2@example.org

salesman2@example.org

Displayed groups

management

marketing

sales

management

marketing

management

sales

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).

Options:

iqdisc: This specifies the processing discipline for Statistics Gathering (http://jabber.org/protocol/stats) IQ queries (see section A.2.1).

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 by sending:

<iq to='example.org' type='get'>
  <query xmlns='http://jabber.org/protocol/stats'>
    <stat name='users/all-hosts/total'/>
  </query>
</iq>

A.19 `mod_time`

This module features support for Entity Time (JEP-0090). By using this JEP, you are able to discover the time at another entity's location.

Options:

iqdisc: This specifies the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section A.2.1).

A.20 `mod_vcard`

This module allows end users to store and retrieve their vCard, and to retrieve other users vCards, as defined in vcard-temp (JEP-0054). The module also implements an uncomplicated Jabber User Directory based on the vCards of these users. Moreover, it enables the server to send its vCard when queried.

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.
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 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 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,
   [
    ...
    {mod_vcard, [{search, true},
                 {matches, 20},
                 {allow_return_all, true},
                 {search_all_hosts, false}]},
    ...
   ]}.
```

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,
   [
    ...
    {mod_vcard, [{search, true},
                 {matches, infinity},
                 {allow_return_all, true}]},
    ...
   ]}.

A.21 `mod_version`

This module implements Software Version (JEP-0092). Consequently, it answers ejabberd's version when queried.

Options:

iqdisc: This specifies the processing discipline for Software Version (jabber:iq:version) IQ queries (see section A.2.1).

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'
      xml:lang='ru'>
    <query xmlns='http://jabber.org/protocol/disco#items'/>
  </iq>

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”

C Release Notes

C.1 ejabberd 0.9

       Release notes
        ejabberd 0.9

    This document describes the major new features of and changes to
    ejabberd 0.9, compared to latest public release ejabber 0.7.5.

    For more detailed information, please refer to ejabberd User
    Guide.


Virtual Hosting

    ejabberd now can host several domain on the same instance.
    This option is enabled by using:

      {hosts, ["erlang-projects.org", "erlang-fr.org"]}.

    instead of the previous host directive.

    Note that you are now using a list of hosts. The main one should
    be the first listed. See migration section further in this release
    note for details.
      

Shared Roster

    Shared roster is a new feature that allow the ejabberd
    administrator to add jabber user that will be present in the
    roster of every users on the server.
    Shared roster are enabled by adding:

            {mod_shared_roster, []}

    at the end of your module list in your ejabberd.cfg file.


PostgreSQL (ODBC) support

    This feature is experimental and not yet properly documented. This
    feature is released for testing purpose.

    You need to have Erlang/OTP R10 to compile with ODBC on various
    flavour of *nix. You should use Erlang/OTP R10B-4, as this task
    has became easier with this release. It comes already build in
    Erlang/OTP Microsoft Windows binary.

    PostgreSQL support is enabled by using the following module in
    ejabberd.cfg instead of their standard counterpart:

     mod_last_odbc.erl
     mod_offline_odbc.erl
     mod_roster_odbc.erl

    The database schema is located in the src/odbc/pq.sql file.

    Look at the src/ejabberd.cfg.example file for more information on
    how to configure ejabberd with odbc support. You can get support
    on how to configure ejabberd with a relational database.


Migration from ejabberd 0.7.5

    Migration is pretty straightforward as Mnesia database schema
    conversions is handled automatically. Remember however that you
    must backup your ejabberd database before migration.

    Here are the following steps to proceed:

    1. Stop your instance of ejabberd.

    2. In ejabberd.cfg, define the host lists. Change the host
    directive to the hosts one:
    Before:
      {host, "erlang-projects.org"}.
    After:
      {hosts, ["erlang-projects.org", "erlang-fr.org"]}.
    Note that when you restart the server the existing users will be
    affected to the first virtual host, so the order is important. You
    should keep the previous hostname as the first virtual host.

    3. Restart ejabberd.


Bugfixes

    This release contains several bugfixes and architectural changes.
    Please refer to the Changelog file supplied with this release for
    details of all improvements in the ejabberd code.

C.2 ejabberd 0.9.1

       Release notes
       ejabberd 0.9.1

   This document describes the main changes from [25]ejabberd 0.9.

   The code can be downloaded from the [26]download page.

   For more detailed information, please refer to ejabberd [27]User Guide.


Groupchat (Multi-user chat and IRC) improvements

   The multi-user chat code has been improved to comply with the latest version
   of Jabber Enhancement Proposal 0045.

   The IRC (Internet Relay Chat) features now support WHOIS and USERINFO
   requests.


Web interface

   ejabberd modules management features have been added to the web interface.
   They now allow to start or stop extension module without restarting the
   ejabberd server.


Publish and subscribe

   It is now possible to a subscribe node with a JabberID that includes a
   resource.


Translations

   A new script has been included to help translate ejabberd into new languages
   and maintain existing translations.

   As a result, ejabberd is now translating into 10 languages:
     * Dutch
     * English
     * French
     * German
     * Polish
     * Portuguese
     * Russian
     * Spanish
     * Swedish
     * Ukrainian


Migration

   No changes have been made to the database. No particular conversion steps
   are needed. However, you should backup your database before upgrading to a
   new ejabberd version.


Bugfixes

   This release contains several bugfixes and architectural changes. Please
   refer to the Changelog file supplied with this release for details of all
   improvements in the ejabberd code.

C.3 ejabberd 0.9.8

       Release notes
       ejabberd 0.9.8
         2005-08-01

   This document describes the main changes in ejabberd 0.9.8. This
   version prepares the way for the release of ejabberd 1.0, which 
   is due later this year.

   The code can be downloaded from the Process-one website:
   http://www.process-one.net/en/projects/ejabberd/

   For more detailed information, please refer to ejabberd User Guide
   on the Process-one website:
   http://www.process-one.net/en/projects/ejabberd/docs.html


   Recent changes include....


Enhanced virtual hosting

   Virtual hosting applies to many more setting options and
   features and is transparent. Virtual hosting accepts different
   parameters for different virtual hosts regarding the following
   features: authentication method, access control lists and access
   rules, users management, statistics, and shared roster. The web
   interface gives access to each virtual host's parameters.


Enhanced Publish-Subscribe module

   ejabberd's Publish-Subscribe module integrates enhancements
   coming from J-EAI, an XMPP-based integration server built on
   ejabberd. ejabberd thus supports Publish-Subscribe node
   configuration. It is possible to define nodes that should be
   persistent, and the number of items to persist. Besides that, it
   is also possible to define various notification parameters, such
   as the delivery of the payload with the notifications, and the
   notification of subscribers when some changes occur on items.
   Other examples are: the maximum size of the items payload, the
   subscription approvers, the limitation of the notification to
   online users only, etc.


Code reorganisation and update

   - The mod_register module has been cleaned up.
   - ODBC support has been updated and several bugs have been fixed.


Development API

   To ease the work of Jabber/XMPP developers, a filter_packet hook
   has been added. As a result it is possible to develop plugins to
   filter or modify packets flowing through ejabberd.


Translations

   - Translations have been updated to support the new Publish-Subscribe features.
   - A new Brazilian Portuguese translation has been contributed.


Web interface

   - The CSS stylesheet from the web interface is W3C compliant.


Installers

   Installers are provided for Microsoft Windows and Linux/x86. The
   Linux installer includes Erlang ASN.1 modules for LDAP
   authentication support.


Bugfixes

   - This release contains several bugfixes and architectural
     changes. Among other bugfixes include improvements in LDAP
     authentication. Please refer to the ChangeLog file supplied 
     with this release regarding all improvements in ejabberd.


References

   The ejabberd feature sheet helps comparing with other Jabber/XMPP 
   servers:
   http://www.process-one.net/en/projects/ejabberd/docs/features.pdf

   Contributed tutorials of interest are:
   - Migration from Jabberd1.4 to ejabberd:
     http://ejabberd.jabber.ru/jabberd1-to-ejabberd
   - Migration from Jabberd2 to ejabberd:
     http://ejabberd.jabber.ru/jabberd2-to-ejabberd
   - Transport configuration for connecting to other networks:
     http://ejabberd.jabber.ru/tutorials-transports

END

C.4 ejabberd 1.0.0

       Release Notes
       ejabberd 1.0.0
       14 December 2005

   This document describes the main changes in ejabberd 1.0.0. Unique in this
   version is the compliancy with the XMPP (eXtensible Messaging and Presence
   Protocol) standard. ejabberd is the first Open Source Jabber server claiming
   to fully comply to the XMPP standard.

   ejabberd can be downloaded from the Process-one website:
   http://www.process-one.net/en/projects/ejabberd/

   Detailed information can be found in the ejabberd Feature Sheet and User
   Guide which are available on the Process-one website:
   http://www.process-one.net/en/projects/ejabberd/docs.html


   Recent changes include:


Server-to-server Encryption for Enhanced Security

  - Support for STARTTLS and SASL EXTERNAL to secure server-to-server traffic
    has been added.
  - Also, STARTTLS and Dialback has been implemented for server-to-server (s2s)
    connections. Detailed information about these new features can be found on
    http://ejabberd.jabber.ru/s2s-encryption
  - commonName and dNSName fields matching were introduced to ease the process
    of retrieving certificates.
  - Different certificates can be defined for each virtual host.

ODBC Support

  - ODBC support has been improved to allow production use of ejabberd with
    relational databases.
  - Support for vCard storage in ODBC has been added.
  - ejd2odbc.erl is a tool to convert an installation from Erlang's database
    Mnesia to an ODBC compatible relational database.

Native PostgreSQL Support

  - Native PostgreSQL support gives you a better performance when you use
    PostgreSQL.

Shared Roster groups

  - Shared Roster groups support has been enhanced. New is the ability to add
    all registered users to everyone's roster. Detailed information about this
    new feature can be found on http://ejabberd.jabber.ru/shared-roster-all

Web Interface

   - The web interface internal code has been modified for better integration
     and compliancy with J-EAI, an ejabberd-based Enterprise Application
     Integration platform.
   - More XHTML 1.0 Transitional compliancy work was done.

Transports

   - A transport workaround can be enabled during compilation. To do this, you
     can pass the "--enable-roster-gateway-workaround" option to the configure
     script. (./configure --enable-roster-gateway-workaround)
     This option allows transports to add items with subscription "to" in the
     roster by sending <presence type='subscribed'/> stanza to user. This option
     is only needed for JIT ICQ transport.
     Warning: by enabling this option, ejabberd will not be fully XMPP compliant
              anymore.

Documentation and Internationalization

   - Documentation has been extended to cover more topics.
   - Translations have been updated.

Bugfixes

   - This release contains several bugfixes.
   - Among other bugfixes include improvements to the client-to-server (c2s)
     connection management module.
   - Please refer to the ChangeLog file supplied
     with this release regarding all improvements in ejabberd.


   Installation Notes


Supported Erlang Version

   - You need at least Erlang/OTP R9C to run ejabberd 1.0.0.

Installation

   Installers are provided for Microsoft Windows and Linux/x86.
   Installers can be retrieved from:
   http://www.process-one.net/en/projects/ejabberd/download.html

Migration Notes

   - Before any migration, ejabberd system and database must be properly
     backed up.
   - When upgrading an ODBC-based installation, you will need to change the
     relational database schema. The following SQL commands must be run on the
     database:
       CREATE SEQUENCE spool_seq_seq;
       ALTER TABLE spool ADD COLUMN seq integer;
       ALTER TABLE spool ALTER COLUMN seq SET DEFAULT nextval('spool_seq_seq');
       UPDATE spool SET seq = DEFAULT;
       ALTER TABLE spool ALTER COLUMN seq SET NOT NULL;

References

   Contributed tutorials of interest are:
   - Migration from Jabberd1.4 to ejabberd:
     http://ejabberd.jabber.ru/jabberd1-to-ejabberd
   - Migration from Jabberd2 to ejabberd:
     http://ejabberd.jabber.ru/jabberd2-to-ejabberd
   - Transport configuration for connecting to other networks:
     http://ejabberd.jabber.ru/tutorials-transports

END

C.5 ejabberd 1.1.0

Release Notes
ejabberd 1.1.0
24 April 2006

This document describes the main changes in ejabberd 1.1.0. This version
introduce new features including support for new Jabber Enhancement
Proposals and several performance improvements enabling deployments on an
even larger scale than already possible.

ejabberd can be downloaded from the Process-one website:
http://www.process-one.net/en/projects/ejabberd/

Detailed information can be found in the ejabberd Feature Sheet and User
Guide which are available on the Process-one website:
http://www.process-one.net/en/projects/ejabberd/docs.html

A complete list of changes is available from:
http://support.process-one.net/secure/ReleaseNote.jspa?projectId=10011&styleName=Html&version=10025

Recent changes include:

New Jabber Enhancement Proposal support:

- JEP-0050: Ad-Hoc Commands.
- JEP-0138: Stream Compression.
- JEP-0175: SASL anonymous.

Anonymous login

- SASL anonymous.
- Anonymous login for clients that do not yet support SASL Anonymous.

Relational database Support

- MySQL is now fully supported through ODBC and in native mode.
- Various improvements to the native database interfaces.
- The migration tool can use relational databases.

Multi-User Chat improvements

- Logging of room discussion to text file is now supported.
- Better reconfiguration support.
- Security oriented fixes.
- Several improvements and updates to latest JEP-0045.

Performance scalability improvements for large clusters

- Improved session synchronisation management between cluster nodes.
- Internal architecture has been reworked to use generalize Erlang/OTP
framework usage.
- Speed improvement on logger.
- TCP/IP packet reception change for better network throttling and
regulation.
As a result, these improvements will reduce load on large scale deployments.

XMPP Protocol related improvements

- XML stanza size can be limited.
- Messages are send to all resources with the same highest priority.

Documentation and Internationalization

- Documentation has been extended to cover more topics.
- Translations have been updated.

Web interface

- XHTML 1.0 compliance.

Bugfixes

- This release contains many bugfixes on various areas such as Publish-Subscribe, build
chain, installers, IRC gateway, ejabberdctl, amongst others.
- Please refer to the ChangeLog file supplied with this release regarding
all improvements in ejabberd.

Installation Notes

Supported Erlang Version

- You need at least Erlang/OTP R9C-2 to run ejabberd 1.1.0.

Installation

Installers are provided for Microsoft Windows, Linux/x86 and MacOSX/PPC.
Installers can be retrieved from:
http://www.process-one.net/en/projects/ejabberd/download.html

Migration Notes

- Before any migration, ejabberd system and database must be properly
backed up.
- The database schema has not been changed comparing to version 1.0.0 and
consequently it does not require any migration.

References

Contributed tutorials and documents of interest are:
- Migration from Jabberd1.4, Jabberd2 and WPJabber to ejabberd:
http://ejabberd.jabber.ru/migrate-to-ejabberd
- Transport configuration for connecting to other networks:
http://ejabberd.jabber.ru/tutorials-transports
- Using ejabberd with MySQL native driver:
http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver
- Anonymous User Support:
http://support.process-one.net/doc/display/MESSENGER/Anonymous+users+support
- Frequently Asked Questions:
http://ejabberd.jabber.ru/faq

END

C.6 ejabberd 1.1.1

Release Notes
ejabberd 1.1.1
28 April 2006

This document describes the main changes in ejabberd 1.1.x. This version
introduce new features including support for new Jabber Enhancement
Proposals and several performance improvements enabling deployments on an
even larger scale than already possible.

This release fix a security issue introduced in ejabberd 1.1.0. In SASL
mode, anonymous login was enabled as a default. Upgrading ejabberd 1.1.0 to
ejabberd 1.1.1 is highly recommanded.

ejabberd can be downloaded from the Process-one website:
http://www.process-one.net/en/projects/ejabberd/

Detailed information can be found in the ejabberd Feature Sheet and User
Guide which are available on the Process-one website:
http://www.process-one.net/en/projects/ejabberd/docs.html

A complete list of changes is available from:
http://support.process-one.net/secure/ReleaseNote.jspa?projectId=10011&styleName=Html&version=10025

Recent changes include:

New Jabber Enhancement Proposal support:

- JEP-0050: Ad-Hoc Commands.
- JEP-0138: Stream Compression.
- JEP-0175: SASL anonymous.

Anonymous login

- SASL anonymous.
- Anonymous login for clients that do not yet support SASL Anonymous.

Relational database Support

- MySQL is now fully supported through ODBC and in native mode.
- Various improvements to the native database interfaces.
- The migration tool can use relational databases.

Multi-User Chat improvements

- Logging of room discussion to text file is now supported.
- Better reconfiguration support.
- Security oriented fixes.
- Several improvements and updates to latest JEP-0045.

Performance scalability improvements for large clusters

XMPP Protocol related improvements

- XML stanza size can be limited.
- Messages are send to all resources with the same highest priority.

Documentation and Internationalization

- Documentation has been extended to cover more topics.
- Translations have been updated.

Web interface

- XHTML 1.0 compliance.

Bugfixes

Installation Notes

Supported Erlang Version

- You need at least Erlang/OTP R9C-2 to run ejabberd 1.1.0.

Installation

Installers are provided for Microsoft Windows, Linux/x86 and MacOSX/PPC.
Installers can be retrieved from:
http://www.process-one.net/en/projects/ejabberd/download.html

Migration Notes

References

END

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)

This document was translated from L^AT_EX by H^EV^EA.

`ejabberd_c2s`	Description	Handles c2s connections.
	Options	`access`, `certfile`, `inet6`, `ip`, `max_stanza_size`, `shaper`, `ssl`, `tls`, `starttls`, `starttls_required`, `zlib`
`ejabberd_s2s_in`	Description	Handles incoming s2s connections.
	Options	`inet6`, `ip`, `max_stanza_size`
`ejabberd_service`	Description	Interacts with external components (*).
	Options	`access`, `hosts`, `inet6`, `ip`, `shaper`
`ejabberd_http`	Description	Handles incoming HTTP connections.
	Options	`certfile`, `http_poll`, `inet6`, `ip`, `tls`, `web_admin`

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	Feature	Dependencies	Needed for XMPP?
`mod_adhoc`	Ad-Hoc Commands (JEP-0050)		No
`mod_announce`	Manage announcements	`mod_adhoc`	No
`mod_configure`	Support for online	`mod_adhoc`	No
	configuration of ejabberd
`mod_disco`	Service Discovery (JEP-0030)		No
`mod_echo`	Echoes Jabber packets		No
`mod_irc`	IRC transport		No
`mod_last`	Last Activity (JEP-0012)		No
`mod_last_odbc`	Last Activity (JEP-0012)	ODBC compatible	No
		database, MySQL
		or PostgreSQL
`mod_muc`	Multi-User Chat (JEP-0045)		No
`mod_muc_log`	Multi-User Chat room logging	`mod_muc`	No
`mod_offline`	Offline message storage		No
`mod_offline_odbc`	Offline message storage	ODBC compatible	No
		database, MySQL
		or PostgreSQL
`mod_privacy`	Blocking Communication		Yes
`mod_private`	Private XML Storage (JEP-0049)		No
`mod_pubsub`	Publish-Subscribe (JEP-0060)		No
`mod_register`	In-Band Registration (JEP-0077)		No
`mod_roster`	Roster management		Yes (*)
`mod_roster_odbc`	Roster management	ODBC compatible	Yes (*)
		database, MySQL
		or PostgreSQL
`mod_service_log`	Copy user messages to logger service		No
`mod_shared_roster`	Shared roster management	`mod_roster` or	No
		`mod_roster_odbc`
`mod_stats`	Statistics Gathering (JEP-0039)		No
`mod_time`	Entity Time (JEP-0090)		No
`mod_vcard`	vcard-temp (JEP-0054)		No
`mod_vcard_ldap`	vcard-temp (JEP-0054)	LDAP server	No
`mod_vcard_odbc`	vcard-temp (JEP-0054)	ODBC compatible	No
		database, MySQL
		or PostgreSQL
`mod_version`	Software Version (JEP-0092)		No

Ejabberd 1.1.1 Installation and Operation Guide

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

Contents

1 Introduction

1.1 Key Features

1.2 Additional Features

2 Installation from Source

2.1 Installation Requirements

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.4 Starting

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 Listened Sockets

3.1.6 Modules

3.1.7 Virtual Hosting

3.1.8 SASL anonymous and anonymous login

3.2 Relational Database Support

3.2.1 Authentication against a relational database

3.2.2 Relational database for other modules

3.3 Creating an Initial Administrator

3.4 Online Configuration and Monitoring

3.4.1 Web Interface

3.4.2 ejabberdctl

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.2 Clustering Setup

A Built-in Modules

A.1 Overview

A.2 Common Options

A.2.1 iqdisc

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 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

D Acknowledgements

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

2.2 Obtaining `ejabberd`

3.4.2 `ejabberdctl`

A.2.1 `iqdisc`

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 `mod_version`