From 12ab036236d626420ae57d3aa75f60af7950bfa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= Date: Thu, 28 Jun 2007 09:16:21 +0000 Subject: * doc/guide.tex: Documentation rework started (EJAB-272) * doc/introduction.tex: Likewise SVN Revision: 803 --- doc/dev.html | 466 +++--- doc/features.html | 211 ++- doc/guide.html | 4334 ++++++++++++++++++++------------------------------ doc/guide.tex | 282 ++-- doc/introduction.tex | 20 +- doc/version.tex | 2 +- 6 files changed, 2170 insertions(+), 3145 deletions(-) (limited to 'doc') diff --git a/doc/dev.html b/doc/dev.html index 327b52cf1..2539d6686 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -1,15 +1,23 @@ - +Ejabberd 2.0.0beta1 Developers Guide + -Ejabberd 1.1.2 Developers Guide - - - + + - - - - - - - -
-
- - - - -

Ejabberd 1.1.2 Developers Guide

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

-
-

- -

- + +

-
-
+

Ejabberd 2.0.0beta1 Developers 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

- +

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

+1 Key Features +
2 Additional Features +
3 How it Works
- -1 Introduction +3.1 Router +
- 3.2 Local Router +
- 3.3 Session Manager +
- 3.4 S2S Manager +
+
4 XML Representation +
5 Module xml +
6 Module xml_stream +
7 Modules
- -1.1 Key Features -
- 1.2 Additional Features -
-
2 How it Works -
- -2.1 Router -
- 2.2 Local Router -
- 2.3 Session Manager -
- 2.4 S2S Manager -
-
3 XML Representation -
4 Module xml -
5 Module xml_stream -
6 Modules -
- -6.1 Module gen_iq_handler -
- 6.2 Services -
-

- - - -

1 Introduction

- - - -ejabberd is a free and open source instant messaging server written in Erlang.
-
-ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
-
-ejabberd is designed to be a rock-solid and feature rich XMPP server.
-
-ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.
-
- - -

1.1 Key Features

- +7.1 Module gen_iq_handler +

7.2 Services +

Introduction +

ejabberd is a free and open source instant messaging server written in Erlang.

ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

ejabberd is designed to be a rock-solid and feature rich XMPP server.

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

1 Key Features

- -ejabberd is: -

-Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
-
-
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
-
-
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
-
-
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: +
ejabberd is: +
- +Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
- Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
- Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
- 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: +
- 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 12 languages. -
- Support for IDNA. -
-
-
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +
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 protocols supported. -

- - -

1.2 Additional Features

- +

XML-based protocol. +

Many protocols supported. +

2 Additional Features

- -Moreover, ejabberd comes with a wide range of other state-of-the-art features: -

+
Moreover, ejabberd comes with a wide range of other state-of-the-art features: +
- Modular
  - Load only the modules you want. -
  - Extend ejabberd with your own custom modules. -
  -
- Security +
- 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 +
STARTTLS and Dialback s2s connections. +
Web interface accessible via HTTPS secure access. +

Databases

Native MySQL support. -
Native PostgreSQL support. -
Mnesia. -
ODBC data storage support. -
Microsoft SQL Server support. -

Authentication +

Native PostgreSQL support. +

Mnesia. +

ODBC data storage support. +

Microsoft SQL Server support. +

Authentication

LDAP and ODBC. -
External Authentication script. -
Internal Authentication. -

Others +

External Authentication script. +

Internal Authentication. +

Others

Compressing XML streams with Stream Compression (XEP-0138). -
Interface with networks such as AIM, ICQ and MSN. -
Statistics via Statistics Gathering (XEP-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 How it Works

- - -A Jabber domain is served by one or more ejabberd nodes. These nodes can +

Interface with networks such as AIM, ICQ and MSN. +

Statistics via Statistics Gathering (XEP-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. +

+ +

3 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 have following modules: -

+connections, registered services, etc…
Each ejabberd node have following modules: +
- router; -
- local router. -
- session manager; -
- S2S manager; -
- - -
2.1 Router
- -This module is the main router of Jabber packets on each node. It routes +
local router. +
session manager; +
S2S manager; +

3.1 Router

This module is the main router of Jabber packets on each node. It routes them based on their destinations domains. It has two tables: local and global routes. First, domain of packet destination searched in local table, and if it found, then the packet is routed to appropriate process. If no, then it searches in global table, and is routed to the appropriate ejabberd node or process. If it does not exists in either tables, then it sent to the S2S -manager.
-
- - -

2.2 Local Router

- -This module routes packets which have a destination domain equal to this server +manager.

3.2 Local Router

This module routes packets which have a destination domain equal to this server name. If destination JID has a non-empty user part, then it routed to the -session manager, else it is processed depending on it's content.
-
- - -

2.3 Session Manager

- -This module routes packets to local users. It searches for what user resource +session manager, else it is processed depending on it's content.

3.3 Session Manager

This module routes packets to local users. It searches for what user resource packet must be sended via presence table. If this resource is connected to this node, it is routed to C2S process, if it connected via another node, then -the packet is sent to session manager on that node.
-
- - -

2.4 S2S Manager

- -This module routes packets to other Jabber servers. First, it checks if an +the packet is sent to session manager on that node.

3.4 S2S Manager

This module routes packets to other Jabber servers. First, it checks if an open S2S connection from the domain of the packet source to the domain of packet destination already exists. If it is open on another node, then it routes the packet to S2S manager on that node, if it is open on this node, then it is routed to the process that serves this connection, and if a connection -does not exist, then it is opened and registered.
-
- - -

3 XML Representation

- - -Each XML stanza is represented as the following tuple: -

-XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
+does not exist, then it is opened and registered.

+4  XML Representation

+
Each XML stanza is represented as the following tuple:
+
XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
         Name = string()
         Attrs = [Attr]
         Attr = {Key, Val}
@@ -251,45 +189,30 @@ XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
         Val = string()
         ElementOrCDATA = XMLElement | CDATA
         CDATA = {xmlcdata, string()}
-E. g. this stanza:
--<message to='test@conference.example.org' type='groupchat'>
+
E. g. this stanza:
+
<message to='test@conference.example.org' type='groupchat'>
   <body>test</body>
 </message>
-is represented as the following structure:
--{xmlelement, "message",
+
is represented as the following structure:
+
{xmlelement, "message",
     [{"to", "test@conference.example.org"},
      {"type", "groupchat"}],
     [{xmlelement, "body",
          [],
          [{xmlcdata, "test"}]}]}}
-
-
-
-4  Module xml

-
-
-
element_to_string(El) -> string()
--El = XMLElement
-
Returns string representation of XML stanza El.

-

-
crypt(S) -> string()
--S = string()
+

+5  Module xml

+

+
element_to_string(El) -> string()
+El = XMLElement
+
Returns string representation of XML stanza El.
crypt(S) -> string()
+S = string()
 
Returns string which correspond to S with encoded XML special
- characters.

-

-
remove_cdata(ECList) -> EList
--ECList = [ElementOrCDATA]
+characters.
remove_cdata(ECList) -> EList
+ECList = [ElementOrCDATA]
 EList = [XMLElement]
-
EList is a list of all non-CDATA elements of ECList.

-

-
get_path_s(El, Path) -> Res
--El = XMLElement
+
EList is a list of all non-CDATA elements of ECList.
get_path_s(El, Path) -> Res
+El = XMLElement
 Path = [PathItem]
 PathItem = PathElem | PathAttr | PathCDATA
 PathElem = {elem, Name}
@@ -298,74 +221,56 @@ PathCDATA = cdata
 Name = string()
 Res = string() | XMLElement
 
If Path is empty, then returns El. Else sequentially
- consider elements of Path. Each element is one of:
- 
{elem, Name} Name is name of subelement of
- El, if such element exists, then this element considered in
- following steps, else returns empty string.
- 
{attr, Name} If El have attribute Name, then
- returns value of this attribute, else returns empty string.
- 
cdata Returns CDATA of El.
- 


-

-
TODO:
--         get_cdata/1, get_tag_cdata/1
+consider elements of Path. Each element is one of:
+
+
{elem, Name} Name is name of subelement of
+El, if such element exists, then this element considered in
+following steps, else returns empty string.
+
{attr, Name} If El have attribute Name, then
+returns value of this attribute, else returns empty string.
+
cdata Returns CDATA of El.
+
TODO:
+         get_cdata/1, get_tag_cdata/1
          get_attr/2, get_attr_s/2
          get_tag_attr/2, get_tag_attr_s/2
          get_subtag/2
-
-
-
-5  Module xml_stream

-
-
-
parse_element(Str) -> XMLElement | {error, Err}
--Str = string()
+

+6  Module xml_stream

+

+
parse_element(Str) -> XMLElement | {error, Err}
+Str = string()
 Err = term()
 
Parses Str using XML parser, returns either parsed element or error
- tuple.
-
-
-
-6  Modules

-
-
-
-
-6.1  Module gen_iq_handler

-
-
-The module gen_iq_handler allows to easily write handlers for IQ packets
-of particular XML namespaces that addressed to server or to users bare JIDs.

-

-In this module the following functions are defined:
-
add_iq_handler(Component, Host, NS, Module, Function, Type)
--Component = Module = Function = atom()
+tuple.
+

+7  Modules

+

+7.1  Module gen_iq_handler

+
The module gen_iq_handler allows to easily write handlers for IQ packets
+of particular XML namespaces that addressed to server or to users bare JIDs.
In this module the following functions are defined:
+

+
add_iq_handler(Component, Host, NS, Module, Function, Type)
+Component = Module = Function = atom()
 Host = NS = string()
 Type = no_queue | one_queue | parallel
 
Registers function Module:Function as handler for IQ packets on
- virtual host Host that contain child of namespace NS in
- Component. Queueing discipline is Type. There are at least
- two components defined:
- 
ejabberd_local Handles packets that addressed to server JID;
- 
ejabberd_sm Handles packets that addressed to users bare JIDs.
- 
-
remove_iq_handler(Component, Host, NS)
--Component = atom()
+virtual host Host that contain child of namespace NS in
+Component. Queueing discipline is Type. There are at least
+two components defined:
+
+
ejabberd_local Handles packets that addressed to server JID;
+
ejabberd_sm Handles packets that addressed to users bare JIDs.
+
+
remove_iq_handler(Component, Host, NS)
+Component = atom()
 Host = NS = string()
 
Removes IQ handler on virtual host Host for namespace NS from
- Component.
-
-Handler function must have the following type:
-
Module:Function(From, To, IQ)
--From = To = jid()
-
---module(mod_cputime).
+Component.
+
Handler function must have the following type:
+

+
Module:Function(From, To, IQ)
+From = To = jid()
+
-module(mod_cputime).
 
 -behaviour(gen_mod).
 
@@ -399,14 +304,9 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) ->
                [{"xmlns", ?NS_CPUTIME}],
                [{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]}
     end.
-
-
-
-6.2  Services

-
-
---module(mod_echo).
+

+7.2  Services

+
-module(mod_echo).
 
 -behaviour(gen_mod).
 
@@ -440,10 +340,10 @@ stop(Host) ->
     Proc = gen_mod:get_module_proc(Host, ?PROCNAME),
     Proc ! stop,
     {wait, Proc}.
-
+

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

+H^EV^EA. diff --git a/doc/features.html b/doc/features.html index 80cec3be3..d64fd8b69 100644 --- a/doc/features.html +++ b/doc/features.html @@ -1,15 +1,23 @@ - +Ejabberd 2.0.0beta1 Feature Sheet + -Ejabberd 1.1.2 Feature Sheet - - - + + - - - - - - - -
-
- - - - -

Ejabberd 1.1.2 Feature Sheet

Sander Devrieze
-`mailto:s.devrieze@pandora.be`
-`xmpp:sander@devrieze.dyndns.org`

-
-

- -

- - -
-
+ +

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

- +

Ejabberd 2.0.0beta1 Feature Sheet

Sander Devrieze
+ `mailto:s.devrieze@pandora.be`
+ `xmpp:sander@devrieze.dyndns.org`

Introduction

- -

I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. — -Joeri

-ejabberd is a free and open source instant messaging server written in Erlang.
-
-ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
-
-ejabberd is designed to be a rock-solid and feature rich XMPP server.
-
-ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.
-
- - -

Key Features

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

Introduction +

I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. — +Joeri

ejabberd is a free and open source instant messaging server written in Erlang.

ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

ejabberd is designed to be a rock-solid and feature rich XMPP server.

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

Key Features

- -

Erlang seems to be tailor-made for writing stable, robust servers. — -Peter Saint-André, Executive Director of the Jabber Software Foundation

-ejabberd is: -

-Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
-
-
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
-
-
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
-
-
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: +
Erlang seems to be tailor-made for writing stable, robust servers. — +Peter Saint-André, Executive Director of the Jabber Software Foundation
ejabberd is: +
- +Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
- Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
- Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
- 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.improved -
  - Web interface for administration tasks. -
  - Shared Roster Groups. -
  - Command line administration tool.improved -
  - 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: +
- Straightforward installers for Linux, Mac OS X, and Windows.
  improved
  +
- Web interface for administration tasks. +
- Shared Roster Groups. +
- Command line administration tool.
  improved
  +
- 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 12 languages.improved -
- Support for IDNA. -
-
-
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +Translated in 12 languages.
improved
+
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 protocols supported. -

- - -

Additional Features

- +

XML-based protocol. +

Many protocols supported. +

Additional Features

- -

ejabberd is making inroads to solving the "buggy incomplete server" problem — -Justin Karneges, Founder of the Psi and the Delta projects

-Moreover, ejabberd comes with a wide range of other state-of-the-art features: -

+
ejabberd is making inroads to solving the "buggy incomplete server" problem — +Justin Karneges, Founder of the Psi and the Delta projects
Moreover, ejabberd comes with a wide range of other state-of-the-art features: +
- Modular
  - Load only the modules you want. -
  - Extend ejabberd with your own custom modules. -
  -
- Security +
- 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 +
STARTTLS and Dialback s2s connections. +
Web interface accessible via HTTPS secure access. +

Databases

Native MySQL support. -
Native PostgreSQL support. -
Mnesia. -
ODBC data storage support. -
Microsoft SQL Server support.new -

Authentication +

Native PostgreSQL support. +

Mnesia. +

ODBC data storage support. +

Microsoft SQL Server support.

new

Authentication

-LDAP and ODBC.improved -
External Authentication script. -
Internal Authentication. -

Others +LDAP and ODBC.

improved

External Authentication script. +

Internal Authentication. +

Others

Compressing XML streams with Stream Compression (XEP-0138). -
Interface with networks such as AIM, ICQ and MSN. -
Statistics via Statistics Gathering (XEP-0039). -
IPv6 support both for c2s and s2s connections. -
Multi-User Chat module with logging.improved -
Users Directory based on users vCards. -
Publish-Subscribe component. -
Support for virtual hosting. -
HTTP Polling service. -
IRC transport. -

- +

Interface with networks such as AIM, ICQ and MSN. +

Statistics via Statistics Gathering (XEP-0039). +

IPv6 support both for c2s and s2s connections. +

Multi-User Chat module with logging.

improved

Users Directory based on users vCards. +

Publish-Subscribe component. +

Support for virtual hosting. +

HTTP Polling service. +

IRC transport. +

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

+H^EV^EA. diff --git a/doc/guide.html b/doc/guide.html index 54784fda1..6eae82257 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1,15 +1,54 @@ - + + + + + & ejabberd 2.0.0 beta 1 + & + & Installation and Operation Guide + + + + + + & + + + + + + + + + + + + + + + + + + -<TITLE>Ejabberd 1.1.2 Installation and Operation Guide + - - + + - - - - - - + +

+

-
- - - -
-
Ejabberd 1.1.2 Installation and Operation Guide
-
ejabberd development Team

+ + + +
ejabberd 2.0.0 beta 1

Installation and Operation Guide

-
- - - -
+
+

+ +

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

-
-
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 -
- -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 Basic Configuration +
+
ejabberd Development Team

+Chapter 1 Introduction
- -3.1 Host Names -
- 3.2 Virtual Hosting -
- 3.3 Listened Sockets -
- 3.4 Authentication +1.1 Key Features +
- 1.2 Additional Features +
+
Chapter 2 Installing ejabberd
- -3.4.1 Internal -
- 3.4.2 SASL Anonymous and Anonymous Login -
-
3.5 Access Rules +2.1 Installing ejabberd with Graphical Installer +
2.2 Installation from Source
-
3.6 Shapers -
3.7 Default Language -

4 Advanced configuration +2.2.1 Installation Requirements +

2.2.2 Obtaining ejabberd +

2.2.3 Compilation +

2.2.4 Starting +

2.3 Creating an Initial Administrator +

Chapter 3 Configuring ejabberd

-4.1 Components Load-Balancing -
4.2 Domain Load-Balancing Algorithm -
4.3 Load-Balancing Buckets -

5 Database and LDAP Configuration +3.1 Basic Configuration

-5.1 MySQL +3.1.1 Host Names +
3.1.2 Virtual Hosting +
3.1.3 Listened Sockets +
3.1.4 Authentication +
3.1.5 Access Rules +
3.1.6 Shapers +
3.1.7 Default Language +

3.2 Database and LDAP Configuration

-5.1.1 Driver Compilation -
5.1.2 Authentication -
5.1.3 Storage -

5.2 Microsoft SQL Server +3.2.1 MySQL +

3.2.2 Microsoft SQL Server +

3.2.3 PostgreSQL +

3.2.4 ODBC Compatible +

3.2.5 LDAP +

3.3 Modules Configuration

-5.2.1 Driver Compilation -
5.2.2 Authentication -
5.2.3 Storage -

5.3 PostgreSQL +3.3.1 Overview +

3.3.2 Common Options +

3.3.3 mod_announce +

3.3.9 mod_muc_log +

3.3.10 mod_offline +

3.3.11 mod_privacy +

3.3.12 mod_private +

3.3.13 mod_proxy65 +

3.3.14 mod_pubsub +

3.3.15 mod_register +

3.3.16 mod_roster +

3.3.17 mod_service_log +

3.3.18 mod_shared_roster +

3.3.19 mod_stats +

3.3.20 mod_time +

3.3.21 mod_vcard +

3.3.22 mod_vcard_ldap +

3.3.23 mod_version +

+ +

Chapter 4 Managing an ejabberd server

-5.3.1 Driver Compilation -
5.3.2 Authentication -
5.3.3 Storage -

5.4 ODBC Compatible +4.1 Online Configuration and Monitoring

-5.4.1 Compilation -
5.4.2 Authentication -
5.4.3 Storage -

5.5 LDAP +4.1.1 Web Interface +

4.1.2 ejabberdctl +

+ +

Chapter 5 Securing ejabberd

-5.5.1 Connection -
5.5.2 Authentication -
5.5.3 Examples -

- -

6 Modules Configuration +5.1 Firewall Settings +

Chapter 6 Integrating ejabberd with other Instant Messaging servers

-6.1 Overview -
6.2 Common Options +6.1 SRV Records +

Chapter 7 Clustering

-6.2.1 iqdisc -
6.2.2 hosts -

6.3 mod_announce -

6.4 mod_disco -

6.5 mod_echo -

6.6 mod_irc -

6.7 mod_last -

6.8 mod_muc -

6.15 mod_register -

6.16 mod_roster -

6.17 mod_service_log -

6.18 mod_shared_roster -

6.19 mod_stats -

6.20 mod_time -

6.21 mod_vcard -

6.22 mod_vcard_ldap -

6.23 mod_version - -

7 Creating an Initial Administrator -

8 Online Configuration and Monitoring +7.1 How it Works

-8.1 Web Interface -
8.2 ejabberdctl -

9 Firewall Settings -

10 SRV Records -

11 Clustering +7.1.1 Router +

7.1.2 Local Router +

7.1.3 Session Manager +

7.1.4 s2s Manager +

7.2 Clustering Setup +

7.3 Service Load-Balancing

-11.1 How it Works +7.3.1 Components Load-Balancing +
7.3.2 Domain Load-Balancing Algorithm +
7.3.3 Load-Balancing Buckets +

Chapter 8 Debugging

-11.1.1 Router -
11.1.2 Local Router -
11.1.3 Session Manager -
11.1.4 s2s Manager -

11.2 Clustering Setup - -

A Internationalization and Localization -

B Release Notes +8.1 Watchdog alerts +

Appendix A Internationalization and Localization +

Appendix B Release Notes

-B.1 ejabberd 0.9 -
B.2 ejabberd 0.9.1 -
B.3 ejabberd 0.9.8 -
B.4 ejabberd 1.0.0 -
B.5 ejabberd 1.1.0 -
B.6 ejabberd 1.1.1 -
B.7 ejabberd 1.1.2 -

C Acknowledgements -

D Copyright Information - - - - -

1 Introduction

1.1 Key Features

- +B.1 ejabberd 0.9 +

Appendix C Acknowledgements +

Appendix D Copyright Information +

Chapter 1 Introduction

ejabberd is a free and open source instant messaging server written in Erlang.

ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

ejabberd is designed to be a rock-solid and feature rich XMPP server.

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

1.1 Key Features

- -ejabberd is: -

-Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
-
-
Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
-
-
Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
-
-
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: +
ejabberd is: +
- +Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
- Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
- Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.
- 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.improved -
  - Web interface for administration tasks. -
  - Shared Roster Groups. -
  - Command line administration tool.improved -
  - 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: +
- 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 12 languages.improved -
- Support for IDNA. -
-
-
Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +Translated in 12 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 protocols supported. -

- - -

1.2 Additional Features

- +

XML-based protocol. +

Many protocols supported. +

1.2 Additional Features

- -Moreover, ejabberd comes with a wide range of other state-of-the-art features: -

+
Moreover, ejabberd comes with a wide range of other state-of-the-art features: +
- Modular
  - Load only the modules you want. -
  - Extend ejabberd with your own custom modules. -
  -
- Security +
- 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 +
STARTTLS and Dialback s2s connections. +
Web interface accessible via HTTPS secure access. +

Databases

Native MySQL support. -
Native PostgreSQL support. -
Mnesia. -
ODBC data storage support. -
Microsoft SQL Server support.new -

Authentication +

Native PostgreSQL support. +

Mnesia. +

ODBC data storage support. +

Microsoft SQL Server support.

Authentication

-LDAP and ODBC.improved -
External Authentication script. -
Internal Authentication. -

Others +LDAP and ODBC.

External Authentication script. +

Internal Authentication. +

Others

Compressing XML streams with Stream Compression (XEP-0138). -
Interface with networks such as AIM, ICQ and MSN. -
Statistics via Statistics Gathering (XEP-0039). -
IPv6 support both for c2s and s2s connections. -
Multi-User Chat module with logging.improved -
Users Directory based on users vCards. -
Publish-Subscribe component. -
Support for virtual hosting. -
HTTP Polling service. -
IRC transport. -

- - - -

2 Installation from Source

- +

Interface with networks such as AIM, ICQ and MSN. +

Statistics via Statistics Gathering (XEP-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. +

+ +

Chapter 2 Installing ejabberd

2.1 Installing ejabberd with Graphical Installer

The easiest approach to install an ejabberd Instant Messaging server +is to use the graphical installer. The installer is available from +Process-one +website.

The installer will deploy and configure a full featured ejabberd +server and does not require any extra dependancies.

2.2 Installation from Source

- - - -

2.1 Installation Requirements

- +

2.2.1 Installation Requirements

- - - -

2.1.1 `Unix-like' operating systems

- - -To compile ejabberd on a `Unix-like' operating system, you need: -

+
+
`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 on systems with GNU libc) -
- - -
2.1.2 Windows
- - -To compile ejabberd on a Windows flavour, you need: -
- +
- GCC +
- libexpat 1.95 or higher +
- Erlang/OTP R9C-2 or higher +
- OpenSSL 0.9.6 or higher (optional) +
- Zlib 1.2.3 or higher (optional) +
- GNU Iconv 1.8 or higher (optional, not needed on systems with GNU libc) +
+
Windows
+
To compile ejabberd on a Windows flavour, you need: +
- MS Visual C++ 6.0 Compiler -
- Erlang/OTP R9C-2 or higher -
- Expat 1.95.7 or higher -
- GNU Iconv 1.9.1 +
- Erlang/OTP R9C-2 or higher +
- Expat 1.95.7 or higher +
- GNU Iconv 1.9.1 (optional) -
- Shining Light OpenSSL +
- Shining Light OpenSSL (to enable SSL connections) -
- Zlib 1.2.3 or higher -
- - -
2.2 Obtaining ejabberd
- - - -Released versions of ejabberd can be obtained from
-http://www.process-one.net/en/projects/ejabberd/download.html.
-
- +
Zlib 1.2.3 or higher +

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

- +

  svn co http://svn.process-one.net/ejabberd/trunk ejabberd
+

2.2.3 Compilation

- - - -

2.3.1 `Unix-like' operating systems

- - -Compile ejabberd on a `Unix-like' operating system by executing: -

- ./configure +

`Unix-like' operating systems

Compile ejabberd on a `Unix-like' operating system by executing:

  ./configure
   make
   su
   make install
-

-These commands will: -

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

-Note: if you want to use an external database, you need to execute the configure -script with the option(s) –enable-odbc or –enable-odbc -–enable-mssql. See section 5 for more information.
-
- - -

2.3.2 Windows

- - -

+
install the configuration file into /etc/ejabberd, +
create a directory called /var/log/ejabberd to store log files. +

Note: if you want to use an external database, you need to execute the configure +script with the option(s) –enable-odbc or –enable-odbc +–enable-mssql. See section 3.2 for more information.

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

- +

Edit the file ejabberd\src\ejabberd.cfg and run +

werl -s ejabberd -name ejabberd
+

2.2.4 Starting

- -Execute the following command to start ejabberd: -

-  erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd
-

or -

-  erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
-

In the latter case the Erlang node will be identified using only the first part -of the host name, i. e. other Erlang nodes outside this domain cannot contact -this node.
-
-Note that when using the above command, ejabberd will search for the +

Execute the following command to start ejabberd: +

  erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd
+

or +

  erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
+

In the latter case the Erlang node will be identified using only the first part +of the host name, i. e. other Erlang nodes outside this domain cannot 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 +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 \ +

  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 +

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 +

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

- +

  export ERL_FULLSWEEP_AFTER=0
+

But in this case ejabberd can start to work slower.

2.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 4.1.2): +
```
% ejabberdctl node@host register admin example.org password
+
```
2. Using In-Band Registration (see section 3.3.15): 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. +

Chapter 3 Configuring ejabberd

3.1 Basic Configuration

- -The configuration file will be loaded the first time you start ejabberd. The +

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 @@ -475,58 +436,38 @@ 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 +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_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 Host Names

- +

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

+
The option hosts defines a list containing one or more domains that +ejabberd will serve.
Examples: +
- Serving one domain: -
```
-  {hosts, ["example.org"]}.
-
```
- Serving one domain, and backwards compatible with older ejabberd - versions: -
```
-  {host, "example.org"}.
-
```
- Serving two domains: -
```
-  {hosts, ["example.net", "example.com"]}.
-
```
- - -
3.2 Virtual Hosting
- +
```
  {hosts, ["example.org"]}.
+
```
Serving one domain, and backwards compatible with older ejabberd +versions: +
```
  {host, "example.org"}.
+
```

Serving two domains: +

  {hosts, ["example.net", "example.com"]}.
+

3.1.2 Virtual Hosting

- -Options can be defined separately for every virtual host using the +

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

  {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}]}.
+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"]},
@@ -534,11 +475,10 @@ Domain example.net is using the internal authentication method while
                               {ldap_rootdn, "dc=localdomain"},
                               {ldap_rootdn, "dc=example,dc=com"},
                               {ldap_password, ""}]}.
-
Domain example.net is using ODBC to perform authentication
- while domain example.com is using the LDAP servers running on the domains
- localhost and otherhost:
--{host_config, "example.net", [{auth_method, odbc},
+
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},
@@ -547,172 +487,134 @@ Domain example.net is using the internal authentication method while
                               {ldap_rootdn, "dc=localdomain"},
                               {ldap_rootdn, "dc=example,dc=com"},
                               {ldap_password, ""}]}.
-

- - -

3.3 Listened Sockets

- +

3.1.3 Listened Sockets

- -The option listen defines for which addresses and ports ejabberd +

The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a tuple with the following elements: -

+
- Port number. -
- Module that serves this port. -
- Options to this module. -
- +
Module that serves this port. +
Options to this module. +

Currently next modules are implemented: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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 (XEP-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 (XEP-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 maximum size in bytes of XML stanzas. - Approximate, because it is calculated with the precision of one block of - readed data. For example {max_stanza_size, 65536}. The default - value is infinity. -
{shaper, <access rule>}: This option defines a - shaper for the port (see section 3.6). The default value - is none. -
ssl: This option specifies that traffic on - the port will be encrypted using SSL. You should also set the - certfile option. It is recommended to use the tls option - 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 XEP-0138) - is available on connections to the port. Client connections cannot use - stream compression and stream encryption simultaneously. Hence, if you - specify both tls (or ssl) and zlib, the latter - option will not affect connections (there will be no stream compression). -
web_admin: This option - enables the web interface for ejabberd administration which is available - at http://server:port/admin/. Login and password are the username and - password of one of the registered users who are granted access by the - `configure' access rule. -

-In addition, the following options are available for s2s connections: -

- {s2s_use_starttls, true|false}: - This option defines whether to - use STARTTLS for s2s connections. -
{s2s_certfile, Path}: Path to a - file containing a SSL certificate. -
{domain_certfile, Domain, Path}: Path - to the file containing the SSL certificate for the specified domain. -

-For instance, the following configuration defines that: -

+ + + + + + + + + +
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 (XEP-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 (XEP-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 maximum size in bytes of XML stanzas. +Approximate, because it is calculated with the precision of one block of +readed data. For example {max_stanza_size, 65536}. The default +value is infinity. +
{shaper, <access rule>}: This option defines a +shaper for the port (see section 3.1.6). The default value +is none. +
ssl: This option specifies that traffic on +the port will be encrypted using SSL. You should also set the +certfile option. It is recommended to use the tls option +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 XEP-0138) +is available on connections to the port. Client connections cannot use +stream compression and stream encryption simultaneously. Hence, if you +specify both tls (or ssl) and zlib, the latter +option will not affect connections (there will be no stream compression). +
web_admin: This option +enables the web interface for ejabberd administration which is available +at http://server:port/admin/. Login and password are the username and +password of one of the registered users who are granted access by the +`configure' access rule. +

In addition, the following options are available for s2s connections: +

+{s2s_use_starttls, true|false}: +This option defines whether to +use STARTTLS for s2s connections. +
{s2s_certfile, Path}: Path to a +file containing a SSL certificate. +
{domain_certfile, Domain, Path}: Path +to the file containing the SSL certificate for the specified domain. +

For instance, the following configuration defines that: +

c2s connections are listened for on port 5222 and 5223 (SSL) and denied - for the user called `bad'. -
s2s connections are listened for on port 5269 with STARTTLS for secured - traffic enabled. -
Port 5280 is serving the web interface and the HTTP Polling service. Note - that it is also possible to serve them on different ports. The second - example in section 8.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"}}.
+for the user called `bad'.
+

s2s connections are listened for on port 5269 with STARTTLS for secured +traffic enabled. +
Port 5280 is serving the web interface and the HTTP Polling service. Note +that it is also possible to serve them on different ports. The second +example in section 4.1.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}}.
@@ -740,10 +642,9 @@ c2s connections are listened for on port 5222 and 5223 (SSL) and denied
   }.
   {s2s_use_starttls, true}.
   {s2s_certfile, "/path/to/ssl.pem"}.
-

Note, that for jabberd 1.4- or WPJabber-based +

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.
   -->
@@ -771,715 +672,460 @@ services you have to make the transports log and do XDB by themselves:
       <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
     </xdb_file>
   </xdb>
-
-
-
-3.4  Authentication

-
+

3.1.4 Authentication

- -The option auth_method defines the authentication method that is used +

The option auth_method defines the authentication method that is used for user authentication: -

-  {auth_method, [<method>]}.
-

-The following authentication methods are supported by ejabberd: -

-internal (default) — See section 3.4.1. -
external — There are some - example authentication scripts. -
ldap — See section 5.5. -
odbc — See section 5.1, 5.3, - 5.2 and 5.4. -
anonymous — See section 3.4.2. -

- - -

3.4.1 Internal

- +

  {auth_method, [<method>]}.
+

The following authentication methods are supported by ejabberd: +

+internal (default) — See section 3.1.4. +
external — There are some +example authentication scripts. +
ldap — See section 3.2.5. +
odbc — See section 3.2.1, 3.2.3, +3.2.2 and 3.2.4. +
anonymous — See section 3.1.4. +

Internal

- -ejabberd uses its internal Mnesia database as the default authentication method. -

ejabberd uses its internal Mnesia database as the default authentication method.

auth_method: The value internal will enable the internal - authentication method. -

-Examples: -

+authentication method. +

Examples: +

To use internal authentication on example.org and LDAP - authentication on example.net: -

-{host_config, "example.org", [{auth_method, [internal]}]}.
+authentication on example.net:
+{host_config, "example.org", [{auth_method, [internal]}]}.
 {host_config, "example.net", [{auth_method, [ldap]}]}.
-
To use internal authentication on all virtual hosts:
- -{auth_method, internal}.
-

- - -

3.4.2 SASL Anonymous and Anonymous Login

- +

To use internal authentication on all virtual hosts: +
```
{auth_method, internal}.
+
```

SASL Anonymous and Anonymous Login

- -The anonymous authentication method can be configured with the following +

The anonymous authentication method can be configured with the following options. Remember that you can use the host_config option to set virtual -host specific options (see section 3.2). Note that there also +host specific options (see section 3.1.2). Note that there also is a detailed tutorial regarding SASL -Anonymous and anonymous login configuration. -

+Anonymous and anonymous login configuration.

auth_method: The value anonymous will enable the anonymous - authentication method. -
allow_multiple_connections: This value for this option can be - either true or false and is only used when the anonymous mode is - enabled. Setting it to true means that the same username can be taken - multiple times in anonymous login mode if different resource are used to - connect. This option is only useful in very special occasions. The default - value is false. -
anonymous_protocol: This option can take three values: - sasl_anon, login_anon or both. sasl_anon means - that the SASL Anonymous method will be used. login_anon means that the - anonymous login method will be used. both means that SASL Anonymous and - login anonymous are both enabled. -

-Those options are defined for each virtual host with the host_config -parameter (see section 3.2).
-
-Examples: -

+authentication method. +
allow_multiple_connections: This value for this option can be +either true or false and is only used when the anonymous mode is +enabled. Setting it to true means that the same username can be taken +multiple times in anonymous login mode if different resource are used to +connect. This option is only useful in very special occasions. The default +value is false. +
anonymous_protocol: This option can take three values: +sasl_anon, login_anon or both. sasl_anon means +that the SASL Anonymous method will be used. login_anon means that the +anonymous login method will be used. both means that SASL Anonymous and +login anonymous are both enabled. +

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

Examples: +

To enable anonymous login on all virtual hosts: -

-{auth_method, [anonymous]}.
+{auth_method, [anonymous]}.
 {anonymous_protocol, login_anon}.
-  
Similar as previous example, but limited to public.example.org:
- -{host_config, "public.example.org", [{auth_method, [anonymous]},
+  
Similar as previous example, but limited to public.example.org:
+{host_config, "public.example.org", [{auth_method, [anonymous]},
                                      {anonymous_protocol, login_anon}]}.
-
To enable anonymous login and internal authentication on a virtual host:
- -{host_config, "public.example.org", [{auth_method, [internal,anonymous]},
+
To enable anonymous login and internal authentication on a virtual host:
+{host_config, "public.example.org", [{auth_method, [internal,anonymous]},
                                      {anonymous_protocol, login_anon}]}.
-
To enable SASL Anonymous on a virtual host:
- -{host_config, "public.example.org", [{auth_method, [anonymous]},
+
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]},
+
To enable SASL Anonymous and anonymous login on a virtual host:
+{host_config, "public.example.org", [{auth_method, [anonymous]},
                                      {anonymous_protocol, both}]}.
-
To enable SASL Anonymous, anonymous login, and internal authentication on
+

To enable SASL Anonymous, anonymous login, and internal authentication on a virtual host: -

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

- - -

3.5 Access Rules

- +

3.1.5 Access Rules

- - - -

3.5.1 ACL Definition

- - - -Access control in ejabberd is performed via Access Control Lists (ACLs). The +

ACL Definition

+ +

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_regexp, "^test[0-9]*$"}}.
-

{user_regexp, <regexp>, <server>}

Matches any user with a name - that matches <regexp> at server <server>. Example: -

-{acl, tests, {user_regexp, "^test", "example.org"}}.
-

{server_regexp, <regexp>}

Matches any JID from the server that - matches <regexp>. Example: -

-{acl, icq, {server_regexp, "^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. -

- - -

3.5.2 Access Rights

- - - -An entry allowing or denying access to different services looks similar to +

  {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_regexp, "^test[0-9]*$"}}.
+

{user_regexp, <regexp>, <server>}

Matches any user with a name +that matches <regexp> at server <server>. Example: +

{acl, tests, {user_regexp, "^test", "example.org"}}.
+

{server_regexp, <regexp>}

Matches any JID from the server that +matches <regexp>. Example: +

{acl, icq, {server_regexp, "^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. +

Access Rights

+ +

An entry allowing or denying access to different services looks similar to this: -

-  {access, <accessname>, [{allow, <aclname>},
+
  {access, <accessname>, [{allow, <aclname>},
                           {deny, <aclname>},
                           ...
                          ]}.
-
When a JID is checked to have access to <accessname>, the server
+

When a JID is checked to have access to <accessname>, the server sequentially checks if that JID mathes any of the ACLs that are named in the second elements of the tuples in the list. If it matches, the first element of the first matched tuple is returned, otherwise the value `deny' is -returned.
-
-Example: -

-  {access, configure, [{allow, admin}]}.
+returned.
Example:
+
  {access, configure, [{allow, admin}]}.
   {access, something, [{deny, badmans},
                        {allow, all}]}.
-
-The following access rules are pre-defined:
-
-all
 Always returns the value `allow'.
-
none
 Always returns the value `deny'.
-
-
-
-3.5.3  Limiting Opened Sessions with ACL

-
+

The following access rules are pre-defined: +

+all: Always returns the value `allow'. +
none: Always returns the value `deny'. +

Limiting Opened Sessions with ACL

- -The special access max_user_sessions specifies the maximum number of sessions (authenticated +

The special access max_user_sessions specifies the maximum number of sessions (authenticated connections) per user. If a user tries to open more sessions by using different resources, the first opened session will be disconnected. The error session replaced will be sent to the disconnected session. The value for this option can be either a number, or infinity. The default -value is infinity.
-
-The syntax is: -

-  {access, max_user_sessions, [{<maxnumber>, <aclname>},
+value is infinity.
The syntax is:
+
  {access, max_user_sessions, [{<maxnumber>, <aclname>},
                                ...
                               ]}.
-
-Examples:
-
+

Examples: +

To limit the number of sessions per user to 10 for all users: -
```
-  {access, max_user_sessions, [{10, all}]}.
-
```

- - -

3.6 Shapers

- +

  {access, max_user_sessions, [{10, all}]}.
+

3.1.6 Shapers

- -Shapers enable you to limit connection traffic. The syntax of +

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 +

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

+
```
  {maxrate, <rate>}
+
```
where <rate> stands for the maximum allowed incomig rate in bytes per +second.
Examples: +
- To define a shaper named `normal' with traffic speed limited to -1,000 bytes/second: -
```
-  {shaper, normal, {maxrate, 1000}}.
-
```
- To define a shaper named `fast' with traffic speed limited to -50,000 bytes/second: -
```
-  {shaper, fast, {maxrate, 50000}}.
-
```
- - -
3.7 Default Language
- +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.7 Default Language

- -The option language defines the default language of server strings that +

The option language defines the default language of server strings that can be seen by Jabber clients. If a Jabber client do not support xml:lang, the specified language is used. The default value is en. In order to take effect there must be a translation file -<language>.msg in ejabberd's msgs directory.
-
-Examples: -

+<language>.msg in ejabberd's msgs directory.
Examples: +
- To set Russian as default language: -
```
-  {language, "ru"}.
-
```
- To set Spanish as default language: -
```
-  {language, "es"}.
-
```
- - -
4  Advanced configuration
- - - -
4.1  Components Load-Balancing
- - - - - -
4.2  Domain Load-Balancing Algorithm
- - - -ejabberd includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
-
-The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances.
-
-If you need a different behaviour, you can change the load balancing behaviour with the option domain_balancing. The syntax of the option is the following: -
```
- {domain_balancing, "component.example.com", <balancing_criterium>}.                                   
-
```
-Several balancing criterium are available: -
- -destination: the full JID of the packet to attribute is used. -
- source: the full JID of the packet from attribute is used. -
- bare_destination: the bare JID (without resource) of the packet to attribute is used. -
- bare_source: the bare JID (without resource) of the packet from attribute is used. -
-If the value corresponding to the criterium is the same, the same component instance in the cluster will be used.
-
- - -
4.3 Load-Balancing Buckets
- - - -When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced.
-
-In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the domain_balancing_component_number option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.
-
-The syntax is the following: -
```
-    {domain_balancing_component_number, "component.example.com", N}
-
```
- - -
5 Database and LDAP Configuration
- +
```
  {language, "ru"}.
+
```
To set Spanish as default language: +
```
  {language, "es"}.
+
```

3.2 Database and LDAP Configuration

- -ejabberd uses its internal Mnesia database by default. However, it is +

ejabberd uses its internal Mnesia database by default. However, it is possible to use a relational database or an LDAP server to store persistant, long-living data. ejabberd is very flexible: you can configure different authentication methods for different virtual hosts, you can configure different authentication mechanisms for the same virtual host (fallback), you can set -different storage systems for modules, and so forth.
-
-The following databases are supported by ejabberd: -

+different storage systems for modules, and so forth.
The following databases are supported by ejabberd: +
- Microsoft SQL Server -
- Mnesia -
- MySQL -
- Any ODBC compatible database -
- PostgreSQL -
-The following LDAP servers are tested with ejabberd: -
- +
- Mnesia +
- MySQL +
- Any ODBC compatible database +
- PostgreSQL +
The following LDAP servers are tested with ejabberd: +
- Active Directory - (see section 5.5.3) -
- OpenLDAP -
- Normally any LDAP compatible server should work; inform us about your - success with a not-listed server so that we can list it here. -
- - -
5.1 MySQL
- +(see section 3.2.5) +
OpenLDAP +
Normally any LDAP compatible server should work; inform us about your +success with a not-listed server so that we can list it here. +

3.2.1 MySQL

- -Although this section will describe ejabberd's configuration when you want to +

Although this section will describe ejabberd's configuration when you want to use the native MySQL driver, it does not describe MySQL's installation and database creation. Check the MySQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. Note that the tutorial contains information about ejabberd's configuration -which is duplicate to this section.
-
-Moreover, the file mysql.sql in the directory src/odbc might be interesting for +which is duplicate to this section.

Moreover, the file mysql.sql in the directory src/odbc might be interesting for you. This file contains the ejabberd schema for MySQL. At the end of the file -you can find information to update your database schema.
-
- - -

5.1.1 Driver Compilation

- +you can find information to update your database schema.

Driver Compilation

- -You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for MySQL. -

+
You can skip this step if you installed ejabberd using a binary installer or +if the binary packages of ejabberd you are using include support for MySQL.
1. First, install the Erlang - MySQL library. Make sure the compiled files are in your Erlang path; you can - put them for example in the same directory as your ejabberd .beam files. -
2. Then, configure and install ejabberd with ODBC support enabled (this is - also needed for native MySQL support!). This can be done, by using next - commands: -
```
-./configure --enable-odbc && make install
-
```
- - -
5.1.2 Authentication
- +MySQL library. Make sure the compiled files are in your Erlang path; you can +put them for example in the same directory as your ejabberd .beam files. +
Then, configure and install ejabberd with ODBC support enabled (this is +also needed for native MySQL support!). This can be done, by using next +commands: +
```
./configure --enable-odbc && make install
+
```

Authentication

- -The option value name may be misleading, as the auth_method name is used +

The option value name may be misleading, as the auth_method name is used for access to a relational database through ODBC, as well as through the native MySQL interface. Anyway, the first configuration step is to define the odbc auth_method. For example: -

-{host_config, "public.example.org", [{auth_method, [odbc]}]}.
-

-The actual database access is defined in the option odbc_server. Its +

{host_config, "public.example.org", [{auth_method, [odbc]}]}.
+

The actual database access is defined in the option odbc_server. Its value is used to define if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.
-
-To use the native MySQL interface, you can pass a tuple of the following form as +interface available, PostgreSQL or MySQL.

To use the native MySQL interface, you can pass a tuple of the following form as parameter: -

-{mysql, "Server", "Database", "Username", "Password"}
-

-mysql is a keyword that should be kept as is. For example: -

-{odbc_server, {mysql, "localhost", "test", "root", "password"}}.
-

- - -

5.1.3 Storage

- +

{mysql, "Server", "Database", "Username", "Password"}
+

mysql is a keyword that should be kept as is. For example: +

{odbc_server, {mysql, "localhost", "test", "root", "password"}}.
+

Optionally, it is possible to define the MySQL port to use. This +option is only useful, in very rare cases, when you are not running +MySQL with the default port setting. The mysql parameter +can thus take the following form: +

{mysql, "Server", Port, "Database", "Username", "Password"}
+

The Port value should be an integer, without quotes. For example: +

{odbc_server, {mysql, "localhost", Port, "test", "root", "password"}}.
+

Storage

- -MySQL also can be used to store information into from several ejabberd -modules. See section 6.1 to see which modules have a version +

MySQL also can be used to store information into from several ejabberd +modules. See section 3.3.1 to see which modules have a version with the `_odbc'. This suffix indicates that the module can be used with relational databases like MySQL. To enable storage to your database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind -that you cannot have several variants of the same module loaded!
-
- - -

5.2 Microsoft SQL Server

- +that you cannot have several variants of the same module loaded!

3.2.2 Microsoft SQL Server

- -Although this section will describe ejabberd's configuration when you want to +

Although this section will describe ejabberd's configuration when you want to use Microsoft SQL Server, it does not describe Microsoft SQL Server's installation and database creation. Check the MySQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. Note that the tutorial contains information about ejabberd's configuration -which is duplicate to this section.
-
-Moreover, the file mssql.sql in the directory src/odbc might be interesting for +which is duplicate to this section.

Moreover, the file mssql.sql in the directory src/odbc might be interesting for you. This file contains the ejabberd schema for Microsoft SQL Server. At the end -of the file you can find information to update your database schema.
-
- - -

5.2.1 Driver Compilation

- +of the file you can find information to update your database schema.

Driver Compilation

- -You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for ODBC.
-
-If you want to use Microsoft SQL Server with ODBC, you need to configure, +

You can skip this step if you installed ejabberd using a binary installer or +if the binary packages of ejabberd you are using include support for ODBC.

If you want to use Microsoft SQL Server with ODBC, you need to configure, compile and install ejabberd with support for ODBC and Microsoft SQL Server enabled. This can be done, by using next commands: -

-./configure --enable-odbc --enable-mssql && make install
-

- - -

5.2.2 Authentication

- +

./configure --enable-odbc --enable-mssql && make install
+

Authentication

- -The configuration of Microsoft SQL Server is the same as the configuration of -ODBC compatible serers (see section 5.4.2).
-
- - -

5.2.3 Storage

- +

The configuration of Microsoft SQL Server is the same as the configuration of +ODBC compatible serers (see section 3.2.4).

Storage

- -Microsoft SQL Server also can be used to store information into from several -ejabberd modules. See section 6.1 to see which modules have +

Microsoft SQL Server also can be used to store information into from several +ejabberd modules. See section 3.3.1 to see which modules have a version with the `_odbc'. This suffix indicates that the module can be used with relational databases like Microsoft SQL Server. To enable storage to your database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind that you cannot have several variants of the same -module loaded!
-
- - -

5.3 PostgreSQL

- +module loaded!

3.2.3 PostgreSQL

- -Although this section will describe ejabberd's configuration when you want to +

Although this section will describe ejabberd's configuration when you want to use the native PostgreSQL driver, it does not describe PostgreSQL's installation and database creation. Check the PostgreSQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. Note that the tutorial contains information about ejabberd's configuration -which is duplicate to this section.
-
-Also the file pg.sql in the directory src/odbc might be interesting for you. +which is duplicate to this section.

Also the file pg.sql in the directory src/odbc might be interesting for you. This file contains the ejabberd schema for PostgreSQL. At the end of the file -you can find information to update your database schema.
-
- - -

5.3.1 Driver Compilation

- +you can find information to update your database schema.

Driver Compilation

- -You can skip this step if you installed ejabberd using a binary installer or +

You can skip this step if you installed ejabberd using a binary installer or if the binary packages of ejabberd you are using include support for -PostgreSQL. -

+PostgreSQL.
1. First, install the Erlang PgSQL library from - Jungerl. Make sure the compiled - files are in your Erlang path; you can put them for example in the same - directory as your ejabberd .beam files. -
2. Then, configure, compile and install ejabberd with ODBC support enabled - (this is also needed for native PostgreSQL support!). This can be done, by - using next commands: -
```
-./configure --enable-odbc && make install
-
```
- - -
5.3.2 Authentication
- +Jungerl. Make sure the compiled +files are in your Erlang path; you can put them for example in the same +directory as your ejabberd .beam files. +
Then, configure, compile and install ejabberd with ODBC support enabled +(this is also needed for native PostgreSQL support!). This can be done, by +using next commands: +
```
./configure --enable-odbc && make install
+
```

Authentication

- -The option value name may be misleading, as the auth_method name is used +

The option value name may be misleading, as the auth_method name is used for access to a relational database through ODBC, as well as through the native PostgreSQL interface. Anyway, the first configuration step is to define the odbc auth_method. For example: -

-{host_config, "public.example.org", [{auth_method, [odbc]}]}.
-

-The actual database access is defined in the option odbc_server. Its +

{host_config, "public.example.org", [{auth_method, [odbc]}]}.
+

The actual database access is defined in the option odbc_server. Its value is used to define if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.
-
-To use the native PostgreSQL interface, you can pass a tuple of the following +interface available, PostgreSQL or MySQL.

To use the native PostgreSQL interface, you can pass a tuple of the following form as parameter: -

-{pgsql, "Server", "Database", "Username", "Password"}
-

-pgsql is a keyword that should be kept as is. For example: -

-{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.
-

- - -

5.3.3 Storage

- +

{pgsql, "Server", "Database", "Username", "Password"}
+

pgsql is a keyword that should be kept as is. For example: +

{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.
+

Optionally, it is possible to define the PostgreSQL port to use. This +option is only useful, in very rare cases, when you are not running +PostgreSQL with the default port setting. The pgsql parameter +can thus take the following form: +

{pgsql, "Server", Port, "Database", "Username", "Password"}
+

The Port value should be an integer, without quotes. For example: +

{odbc_server, {pgsql, "localhost", 5432, "database", "ejabberd", "password"}}.
+

Storage

- -PostgreSQL also can be used to store information into from several ejabberd -modules. See section 6.1 to see which modules have a version +

PostgreSQL also can be used to store information into from several ejabberd +modules. See section 3.3.1 to see which modules have a version with the `_odbc'. This suffix indicates that the module can be used with relational databases like PostgreSQL. To enable storage to your database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. -Keep in mind that you cannot have several variants of the same module loaded!
-
- - -

5.4 ODBC Compatible

- +Keep in mind that you cannot have several variants of the same module loaded!

3.2.4 ODBC Compatible

- -Although this section will describe ejabberd's configuration when you want to +

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

5.4.1 Compilation

- - -You can skip this step if you installed ejabberd using a binary installer or +this section.

Compilation

You can skip this step if you installed ejabberd using a binary installer or if the binary packages of ejabberd you are using include support for -ODBC. -

+ODBC.
1. First, install the Erlang - MySQL library. Make sure the compiled files are in your Erlang path; you can - put them for example in the same directory as your ejabberd .beam files. -
2. Then, configure, compile and install ejabberd with ODBC support - enabled. This can be done, by using next commands: -
```
-./configure --enable-odbc && make install
-
```
- - -
5.4.2 Authentication
- +MySQL library. Make sure the compiled files are in your Erlang path; you can +put them for example in the same directory as your ejabberd .beam files. +
Then, configure, compile and install ejabberd with ODBC support +enabled. This can be done, by using next commands: +
```
./configure --enable-odbc && make install
+
```

Authentication

- -The first configuration step is to define the odbc auth_method. For +

The first configuration step is to define the odbc auth_method. For example: -

-{host_config, "public.example.org", [{auth_method, [odbc]}]}.
-

-The actual database access is defined in the option odbc_server. Its +

{host_config, "public.example.org", [{auth_method, [odbc]}]}.
+

The actual database access is defined in the option odbc_server. Its value is used to defined if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.
-
-To use a relational database through ODBC, you can pass the ODBC connection +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"}.
-

- - -

5.4.3 Storage

- +

{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.
+

Storage

- -An ODBC compatible database also can be used to store information into from -several ejabberd modules. See section 6.1 to see which +

An ODBC compatible database also can be used to store information into from +several ejabberd modules. See section 3.3.1 to see which modules have a version with the `_odbc'. This suffix indicates that the module can be used with ODBC compatible relational databases. To enable storage to your database, just make sure that your database is running well (see previous sections), and replace the suffix-less or ldap module variant with the odbc module variant. Keep in mind that you cannot have several variants of the same -module loaded!
-
- - -

5.5 LDAP

- +module loaded!

3.2.5 LDAP

- -ejabberd has built-in LDAP support. You can authenticate users against LDAP +

ejabberd has built-in LDAP support. You can authenticate users against LDAP server and use LDAP directory as vCard storage. Shared rosters are not supported -yet.
-
- - -

5.5.1 Connection

- - -Parameters: -

-ldap_server

IP address or dns name of your +yet.

Connection

Parameters: +

+ldap_server: IP address or dns name of your LDAP server. This option is required. -
ldap_port: Port to connect to your LDAP server. - The default value is 389. -
ldap_rootdn: Bind DN. The default value - is "" which means `anonymous connection'. -
ldap_password: Bind password. The default - value is "". -

-Example: -

-  {auth_method, ldap}.
+

ldap_port

Port to connect to your LDAP server. +The default value is 389. +

ldap_rootdn

Bind DN. The default value +is "" which means `anonymous connection'. +

ldap_password

Bind password. The default +value is "". +

Example: +

  {auth_method, ldap}.
   {ldap_servers, ["ldap.example.org"]}.
   {ldap_port, 389}.
   {ldap_rootdn, "cn=Manager,dc=domain,dc=org"}.
   {ldap_password, "secret"}.
-

-Note that current LDAP implementation does not support SSL secured communication -and SASL authentication.
-
- - -

5.5.2 Authentication

- - -You can authenticate users against an LDAP directory. Available options are: -

-ldap_base

LDAP base directory which stores - users accounts. This option is required. -

ldap_uids

LDAP attribute which holds a list - of attributes to use as alternatives for getting the JID. The value is of - the form: [{ldap_uidattr}] or [{ldap_uidattr, - ldap_uidattr_format}]. You can use as many comma separated tuples - {ldap_uidattr, ldap_uidattr_format} that is needed. The default - value is [{"uid", "%u"}]. The defaut ldap_uidattr_format - is "%u". The values for ldap_uidattr and - ldap_uidattr_format are described as follow: -

- ldap_uidattr: LDAP attribute which holds - the user's part of a JID. The default value is "uid". -
ldap_uidattr_format: Format of - the ldap_uidattr variable. The format must contain one and - only one pattern variable "%u" which will be replaced by the - user's part of a JID. For example, "%u@example.org". The default - value is "%u". -

ldap_filter

- RFC 2254 LDAP filter. The - default is none. Example: - "(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, do - not forget to close brackets and do not use superfluous whitespaces. Also you - must not use ldap_uidattr attribute in filter because this - attribute will be substituted in LDAP filter automatically. -

- - -

5.5.3 Examples

- - - - -

Common example

- -Let's say ldap.example.org is the name of our LDAP server. We have +

Note that current LDAP implementation does not support SSL secured communication +and SASL authentication.

Authentication

You can authenticate users against an LDAP directory. Available options are:

+ldap_base

LDAP base directory which stores +users accounts. This option is required. +

ldap_uids

LDAP attribute which holds a list +of attributes to use as alternatives for getting the JID. The value is of +the form: [{ldap_uidattr}] or [{ldap_uidattr, +ldap_uidattr_format}]. You can use as many comma separated tuples +{ldap_uidattr, ldap_uidattr_format} that is needed. The default +value is [{"uid", "%u"}]. The defaut ldap_uidattr_format +is "%u". The values for ldap_uidattr and +ldap_uidattr_format are described as follow: +

+ldap_uidattr: LDAP attribute which holds +the user's part of a JID. The default value is "uid". +
ldap_uidattr_format: Format of +the ldap_uidattr variable. The format must contain one and +only one pattern variable "%u" which will be replaced by the +user's part of a JID. For example, "%u@example.org". The default +value is "%u". +

ldap_filter

+RFC 2254 LDAP filter. The +default is none. Example: +"(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, do +not forget to close brackets and do not use superfluous whitespaces. Also you +must not use ldap_uidattr attribute in filter because this +attribute will be substituted in LDAP filter automatically. +

Examples

Common example

Let's say ldap.example.org is the name of our LDAP server. We have users with their passwords in "ou=Users,dc=example,dc=org" directory. Also we have addressbook, which contains users emails and their additional infos in "ou=AddressBook,dc=example,dc=org" directory. Corresponding -authentication section should looks like this: -

-  %% authentication method
+authentication section should looks like this:
  %% authentication method
   {auth_method, ldap}.
   %% DNS name of our LDAP server
   {ldap_servers, ["ldap.example.org"]}.
@@ -1490,13 +1136,10 @@ authentication section should looks like this:
   {ldap_base, "ou=Users,dc=example,dc=org"}.
   %% We want to authorize users from 'shadowAccount' object class only
   {ldap_filter, "(objectClass=shadowAccount)"}.
-
-Now we want to use users LDAP-info as their vCards. We have four attributes
-defined in our LDAP schema: "mail" — email address, "givenName"
-— first name, "sn" — second name, "birthDay" — birthday.
-Also we want users to search each other. Let's see how we can set it up:
--  {modules,
+
Now we want to use users LDAP-info as their vCards. We have four attributes
+defined in our LDAP schema: "mail" — email address, "givenName"
+— first name, "sn" — second name, "birthDay" — birthday.
+Also we want users to search each other. Let's see how we can set it up:
  {modules,
     ...
     {mod_vcard_ldap,
      [
@@ -1537,20 +1180,12 @@ Also we want users to search each other. Let's see how we can set it up:
     ]}
     ...
   }.
-
-Note that mod_vcard_ldap module checks for the existence of the user before
-searching in his information in LDAP.

-

-
-
-Active Directory

-
+

Note that mod_vcard_ldap module checks for the existence of the user before +searching in his information in LDAP.

Active Directory

- -Active Directory is just an LDAP-server with predefined attributes. A sample -configuration is showed below: -

-  {auth_method, ldap}.
+
Active Directory is just an LDAP-server with predefined attributes. A sample
+configuration is showed below:
  {auth_method, ldap}.
   {ldap_servers, ["office.org"]}.    % List of LDAP servers
   {ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory
   {ldap_rootdn, "CN=Administrator,CN=Users,DC=office,DC=org"}. % LDAP manager
@@ -1593,357 +1228,188 @@ configuration is showed below:
       {"Email", "EMAIL"}]}
    ]
   }.
-
-
-
-6  Modules Configuration

-
+

3.3 Modules Configuration

- -The option modules defines the list of modules that will be loaded after +

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

+module.

Examples: +

In this example only the module mod_echo is loaded and no module - options are specified between the square brackets: -

-  {modules,
+options are specified between the square brackets:
+  {modules,
    [{mod_echo,      []}
    ]}.
-
In the second example 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,
+
In the second example 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,   []}
    ]}.
-

- - -

6.1 Overview

- +

3.3.1 Overview

- -The following table lists all modules available in the official ejabberd +

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

+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 a supported database - (see 5) as backend. -
- No suffix, this means that the modules uses Erlang's built-in database - Mnesia as backend. -
-If you want to +
`_odbc', this means that the module needs a supported database +(see 3.2) as backend. +
No suffix, this means that the modules uses Erlang's built-in database +Mnesia as backend. +

If you want to 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: -

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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Module Feature Dependencies Needed for XMPP?
mod_adhoc Ad-Hoc Commands (XEP-0050) No
mod_announce Manage announcements mod_adhoc No
mod_configure Support for online mod_adhoc No
configuration of ejabberd
mod_disco Service Discovery (XEP-0030) No
mod_echo Echoes Jabber packets No
mod_irc IRC transport No
mod_last Last Activity (XEP-0012) No
mod_last_odbc Last Activity (XEP-0012) supported database (*) No
mod_muc Multi-User Chat (XEP-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 supported database (*) No
mod_privacy Blocking Communication Yes
mod_private Private XML Storage (XEP-0049) No
mod_private_odbc Private XML Storage (XEP-0049) supported database (*) No
mod_proxy65 SOCKS5 Bytestreams (XEP-0065) No
mod_pubsub Publish-Subscribe (XEP-0060) No
mod_register In-Band Registration (XEP-0077) No
mod_roster Roster management Yes (**)
mod_roster_odbc Roster management supported database (*) Yes (**)
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 (XEP-0039) No
mod_time Entity Time (XEP-0090) No
mod_vcard vcard-temp (XEP-0054) No
mod_vcard_ldap vcard-temp (XEP-0054) LDAP server No
mod_vcard_odbc vcard-temp (XEP-0054) supported database (*) No
mod_version Software Version (XEP-0092) No
-

-(*) For a list of supported databases, see section 5. -
(**) This module or a similar one with another database backend is needed for +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. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Module Feature Dependencies Needed for XMPP?
mod_adhoc Ad-Hoc Commands (XEP-0050) No
mod_announce Manage announcements mod_adhoc No
mod_configure Support for online mod_adhoc No
configuration of ejabberd
mod_disco Service Discovery (XEP-0030) No
mod_echo Echoes Jabber packets No
mod_irc IRC transport No
mod_last Last Activity (XEP-0012) No
mod_last_odbc Last Activity (XEP-0012) supported database (*) No
mod_muc Multi-User Chat (XEP-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 supported database (*) No
mod_privacy Blocking Communication Yes
mod_private Private XML Storage (XEP-0049) No
mod_private_odbc Private XML Storage (XEP-0049) supported database (*) No
mod_proxy65 SOCKS5 Bytestreams (XEP-0065) No
mod_pubsub Publish-Subscribe (XEP-0060) No
mod_register In-Band Registration (XEP-0077) No
mod_roster Roster management Yes (**)
mod_roster_odbc Roster management supported database (*) Yes (**)
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 (XEP-0039) No
mod_time Entity Time (XEP-0090) No
mod_vcard vcard-temp (XEP-0054) No
mod_vcard_ldap vcard-temp (XEP-0054) LDAP server No
mod_vcard_odbc vcard-temp (XEP-0054) supported database (*) No
mod_version Software Version (XEP-0092) No
+

+(*) For a list of supported databases, see section 3.2. +
(**) This module or a similar one with another database backend is needed for XMPP compliancy. -

- - -

6.2 Common Options

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

6.2.1 `iqdisc`

- +

3.3.2 Common Options

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

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

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

+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}]},
     ...
    ]}.
-
-
-
-6.2.2  hosts

-
+

`hosts`

- -A module acting as a service can have one or more hostnames. These hostnames -can be defined with the hosts option.
-
-Examples: -

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,
+
+  {modules,
    [
     ...
     {mod_echo, [{hosts, ["echo.example.org"]}]},
     ...
    ]}.
-
Backwards compatibility with older ejabberd versions can be retained
- with:
- -  {modules,
+
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,
+

Serving the echo module on two domains: +

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

- - -

6.3 `mod_announce`

- +

3.3.3 `mod_announce`

- -This module enables configured users to broadcast announcements and to set +

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

+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 3.3.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}]}.
+  {access, announce, [{allow, admins}]}.
 
   {modules,
    [
@@ -1951,9 +1417,8 @@ Only administrators can send announcements:
     {mod_announce, [{access, announce}]},
     ...
    ]}.
-
Administrators as well as the direction can send announcements:
- -  {acl, direction, {user, "big_boss", "example.org"}}.
+
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"}}.
   ...
@@ -1966,148 +1431,120 @@ Only administrators can send announcements:
     {mod_announce, [{access, announce}]},
     ...
    ]}.
-

- - -

6.4 `mod_disco`

- +

3.3.4 `mod_disco`

- -This module adds support for Service Discovery (XEP-0030). With +

This module adds support for Service Discovery (XEP-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 (XEP-0011) and Agent Information (XEP-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 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 6.2.1). -
extra_domains: With this option, - extra domains can be added to the Service Discovery item list. -

-Examples: -

+http://jabber.org/protocol/disco#info) IQ queries (see section 3.3.2). +

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,
+  {modules,
    [
     ...
     {mod_disco, [{extra_domains, ["users.jabber.org"]}]},
     ...
    ]}.
-
To serve a link to the transports on another server:
- -  {modules,
+
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,
+
To serve a link to a few friendly servers:
+  {modules,
    [
     ...
     {mod_disco, [{extra_domains, ["example.org",
                                   "example.com"]}]},
     ...
    ]}.
-

- - -

6.5 `mod_echo`

- + +

3.3.5 `mod_echo`

- -This module simply echoes any Jabber +

This module simply echoes any Jabber packet back to the sender. This mirror can be of interest for -ejabberd and Jabber client debugging.
-
-Options: -

+ejabberd and Jabber client debugging.
Options: +
- hosts
This option defines the hostnames of the - service (see section 6.2.2). If neither hosts nor - the old host is present, the prefix `echo.' is added to all - ejabberd hostnames. +hosts: This option defines the hostnames of the +service (see section 3.3.2). If neither hosts nor +the old host is present, the prefix `echo.' is added to all +ejabberd hostnames. -

-Examples: -

Examples: +

Mirror, mirror, on the wall, who is the most beautiful - of them all? -

-  {modules,
+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 6.2.2.
-

- - -

6.6 `mod_irc`

- +

If you still do not understand the inner workings of mod_echo, +you can find a few more examples in section 3.3.2. +

3.3.6 `mod_irc`

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

End user information: -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 (XEP-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 6.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: -
- +Chat support (XEP-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 3.3.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). +
default_encoding
Set the default IRC encoding (default value: "koi8-r"). +
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,
+virtual host(s) with the prefix `irc.'. Furthermore, anyone is
+able to use the transport. The default encoding is set to "iso8859-15".
+  {modules,
    [
     ...
-    {mod_irc, [{access, all}]},
+    {mod_irc, [{access, all}, {default_encoding, "iso8859-15"}]},
     ...
    ]}.
-
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"}}.
+
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"}}.
   ...
@@ -2121,82 +1558,91 @@ In the first example, the IRC transport is available on (all) your
                {hosts, ["irc.example.net", "irc-transport.example.com"]}]},
     ...
    ]}.
-
```
- - -
6.7 mod_last
- +

3.3.7 `mod_last`

- -This module adds support for Last Activity (XEP-0012). It can be used to +

This module adds support for Last Activity (XEP-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 6.2.1). -

- - -

6.8 `mod_muc`

- +ejabberd server.

Options: +

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

3.3.8 `mod_muc`

- -With this module enabled, your server will support Multi-User Chat +

With this module enabled, your server will support Multi-User Chat (XEP-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: -

+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 6.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. -
history_size
A small history of the - current discussion is sent to users when they enter the room. With this option - you can define the number of history messages to keep and send to users - joining the room. The value is an integer. Setting the value to 0 - disables the history feature and, as a result, nothing is kept in memory. The - default value is 20. This value is global and thus affects all rooms on - the server. -
-Examples: -
- +
- 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 3.3.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_persistent
To configure who is +allowed to modify the 'persistent' chatroom option +(by default, everybody is allowed to modify that option). +
access_admin
This option specifies +who is allowed to administrate the Multi-User Chat service (the default +value is none, which means that only the room creator can +administer his room). By sending a message to the service JID, +administrators can send service messages that will be displayed in every +active room. +
history_size
A small history of the +current discussion is sent to users when they enter the room. With this option +you can define the number of history messages to keep and send to users +joining the room. The value is an integer. Setting the value to 0 +disables the history feature and, as a result, nothing is kept in memory. The +default value is 20. This value is global and thus affects all rooms on +the server. +
min_message_interval
+This option defines the minimum interval between two messages send by +a user in seconds. This option is global and valid for all chat +rooms. A decimal value can be used. When this option is not defined, +message rate is not limited. This feature can be used to protect a MUC +service from users abuses and limit number of messages that will be +broadcasted by the service. A good value for this minimum message +interval is 0.4 second. If a user tries to send messages faster, an +error is send back explaining that the message have been discarded and +describing the reason why the message is not acceptable. +
min_presence_interval
+This option defines the minimum of time between presence changes +coming from a given user in seconds. This option is global and valid +for all chat rooms. A decimal value can be used. When this option is +not defined, no restriction is applied. This option can be used to +protect a MUC service for users abuses, as fastly changing a user +presence will result in possible large presence packet broadcast. If a +user tries to change its presence more often than the specified +interval, the presence is cached by ejabberd and only the last +presence is broadcasted to all users in the room after expiration of +the interval delay. Intermediate presence packets are silently +discarded. A good value for this option is 4 seconds. +
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. In this example the history - feature is disabled. -
```
-  {acl, admins, {user, "admin", "example.org"}}.
+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. In this example the history
+feature is disabled.
+  {acl, admins, {user, "admin", "example.org"}}.
   ...
   {access, muc_admins, [{allow, admins}]}.
   ...
@@ -2209,18 +1655,17 @@ In the first example everyone is allowed to use the Multi-User Chat
                {history_size, 0}]},
     ...
    ]}.
-
In the second example the Multi-User Chat service is only accessible by
- 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. No
- history_size option is used, this means that the feature is enabled
- and the default value of 20 history messages will be send to the users.
- -  {acl, paying_customers, {user, "customer1", "example.net"}}.
+
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. No
+history_size option is used, this means that the feature is enabled
+and the default value of 20 history messages will be send to the users.
+  {acl, paying_customers, {user, "customer1", "example.net"}}.
   {acl, paying_customers, {user, "customer2", "example.com"}}.
   {acl, paying_customers, {user, "customer3", "example.org"}}.
   {acl, admins, {user, "admin", "example.org"}}.
@@ -2239,81 +1684,92 @@ In the first example everyone is allowed to use the Multi-User Chat
                {access_admin, muc_admins}]},
     ...
    ]}.
-
```
-The Multi-Users Chat module now supports clustering and load balancing. One module can be started per cluster node. Rooms are distributed at creation time on all available MUC module instances. The multi-user chat module is clustered but the room themselves are not clustered nor fault-tolerant: If the not managing a set of rooms goes down, the rooms disappear and they will be recreated on an available node on first connection attempt.
-
- - -
6.9 mod_muc_log
- +
In the following example, MUC anti abuse options are used. A +user cannot send more than one message every 0.4 seconds and cannot +change its presence more than once every 4 seconds. No ACLs are +defined, but some user restriction could be added as well:
```
  ...
+  {modules,
+   [
+    ...
+    {mod_muc, [{min_message_interval, 0.4},
+               {min_presence_interval, 4}]},
+    ...
+   ]}.
+
```

The Multi-Users Chat module now supports clustering and load +balancing. One module can be started per cluster node. Rooms are +distributed at creation time on all available MUC module +instances. The multi-user chat module is clustered but the room +themselves are not clustered nor fault-tolerant: If the node managing a +set of rooms goes down, the rooms disappear and they will be recreated +on an available node on first connection attempt.

3.3.9 `mod_muc_log`

- -This module enables optional logging of Multi-User Chat (MUC) conversations to +

This module enables optional logging of Multi-User Chat (MUC) conversations to HTML. Once you enable this module, users can join a chatroom using a MUC capable Jabber client, and if they have enough privileges, they can request the -configuration form in which they can set the option to enable chatroom logging.
-
-Features: -

+configuration form in which they can set the option to enable chatroom logging.
Features: +
- Chatroom details are added on top of each page: room title, JID, - author, subject and configuration. -
- - Room title and JID are links to join the chatroom (using - XMPP URIs). -
- Subject and chatroom configuration changes are tracked and displayed. -
- Joins, leaves, nick changes, kicks, bans and `/me' are tracked and - displayed, including the reason if 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 each page. -
-Options: -
-access_log
- This option restricts which users are allowed to enable or disable chatroom - logging. The default value is muc_admin. Note for this default setting - you need to have an access rule for muc_admin in order to take effect. -
cssfile
- With this option you can set whether the HTML files should have a custom CSS - file or if they need to use the embedded CSS file. Allowed values are - false and an URL to a CSS file. With the first value, HTML files will - include the embedded CSS code. With the latter, you can specify the URL of the - custom CSS file (for example: `http://example.com/my.css'). The default value - is false. -
dirtype
- The type of the created directories can be specified with this option. Allowed - values are subdirs and plain. With the first value, - subdirectories are created for each year and month. With the latter, the - names of the log files contain the full date, and there are no subdirectories. - The default value is subdirs. -
outdir
- This option sets the full path to the directory in which the HTML files should - be stored. Make sure the ejabberd daemon user has write access on that - directory. The default value is "www/muc". -
timezone
- The time zone for the logs is configurable with this option. Allowed values - are local and universal. With the first value, the local time, - as reported to Erlang by the operating system, will be used. With the latter, - GMT/UTC time will be used. The default value is local. -
top_link
- With this option you can customize the link on the top right corner of each - log file. The syntax of this option is {"URL", "Text"}. The default - value is {"/", "Home"}. -
-Examples: -
- +author, subject and configuration. +
- +Room title and JID are links to join the chatroom (using +XMPP URIs). +
- Subject and chatroom configuration changes are tracked and displayed. +
- Joins, leaves, nick changes, kicks, bans and `/me' are tracked and +displayed, including the reason if 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 each page. +
Options: +
+access_log
+This option restricts which users are allowed to enable or disable chatroom +logging. The default value is muc_admin. Note for this default setting +you need to have an access rule for muc_admin in order to take effect. +
cssfile
+With this option you can set whether the HTML files should have a custom CSS +file or if they need to use the embedded CSS file. Allowed values are +false and an URL to a CSS file. With the first value, HTML files will +include the embedded CSS code. With the latter, you can specify the URL of the +custom CSS file (for example: `http://example.com/my.css'). The default value +is false. +
dirtype
+The type of the created directories can be specified with this option. Allowed +values are subdirs and plain. With the first value, +subdirectories are created for each year and month. With the latter, the +names of the log files contain the full date, and there are no subdirectories. +The default value is subdirs. +
outdir
+This option sets the full path to the directory in which the HTML files should +be stored. Make sure the ejabberd daemon user has write access on that +directory. The default value is "www/muc". +
timezone
+The time zone for the logs is configurable with this option. Allowed values +are local and universal. With the first value, the local time, +as reported to Erlang by the operating system, will be used. With the latter, +GMT/UTC time will be used. The default value is local. +
spam_prevention
+To prevent spam, the spam_prevention option adds a special attribute +to links that prevent their indexation by search engines. The default value +is true, which mean that nofollow attributes will be added to user +submitted links. +
top_link
+With this option you can customize the link on the top right corner of each +log file. The syntax of this option is {"URL", "Text"}. The default +value is {"/", "Home"}. +
Examples: +
- In the first example any chatroom owner can enable logging, and a - custom CSS file will be used (http://example.com/my.css). Further, the names - of the log files will contain the full date, and there will be no - subdirectories. The log files will be stored in /var/www/muclogs, and the - time zone will be GMT/UTC. Finally, the top link will be - <a href="http://www.jabber.ru">Jabber.ru</a>. -
```
-  {access, muc, [{allow, all}]}.
+custom CSS file will be used (http://example.com/my.css). Further, the names
+of the log files will contain the full date, and there will be no
+subdirectories. The log files will be stored in /var/www/muclogs, and the
+time zone will be GMT/UTC. Finally, the top link will be
+<a href="http://www.jabber.ru">Jabber.ru</a>.
+  {access, muc, [{allow, all}]}.
   ...
   {modules,
    [
@@ -2324,18 +1780,18 @@ In the first example any chatroom owner can enable logging, and a
                {dirtype, plain},
                {outdir, "/var/www/muclogs"},
                {timezone, universal},
+               {spam_prevention, true},
                {top_link, {"http://www.jabber.ru", "Jabber.ru"}}
     ]},
     ...
    ]}.
-
In the second example only admin1@example.org and
- admin2@example.net can enable logging, and the embedded CSS file will be
- used. Further, the names of the log files will only contain the day (number),
- and there will be subdirectories for each year and month. The log files will
- be stored in /var/www/muclogs, and the local time will be used. Finally, the
- top link will be the default <a href="/">Home</a>.
- -  {acl, admins, {user, "admin1", "example.org"}}.
+
In the second example only admin1@example.org and
+admin2@example.net can enable logging, and the embedded CSS file will be
+used. Further, the names of the log files will only contain the day (number),
+and there will be subdirectories for each year and month. The log files will
+be stored in /var/www/muclogs, and the local time will be used. Finally, the
+top link will be the default <a href="/">Home</a>.
+  {acl, admins, {user, "admin1", "example.org"}}.
   {acl, admins, {user, "admin2", "example.net"}}.
   ...
   {access, muc_log, [{allow, admins},
@@ -2353,119 +1809,93 @@ In the first example any chatroom owner can enable logging, and a
     ]},
     ...
    ]}.
-
```
- - -
6.10 mod_offline
- +

3.3.10 `mod_offline`

- -This module implements offline message storage. This means that all messages +

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

6.11 `mod_privacy`

- +(see section 4.1.2).

3.3.11 `mod_privacy`

- -This module implements Blocking Communication (also known as Privacy Rules) +

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). -
+
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 6.2.1). -
- - -
6.12 mod_private
- +

Options: +

+iqdisc: This specifies +the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section 3.3.2). +

3.3.12 `mod_private`

- -This module adds support for Private XML Storage (XEP-0049): -

+
This module adds support for Private XML Storage (XEP-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 (XEP-0048). -
-Options: -
-iqdisc
This specifies -the processing discipline for Private XML Storage (jabber:iq:private) IQ queries -(see section 6.2.1). -
- - -
6.13 mod_proxy65
- +

Options: +

+iqdisc: This specifies +the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section 3.3.2). +

3.3.13 `mod_proxy65`

- -This module implements SOCKS5 Bytestreams (XEP-0065). +

This module implements SOCKS5 Bytestreams (XEP-0065). It allows ejabberd to act as a file transfer proxy between two -XMPP clients.
-
-Options: -

-host

This option defines the hostname of the service. +XMPP clients.

Options: +

+host: This option defines the hostname of the service. If this option is not set, the prefix `proxy.' is added to ejabberd hostname. -
name: Defines Service Discovery name of the service. +
name: Defines Service Discovery name of the service. Default is "SOCKS5 Bytestreams". -
ip: This option specifies which network interface +
ip: This option specifies which network interface to listen for. Default is an IP address of the service's DNS name, or, if fails, {127,0,0,1}. -
port: This option defines port to listen for -incoming connections. Default is 7777. -
auth_type: SOCKS5 authentication type. +
port: This option defines port to listen for +incoming connections. Default is 7777. +
auth_type: SOCKS5 authentication type. Possible values are anonymous and plain. Default is anonymous. -
access: Defines ACL for file transfer initiators. +
access: Defines ACL for file transfer initiators. Default is all. -
max_connections: Maximum number of +
max_connections: Maximum number of active connections per file transfer initiator. No limit by default. -
shaper: This option defines shaper for +
shaper: This option defines shaper for the file transfer peers. Shaper with the maximum bandwidth will be selected. Default is none. -

-Examples: -

Examples: +

The simpliest configuration of the module: -

-  {modules,
+  {modules,
    [
     ...
     {mod_proxy65, []},
     ...
   ]}.
-
More complicated configuration.
- -  {acl, proxy_users, {server, "example.org"}}.
+
More complicated configuration.
+  {acl, proxy_users, {server, "example.org"}}.
   {access, proxy65_access, [{allow, proxy_users}, {deny, all}]}.
   ...
   {acl, admin, {user, "admin", "example.org"}}.
@@ -2484,51 +1914,42 @@ The simpliest configuration of the module:
                    {shaper, proxy65_shaper}]},
     ...
   ]}.
-

- - -

6.14 `mod_pubsub`

- + +

3.3.14 `mod_pubsub`

- -This module offers a Publish-Subscribe Service (XEP-0060). +

This module offers a Publish-Subscribe Service (XEP-0060). Publish-Subscribe can be used to develop (examples are taken from the XEP): -

+

news feeds and content syndacation, -
avatar management, -
shared bookmarks, -
auction and trading systems, -
online catalogs, -
workflow systems, -
network management systems, -
NNTP gateways, -
vCard/profile management, -
and weblogs. -
-
- +
avatar management, +
shared bookmarks, +
auction and trading systems, +
online catalogs, +
workflow systems, +
network management systems, +
NNTP gateways, +
vCard/profile management, +
and weblogs. +
+

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 6.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.
access_createnode: - This option restricts which users are allowed to create pubsub nodes using - ACL and ACCESS. The default value is pubsub_createnode.

-Example: -

-  {modules,
+ejabberd's codebase and has contributed several features to mod_pubsub.
Options:
+

+
+hosts
  This option defines the hostnames of the
+service (see section 3.3.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. 
access_createnode
 
+This option restricts which users are allowed to create pubsub nodes using
+ACL and ACCESS. The default value is pubsub_createnode. 
Example:
+
  {modules,
    [
     ...
     {mod_pubsub, [{served_hosts, ["example.com",
@@ -2536,35 +1957,27 @@ Example:
                   {access_createnode, pubsub_createnode}]}
     ...
    ]}.
-
-
-
-6.15  mod_register

-
+

3.3.15 `mod_register`

- -This module adds support for In-Band Registration (XEP-0077). This protocol +

This module adds support for In-Band Registration (XEP-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 6.2.1). -

-Examples: -

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

Examples: +

Next example prohibits the registration of too short account names: -

-  {acl, shortname, {user_glob, "?"}}.
+  {acl, shortname, {user_glob, "?"}}.
   {acl, shortname, {user_glob, "??"}}.
   % The same using regexp:
   %{acl, shortname, {user_regexp, "^..?$"}}.
@@ -2578,13 +1991,12 @@ Next example prohibits the registration of too short account names:
     {mod_register, [{access, register}]},
     ...
    ]}.
-
The in-band registration of new accounts can be prohibited by changing the
- 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}]}.
+
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,
    [
@@ -2592,290 +2004,192 @@ Next example prohibits the registration of too short account names:
 %    {mod_register, [{access, register}]},
     ...
    ]}.
-

- - -

6.16 `mod_roster`

- +

3.3.16 `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 6.2.1). -

- - -

6.17 `mod_service_log`

- +

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

3.3.17 `mod_service_log`

- -This module adds support for logging end user packets via a Jabber message +

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

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

- - -

6.18 `mod_shared_roster`

- +

3.3.18 `mod_shared_roster`

- -This module enables you to create shared roster groups. This means that you can +

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 +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 does not 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: -

+Name: The name of the group, which will be displayed in the roster. +
Description: The description of the group. This parameter does not 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: +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
+ + + + + +
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: +

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

- - -

6.19 `mod_stats`

- +

3.3.19 `mod_stats`

- -This module adds support for Statistics Gathering (XEP-0039). This protocol +

This module adds support for Statistics Gathering (XEP-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 6.2.1). -
-As there are only a small amount of clients (for example +
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 3.3.2). +

As there are only a small amount of clients (for example Tkabber) and software libraries with support for this XEP, 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'>
+(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'>
+
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>
-

- - -

6.20 `mod_time`

- +

3.3.20 `mod_time`

- -This module features support for Entity Time (XEP-0090). By using this XEP, -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 6.2.1). -

- - -

6.21 `mod_vcard`

- +

This module features support for Entity Time (XEP-0090). By using this XEP, +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 3.3.2). +

3.3.21 `mod_vcard`

- -This module allows end users to store and retrieve their vCard, and to retrieve +

This module allows end users to store and retrieve their vCard, and to retrieve other users vCards, as defined in vcard-temp (XEP-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 6.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 6.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: -

+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 3.3.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 3.3.2). +
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,
+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},
@@ -2884,10 +2198,9 @@ In this first situation, search results are limited to twenty items,
                  {search_all_hosts, false}]},
     ...
    ]}.
-
The second situation differs in a way that search results are not limited,
- and that all virtual hosts will be searched instead of only the current one:
- -  {modules,
+
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},
@@ -2895,52 +2208,45 @@ In this first situation, search results are limited to twenty items,
                  {allow_return_all, true}]},
     ...
    ]}.
-

- - -

6.22 `mod_vcard_ldap`

- +

3.3.22 `mod_vcard_ldap`

- -ejabberd can map LDAP attributes to vCard fields. This behaviour is +

ejabberd can map LDAP attributes to vCard fields. This behaviour is implemented in the mod_vcard_ldap module. This module does not depend on the -authentication method (see 5.5.2). The mod_vcard_ldap module has +authentication method (see 3.2.5). The mod_vcard_ldap module has its own optional parameters. The first group of parameters has the same meaning as the top-level LDAP parameters to set the authentication method: ldap_servers, ldap_port, ldap_rootdn, ldap_password, ldap_base, ldap_uids, and -ldap_filter. See section 5.5.2 for detailed information +ldap_filter. See section 3.2.5 for detailed information about these options. If one of these options is not set, ejabberd will look for the top-level option with the same name. The second group of parameters -consists of the following mod_vcard_ldap-specific options: -

- - hosts

This option defines the hostnames of the - service (see section 6.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 6.2.1). -

search

This option specifies whether the search - functionality is enabled (value: true) or disabled (value: - false). If disabled, the option hosts will be ignored and the - Jabber User Directory service will not appear in the Service Discovery item - list. The default value is true. -

ldap_vcard_map

With this option you can - set the table that maps LDAP attributes to vCard fields. The format is: - [Name_of_vCard_field, Pattern, List_of_LDAP_attributes, ...]. - Name_of_vcard_field is the type name of the vCard as defined in - RFC 2426. Pattern is a - string which contains pattern variables "%u", "%d" or - "%s". List_of_LDAP_attributes is the list containing LDAP - attributes. The pattern variables "%s" will be sequentially replaced - with the values of LDAP attributes from List_of_LDAP_attributes, - "%u" will be replaced with the user part of a JID, and "%d" - will be replaced with the domain part of a JID. The default is: -

-  [{"NICKNAME", "%u", []},
+consists of the following mod_vcard_ldap-specific options:

+
+hosts
  This option defines the hostnames of the
+service (see section 3.3.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 3.3.2).
+
search
This option specifies whether the search
+functionality is enabled (value: true) or disabled (value:
+false). If disabled, the option hosts will be ignored and the
+Jabber User Directory service will not appear in the Service Discovery item
+list. The default value is true.
+
ldap_vcard_map
With this option you can
+set the table that maps LDAP attributes to vCard fields. The format is:
+[Name_of_vCard_field, Pattern, List_of_LDAP_attributes, ...].
+Name_of_vcard_field is the type name of the vCard as defined in
+RFC 2426. Pattern is a
+string which contains pattern variables "%u", "%d" or
+"%s". List_of_LDAP_attributes is the list containing LDAP
+attributes. The pattern variables "%s" will be sequentially replaced
+with the values of LDAP attributes from List_of_LDAP_attributes,
+"%u" will be replaced with the user part of a JID, and "%d"
+will be replaced with the domain part of a JID. The default is:
+  [{"NICKNAME", "%u", []},
    {"FN", "%s", ["displayName"]},
    {"FAMILY", "%s", ["sn"]},
    {"GIVEN", "%s", ["givenName"]},
@@ -2960,14 +2266,13 @@ the processing discipline for vcard-temp IQ queries
    {"BDAY", "%s", ["birthDay"]},
    {"ROLE", "%s", ["employeeType"]},
    {"PHOTO", "%s", ["jpegPhoto"]}]
-
ldap_search_fields
This option
- defines the search form and the LDAP attributes to search within. The format
- is: [Name, Attribute, ...]. Name is the name of a search form
- field which will be automatically translated by using the translation
- files (see msgs/*.msg for available words). Attribute is the
- LDAP attribute or the pattern "%u". The default is:
- -  [{"User", "%u"},
+
ldap_search_fields
This option
+defines the search form and the LDAP attributes to search within. The format
+is: [Name, Attribute, ...]. Name is the name of a search form
+field which will be automatically translated by using the translation
+files (see msgs/*.msg for available words). Attribute is the
+LDAP attribute or the pattern "%u". The default is:
+  [{"User", "%u"},
    {"Full Name", "displayName"},
    {"Given Name", "givenName"},
    {"Middle Name", "initials"},
@@ -2979,15 +2284,14 @@ the processing discipline for vcard-temp IQ queries
    {"Email", "mail"},
    {"Organization Name", "o"},
    {"Organization Unit", "ou"}]
-
ldap_search_reported
This option
- defines which search fields should be reported. The format is:
- [Name, vCard_Name, ...]. Name is the name of a search form
- field which will be automatically translated by using the translation
- files (see msgs/*.msg for available words). vCard_Name is the
- vCard field name defined in the ldap_vcard_map option. The default
- is:
--  [{"Full Name", "FN"},
+
ldap_search_reported
This option
+defines which search fields should be reported. The format is:
+[Name, vCard_Name, ...]. Name is the name of a search form
+field which will be automatically translated by using the translation
+files (see msgs/*.msg for available words). vCard_Name is the
+vCard field name defined in the ldap_vcard_map option. The default
+is:
+  [{"Full Name", "FN"},
    {"Given Name", "GIVEN"},
    {"Middle Name", "MIDDLE"},
    {"Family Name", "FAMILY"},
@@ -2998,30 +2302,22 @@ the processing discipline for vcard-temp IQ queries
    {"Email", "EMAIL"},
    {"Organization Name", "ORGNAME"},
    {"Organization Unit", "ORGUNIT"}]
-
-Examples:
-
-

-

-Let's say ldap.example.org is the name of our LDAP server. We have
+

Examples: +

-  %% authentication method
+authentication section should looks like this:
  %% authentication method
   {auth_method, ldap}.
   %% DNS name of our LDAP server
   {ldap_servers, ["ldap.example.org"]}.
   %% We want to authorize users from 'shadowAccount' object class only
   {ldap_filter, "(objectClass=shadowAccount)"}.
-
-Now we want to use users LDAP-info as their vCards. We have four attributes
-defined in our LDAP schema: "mail" — email address, "givenName"
-— first name, "sn" — second name, "birthDay" — birthday.
-Also we want users to search each other. Let's see how we can set it up:
--  {modules,
+
Now we want to use users LDAP-info as their vCards. We have four attributes
+defined in our LDAP schema: "mail" — email address, "givenName"
+— first name, "sn" — second name, "birthDay" — birthday.
+Also we want users to search each other. Let's see how we can set it up:
  {modules,
     ...
     {mod_vcard_ldap,
      [
@@ -3062,132 +2358,74 @@ Also we want users to search each other. Let's see how we can set it up:
     ]}
     ...
   }.
-
-Note that mod_vcard_ldap module checks an existence of the user before
-searching his info in LDAP.

-

-ldap_vcard_map example:
--  {ldap_vcard_map,
+
Note that mod_vcard_ldap module checks an existence of the user before
+searching his info in LDAP.
ldap_vcard_map example:
+  {ldap_vcard_map,
    [{"NICKNAME", "%u", []},
     {"FN", "%s", ["displayName"]},
     {"CTRY", "Russia", []},
     {"EMAIL", "%u@%d", []},
     {"DESC", "%s\n%s", ["title", "description"]}
    ]},
-
ldap_search_fields example:
--  {ldap_search_fields,
+
ldap_search_fields example:
+  {ldap_search_fields,
    [{"User", "uid"},
     {"Full Name", "displayName"},
     {"Email", "mail"}
    ]},
-
ldap_search_reported example:
--  {ldap_search_reported,
+
ldap_search_reported example:
+  {ldap_search_reported,
    [{"Full Name", "FN"},
     {"Email", "EMAIL"},
     {"Birthday", "BDAY"},
     {"Nickname", "NICKNAME"}
    ]},
-

- - -

6.23 `mod_version`

- + +

3.3.23 `mod_version`

- -This module implements Software Version (XEP-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 6.2.1). -

- - -

7 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 8.2): -
```
-% ejabberdctl node@host register admin example.org password
-
```
2. Using In-Band Registration (see section 6.15): 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. -

- - -

8 Online Configuration and Monitoring

- - - - -

8.1 Web Interface

- +

This module implements Software Version (XEP-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 3.3.2). +

Chapter 4 Managing an ejabberd server

4.1 Online Configuration and Monitoring

4.1.1 Web Interface

- -To perform online configuration of ejabberd you need to enable the +

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

- - - +you will see a page similar to figure 4.1.
-
-
-
Figure 1: Top page from the web interface

-
+ - -
+ +
+
Figure 4.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: -

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

-  ...
+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}]}.
@@ -3200,12 +2438,11 @@ You can serve the web interface on the same port as the
     ...
    ]
   }.
-
For security reasons, you can serve the web interface on a secured
- 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/:
- -  ...
+
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,
@@ -3216,18 +2453,13 @@ You can serve the web interface on the same port as the
     ...
    ]
   }.
-

- - -

8.2 `ejabberdctl`

- +

4.1.2 `ejabberdctl`

- -It is possible to do some administration operations using the command +

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
+
% ejabberdctl
 Usage: ejabberdctl node command
 
 Available commands:
@@ -3249,262 +2481,182 @@ Available commands:
 
 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 other software to ejabberd.
-
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.
-
-
-
-9  Firewall Settings

-
+

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 other software to ejabberd. +
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. +

Chapter 5 Securing ejabberd

5.1 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 11).
port range Only for clustring (see 11). This range - is configurable (see 2.4).
-

- - -

10 SRV Records

- +

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 7).
port range Only for clustring (see 7). This range +is configurable (see 2.2.4).
+

Chapter 6 Integrating ejabberd with other Instant Messaging servers

6.1 SRV Records

- -

+
- General information: - SRV record -
- Practical information: - Setting DNS SRV Records -
- - -
11 Clustering
- +SRV record +
Practical information: +Setting DNS SRV Records +

Chapter 7 Clustering

- - - -

11.1 How it Works

- +

7.1 How it Works

- -A Jabber domain is served by one or more ejabberd nodes. These nodes can +

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

+connections, registered services, etc…
Each ejabberd node has the following modules: +
- router, -
- local router, -
- session manager, -
- s2s manager. -
- - -
11.1.1 Router
- +
local router, +
session manager, +
s2s manager. +

7.1.1 Router

- -This module is the main router of Jabber packets on each node. It +

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

11.1.2 Local Router

- +appropriate process. If not, it is sent to the s2s manager.

7.1.2 Local Router

- -This module routes packets which have a destination domain equal to +

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

11.1.3 Session Manager

- +on its content.

7.1.3 Session Manager

- -This module routes packets to local users. It looks up to which user +

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

11.1.4 s2s Manager

- +storage, or bounced back.

7.1.4 s2s Manager

- -This module routes packets to other Jabber servers. First, it +

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

11.2 Clustering Setup

- +serving this connection, otherwise a new connection is opened.

7.2 Clustering Setup

- -Suppose you already configured ejabberd on one machine named (first), +

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

+following steps:
1. 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.
  -
  -
2. On second run the following command as the ejabberd daemon user, - in the working directory of ejabberd: -
```
-erl -sname ejabberd \
+second.(alt) You can also add `-cookie content_of_.erlang.cookie'
+option to all `erl' commands below.
```
3. On second run the following command as the ejabberd daemon user, +in the working directory of ejabberd:
```
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]
-
```
  -
  -
4. 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 the scheme table to `RAM and disc - copy' on the second node via the web interface.
  -
  -
5. 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.
  -
  -
6. 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.
  -
  -
7. Now run ejabberd on second with almost the same config as - on first (you probably do not 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 Internationalization and Localization
- +
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 the 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 do not 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.

7.3 Service Load-Balancing

7.3.1 Components Load-Balancing

+ +

7.3.2 Domain Load-Balancing Algorithm

+ +

ejabberd includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.

The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances.

If you need a different behaviour, you can change the load balancing behaviour with the option domain_balancing. The syntax of the option is the following:

 {domain_balancing, "component.example.com", <balancing_criterium>}.                                   
+

Several balancing criteria are available: +

+destination: the full JID of the packet to attribute is used. +
source: the full JID of the packet from attribute is used. +
bare_destination: the bare JID (without resource) of the packet to attribute is used. +
bare_source: the bare JID (without resource) of the packet from attribute is used. +

If the value corresponding to the criterium is the same, the same component instance in the cluster will be used.

7.3.3 Load-Balancing Buckets

+ +

When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced.

In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the domain_balancing_component_number option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.

The syntax is the following: +

    {domain_balancing_component_number, "component.example.com", N}
+

Chapter 8 Debugging

+ +

8.1 Watchdog alerts

+ +

ejabberd includes a watchdog mechanism to notify admins in realtime +through XMPP when any process consumes too much memory.

To enable the watchdog, add the watchdog_admins + option in the config file:

{watchdog_admins, [``admin@localhost'']}.
+

Appendix A 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'
+
All built-in modules support the xml:lang attribute inside IQ queries.
+Figure A.1, 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'

-
+
+
Figure A.1: Service Discovery when xml:lang='ru'
+ +

The web interface also supports the Accept-Language HTTP header (compare +figure A.2 with figure 4.1)

- -

- +

B Release Notes

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

+ +

Appendix B Release Notes

- - - -

B.1 ejabberd 0.9

- -

-       Release notes
+

+B.1  ejabberd 0.9
       Release notes
         ejabberd 0.9
 
     This document describes the major new features of and changes to
@@ -3592,13 +2744,8 @@ 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.
-
-
-
-B.2  ejabberd 0.9.1

-
--       Release notes
+

+B.2  ejabberd 0.9.1
       Release notes
        ejabberd 0.9.1
 
    This document describes the main changes from [25]ejabberd 0.9.
@@ -3660,13 +2807,8 @@ 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.
-
-
-
-B.3  ejabberd 0.9.8

-
--       Release notes
+

+B.3  ejabberd 0.9.8
       Release notes
        ejabberd 0.9.8
          2005-08-01
 
@@ -3765,13 +2907,8 @@ References
 
 END
 
-
-
-
-B.4  ejabberd 1.0.0

-
--       Release Notes
+

+B.4  ejabberd 1.0.0
       Release Notes
        ejabberd 1.0.0
        14 December 2005
 
@@ -3891,13 +3028,8 @@ References
 
 END
 
-
-
-
-B.5  ejabberd 1.1.0

-
--    Release Notes
+

+B.5  ejabberd 1.1.0
    Release Notes
     ejabberd 1.1.0
     24 April 2006
 
@@ -4012,13 +3144,8 @@ References
      http://ejabberd.jabber.ru/faq
 
 END
-
-
-
-B.6  ejabberd 1.1.1

-
--    Release Notes
+

+B.6  ejabberd 1.1.1
    Release Notes
     ejabberd 1.1.1 
     28 April 2006
 
@@ -4137,13 +3264,8 @@ References
      http://ejabberd.jabber.ru/faq
 
 END
-
-
-
-B.7  ejabberd 1.1.2

-
--    Release Notes
+

+B.7  ejabberd 1.1.2
    Release Notes
     ejabberd 1.1.2
          27 September 2006
 
@@ -4262,49 +3384,35 @@ References
      http://ejabberd.jabber.ru/faq
 
 END
-
-
-
-C  Acknowledgements

-
+

Appendix C Acknowledgements

Thanks to all people who contributed to this guide: -

+
- Alexey Shchepin (xmpp:aleksey@jabber.ru) -
- Badlop (xmpp:badlop@jabberes.org) -
- Evgeniy Khramtsov (xmpp:xram@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) -
- - -
D Copyright Information
- - -Ejabberd Installation and Operation Guide.
-Copyright © January 23, 2003 — Alexey Shchepin
-
-This document is free software; you can redistribute it and/or +
Badlop (xmpp:badlop@jabberes.org) +
Evgeniy Khramtsov (xmpp:xram@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) +

Appendix D Copyright Information

This document is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 -of the License, or (at your option) any later version.
-
-This document is distributed in the hope that it will be useful, +of the License, or (at your option) any later version.

This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with +GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this document; if not, write to the Free Software Foundation, Inc., 51 Franklin -Street, Fifth Floor, Boston, MA 02110-1301, USA.
-
+Street, Fifth Floor, Boston, MA 02110-1301, USA.

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

+H^EV^EA. diff --git a/doc/guide.tex b/doc/guide.tex index 69a62eb4b..deb4ca7fc 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1,17 +1,30 @@ -\documentclass[a4paper,10pt]{article} +\documentclass[a4paper,10pt]{book} %% Packages \usepackage{float} \usepackage{graphics} \usepackage{hevea} \usepackage[pdftex,colorlinks,unicode,urlcolor=blue,linkcolor=blue, - pdftitle=Ejabberd\ Installation\ and\ Operation\ Guide,pdfauthor=Alexey\ - Shchepin,pdfsubject=ejabberd,pdfkeywords=ejabberd, + pdftitle=Ejabberd\ Installation\ and\ Operation\ Guide,pdfauthor=Process-one,pdfsubject=ejabberd,pdfkeywords=ejabberd, pdfpagelabels=false]{hyperref} \usepackage{makeidx} %\usepackage{showidx} % Only for verifying the index entries. \usepackage{verbatim} \usepackage{geometry} +\usepackage{fancyhdr} + +\pagestyle{fancy} %Forces the page to use the fancy template +\renewcommand{\chaptermark}[1]{\markboth{\textbf{\thechapter}.\ \emph{#1}}{}} +\renewcommand{\sectionmark}[1]{\markright{\thesection\ \boldmath\textbf{#1}\unboldmath}} +\fancyhf{} +\fancyhead[LE,RO]{\textbf{\thepage}} %Displays the page number in bold in the header, + % to the left on even pages and to the right on odd pages. +\fancyhead[RE]{\nouppercase{\leftmark}} %Displays the upper-level (chapter) information--- + % as determined above---in non-upper case in the header, to the right on even pages. +\fancyhead[LO]{\rightmark} %Displays the lower-level (section) information---as + % determined above---in the header, to the left on odd pages. +\renewcommand{\headrulewidth}{0.5pt} %Underlines the header. (Set to 0pt if not required). +\renewcommand{\footrulewidth}{0.5pt} %Underlines the footer. (Set to 0pt if not required). %% Index \makeindex @@ -75,8 +88,7 @@ %% Common options \newcommand{\iqdiscitem}[1]{\titem{iqdisc} \ind{options!iqdisc}This specifies -the processing discipline for #1 IQ queries -(see section~\ref{modiqdiscoption}).} +the processing discipline for #1 IQ queries (see section~\ref{modiqdiscoption}).} \newcommand{\hostitem}[1]{ \titem{hosts} \ind{options!hosts} This option defines the hostnames of the service (see section~\ref{modhostsoption}). If neither \texttt{hosts} nor @@ -84,21 +96,36 @@ the processing discipline for #1 IQ queries \ejabberd{} hostnames. } -%\newcommand{\quoting}[2][yozhik]{\begin{quotation}\textcolor{#1}{\textit{#2}}\end{quotation}} % Quotes enabled -%\renewcommand{command}[args][default]{def} -%\renewcommand{\headrule}{{\color{ejblue}% -%\hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}} - %% Title page \include{version} -\title{Ejabberd \version\ Installation and Operation Guide} -\author{ejabberd development Team} +\newlength{\larg} +\setlength{\larg}{14.5cm} +\title{ +{\rule{\larg}{1mm}}\vspace{7mm} +\begin{tabular}{p{4cm} r} + & {\huge {\bf ejabberd \version\ }} \\ + & \\ + & {\huge Installation and Operation Guide} +\end{tabular}\\ +\vspace{2mm} +{\rule{\larg}{1mm}} +\vspace{2mm} \\ +\begin{tabular}{p{11cm} r} + & {\large \bf \today} +\end{tabular}\\ +\vspace{5.5cm} +} +\author{\begin{tabular}{p{13.7cm}} +ejabberd Development Team +\end{tabular}} +\date{} + %% Options \newcommand{\marking}[1]{#1} % Marking disabled \newcommand{\quoting}[2][yozhik]{} % Quotes disabled -\newcommand{\new}{\marginpar{\textsc{new}}} % Highlight new features -\newcommand{\improved}{\marginpar{\textsc{improved}}} % Highlight improved features +%\newcommand{\new}{\marginpar{\textsc{new}}} % Highlight new features +%\newcommand{\improved}{\marginpar{\textsc{improved}}} % Highlight improved features %% To by-pass errors in the HTML version. \newstyle{SPAN}{width:20\%; float:right; text-align:left; margin-left:auto;} @@ -119,14 +146,15 @@ the processing discipline for #1 IQ queries \begin{titlepage} \maketitle{} - \begin{center} - {\insscaleimg{\logoscale}{logo.png} - \par - } - \end{center} +%% Commenting. Breaking clean layout for now: +%% \begin{center} +%% {\insscaleimg{\logoscale}{logo.png} +%% \par +%% } +%% \end{center} - \begin{quotation}\textit{I can thoroughly recommend ejabberd for ease of setup --- - Kevin Smith, Current maintainer of the Psi project}\end{quotation} +%% \begin{quotation}\textit{I can thoroughly recommend ejabberd for ease of setup --- +%% Kevin Smith, Current maintainer of the Psi project}\end{quotation} \end{titlepage} @@ -142,6 +170,17 @@ the processing discipline for #1 IQ queries % Input introduction.tex \input{introduction} +\chapter{Installing ejabberd} +\section{Installing ejabberd with Graphical Installer} + +The easiest approach to install an ejabberd Instant Messaging server +is to use the graphical installer. The installer is available from +Process-one +website\footahref{http://www.process-one.net/en/ejabberd/downloads/}. + +The installer will deploy and configure a full featured ejabberd +server and does not require any extra dependancies. + \section{Installation from Source} \label{installsource} \ind{installation} @@ -307,7 +346,41 @@ To reduce memory usage, you may set the environment variable \end{verbatim} But in this case \ejabberd{} can start to work slower. +\section{Creating an Initial Administrator} +\label{initialadmin} + +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: +\begin{enumerate} +\item Register an account on your \ejabberd{} deployment. An account can be + created in two ways: + \begin{enumerate} + \item Using the tool \term{ejabberdctl}\ind{ejabberdctl} (see + section~\ref{ejabberdctl}): + \begin{verbatim} +% ejabberdctl node@host register admin example.org password +\end{verbatim} + \item Using In-Band Registration (see section~\ref{modregister}): you can + use a \Jabber{} client to register an account. + \end{enumerate} +\item 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. + \begin{verbatim} + {acl, admins, {user, "admin", "example.org"}}. + {access, configure, [{allow, admins}]}. +\end{verbatim} +\item Restart \ejabberd{} to load the new configuration. +\item Open the web interface (\verb|http://server:port/admin/|) in your + favourite browser. Make sure to enter the \emph{full} JID as username (in this + example: \jid{admin@example.org}. The reason that you also need to enter the + suffix, is because \ejabberd{}'s virtual hosting support. +\end{enumerate} + + +\chapter{Configuring ejabberd} \section{Basic Configuration} \label{basicconfig} \ind{configuration file} @@ -905,48 +978,6 @@ Examples: \end{verbatim} \end{itemize} -\section{Advanced configuration} -\subsection{Components Load-Balancing} -\label{componentlb} -\ind{component load-balancing} - -\subsection{Domain Load-Balancing Algorithm} -\label{domainlb} -\ind{options!domain\_balancing} - -\ejabberd{} includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed. - -The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances. - -If you need a different behaviour, you can change the load balancing behaviour with the option \option{domain\_balancing}. The syntax of the option is the following: - -\begin{verbatim} - {domain_balancing, "component.example.com", }. -\end{verbatim} - -Several balancing criteria are available: -\begin{itemize} -\item \term{destination}: the full JID of the packet \term{to} attribute is used. -\item \term{source}: the full JID of the packet \term{from} attribute is used. -\item \term{bare\_destination}: the bare JID (without resource) of the packet \term{to} attribute is used. -\item \term{bare\_source}: the bare JID (without resource) of the packet \term{from} attribute is used. -\end{itemize} - -If the value corresponding to the criterium is the same, the same component instance in the cluster will be used. - -\subsection{Load-Balancing Buckets} -\label{lbbuckets} -\ind{options!domain\_balancing\_component\_number} - -When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced. - -In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the \term{domain\_balancing\_component\_number} option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances. - -The syntax is the following: -\begin{verbatim} - {domain_balancing_component_number, "component.example.com", N} -\end{verbatim} - \section{Database and LDAP Configuration} \label{database} \ind{database} @@ -2884,41 +2915,7 @@ Options: \iqdiscitem{Software Version (\ns{jabber:iq:version})} \end{description} - -\section{Creating an Initial Administrator} -\label{initialadmin} - -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: -\begin{enumerate} -\item Register an account on your \ejabberd{} deployment. An account can be - created in two ways: - \begin{enumerate} - \item Using the tool \term{ejabberdctl}\ind{ejabberdctl} (see - section~\ref{ejabberdctl}): - \begin{verbatim} -% ejabberdctl node@host register admin example.org password -\end{verbatim} - \item Using In-Band Registration (see section~\ref{modregister}): you can - use a \Jabber{} client to register an account. - \end{enumerate} -\item 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. - \begin{verbatim} - {acl, admins, {user, "admin", "example.org"}}. - {access, configure, [{allow, admins}]}. -\end{verbatim} -\item Restart \ejabberd{} to load the new configuration. -\item Open the web interface (\verb|http://server:port/admin/|) in your - favourite browser. Make sure to enter the \emph{full} JID as username (in this - example: \jid{admin@example.org}. The reason that you also need to enter the - suffix, is because \ejabberd{}'s virtual hosting support. -\end{enumerate} - - +\chapter{Managing an ejabberd server} \section{Online Configuration and Monitoring} \label{onlineconfig} @@ -3040,7 +3037,7 @@ Additional information: is very high. \end{description} - +\chapter{Securing ejabberd} \section{Firewall Settings} \label{firewall} \ind{firewall}\ind{ports}\ind{SASL}\ind{TLS}\ind{clustering!ports} @@ -3060,7 +3057,7 @@ You need to take the following TCP ports in mind when configuring your firewall: \end{tabular} \end{table} - +\chapter{Integrating ejabberd with other Instant Messaging servers} \section{SRV Records} \label{srv} \ind{SRV Records}\ind{clustering!SRV Records} @@ -3072,12 +3069,11 @@ You need to take the following TCP ports in mind when configuring your firewall: \footahref{http://jabberd.jabberstudio.org/2/docs/section05.html\#5\_7}{Setting DNS SRV Records} \end{itemize} - -\section{Clustering} +\chapter{Clustering} \label{clustering} \ind{clustering} -\subsection{How it Works} +\section{How it Works} \label{howitworks} \ind{clustering!how it works} @@ -3097,7 +3093,7 @@ Each \ejabberd{} node has the following modules: \item s2s manager. \end{itemize} -\subsubsection{Router} +\subsection{Router} \label{router} \ind{clustering!router} @@ -3107,7 +3103,7 @@ 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. -\subsubsection{Local Router} +\subsection{Local Router} \label{localrouter} \ind{clustering!local router} @@ -3116,7 +3112,7 @@ 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. -\subsubsection{Session Manager} +\subsection{Session Manager} \label{sessionmanager} \ind{clustering!session manager} @@ -3125,7 +3121,7 @@ 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. -\subsubsection{s2s Manager} +\subsection{s2s Manager} \label{s2smanager} \ind{clustering!s2s manager} @@ -3135,7 +3131,7 @@ 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. -\subsection{Clustering Setup} +\section{Clustering Setup} \label{cluster} \ind{clustering!setup} @@ -3217,17 +3213,61 @@ mnesia:change_table_copy_type(schema, node(), disc_copies). You can repeat these steps for other machines supposed to serve this domain. +\section{Service Load-Balancing} +\subsection{Components Load-Balancing} +\label{componentlb} +\ind{component load-balancing} + +\subsection{Domain Load-Balancing Algorithm} +\label{domainlb} +\ind{options!domain\_balancing} + +\ejabberd{} includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed. + +The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances. + +If you need a different behaviour, you can change the load balancing behaviour with the option \option{domain\_balancing}. The syntax of the option is the following: + +\begin{verbatim} + {domain_balancing, "component.example.com", }. +\end{verbatim} + +Several balancing criteria are available: +\begin{itemize} +\item \term{destination}: the full JID of the packet \term{to} attribute is used. +\item \term{source}: the full JID of the packet \term{from} attribute is used. +\item \term{bare\_destination}: the bare JID (without resource) of the packet \term{to} attribute is used. +\item \term{bare\_source}: the bare JID (without resource) of the packet \term{from} attribute is used. +\end{itemize} + +If the value corresponding to the criterium is the same, the same component instance in the cluster will be used. + +\subsection{Load-Balancing Buckets} +\label{lbbuckets} +\ind{options!domain\_balancing\_component\_number} + +When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced. + +In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the \term{domain\_balancing\_component\_number} option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances. + +The syntax is the following: +\begin{verbatim} + {domain_balancing_component_number, "component.example.com", N} +\end{verbatim} + + + % TODO % See also the section about ejabberdctl!!!! %\section{Backup and Restore} %\label{backup} %\ind{backup} -\section{Debugging} +\chapter{Debugging} \label{debugging} \ind{debugging} -\subsection{Watchdog alerts} +\section{Watchdog alerts} \label{watchdog} \ind{debugging!watchdog} @@ -3242,7 +3282,7 @@ To enable the watchdog, add the \term{watchdog\_admins} \end{verbatim} \appendix{} -\section{Internationalization and Localization} +\chapter{Internationalization and Localization} \label{i18nl10n} \ind{xml:lang}\ind{internationalization}\ind{localization}\ind{i18n}\ind{l10n} @@ -3281,32 +3321,32 @@ figure~\ref{fig:webadmmainru} with figure~\ref{fig:webadmmain}) %TODO: a very big example covering the whole guide, with a good explanation before the example: different authenticaton mechanisms, transports, ACLs, multple virtual hosts, virtual host specific settings and general settings, modules,... \newpage -\section{Release Notes} +\chapter{Release Notes} \label{releasenotes} \ind{release notes} -\subsection{ejabberd 0.9} +\section{ejabberd 0.9} \verbatiminput{release_notes_0.9.txt} -\subsection{ejabberd 0.9.1} +\section{ejabberd 0.9.1} \verbatiminput{release_notes_0.9.1.txt} -\subsection{ejabberd 0.9.8} +\section{ejabberd 0.9.8} \verbatiminput{release_notes_0.9.8.txt} -\subsection{ejabberd 1.0.0} +\section{ejabberd 1.0.0} \verbatiminput{release_notes_1.0.0.txt} -\subsection{ejabberd 1.1.0} +\section{ejabberd 1.1.0} \verbatiminput{release_notes_1.1.0.txt} -\subsection{ejabberd 1.1.1} +\section{ejabberd 1.1.1} \verbatiminput{release_notes_1.1.1.txt} -\subsection{ejabberd 1.1.2} +\section{ejabberd 1.1.2} \verbatiminput{release_notes_1.1.2.txt} -\section{Acknowledgements} +\chapter{Acknowledgements} \label{acknowledgements} Thanks to all people who contributed to this guide: \begin{itemize} @@ -3322,7 +3362,7 @@ Thanks to all people who contributed to this guide: \end{itemize} -\section{Copyright Information} +\chapter{Copyright Information} \label{copyright} Ejabberd Installation and Operation Guide.\\ diff --git a/doc/introduction.tex b/doc/introduction.tex index cdbb214e1..658f0eb03 100644 --- a/doc/introduction.tex +++ b/doc/introduction.tex @@ -1,6 +1,8 @@ -\section{Introduction} +\chapter{Introduction} \label{intro} +%% TODO: improve the feature sheet with a nice table to highlight new features. + \quoting{I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. --- Joeri} @@ -38,7 +40,7 @@ Joeri} %\end{itemize} \newpage -\subsection{Key Features} +\section{Key Features} \label{keyfeatures} \ind{features!key features} @@ -56,17 +58,17 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation} \item \marking{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: \begin{itemize} \item Comprehensive documentation. -\item Straightforward installers for Linux, Mac OS X, and Windows.\improved{} +\item Straightforward installers for Linux, Mac OS X, and Windows. %%\improved{} \item Web interface for administration tasks. \item Shared Roster Groups. -\item Command line administration tool.\improved{} +\item Command line administration tool. %%\improved{} \item Can integrate with existing authentication mechanisms. \item Capability to send announce messages. \end{itemize} \item \marking{Internationalized:} \ejabberd{} leads in internationalization. Hence it is very well suited in a globalized world. Related features are: \begin{itemize} -\item Translated in 12 languages.\improved{} +\item Translated in 12 languages. %%\improved{} \item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}. \end{itemize} @@ -81,7 +83,7 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation} \newpage -\subsection{Additional Features} +\section{Additional Features} \label{addfeatures} \ind{features!additional features} @@ -107,11 +109,11 @@ Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features \item Native PostgreSQL support. \item Mnesia. \item ODBC data storage support. -\item Microsoft SQL Server support.\new{} +\item Microsoft SQL Server support. %%\new{} \end{itemize} \item Authentication \begin{itemize} -\item LDAP and ODBC.\improved{} +\item LDAP and ODBC. %%\improved{} \item External Authentication script. \item Internal Authentication. \end{itemize} @@ -121,7 +123,7 @@ Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features \item Interface with networks such as AIM, ICQ and MSN. \item Statistics via Statistics Gathering (\xepref{0039}). \item IPv6 support both for c2s and s2s connections. -\item \txepref{0045}{Multi-User Chat} module with logging.\improved{} +\item \txepref{0045}{Multi-User Chat} module with logging. %%\improved{} \item Users Directory based on users vCards. \item \txepref{0060}{Publish-Subscribe} component. \item Support for virtual hosting. diff --git a/doc/version.tex b/doc/version.tex index f51f8de60..4ab44c01d 100644 --- a/doc/version.tex +++ b/doc/version.tex @@ -1,2 +1,2 @@ % ejabberd version (automatically generated). -\newcommand{\version}{1.1.2} +\newcommand{\version}{2.0.0 beta 1} -- cgit v1.2.3

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

Module	Feature	Dependencies	Needed for XMPP?
`mod_adhoc`	Ad-Hoc Commands (XEP-0050)		No
`mod_announce`	Manage announcements	`mod_adhoc`	No
`mod_configure`	Support for online	`mod_adhoc`	No
	configuration of `ejabberd`
`mod_disco`	Service Discovery (XEP-0030)		No
`mod_echo`	Echoes Jabber packets		No
`mod_irc`	IRC transport		No
`mod_last`	Last Activity (XEP-0012)		No
`mod_last_odbc`	Last Activity (XEP-0012)	supported database (*)	No
`mod_muc`	Multi-User Chat (XEP-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	supported database (*)	No
`mod_privacy`	Blocking Communication		Yes
`mod_private`	Private XML Storage (XEP-0049)		No
`mod_private_odbc`	Private XML Storage (XEP-0049)	supported database (*)	No
`mod_proxy65`	SOCKS5 Bytestreams (XEP-0065)		No
`mod_pubsub`	Publish-Subscribe (XEP-0060)		No
`mod_register`	In-Band Registration (XEP-0077)		No
`mod_roster`	Roster management		Yes (**)
`mod_roster_odbc`	Roster management	supported database (*)	Yes (**)
`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 (XEP-0039)		No
`mod_time`	Entity Time (XEP-0090)		No
`mod_vcard`	vcard-temp (XEP-0054)		No
`mod_vcard_ldap`	vcard-temp (XEP-0054)	LDAP server	No
`mod_vcard_odbc`	vcard-temp (XEP-0054)	supported database (*)	No
`mod_version`	Software Version (XEP-0092)		No

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

Ejabberd 1.1.2 Developers Guide

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

Ejabberd 2.0.0beta1 Developers Guide

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

Contents

Contents

1 Introduction

1.1 Key Features

1 Key Features

1.2 Additional Features

2 Additional Features

2 How it Works

3 How it Works

2.1 Router

3.1 Router

2.2 Local Router

3.2 Local Router

2.3 Session Manager

3.3 Session Manager

2.4 S2S Manager

3.4 S2S Manager

3 XML Representation

4 XML Representation

4 Module xml

5 Module xml

5 Module xml_stream

6 Module xml_stream

6 Modules

6.1 Module gen_iq_handler

7 Modules

7.1 Module gen_iq_handler

6.2 Services

7.2 Services

Ejabberd 1.1.2 Feature Sheet

Sander Devrieze -mailto:s.devrieze@pandora.be -xmpp:sander@devrieze.dyndns.org

Ejabberd 2.0.0beta1 Feature Sheet

Sander Devrieze + mailto:s.devrieze@pandora.be + xmpp:sander@devrieze.dyndns.org

Introduction

Key Features

Key Features

Additional Features

Additional Features

Ejabberd 1.1.2 Installation and Operation Guide

ejabberd development Team

Contents

+ejabberd Development Team

Contents

1 Introduction

1.1 Key Features

Chapter 1 Introduction

1.1 Key Features

1.2 Additional Features

1.2 Additional Features

2 Installation from Source

Chapter 2 Installing ejabberd

2.1 Installing ejabberd with Graphical Installer

2.2 Installation from Source

2.1 Installation Requirements

2.2.1 Installation Requirements

2.1.1 `Unix-like' operating systems

`Unix-like' operating systems

2.1.2 Windows

Windows

2.2 Obtaining ejabberd

2.2.2 Obtaining ejabberd

2.3 Compilation

2.2.3 Compilation

2.3.1 `Unix-like' operating systems

`Unix-like' operating systems

2.3.2 Windows

Windows

2.4 Starting

2.2.4 Starting

3 Basic Configuration

2.3 Creating an Initial Administrator

Chapter 3 Configuring ejabberd

3.1 Basic Configuration

3.1 Host Names

3.1.1 Host Names

3.2 Virtual Hosting

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

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

4 Module `xml`

5 Module `xml`

5 Module `xml_stream`

6 Module `xml_stream`

Sander Devrieze
-`mailto:s.devrieze@pandora.be`
-`xmpp:sander@devrieze.dyndns.org`

Sander Devrieze
+ `mailto:s.devrieze@pandora.be`
+ `xmpp:sander@devrieze.dyndns.org`

+
ejabberd Development Team

2.2 Obtaining `ejabberd`

2.2.2 Obtaining `ejabberd`