@@ -29,99 +34,99 @@
-
1 Introduction
+
1 Introduction
-
ejabberd is a Free and Open Source distributed fault-tolerant Jabber
-server. It writen mostly in Erlang.
+
+
ejabberd is a Free and Open Source distributed fault-tolerant Jabber
+server. It is writen mostly in Erlang.
Main features of ejabberd is:
-
--
- Distribution. You can run ejaberd on cluster of machines and all them
- will serve one Jabber domain.
-
-
- Fault-tolerance. You can setup ejabberd cluster in such way, that all
- information required for properly working will be stored permanently on more
- then one machine, so if one of them crashed, then all other ones continue
- working without any pauses. Also you can replace or add more machines ``on
- the fly''.
-
-
- Support of JEP-0030
+
-
+Distributed. You can run ejabberd on a cluster of machines and
+ all of them will serve one Jabber domain.
+
- Fault-tolerance. You can setup an ejabberd cluster so that all
+ information required for a properly working service will be stored
+ permanently on more then one node. This means that if one of the
+ nodes crashed, then the others continue working without disruption.
+ You can also add or replace more nodes ``on the fly''.
+
- Support for
+ JEP-0030
(Service Discovery).
-
-
- Support of JEP-0039
+
- Support for
+ JEP-0039
(Statistics Gathering).
+
- Support for xml:lang attribute in many XML elements.
+
- JUD based on users vCards.
+
+
- - Support of xml:lang attribute in many XML elements.
+
2 Installation
- - JUD based on users vCards.
-
+
+
-
2 Installation
+
2.1 Installation Requirements
-
+
+To compile
ejabberd, you need following packages:
+
-
+GNU Make;
+
- GCC;
+
- libexpat 1.95 or later;
+
- Erlang/OTP R8B or later.
+
+
-
2.1 Installation Requirements
+
2.2 Obtaining
-
To compile
ejabberd, you need following packages:
-
--
- GNU Make;
-
-
- GCC;
-
-
- libexpat 1.95 or later;
-
-
- Erlang/OTP R8B or later.
-
-
-
2.2 Obtaining
-
-
Currently no stable version released.
+
+Currently no stable version has been released.
-Latest alpha version can be retrieved via CVS. Do following steps:
-
--
- export CVSROOT=:pserver:cvs@www.jabber.ru:/var/spool/cvs
+The latest alpha version can be retrieved via CVS. Do following steps:
+
-
+export CVSROOT=:pserver:cvs@www.jabber.ru:/var/spool/cvs
+
- cvs login
+
- Press Enter when asked for a password
+
- cvs -z3 co ejabberd
+
+
- - cvs login
+
2.3 Compilation
- - Enter empty password
-
-
- cvs -z3 co ejabberd
-
-
-
2.3 Compilation
-
-
+
+
./configure
make
-
TBD
+
+TBD
-
2.4 Starting
+
2.4 Starting
-
... To use more then 1024 connections, you need to set environment
+
+... To use more then 1024 connections, you need to set environment
variable
ERL_MAX_PORTS:
export ERL_MAX_PORTS=32000
Note that with this value
ejabberd will use more memory (approximately 6MB
-more)...
-
+more)...
erl -name ejabberd -s ejabberd
-
TBD
+
+TBD
-
3 Configuration
+
3 Configuration
-
+
+
-
3.1 Initial Configuration
+
3.1 Initial Configuration
-
Configuration file is loaded after first start of
ejabberd. It consists of
+
+Configuration file is loaded after first start of
ejabberd. It consists of
sequence of Erlang terms. Parts of lines after
`%' sign are ignored.
Each term is tuple, where first element is name of option, and other are option
values. Note, that after first start all values from this file stored in
@@ -139,90 +144,79 @@ adding new ones.
-
3.1.1 Host Name
+
-
Option
hostname defines name of Jabber domain that
ejabberd
+
+Option
hostname defines name of Jabber domain that
ejabberd
serves. E. g. to use
jabber.org domain add following line in config:
{host, "jabber.org"}.
-
+
+
-
3.1.2 Access Rules
+
3.1.2 Access Rules
-
Access control in
ejabberd is done via Access Control Lists (ACL).
+
+Access control in
ejabberd is done via Access Control Lists (ACL).
Declaration of ACL in config file have following syntax:
{acl, <aclname>, {<acltype>, ...}}.
-
<acltype> can be one of following:
-
--
-all
- Matches all JIDs. Example:
+
+<acltype> can be one of following:
+
-
+all
- Matches all JIDs. Example:
{acl, all, all}.
-
- - {user, <username>}
- Matches local user with name
+
- {user, <username>}
- Matches local user with name
<username>. Example:
{acl, admin, {user, "aleksey"}}.
-
- - {user, <username>, <server>}
- Matches user with JID
+
- {user, <username>, <server>}
- Matches user with JID
<username>@<server> and any resource. Example:
{acl, admin, {user, "aleksey", "jabber.ru"}}.
-
- - {server, <server>}
- Matches any JID from server
+
- {server, <server>}
- Matches any JID from server
<server>. Example:
{acl, jabberorg, {server, "jabber.org"}}.
-
- - {user_regexp, <regexp>}
- Matches local user with name that
+
- {user_regexp, <regexp>}
- Matches local user with name that
mathes <regexp>. Example:
{acl, tests, {user, "^test[0-9]*$"}}.
-
- - {user_regexp, <regexp>, <server>}
- Matches user with name
+
- {user_regexp, <regexp>, <server>}
- Matches user with name
that mathes <regexp> and from server <server>. Example:
{acl, tests, {user, "^test", "localhost"}}.
-
- - {server_regexp, <regexp>}
- Matches any JID from server that
+
- {server_regexp, <regexp>}
- Matches any JID from server that
matches <regexp>. Example:
{acl, icq, {server, "^icq\\."}}.
-
- - {node_regexp, <user_regexp>, <server_regexp>}
- Matches user
+
- {node_regexp, <user_regexp>, <server_regexp>}
- Matches user
with name that mathes <user_regexp> and from server that matches
<server_regexp>. Example:
{acl, aleksey, {node_regexp, "^aleksey", "^jabber.(ru|org)$"}}.
-
- - {user_glob, <glob>}
-
-
-
- {user_glob, <glob>, <server>}
-
-
-
- {server_glob, <glob>}
-
-
-
- {node_glob, <user_glob>, <server_glob>}
- This is same as
+
- {user_glob, <glob>}
-
+
- {user_glob, <glob>, <server>}
-
+
- {server_glob, <glob>}
-
+
- {node_glob, <user_glob>, <server_glob>}
- This is same as
above, but use shell glob patterns instead of regexp. This patterns can have
following special characters:
-
--
- *
- matches any string including the null string.
-
-
- ?
- matches any single character.
-
-
- [...]
- matches any of the enclosed characters. Character
+
-
+ *
- matches any string including the null string.
+
- ?
- matches any single character.
+
- [...]
- matches any of the enclosed characters. Character
ranges are specified by a pair of characters separated by a `-'.
If the first character after `[' is a `!', then any
character not enclosed is matched.
-
Following ACLs pre-defined:
-
--
-all
- Matches all JIDs.
-
-
- none
- Matches none JIDs.
-
Allowing or denying of different services is like this:
+
+Following ACLs pre-defined:
+-
+all
- Matches all JIDs.
+
- none
- Matches none JIDs.
+
+Allowing or denying of different services is like this:
{access, <accessname>, [{allow, <aclname>},
{deny, <aclname>},
@@ -238,48 +232,42 @@ Example:
{access, configure, [{allow, admin}]}.
{access, something, [{deny, badmans},
{allow, all}]}.
-
Following access rules pre-defined:
-
--
-all
- Always return ``allow''
+
+Following access rules pre-defined:
+
-
+all
- Always return ``allow''
+
- none
- Always return ``deny''
+
+
- - none
- Always return ``deny''
-
+3.1.3 Listened Sockets
-3.1.3 Listened Sockets
-
-Option listen defines list of listened sockets and what services
+
+Option listen defines list of listened sockets and what services
runned on them. Each element of list is a tuple with following elements:
-
--
- Port number;
-
-
- Module that serves this port;
-
-
- Function in this module that starts connection (likely will be removed);
-
-
- Options to this module.
-
Currently three modules implemented:
-
--
-ejabberd_c2s
- This module serves C2S connections.
+-
+Port number;
+
- Module that serves this port;
+
- Function in this module that starts connection (likely will be removed);
+
- Options to this module.
+
+Currently three modules implemented:
+-
+ejabberd_c2s
- This module serves C2S connections.
- Following options defined:
-
--
- {access, <access rule>}
- This option defines access of users
+Following options defined:
+
-
+ {access, <access rule>}
- This option defines access of users
to this C2S port. Default value is ``all''.
-
- - ejabberd_s2s_in
- This module serves incoming S2S connections.
-
-
- ejabberd_service
- This module serves connections to Jabber
+
- ejabberd_s2s_in
- This module serves incoming S2S connections.
+
- ejabberd_service
- This module serves connections to Jabber
services (i. e. that use jabber:component:accept namespace).
-
For example, following configuration defines that C2S connections listened on
+
+For example, following configuration defines that C2S connections listened on
port 5222 and denied for user ``bad'', S2S on port 5269 and that
service conference.jabber.org must be connected to port 8888 with
-password ``secret''.
-
+password ``secret''.
{acl, blocked, {user, "bad"}}.
{access, c2s, [{deny, blocked},
@@ -289,11 +277,13 @@ password ``secret''.
{8888, ejabberd_service, start,
[{host, "conference.jabber.org", [{password, "secret"}]}]}
]}.
-
+
+
-3.1.4 Modules
+
-Option modules defines list of modules that will be loaded after
+
+Option modules defines list of modules that will be loaded after
ejabberd startup. Each list element is a tuple where first element is a
name of module and second is list of options to this module. See
section A for detailed information on each module.
@@ -313,11 +303,13 @@ Example:
{mod_time, [{iqdisc, no_queue}]},
{mod_version, []}
]}.
-
+
+
-3.2 Online Configuration and Monitoring
+3.2 Online Configuration and Monitoring
-To use facility of online reconfiguration of ejabberd needed to have
+
+To use facility of online reconfiguration of ejabberd needed to have
mod_configure loaded (see section A.4). Also highly
recommended to load mod_disco (see section A.5), because
mod_configure highly integrates with it. Also recommended to use disco- and
@@ -327,15 +319,11 @@ developed synchronously with ejabberd, its CVS version use most of
ejabberd features).
On disco query ejabberd returns following items:
-
--
- Identity of server.
-
-
- List of features, including defined namespaces.
-
-
- List of JIDs from route table.
-
-
- List of disco-nodes described in following subsections.
+
-
+Identity of server.
+
- List of features, including defined namespaces.
+
- List of JIDs from route table.
+
- List of disco-nodes described in following subsections.
@@ -343,18 +331,20 @@ On disco query
ejabberd returns following items:
-
Figure 1: Tkabber Discovery window
-
+
server. (See figure
) (Currently will work
correctly only after restart)
@@ -364,13 +354,14 @@ correctly only after restart)