ejabberd - Distributed fault-tolerant Jabber/XMPP server

ejabberd [options] [--] [erlang_options]

ejabberd is a distributed fault-tolerant Jabber/XMPP server written in Erlang.

main features are:

- Distributed: ejabberd can run on a cluster of machines

- Fault-tolerance: All the information can be stored on more than one node, nodes can be added or replaced 'on the fly'

- Built-in Multi-User Chat service

- Built-in IRC transport

- Built-in Publish-Subscribe service

- Built-in Jabber User Directory service based on users vCards

- SSL support

- Mostly XMPP-compliant

- Support for JEP-0030 (Service Discovery)

- Support for JEP-0039 (Statistics Gathering)

- Support for xml:lang

--config config-file

Specifies an alternate config-file to be parsed at startup, rather than the default (/etc/ejabberd/ejabberd.cfg).

--spool spool-dir

Specifies an alternate spool-dir to store user database instead of the default (/var/lib/ejabberd).

--log log-file

Log Jabber events to specified log-file rather than to the default (/var/log/ejabberd/ejabberd.log).

--sasl-log sasl-log-file

Log SASL (System Application Support Libraries) events to specified sasl-log-file rather than to the default (/var/log/ejabberd/sasl.log).

erlang_options

Other options (and all options following --) are passed directly to Erlang interpreter. See Erlang documentation for more details on interpreter options. Some useful options are:

-detached Starts the Erlang system detached from the system console.

-heart Starts heart beat monitoring of the Erlang system.

-noinput Ensures that the Erlang system never tries to read any input.

The file /etc/ejabberd/ejabberd.cfg contains the main configuration. It is initially loaded the first time ejabberd is executed, then it is parsed and stored in a database. Subsiquently the configuration is loaded from the database and any commands in the configuration file are appended to the entries in the database. The configuration file consists of a sequence of Erlang terms. Parts of lines after `%' sign are ignored. Each term is a tuple, where the first element is the name of an option, and the others are option values. E. g. if this file does not contain a "host" definition, then the value stored in the database will be used.

To override old values stored in the database the following lines can be added in config:

override_global.

override_local.

override_acls.

A complete explanation of each configuration value can be found in the official ejabberd documentation. See "SEE ALSO" part of this manual page for more information about the documentation.

The file /etc/default/ejabberd contains specific options.

ERL_OPTIONS

With this option, parameters can be passed to Erlang interpretor. See Erlang documentation for more details on interpreter options.

ERL_MAX_PORTS

To use more than 1024 connections (default value), ERL_MAX_PORTS should be set to the number of connections needed.

ERL_FULLSWEEP_AFTER

To reduce memory usage when allowing a large number of connections, ERL_FULLSWEEP_AFTER may be set to 0 by uncommenting the corresponding line into the options file, but in this case ejabberd may start to work slower.

/etc/ejabberd/ejabberd.cfg

default configuration file

/etc/default/ejabberd

default variables

erl(1), sasl(6), ejabberdctl(8).

The program documentation is available at http://www.process-one.net/en/projects/ejabberd/. A copy of the documentation can be found at /usr/share/doc/ejabberd/html/guide.html.

This manual page was adapted by Christophe Romain <cro@tuxfamily.org> and Sergei Golovan <sgolovan@nes.ru> for the Debian system (but may be used by others) from the ejabberd documentation written by Alexey Shchepin <alexey@sevcom.net>.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.