@@ -32,114 +49,115 @@
I can thoroughly recommend ejabberd for ease of setup -- +I can thoroughly recommend ejabberd for ease of setup – Kevin Smith, Current maintainer of the Psi project- + -Table of Contents
+Contents
-
- +
- 1 Introduction -
- + -
- 2 Installation from Source -
- +
- 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 - -
- 3 Configuration -
- +
- 3 Configuration +
- 3.1 Initial Configuration -
- +
-
- 3.1.1 Host Names -
- 3.1.2 Default Language -
- 3.1.3 Access Rules -
- 3.1.4 Shapers -
- 3.1.5 Listened Sockets -
- 3.1.6 Modules -
- 3.1.7 Virtual Hosting -
- 3.1.8 SASL anonymous and anonymous login +
- 3.1.2 Default Language +
- 3.1.3 Access Rules +
- 3.1.4 Shapers +
- 3.1.5 Listened Sockets +
- 3.1.6 Modules +
- 3.1.7 Virtual Hosting +
- 3.1.8 SASL anonymous and anonymous login
- 3.2 Relational Database Support -
- +
- 3.2 Relational Database Support + -
- 3.3 Creating an Initial Administrator -
- 3.4 Online Configuration and Monitoring - -
- 4 Firewall Settings -
- 5 SRV Records -
- 6 Clustering -
- +
- 4 Firewall Settings +
- 5 SRV Records +
- 6 Clustering +
- 6.1 How it Works - -
- A Built-in Modules -
- +
- A Built-in Modules +
- A.1 Overview -
- A.2 Common Options -
-
- +
- A.2 Common Options + -
- A.3 mod_announce -
- A.4 mod_disco -
- A.5 mod_echo -
- A.6 mod_irc -
- A.7 mod_last -
- A.8 mod_muc -
- A.9 mod_muc_log -
- A.10 mod_offline -
- A.11 mod_privacy -
- A.12 mod_private -
- A.13 mod_pubsub -
- A.14 mod_register -
- A.15 mod_roster -
- A.16 mod_service_log -
- A.17 mod_shared_roster -
- A.18 mod_stats -
- A.19 mod_time -
- A.20 mod_vcard -
- A.21 mod_version +
- A.3 mod_announce +
- A.4 mod_disco +
- A.5 mod_echo +
- A.6 mod_irc +
- A.7 mod_last +
- A.8 mod_muc +
- A.9 mod_muc_log +
- A.10 mod_offline +
- A.11 mod_privacy +
- A.12 mod_private +
- A.13 mod_pubsub +
- A.14 mod_register +
- A.15 mod_roster +
- A.16 mod_service_log +
- A.17 mod_shared_roster +
- A.18 mod_stats +
- A.19 mod_time +
- A.20 mod_vcard +
- A.21 mod_version
- B Internationalization and Localization -
- C Release Notes - -
1 Introduction
+1 Introduction
@@ -151,134 +169,134 @@
-1.1 Key Features
+1.1 Key Features
ejabberd is: -
- +
- Multiplatform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
-- Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
+- Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
-- Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.
+- Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced “on the fly”.
-- Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: -
- +
- Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: +
- Comprehensive documentation. -
- Straightforward installers for Linux, Mac OS X, and Windows. -
- Web interface for administration tasks. -
- Shared Roster Groups. -
- Command line administration tool. -
- Can integrate with existing authentication mechanisms. -
- Capability to send announce messages. +
- Straightforward installers for Linux, Mac OS X, and Windows. +
- Web interface for administration tasks. +
- Shared Roster Groups. +
- Command line administration tool. +
- Can integrate with existing authentication mechanisms. +
- Capability to send announce messages.
-- Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -
- +
- Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: +
-- Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -
-
- +
- Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +
- Fully XMPP compliant -
- XML-based protocol -
- Many JEPs supported. +
- XML-based protocol +
- Many JEPs supported.
1.2 Additional Features
+1.2 Additional Features
Besides common Jabber server features, ejabberd comes with a wide range of other features: -
- +
- Modular -
- +
-
- Load only the modules you want. -
- Extend ejabberd with your own custom modules. +
- Extend ejabberd with your own custom modules.
- Security -
- +
- Security +
-
- SASL and STARTTLS for c2s and s2s connections. -
- STARTTLS and Dialback s2s connections. -
- Web interface accessible via HTTPS secure access. +
- STARTTLS and Dialback s2s connections. +
- Web interface accessible via HTTPS secure access.
- Databases -
- +
- Databases +
-
- Native MySQL support. -
- Native PostgreSQL support. -
- Mnesia. -
- ODBC data storage support. +
- Native PostgreSQL support. +
- Mnesia. +
- ODBC data storage support.
- Authentication -
- +
- Authentication +
-
- LDAP and ODBC. -
- External Authentication script. -
- Internal Authentication. +
- External Authentication script. +
- Internal Authentication.
- Others -
-
- +
- Others +
- Compressing XML streams with Stream Compression (JEP-0138). -
- Interface with networks such as AIM, ICQ and MSN. -
- Statistics via Statistics Gathering (JEP-0039). -
- IPv6 support both for c2s and s2s connections. -
- Multi-User Chat module with logging. -
- Users Directory based on users vCards. -
- Publish-Subscribe component. -
- Support for virtual hosting. -
- HTTP Polling service. -
- IRC transport. +
- Interface with networks such as AIM, ICQ and MSN. +
- Statistics via Statistics Gathering (JEP-0039). +
- IPv6 support both for c2s and s2s connections. +
- Multi-User Chat module with logging. +
- Users Directory based on users vCards. +
- Publish-Subscribe component. +
- Support for virtual hosting. +
- HTTP Polling service. +
- IRC transport.
2 Installation from Source
+2 Installation from Source
-2.1 Installation Requirements
+2.1 Installation Requirements
- + -2.1.1 ``Unix-like'' operating systems
+2.1.1 “Unix-like” operating systems
-To compile ejabberd on a ``Unix-like'' operating system, you need: -
- +To compile ejabberd on a “Unix-like” operating system, you need: +
-
- GNU Make; -
- GCC; -
- libexpat 1.95 or higher; -
- Erlang/OTP R9C-2 or higher; -
- OpenSSL 0.9.6 or higher (optional). -
- Zlib 1.2.3 or higher (optional). -
- GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc). +
- GCC; +
- libexpat 1.95 or higher; +
- Erlang/OTP R9C-2 or higher; +
- OpenSSL 0.9.6 or higher (optional). +
- Zlib 1.2.3 or higher (optional). +
- GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc).
2.1.2 Windows
+2.1.2 Windows
To compile ejabberd on a Windows flavour, you need: -
- +
-
- MS Visual C++ 6.0 Compiler -
- Erlang/OTP R9C-2 or higher -
- Expat 1.95.7 or higher -
- GNU Iconv 1.9.1 +
- Erlang/OTP R9C-2 or higher +
- Expat 1.95.7 or higher +
- GNU Iconv 1.9.1 (optional) -
- Shining Light OpenSSL +
- Shining Light OpenSSL (to enable SSL connections) -
- Zlib 1.2.3 or higher +
- Zlib 1.2.3 or higher
2.2 Obtaining ejabberd
+2.2 Obtaining ejabberd
@@ -287,49 +305,49 @@ Released versions of ejabberd can be obtained from
The latest development version can be retrieved from the Subversion repository. -+svn co http://svn.process-one.net/ejabberd/trunk ejabberd-2.3 Compilation
+2.3 Compilation
- + -2.3.1 ``Unix-like'' operating systems
+2.3.1 “Unix-like” operating systems
-Compile ejabberd on a ``Unix-like'' operating system by executing: -+Compile ejabberd on a “Unix-like” operating system by executing: +./configure make su make installThese commands will: -
- +
-
- install ejabberd into the directory
/var/lib/ejabberd, -- install the configuration file into
/etc/ejabberd, -- create a directory called
/var/log/ejabberdto store log files. +- install the configuration file into
/etc/ejabberd, +- create a directory called
/var/log/ejabberdto store log files.2.3.2 Windows
+2.3.2 Windows
-
- +
-
- Install Erlang emulator (for example, into
C:\Program Files\erl5.3). -- Install Expat library into
C:\Program Files\Expat-1.95.7+- Install Expat library into
C:\Program Files\Expat-1.95.7directory.
Copy fileC:\Program Files\Expat-1.95.7\Libs\libexpat.dllto your Windows system directory (for example,C:\WINNTorC:\WINNT\System32) -- Build and install the Iconv library into the directory +
- Build and install the Iconv library into the directory
C:\Program Files\iconv-1.9.1.
Copy fileC:\Program Files\iconv-1.9.1\bin\iconv.dllto your @@ -341,25 +359,25 @@ Note: instead of copying libexpat.dll and iconv.dll to the WindowsC:\Program Files\Expat-1.95.7\LibsandC:\Program Files\iconv-1.9.1\binto thePATHenvironment variable. -- While in the directory
ejabberd\srcrun: -+- While in the directory
ejabberd\srcrun: +configure.bat nmake -f Makefile.win32 -- Edit the file
ejabberd\src\ejabberd.cfgand run -+- Edit the file
ejabberd\src\ejabberd.cfgand run +werl -s ejabberd -name ejabberd2.4 Starting
+2.4 Starting
Execute the following command to start ejabberd: -+erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberdor -+erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberdIn the latter case the Erlang node will be identified using only the first part of the host name, i. e. other Erlang nodes outside this domain can't contact @@ -371,7 +389,7 @@ for storing its user database and for logging.
To specify the path to the configuration file, the log files and the Mnesia database directory, you may use the following command: -+erl -pa /var/lib/ejabberd/ebin \ -sname ejabberd \ -s ejabberd \ @@ -385,25 +403,25 @@ You can find other useful options in the Erlang manual page
To use more than 1024 connections, you should set the environment variableERL_MAX_PORTS: -+export ERL_MAX_PORTS=32000Note that with this value, ejabberd will use more memory (approximately 6 MB more).
To reduce memory usage, you may set the environment variableERL_FULLSWEEP_AFTER: -+export ERL_FULLSWEEP_AFTER=0But in this case ejabberd can start to work slower.
-3 Configuration
+3 Configuration
-3.1 Initial Configuration
+3.1 Initial Configuration
@@ -414,12 +432,12 @@ configuration file are appended to the entries in the database. The configuration file contains a sequence of Erlang terms. Lines beginning with a `%' sign are ignored. Each term is a tuple of which the first element is the name of an option, and any further elements are that option's values. If the -configuration file do not contain for instance the ``hosts'' option, the old +configuration file do not contain for instance the “hosts” option, the old host name(s) stored in the database will be used.
You can override the old values stored in the database by adding next lines to the configuration file: -+override_global. override_local. override_acls. @@ -428,7 +446,7 @@ before new ones are added.
-3.1.1 Host Names
+3.1.1 Host Names
@@ -436,23 +454,23 @@ The option hosts defines a list containing one or more domains that ejabberd will serve.
Examples: -
- +
- Serving one domain: -
-
- -
+-
- +
{hosts, ["example.org"]}. -- Backwards compatibility with older ejabberd versions can be retained +
- Backwards compatibility with older ejabberd versions can be retained with: -
+{host, "example.org"}.- Serving two domains: -
+- Serving two domains: +
{hosts, ["example.net", "example.com"]}.3.1.2 Default Language
+3.1.2 Default Language
@@ -463,82 +481,82 @@ option language is "en". In order to take effect there must be translation file <language>.msg in ejabberd's msgs directory.
Examples: -
- +
-
- To set Russian as default language: -
+{language, "ru"}. -- To set Spanish as default language: -
+- To set Spanish as default language: +
{language, "es"}.3.1.3 Access Rules
+3.1.3 Access Rules
Access control in ejabberd is performed via Access Control Lists (ACLs). The declarations of ACLs in the configuration file have the following syntax: -+{acl, <aclname>, {<acltype>, ...}}.<acltype> can be one of the following: -
- -all
- Matches all JIDs. Example: -
+
- +all
- Matches all JIDs. Example: +
{acl, all, all}. -- {user, <username>}
- Matches the user with the name +
- {user, <username>}
- Matches the user with the name <username> at the first virtual host. Example: -
+{acl, admin, {user, "yozhik"}}. -- {user, <username>, <server>}
- Matches the user with the JID +
- {user, <username>, <server>}
- Matches the user with the JID <username>@<server> and any resource. Example: -
+{acl, admin, {user, "yozhik", "example.org"}}. -- {server, <server>}
- Matches any JID from server +
- {server, <server>}
- Matches any JID from server <server>. Example: -
+{acl, exampleorg, {server, "example.org"}}. -- {user_regexp, <regexp>}
- Matches any local user with a name that +
- {user_regexp, <regexp>}
- Matches any local user with a name that matches <regexp> at the first virtual host. Example: -
+{acl, tests, {user, "^test[0-9]*$"}}. -- {user_regexp, <regexp>, <server>}
- Matches any user with a name +
- {user_regexp, <regexp>, <server>}
- Matches any user with a name that matches <regexp> at server <server>. Example: -
+{acl, tests, {user, "^test", "example.org"}}. -- {server_regexp, <regexp>}
- Matches any JID from the server that +
- {server_regexp, <regexp>}
- Matches any JID from the server that matches <regexp>. Example: -
+{acl, icq, {server, "^icq\\."}}. -- {node_regexp, <user_regexp>, <server_regexp>}
- Matches any user +
- {node_regexp, <user_regexp>, <server_regexp>}
- Matches any user with a name that matches <user_regexp> at any server that matches <server_regexp>. Example: -
+{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. -- {user_glob, <glob>}
- -
- {user_glob, <glob>, <server>}
- -
- {server_glob, <glob>}
- -
- {node_glob, <user_glob>, <server_glob>}
- This is the same as +
- {user_glob, <glob>}
- +
- {user_glob, <glob>, <server>}
- +
- {server_glob, <glob>}
- +
- {node_glob, <user_glob>, <server_glob>}
- This is the same as above. However, it uses shell glob patterns instead of regexp. These patterns can have the following special characters: -
The following ACLs are pre-defined: -
- - *
- matches any string including the null string. -
- ?
- matches any single character. -
- [...]
- matches any of the enclosed characters. Character +
- + *
- matches any string including the null string. +
- ?
- matches any single character. +
- [...]
- matches any of the enclosed characters. Character ranges are specified by a pair of characters separated by a `-'. If the first character after `[' is a `!', any character not enclosed is matched.
- -all
- Matches any JID. -
- none
- Matches no JID. +
An entry allowing or denying access to different services looks similar to this: -
- +all
- Matches any JID. +
- none
- Matches no JID.
+{access, <accessname>, [{allow, <aclname>}, {deny, <aclname>}, ... @@ -546,64 +564,64 @@ this:When a JID is checked to have access to <accessname>, the server sequentially checks if that JID mathes any of the ACLs that are named in the second elements of the tuples in the list. If it matches, the first element of -the first matched tuple is returned, otherwise ``deny'' is returned.
+the first matched tuple is returned, otherwise “deny” is returned.
Example: -+{access, configure, [{allow, admin}]}. {access, something, [{deny, badmans}, {allow, all}]}.The following access rules are pre-defined: -
- -all
- Always returns ``allow'' -
- none
- Always returns ``deny'' +
-
- +all
- Always returns “allow” +
- none
- Always returns “deny”
3.1.4 Shapers
+3.1.4 Shapers
Shapers enable you to limit connection traffic. The syntax of shapers is like this: -+{shaper, <shapername>, <kind>}.Currently only one kind of shaper called maxrate is available. It has the following syntax: -+{maxrate, <rate>}where <rate> stands for the maximum allowed incomig rate in bytes per second.
Examples: -
- -To define a shaper named ``normal'' with traffic speed limited to +
-
- +To define a shaper named “normal” with traffic speed limited to 1,000 bytes/second: -
+{shaper, normal, {maxrate, 1000}}. -- To define a shaper named ``fast'' with traffic speed limited to +
- To define a shaper named “fast” with traffic speed limited to 50,000 bytes/second: -
+{shaper, fast, {maxrate, 50000}}.3.1.5 Listened Sockets
+3.1.5 Listened Sockets
The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a tuple with the following elements: -
- +
Currently next modules are implemented: -
- Port number. -
- Module that serves this port. -
- Options to this module. +
- Module that serves this port. +
- Options to this module.
(*) The mechanism for external components is defined in Jabber Component Protocol (JEP-0114).++-
ejabberd_c2s @@ -647,18 +665,18 @@ Currently next modules are implemented:certfile, http_poll, inet6, ip, tls, web_admin
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 +
Also the following global options are available for s2s connections: -
- + {access, <access rule>}
- This option defines + access to the port. The default value is “all”. +
- {certfile, Path}
- Path to a file containing the SSL certificate. +
- {hosts, [Hostnames], [HostOptions]}
- This option defines one or more hostnames of connected services and enables you to specify additional options including {password, Secret}. -
- http_poll
- +
- http_poll
- This option enables HTTP Polling (JEP-0025) support. HTTP Polling enables access via HTTP requests to ejabberd from behind firewalls which do not allow outgoing sockets on port 5222.
@@ -670,85 +688,85 @@ If HTTP Polling is enabled, it will be available at JWChat (there is a tutorial to install JWChat with instructions for ejabberd). -- inet6
- Set up the socket for IPv6. -
- {ip, IPAddress}
- This option specifies which network +
- inet6
- Set up the socket for IPv6. +
- {ip, IPAddress}
- This option specifies which network interface to listen for. For example
{ip, {192, 168, 1, 1}}. -- {max_stanza_size, Size}
- This +
- {max_stanza_size, Size}
- This option specifies an approximate maximal size in bytes of XML stanzas. For example
{max\_stanza\_size, 65536}. The default value - is ``infinity''. -- {shaper, <access rule>}
- This option defines a + is “infinity”. +
- {shaper, <access rule>}
- This option defines a shaper for the port (see section 3.1.4). The default value - is ``none''. -
- ssl
- This option specifies that traffic on + is “none”. +
- ssl
- This option specifies that traffic on the port will be encrypted using SSL. You should also set the certfile option. It is recommended to use the tls option instead. -
- starttls
- This option +
- starttls
- This option specifies that STARTTLS encryption is available on connections to the port. You should also set the certfile option. -
- starttls_required
- This option +
- starttls_required
- This option specifies that STARTTLS encryption is required on connections to the port. No unencrypted connections will be allowed. You should also set the certfile option. -
- tls
- This option specifies that traffic on +
- tls
- This option specifies that traffic on the port will be encrypted using SSL immediately after connecting. You should also set the certfile option. -
- zlib
- This +
- zlib
- This option specifies that Zlib stream compression (as defined in JEP-0138) is available on connections to the port. Client cannot use stream compression and stream encryption simultaneously, so if you specify both tls (or ssl) and zlib the latter option will not affect connection at all. -
- web_admin
- This option +
- web_admin
- This option enables the web interface for ejabberd administration which is available at
http://server:port/admin/. Login and password are the username and password of one of the registered users who are granted access by the - ``configure'' access rule. + “configure” access rule.
- - {s2s_use_starttls, true|false}
- +
For instance, the following configuration defines that: -
- + {s2s_use_starttls, true|false}
- This option defines whether to use STARTTLS for s2s connections. -
- {s2s_certfile, Path}
- Path to the +
- {s2s_certfile, Path}
- Path to the file containing the SSL certificate. -
- {domain_certfile, Domain, Path}
- Path +
- {domain_certfile, Domain, Path}
- Path to the file containing the SSL certificate for the specified domain.
- +
-
- c2s connections are listened for on port 5222 and 5223 (SSL) and denied - for the user ``bad'' -
- s2s connections are listened for on port 5269 with STARTTLS for secured + for the user “bad” +
- s2s connections are listened for on port 5269 with STARTTLS for secured traffic enabled. -
- Port 5280 is serving the web interface and the HTTP Polling service. Note +
- Port 5280 is serving the web interface and the HTTP Polling service. Note that it is also possible to serve them on different ports. The second example in section 3.4.1 shows how exactly this can be done. -
- All users except for the administrators have a traffic of limit +
- All users except for the administrators have a traffic of limit 1,000 Bytes/second -
- The +
- The AIM transport aim.example.org is connected to port 5233 with password - ``aimsecret'' -
- The ICQ transport JIT (icq.example.org and + “aimsecret” +
- The ICQ transport JIT (icq.example.org and sms.example.org) is connected to port 5234 with password - ``jitsecret'' -
- The + “jitsecret” +
- The MSN transport msn.example.org is connected to port 5235 with password - ``msnsecret'' -
- The + “msnsecret” +
- The Yahoo! transport yahoo.example.org is connected to port 5236 with password - ``yahoosecret'' -
- The Gadu-Gadu transport gg.example.org is - connected to port 5237 with password ``ggsecret'' -
- The + “yahoosecret” +
- The Gadu-Gadu transport gg.example.org is + connected to port 5237 with password “ggsecret” +
- The Jabber Mail Component jmc.example.org is connected to port 5238 with password - ``jmcsecret'' + “jmcsecret”
+{acl, blocked, {user, "bad"}}. {access, c2s, [{deny, blocked}, {allow, all}]}. @@ -779,7 +797,7 @@ c2s connections are listened for on port 5222 and 5223 (SSL) and denied {s2s_certfile, "/path/to/ssl.pem"}.Note, that for jabberd 1.4- or WPJabber-based services you have to make the transports log and do XDB by themselves: -+<!-- You have to add elogger and rlogger entries here when using ejabberd. In this case the transport will do the logging. @@ -811,7 +829,7 @@ services you have to make the transports log and do XDB by themselves:-3.1.6 Modules
+3.1.6 Modules
@@ -821,17 +839,17 @@ element is the name of a module and the second is a list of options for that module. Read section A for detailed information about modules.
Examples: -
- +
-
- In this simple example, only the module mod_echo is loaded and no options are specified between square brackets: -
+{modules, [{mod_echo, []} ]}. -- The second example is also simple: the modules mod_echo, mod_time, and +
- The second example is also simple: the modules mod_echo, mod_time, and mod_version are loaded without options. Remark that, besides the last entry, all entries end with a comma: -
+{modules, [{mod_echo, []}, {mod_time, []}, @@ -840,22 +858,22 @@ In this simple example, only the module mod_echo is loaded and no3.1.7 Virtual Hosting
+3.1.7 Virtual Hosting
Options can be defined separately for every virtual host using the host_config option. It has the following syntax: -+{host_config, <hostname>, [<option>, <option>, ...]}.Examples: -
- +
-
- Domain example.net is using the internal authentication method while domain example.com is using the LDAP server running on the domain localhost to perform authentication: -
+{host_config, "example.net", [{auth_method, internal}]}. {host_config, "example.com", [{auth_method, ldap}, @@ -864,10 +882,10 @@ Domain example.net is using the internal authentication method while {ldap_rootdn, "dc=localdomain"}, {ldap_rootdn, "dc=example,dc=com"}, {ldap_password, ""}]}. -- Domain example.net is using ODBC to perform authentication +
- Domain example.net is using ODBC to perform authentication while domain example.com is using the LDAP servers running on the domains localhost and otherhost: -
+{host_config, "example.net", [{auth_method, odbc}, {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. @@ -880,24 +898,24 @@ Domain example.net is using the internal authentication method while3.1.8 SASL anonymous and anonymous login
+3.1.8 SASL anonymous and anonymous login
The configuration of the anonymous mode can be done with three host_config parameters: -
- +
- auth_method: This value is used for defining the authentication method: internal, odbc, ldap, external). You now have a special extra option to enable anonymous mode: anonymous.
-- allow_multiple_connections: This option can be either true or false and +
- allow_multiple_connections: This option can be either true or false and is only used when the anonymous mode is enabled. Setting it to true means that the same username will be able to be taken several time in anonymous login mode if different resource are used to connect. This option is only useful in very special cases. It defaults to false.
-- anonymous_protocol: This option can take three values: +
- anonymous_protocol: This option can take three values: sasl_anon, login_anon or both. sasl_anon means that SASL anonymous mode is enabled. login_anon means that anonymous login mode is enabled. both means that SASL anonymous and login anonymous are @@ -907,26 +925,26 @@ Those options are defined for each virtual host with the host_config parameter (see section 3.1.7).
Examples: -
- +
@@ -936,12 +954,12 @@ available from:
- To enable anonymous login on a virtual host: -
+{host_config, "public.example.org", [{auth_method, anonymous}, {anonymous_protocol, login_anon}]}. -- To enable anonymous login and internal authentication on a virtual host: -
+- To enable anonymous login and internal authentication on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, login_anon}]}. -- To enable SASL anonymous on a virtual host: -
+- To enable SASL anonymous on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, sasl_anon}]}. -- To enable SASL anonymous and anonymous login on a virtual host: -
+- To enable SASL anonymous and anonymous login on a virtual host: +
{host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, both}]}. -- To enable SASL anonymous, anonymous login and internal authentication on +
- To enable SASL anonymous, anonymous login and internal authentication on a virtual host: -
+{host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, both}]}.
-3.2 Relational Database Support
+3.2 Relational Database Support
-3.2.1 Authentication against a relational database
+3.2.1 Authentication against a relational database
ejabberd use its internal Mnesia database as a default. It is however possible @@ -954,7 +972,7 @@ system.
The option value name be misleading, as the method name is use both for access to relational database through ODBC or through the native interface. In any case, the first step is to define the odbc auth_method. For example: -+{host_config, "public.example.org", [{auth_method, [odbc]}]}.The actual database access is defined in the option odbc_server. Its @@ -963,16 +981,16 @@ interface available, PostgreSQL or MySQL.
To use a relational database through ODBC, you can pass the ODBC connection string as odbc_server parameter. For example: -+{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.To use the native PostgreSQL interface, you can pass a tuple of the following form as parameter: -+{pgsql, "Server", "Database", "Username", "Password"}pgsql is a keyword that should be kept as is. For example: -+mysql is a keyword that should be kept as is. For example: -{odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.Note that you need to install the Erlang PgSQL library first. This library is @@ -981,11 +999,11 @@ available from Sourceforge: {mysql, "Server", "Database", "Username", "Password"}+{odbc_server, {mysql, "localhost", "test", "root", "password"}}.Note that you need to install the Erlang MySQL library first. This library is @@ -996,61 +1014,61 @@ available from: 3.2.2 Relational database for other modules +3.2.2 Relational database for other modules
It is possible to use a relational database to store pieces of information. You can do this by changing the module name to a name with an _odbc suffix in ejabberd config file. You can use a relational database for the following data: -
- +
-
- Last connection date and time: Use mod_last_odbc instead of mod_last. -
- Offline messages: Use mod_offline_odbc instead of +
- Offline messages: Use mod_offline_odbc instead of mod_offline. -
- Rosters: Use mod_roster_odbc instead of mod_roster. -
- Users' VCARD: Use mod_vcard_odbc instead of mod_vcard. +
- Rosters: Use mod_roster_odbc instead of mod_roster. +
- Users' VCARD: Use mod_vcard_odbc instead of mod_vcard.
3.3 Creating an Initial Administrator
+3.3 Creating an Initial Administrator
Before the web interface can be entered to perform administration tasks, an account with administrator rights is needed on your ejabberd deployment.
Instructions to create an initial administrator account: -
- +
- Register an account on your ejabberd deployment. An account can be created in two ways: -
-
- + -
- Edit the configuration file to promote the account created in the previous +
- Edit the configuration file to promote the account created in the previous step to an account with administrator rights. Note that if you want to add more administrators, a seperate acl entry is needed for each administrator. -
+{acl, admins, {user, "admin", "example.org"}}. {access, configure, [{allow, admins}]}. -- Restart ejabberd to load the new configuration. -
- Open the web interface (
http://server:port/admin/) in your +- Restart ejabberd to load the new configuration. +
- Open the web interface (
http://server:port/admin/) in your favourite browser. Make sure to enter the full JID as username (in this example: admin@example.org. The reason that you also need to enter the suffix, is because ejabberd's virtual hosting support.3.4 Online Configuration and Monitoring
+3.4 Online Configuration and Monitoring
-3.4.1 Web Interface
+3.4.1 Web Interface
@@ -1061,22 +1079,24 @@ section 3.1.5). Then you can open will be asked to enter the username (the full Jabber ID) and password of an ejabberd user with administrator rights. After authentication you will see a page similar to figure 1. -Here you can edit access restrictions, manage users, create backups, manage the database, enable/disable ports listened for, view server statistics,...
Examples: -
- +
-
- You can serve the web interface on the same port as the HTTP Polling interface. In this example you should point your web browser to
http://example.org:5280/admin/to @@ -1085,11 +1105,11 @@ You can serve the web interface on the same port as the the virtual host example.com. Before you get access to the web interface you need to enter as username, the JID and password from a registered user that is allowed to configure ejabberd. In this example you can enter as - username ``admin@example.net'' to administer all virtual hosts (first - URL). If you log in with ``admin@example.com'' on
+ username “admin@example.net” to administer all virtual hosts (first + URL). If you log in with “admin@example.com” on
http://example.org:5280/admin/server/example.com/you can only administer the virtual host example.com. -+... {acl, admins, {user, "admin", "example.net"}}. {host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}. @@ -1103,11 +1123,11 @@ You can serve the web interface on the same port as the ... ] }. -- For security reasons, you can serve the web interface on a secured +
- For security reasons, you can serve the web interface on a secured connection, on a port differing from the HTTP Polling interface, and bind it to the internal LAN IP. The web interface will be accessible by pointing your web browser to
https://192.168.1.1:5280/admin/: -+... {hosts, ["example.org"]}. ... @@ -1122,13 +1142,13 @@ You can serve the web interface on the same port as the3.4.2 ejabberdctl
+3.4.2 ejabberdctl
It is possible to do some administration operations using the command line tool ejabberdctl. You can list all available options by running ejabberdctl without arguments: -+% ejabberdctl Usage: ejabberdctl node command @@ -1153,27 +1173,27 @@ Example: ejabberdctl ejabberd@host restartAdditional information: -
- -reopen-log
- If you use a tool to rotate logs, you have to configure it +
-
- +reopen-log
- If you use a tool to rotate logs, you have to configure it so that this command is executed after each rotation. -
- backup, restore, install-fallback, dump, load
- You can use these +
- backup, restore, install-fallback, dump, load
- You can use these commands to create and restore backups. -
- import-file, import-dir
- +
- import-file, import-dir
- These options can be used to migrate from other Jabber/XMPP servers. There exist tutorials to migrate from jabberd 1.4 and to migrate from jabberd2. -
- delete-expired-messages
- This option can be used to delete old messages +
- delete-expired-messages
- This option can be used to delete old messages in offline storage. This might be useful when the number of offline messages is very high.
4 Firewall Settings
+4 Firewall Settings
You need to take the following TCP ports in mind when configuring your firewall: --5 SRV Records
+5 SRV Records
-
- +
-
- General information: SRV record -
- Practical information: +
- Practical information: Setting DNS SRV Records
6 Clustering
+6 Clustering
-6.1 How it Works
+6.1 How it Works
@@ -1228,15 +1248,15 @@ needed because all nodes exchange information about connected users, s2s connections, registered services, etc...
Each ejabberd node has the following modules: -
- +
-
- router, -
- local router, -
- session manager, -
- s2s manager. +
- local router, +
- session manager, +
- s2s manager.
6.1.1 Router
+6.1.1 Router
This module is the main router of Jabber packets on each node. It @@ -1247,7 +1267,7 @@ appropriate process. If not, it is sent to the s2s manager.
-6.1.2 Local Router
+6.1.2 Local Router
This module routes packets which have a destination domain equal to @@ -1257,7 +1277,7 @@ on its content.
-6.1.3 Session Manager
+6.1.3 Session Manager
This module routes packets to local users. It looks up to which user @@ -1267,7 +1287,7 @@ storage, or bounced back.
-6.1.4 s2s Manager
+6.1.4 s2s Manager
This module routes packets to other Jabber servers. First, it @@ -1278,52 +1298,52 @@ serving this connection, otherwise a new connection is opened.
-6.2 Clustering Setup
+6.2 Clustering Setup
Suppose you already configured ejabberd on one machine named (first), and you need to setup another one to make an ejabberd cluster. Then do following steps: -
- +
@@ -1351,13 +1371,13 @@ domain.
- Copy
~ejabberd/.erlang.cookiefile from first to second.
-(alt) You can also add ``-cookie content_of_.erlang.cookie'' - option to all ``erl'' commands below.
+(alt) You can also add “-cookie content_of_.erlang.cookie” + option to all “erl” commands below.
-- On second run as the `ejabberd' user in the directory +
- On second run as the `ejabberd' user in the directory where ejabberd will work later the following command: -
+erl -sname ejabberd \ -mnesia extra_db_nodes "['ejabberd@first']" \ -s mnesiaThis will start Mnesia serving the same database as ejabberd@first. - You can check this by running the command ``mnesia:info().''. You + You can check this by running the command “mnesia:info().”. You should see a lot of remote tables and a line like the following: -+running db nodes = [ejabberd@first, ejabberd@second]
-- Now run the following in the same ``erl'' session: -
+- Now run the following in the same “erl” session: +
mnesia:change_table_copy_type(schema, node(), disc_copies).This will create local disc storage for the database.
-(alt) Change storage type of `scheme' table to ``RAM and disc - copy'' on the second node via the web interface.
+(alt) Change storage type of `scheme' table to “RAM and disc + copy” on the second node via the web interface.
-- Now you can add replicas of various tables to this node with - ``
mnesia:add_table_copy'' or - ``mnesia:change_table_copy_type'' as above (just replace - ``schema'' with another table name and ``disc_copies'' - can be replaced with ``ram_copies'' or - ``disc_only_copies'').
+- Now you can add replicas of various tables to this node with + “
mnesia:add_table_copy” or + “mnesia:change_table_copy_type” as above (just replace + “schema” with another table name and “disc_copies” + can be replaced with “ram_copies” or + “disc_only_copies”).
Which tables to replicate is very dependant on your needs, you can get - some hints from the command ``mnesia:info().'', by looking at the + some hints from the command “mnesia:info().”, by looking at the size of tables and the default storage type for each table on 'first'.
Replicating a table makes lookups in this table faster on this node. @@ -1335,13 +1355,13 @@ Also Run “init:stop().” or just “q().” to exit from the Erlang shell. This probably can take some time if Mnesia has not yet transfered and processed all data it needed from first.
-- Now run ejabberd on second with almost the same config as - on first (you probably don't need to duplicate ``
acl'' - and ``access'' options --- they will be taken from +- Now run ejabberd on second with almost the same config as + on first (you probably don't need to duplicate “
acl” + and “access” options — they will be taken from first, andmod_mucandmod_ircshould be enabled only on one machine in the cluster).
-A Built-in Modules
+A Built-in Modules
-A.1 Overview
+A.1 Overview
@@ -1369,14 +1389,14 @@ that they can contain severe bugs and security leaks. Therefore, use them at your own risk!
You can see which database backend each module needs by looking at the suffix: -
- -``_ldap'', this means that the module needs an LDAP server as backend. -
- ``_odbc'', this means that the module needs an ODBC compatible database, +
-
- +“_ldap”, this means that the module needs an LDAP server as backend. +
- “_odbc”, this means that the module needs an ODBC compatible database, a MySQL database, or a PostgreSQL database as backend. -
- Nothing, this means that the modules uses Erlang's built-in database +
- Nothing, this means that the modules uses Erlang's built-in database Mnesia as backend.
(*) This module or a similar one with another database backend is needed for XMPP compliancy.++-
Module Feature @@ -1563,13 +1583,13 @@ You can see which database backend each module needs by looking at the suffix:No
-A.2 Common Options
+A.2 Common Options
The following options are used by many modules. Therefore, they are described in @@ -1577,7 +1597,7 @@ this separate section.
-A.2.1 iqdisc
+A.2.1 iqdisc
@@ -1585,23 +1605,23 @@ Many modules define handlers for processing IQ queries of different namespaces to this server or to a user (e. g. to example.org or to user@example.org). This option defines processing discipline for these queries. Possible values are: -
- -no_queue
- All queries of a namespace with this processing discipline are +
Example: -
- +no_queue
- All queries of a namespace with this processing discipline are processed immediately. This also means that no other packets can be processed until this one has been completely processed. Hence this discipline is not recommended if the processing of a query can take a relatively long time. -
- one_queue
- In this case a separate queue is created for the processing +
- one_queue
- In this case a separate queue is created for the processing of IQ queries of a namespace with this discipline. In addition, the processing of this queue is done in parallel with that of other packets. This discipline is most recommended. -
- parallel
- For every packet with this discipline a separate Erlang process +
- parallel
- For every packet with this discipline a separate Erlang process is spawned. Consequently, all these packets are processed in parallel. Although spawning of Erlang process has a relatively low cost, this can break the server's normal work, because the Erlang emulator has a limit on the number of processes (32000 by default).
+{modules, [ ... @@ -1611,7 +1631,7 @@ Example:-A.2.2 hosts
+A.2.2 hosts
@@ -1619,19 +1639,19 @@ A module acting as a service can have one or more hostnames. These hostnames can be defined with the hosts option.
Examples: -
- +
- Serving the echo module on one domain: -
-
- -
+-
- +
{modules, [ ... {mod_echo, [{hosts, ["echo.example.org"]}]}, ... ]}. -- Backwards compatibility with older ejabberd versions can be retained +
- Backwards compatibility with older ejabberd versions can be retained with: -
+{modules, [ ... @@ -1639,8 +1659,8 @@ Serving the echo module on one domain: ... ]}.- Serving the echo module on two domains: -
+- Serving the echo module on two domains: +
{modules, [ ... @@ -1650,7 +1670,7 @@ Serving the echo module on one domain:A.3 mod_announce
+A.3 mod_announce
@@ -1660,36 +1680,36 @@ Jabber client by sending messages to specific JIDs. These JIDs are listed in next paragraph. The first JID in each entry will apply only to the virtual host example.org, while the JID between brackets will apply to all virtual hosts: -
- -example.org/announce/all (example.org/announce/all-hosts/all)
- The +
Options: -
- +example.org/announce/all (example.org/announce/all-hosts/all)
- The message is sent to all registered users. If the user is online and connected to several resources, only the resource with the highest priority will receive the message. If the registered user is not connected, the message will be stored offline in assumption that offline storage (see section A.10) is enabled. -
- example.org/announce/online (example.org/announce/all-hosts/online)
- The +
- example.org/announce/online (example.org/announce/all-hosts/online)
- The message is sent to all connected users. If the user is online and connected to several resources, all resources will receive the message. -
- example.org/announce/motd (example.org/announce/all-hosts/motd)
- The +
- example.org/announce/motd (example.org/announce/all-hosts/motd)
- The message is set as the message of the day (MOTD) and is sent to users when they login. In addition the message is sent to all connected users (similar to announce/online). -
- example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
- +
- example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
- The message is set as message of the day (MOTD) and is sent to users when they login. The message is not sent to any currently connected user. -
- example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
- +
- example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
- Any message sent to this JID removes the existing message of the day (MOTD).
- -access
- This option specifies who is allowed to +
Examples: -
- +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).
- +
-
- Only administrators can send announcements: -
+{access, announce, [{allow, admins}]}. {modules, @@ -1698,8 +1718,8 @@ Only administrators can send announcements: {mod_announce, [{access, announce}]}, ... ]}. -- Administrators as well as the direction can send announcements: -
+- Administrators as well as the direction can send announcements: +
{acl, direction, {user, "big_boss", "example.org"}}. {acl, direction, {user, "assistant", "example.org"}}. {acl, admins, {user, "admin", "example.org"}}. @@ -1716,7 +1736,7 @@ Only administrators can send announcements:A.4 mod_disco
+A.4 mod_disco
@@ -1729,26 +1749,26 @@ the newer Service Discovery protocol if you want them be able to discover the services you offer.
Options: -
- -iqdisc
- This specifies +
Examples: -
- +iqdisc
- This specifies the processing discipline for Service Discovery (http://jabber.org/protocol/disco#items and http://jabber.org/protocol/disco#info) IQ queries (see section A.2.1). -
- extra_domains
- With this option, +
- extra_domains
- With this option, extra domains can be added to the Service Discovery item list.
- +
-
- To serve a link to the Jabber User Directory on jabber.org: -
+{modules, [ ... {mod_disco, [{extra_domains, ["users.jabber.org"]}]}, ... ]}. -- To serve a link to the transports on another server: -
+- To serve a link to the transports on another server: +
{modules, [ ... @@ -1756,8 +1776,8 @@ To serve a link to the Jabber User Directory on jabber.org: "msn.example.com"]}]}, ... ]}. -- To serve a link to a few friendly servers: -
+- To serve a link to a few friendly servers: +
{modules, [ ... @@ -1768,7 +1788,7 @@ To serve a link to the Jabber User Directory on jabber.org:A.5 mod_echo
+A.5 mod_echo
@@ -1777,31 +1797,31 @@ packet back to the sender. This mirror can be of interest for ejabberd and Jabber client debugging.
Options: -
- +
Examples: -
- - hosts
- This option defines the hostnames of the + hosts
- This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``echo.'' is added to all + the old host is present, the prefix “echo.” is added to all ejabberd hostnames.
- +
-
- Mirror, mirror, on the wall, who is the most beautiful of them all? -
+{modules, [ ... {mod_echo, [{hosts, ["mirror.example.org"]}]}, ... ]}. -- If you still do not understand the inner workings of mod_echo, +
- If you still do not understand the inner workings of mod_echo, you can find a few more examples in section A.2.2.
A.6 mod_irc
+A.6 mod_irc
@@ -1810,50 +1830,50 @@ servers.
End user information: -
- -A Jabber client with ``groupchat 1.0'' support or Multi-User +
Options: -
- +A Jabber client with “groupchat 1.0” support or Multi-User Chat support (JEP-0045) is necessary to join IRC channels. -
- An IRC channel can be joined in nearly the same way as joining a +
- An IRC channel can be joined in nearly the same way as joining a Jabber Multi-User Chat room. The difference is that the room name will - be ``channel%irc.example.org'' in case irc.example.org is - the IRC server hosting ``channel''. And of course the host should point + be “channel%irc.example.org” in case irc.example.org is + the IRC server hosting “channel”. And of course the host should point to the IRC transport instead of the Multi-User Chat service. -
- You can register your nickame by sending ``IDENTIFY password'' to
+- You can register your nickame by sending “IDENTIFY password” to
nickserver!irc.example.org@irc.jabberserver.org. -- Entering your password is possible by sending ``LOGIN nick password''
+- Entering your password is possible by sending “LOGIN nick password”
to nickserver!irc.example.org@irc.jabberserver.org. -- When using a popular Jabber server, it can occur that no +
- When using a popular Jabber server, it can occur that no connection can be achieved with some IRC servers because they limit the number of conections from one IP.
- +
Examples: -
- - hosts
- This option defines the hostnames of the + hosts
- This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``irc.'' is added to all + the old host is present, the prefix “irc.” is added to all ejabberd hostnames. -
- access
- This option can be used to specify who +
- access
- This option can be used to specify who may use the IRC transport (default value: all).
- +
-
- In the first example, the IRC transport is available on (all) your - virtual host(s) with the prefix ``irc.''. Furthermore, anyone is + virtual host(s) with the prefix “irc.”. Furthermore, anyone is able to use the transport. -
+{modules, [ ... {mod_irc, [{access, all}]}, ... ]}. -- In next example the IRC transport is available on the two virtual hosts +
- In next example the IRC transport is available on the two virtual hosts example.net and example.com with different prefixes on each host. Moreover, the transport is only accessible by paying customers registered on our domains and on other servers. -
+{acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -1871,7 +1891,7 @@ In the first example, the IRC transport is available on (all) yourA.7 mod_last
+A.7 mod_last
@@ -1881,14 +1901,14 @@ connected user was last active on the server, or to query the uptime of the ejabberd server.
Options: -
- -iqdisc
- This specifies +
-
- +iqdisc
- This specifies the processing discipline for Last activity (jabber:iq:last) IQ queries (see section A.2.1).
A.8 mod_muc
+A.8 mod_muc
@@ -1897,27 +1917,27 @@ With this module enabled, your server will support Multi-User Chat that this module is not (yet) clusterable.
Some of the features of Multi-User Chat: -
- +
Options: -
- Sending private messages to room participants. -
- Inviting users. -
- Setting a conference topic. -
- Creating password protected rooms. -
- Kicking and banning participants. +
- Inviting users. +
- Setting a conference topic. +
- Creating password protected rooms. +
- Kicking and banning participants.
- +
Examples: -
- - hosts
- This option defines the hostnames of the + hosts
- This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``conference.'' is added to all + the old host is present, the prefix “conference.” is added to all ejabberd hostnames. -
- access
- You can specify who is allowed to use +
- access
- You can specify who is allowed to use the Multi-User Chat service (by default, everyone is allowed to use it). -
- access_create
- To configure who is +
- access_create
- To configure who is allowed to create new rooms at the Multi-User Chat service, this option can be used (by default, everybody is allowed to create rooms). -
- access_admin
- This option specifies +
- access_admin
- This option specifies who is allowed to administrate the Multi-User Chat service (the default value is none, which means that only the room creator can administer his room). By sending a message to the service JID, @@ -1925,16 +1945,16 @@ Options: active room.
- +
-
- In the first example everyone is allowed to use the Multi-User Chat service. Everyone will also be able to create new rooms but only the user admin@example.org is allowed to administrate any room. In this example he is also a global administrator. When admin@example.org - sends a message such as ``Tomorrow, the Jabber server will be moved + sends a message such as “Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns around 23:00 UMT. - We apologise for this inconvenience.'' to conference.example.org, + We apologise for this inconvenience.” to conference.example.org, it will be displayed in all active rooms. -
+{acl, admins, {user, "admin", "example.org"}}. ... {access, muc_admins, [{allow, admins}]}. @@ -1947,15 +1967,15 @@ In the first example everyone is allowed to use the Multi-User Chat {access_admin, muc_admins}]}, ... ]}. -- In the second example the Multi-User Chat service is only accessible by +
- In the second example the Multi-User Chat service is only accessible by paying customers registered on our domains and on other servers. Of course the administrator is also allowed to access rooms. In addition, he is the only authority able to create and administer rooms. When - admin@example.org sends a message such as ``Tomorrow, the Jabber + admin@example.org sends a message such as “Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns - around 23:00 UMT. We apologise for this inconvenience.'' to + around 23:00 UMT. We apologise for this inconvenience.” to conference.example.org, it will be displayed in all active rooms. -
+{acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -1978,7 +1998,7 @@ In the first example everyone is allowed to use the Multi-User ChatA.9 mod_muc_log
+A.9 mod_muc_log
@@ -1987,53 +2007,53 @@ Once you enable this module, join a chatroom with enought privileges using a MUC request the configuration form and there you will have an option to enable chatroom logging.
Some of the features of generated logs: --
- +
Options: -
- A lot of information about chatroom is added on top of the page: Room title, JID, subject author, subject and configuration. -
- Room title and JID are links to join the chatroom (using XMPP-IRI). -
- Subject and chatroom configuration changes are tracked and displayed. -
- Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. -
- Generated HTML files are XHTML 1.0 Transitional and CSS compliant. -
- Timestamps are self-referencing links. -
- Links on top for quicker navigation: Previous day, Next day, Up. -
- CSS is used for style definition, and a custom CSS file can be used. -
- URLs on messages and subjects are converted to hyperlinks. -
- Timezone used on timestamps is shown on the log files. -
- A custom link can be added on top of page. +
- Room title and JID are links to join the chatroom (using XMPP-IRI). +
- Subject and chatroom configuration changes are tracked and displayed. +
- Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. +
- Generated HTML files are XHTML 1.0 Transitional and CSS compliant. +
- Timestamps are self-referencing links. +
- Links on top for quicker navigation: Previous day, Next day, Up. +
- CSS is used for style definition, and a custom CSS file can be used. +
- URLs on messages and subjects are converted to hyperlinks. +
- Timezone used on timestamps is shown on the log files. +
- A custom link can be added on top of page.
- -access_log
- +
Example configuration: -
- +access_log
- Restricts which users are allowed to enable or disable chatroom logging using ACL and ACCESS. Default: muc_admin. If you want to allow any chatroom owner put: muc. -
- cssfile
- +
- cssfile
- If HTMLs will use a custom CSS file or the embedded one. Allowed values: false: HTMLs will include the standard CSS code; "CSS-URL": the URL of the CSS file (for example: "http://example.com/my.css"). Default: false. -
- dirtype
- +
- dirtype
- Type of directory that will be created. Allowed values: subdirs: creates subdirectories for year and month; plain: the filename contains the full date, no subdirs. Default: subdirs. -
- outdir
- +
- outdir
- Full path to the directory where html will be generated. Make sure the system user has write access on that directory. Default: "www/muc". -
- timezone
- +
- timezone
- What timezone should be used. Allowed values: local: use local time, as reported to Erlang by the operating system; universal: use GMT/UTC time. Default: local. -
- top_link
- +
- top_link
- Customizable link on top right corner. Syntax of this option: {"URL", "Text"}. Default: {"/", "Home"}.
+{modules, [ ... @@ -2050,7 +2070,7 @@ Example configuration:-A.10 mod_offline
+A.10 mod_offline
@@ -2062,78 +2082,78 @@ online again. Thus it is very similar to how email works. Note that
-A.11 mod_privacy
+A.11 mod_privacy
This module implements Blocking Communication (also known as Privacy Rules) as defined in section 10 from XMPP IM. If end users have support for it in their Jabber client, they will be able to: --
- +
+Options: -(from http://www.xmpp.org/specs/rfc3921.html#privacy)
- Retrieving one's privacy lists. -
- Adding, removing, and editing one's privacy lists. -
- Setting, changing, or declining active lists. -
- Setting, changing, or declining the default list (i.e., the list that +
- Adding, removing, and editing one's privacy lists. +
- Setting, changing, or declining active lists. +
- Setting, changing, or declining the default list (i.e., the list that is active by default). -
- Allowing or blocking messages based on JID, group, or subscription type +
- Allowing or blocking messages based on JID, group, or subscription type (or globally). -
- Allowing or blocking inbound presence notifications based on JID, group, +
- Allowing or blocking inbound presence notifications based on JID, group, or subscription type (or globally). -
- Allowing or blocking outbound presence notifications based on JID, group, +
- Allowing or blocking outbound presence notifications based on JID, group, or subscription type (or globally). -
- Allowing or blocking IQ stanzas based on JID, group, or subscription type +
- Allowing or blocking IQ stanzas based on JID, group, or subscription type (or globally). -
- Allowing or blocking all communications based on JID, group, or +
- Allowing or blocking all communications based on JID, group, or subscription type (or globally).
- -iqdisc
- This specifies +
-
- +iqdisc
- This specifies the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section A.2.1).
A.12 mod_private
+A.12 mod_private
This module adds support for Private XML Storage (JEP-0049): -+Using this method, Jabber entities can store private data on the server and retrieve it whenever necessary. The data stored might be anything, as long as it is valid XML. One typical usage for this namespace is the server-side storage of client-specific preferences; another is Bookmark Storage (JEP-0048).Options: -
- -iqdisc
- This specifies +
-
- +iqdisc
- This specifies the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section A.2.1).
A.13 mod_pubsub
+A.13 mod_pubsub
This module offers a Publish-Subscribe Service (JEP-0060). Publish-Subscribe can be used to develop (examples are taken from the JEP): --
- +
+@@ -2143,18 +2163,18 @@ known as ESB, the Enterprise Service Bus). The J-EAI project builts upon ejabberd's codebase and has contributed several features to mod_pubsub.
- 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.
Options: -
- +
Example: -
- - hosts
- This option defines the hostnames of the + hosts
- This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``pubsub.'' is added to all + the old host is present, the prefix “pubsub.” is added to all ejabberd hostnames. -
- served_hosts
- To specify which hosts needs to +
- served_hosts
- To specify which hosts needs to be served, you can use this option. If absent, only the main ejabberd host is served.
+{modules, [ ... @@ -2165,32 +2185,32 @@ Example:-A.14 mod_register
+A.14 mod_register
This module adds support for In-Band Registration (JEP-0077). This protocol enables end users to use a Jabber client to: -
- +
Options: -
- Register a new account on the server. -
- Change the password from an existing account on the server. -
- Delete an existing account on the server. +
- Change the password from an existing account on the server. +
- Delete an existing account on the server.
- -access
- This option can be configured to specify - rules to restrict registration. If a rule returns ``deny'' on the requested +
Examples: -
- +access
- This option can be configured to specify + rules to restrict registration. If a rule returns “deny” on the requested user name, registration for that user name is dennied. (there are no restrictions by default). -
- iqdisc
- This specifies +
- iqdisc
- This specifies the processing discipline for In-Band Registration (jabber:iq:register) IQ queries (see section A.2.1).
- +
- Next example prohibits the registration of too short account names and of account names with exotic characters in it: -
+{acl, shortname, {user_glob, "?"}}. {acl, shortname, {user_glob, "??"}}. {acl, strangename, {user_regexp, "^..?$"}}. @@ -2205,12 +2225,12 @@ Next example prohibits the registration of too short account names and of {mod_register, [{access, register}]}, ... ]}. -- The in-band registration of new accounts can be prohibited by changing the +
- The in-band registration of new accounts can be prohibited by changing the access option. If you really want to disable all In-Band Registration functionality, that is changing passwords in-band and deleting accounts in-band, you have to remove mod_register from the modules list. In this example all In-Band Registration functionality is disabled: -
+{access, register, [{deny, all}]}. {modules, @@ -2222,21 +2242,21 @@ Next example prohibits the registration of too short account names and ofA.15 mod_roster
+A.15 mod_roster
This module implements roster management as defined in RFC 3921: XMPP IM.
Options: -
- -iqdisc
- This specifies +
-
- +iqdisc
- This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section A.2.1).
A.16 mod_service_log
+A.16 mod_service_log
@@ -2247,25 +2267,25 @@ packets are encapsulated in a<route/>element and sent to th service(s).
Options: -
- -loggers
- With this option a (list of) service(s) +
Examples: -
- +loggers
- With this option a (list of) service(s) that will receive the packets can be specified.
- +
-
- To log all end user packets to the Bandersnatch service running on bandersnatch.example.com: -
+{modules, [ ... {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]}, ... ]}. -- To log all end user packets to the Bandersnatch service running on +
- To log all end user packets to the Bandersnatch service running on bandersnatch.example.com and the backup service on bandersnatch.example.org: -
+{modules, [ ... @@ -2276,7 +2296,7 @@ To log all end user packets to the Bandersnatch service running onA.17 mod_shared_roster
+A.17 mod_shared_roster
@@ -2288,21 +2308,21 @@ users from the shared roster groups.
Shared roster groups can be edited only via the web interface. Each group has a unique identification and the following parameters: -
- -Name
- The name of the group, which will be displayed in the roster. -
- Description
- The description of the group. This parameter doesn't affect +
Examples: -
- +Name
- The name of the group, which will be displayed in the roster. +
- Description
- The description of the group. This parameter doesn't affect anything. -
- Members
- A list of full JIDs of group members, entered one per line in +
- Members
- A list of full JIDs of group members, entered one per line in the web interface. -
- Displayed groups
- A list of groups that will be in the rosters of this +
- Displayed groups
- A list of groups that will be in the rosters of this group's members.
- +
-
- Take the case of a computer club that wants all its members seeing each other in their rosters. To achieve this, they need to create a shared roster group similar to next table: -
++--
Identification Group `club_members' @@ -2325,14 +2345,14 @@ Take the case of a computer club that wants all its members seeing eachDisplayed groups club_members - In another case we have a company which has three divisions: Management, +
- In another case we have a company which has three divisions: Management, Marketing and Sales. All group members should see all other members in their rosters. Additonally, all managers should have all marketing and sales people in their roster. Simultaneously, all marketeers and the whole sales team should see all managers. This scenario can be achieved by creating shared roster groups as shown in the following table: -
++-
Identification Group `management' @@ -2399,25 +2419,25 @@ Take the case of a computer club that wants all its members seeing eachsales A.18 mod_stats
+A.18 mod_stats
This module adds support for Statistics Gathering (JEP-0039). This protocol allows you to retrieve next statistics from your ejabberd deployment: -
- +
Options: -
- Total number of registered users on the current virtual host (users/total). -
- Total number of registered users on all virtual hosts (users/all-hosts/total). -
- Total number of online users on the current virtual host (users/online). -
- Total number of online users on all virtual hosts (users/all-hosts/online). +
- Total number of registered users on all virtual hosts (users/all-hosts/total). +
- Total number of online users on the current virtual host (users/online). +
- Total number of online users on all virtual hosts (users/all-hosts/online).
-
- -iqdisc
- This specifies +
@@ -2425,18 +2445,18 @@ As there are only a small amount of clients (for example Tkabber) and software libraries with support for this JEP, a few examples are given of the XML you need to send in order to get the statistics. Here they are: -
- +iqdisc
- This specifies the processing discipline for Statistics Gathering (http://jabber.org/protocol/stats) IQ queries (see section A.2.1).
- +
-
- You can request the number of online users on the current virtual host (example.org) by sending: -
+<iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/online'/> </query> </iq> -- You can request the total number of registered users on all virtual hosts +
- You can request the total number of registered users on all virtual hosts by sending: -
+<iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/all-hosts/total'/> @@ -2445,7 +2465,7 @@ You can request the number of online users on the current virtual hostA.19 mod_time
+A.19 mod_time
@@ -2453,14 +2473,14 @@ This module features support for Entity Time (- +iqdisc
- This specifies the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section A.2.1).
A.20 mod_vcard
+A.20 mod_vcard
@@ -2470,39 +2490,39 @@ implements an uncomplicated Jabber User Directory based on the vCards of these users. Moreover, it enables the server to send its vCard when queried.
Options: --
- +
Examples: -
- - hosts
- This option defines the hostnames of the + hosts
- This option defines the hostnames of the service (see section A.2.2). If neither hosts nor - the old host is present, the prefix ``vjud.'' is added to all + the old host is present, the prefix “vjud.” is added to all ejabberd hostnames. -
- iqdisc
- This specifies +
- iqdisc
- This specifies the processing discipline for vcard-temp IQ queries (see section A.2.1). -
- search
- This option specifies whether the search +
- search
- This option specifies whether the search functionality is enabled (value: true) or disabled (value: false). If disabled, the option hosts will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true. -
- matches
- With this option, the number of reported +
- matches
- With this option, the number of reported search results can be limited. If the option's value is set to infinity, all search results are reported. The default value is 30. -
- allow_return_all
- This option enables +
- allow_return_all
- This option enables you to specify if search operations with empty input fields should return all users who added some information to their vCard. The default value is false. -
- search_all_hosts
- If this option is +
- search_all_hosts
- If this option is set to true, search operations will apply to all virtual hosts. Otherwise only the current host will be searched. The default value is true.
- +
-
- 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, [ ... @@ -2512,9 +2532,9 @@ In this first situation, search results are limited to twenty items, {search_all_hosts, false}]}, ... ]}. -- The second situation differs in a way that search results are not limited, +
- The second situation differs in a way that search results are not limited, and that all virtual hosts will be searched instead of only the current one: -
+{modules, [ ... @@ -2526,7 +2546,7 @@ In this first situation, search results are limited to twenty items,A.21 mod_version
+A.21 mod_version
@@ -2534,20 +2554,20 @@ This module implements Software Version (- +iqdisc
- This specifies the processing discipline for Software Version (jabber:iq:version) IQ queries (see section A.2.1).
B Internationalization and Localization
+B Internationalization and Localization
All built-in modules support the xml:lang attribute inside IQ queries. Figure 2, for example, shows the reply to the following query: -+<iq id='5' to='example.org' type='get' @@ -2555,40 +2575,44 @@ Figure 2, for example, shows the reply to the f <query xmlns='http://jabber.org/protocol/disco#items'/> </iq>-The web interface also supports theAccept-LanguageHTTP header (compare figure 3 with figure 1) --C Release Notes
+C Release Notes
-C.1 ejabberd 0.9
+C.1 ejabberd 0.9
-+Release notes ejabberd 0.9 @@ -2680,9 +2704,9 @@ Bugfixes-C.2 ejabberd 0.9.1
+C.2 ejabberd 0.9.1
-+Release notes ejabberd 0.9.1 @@ -2748,9 +2772,9 @@ Bugfixes-C.3 ejabberd 0.9.8
+C.3 ejabberd 0.9.8
-+Release notes ejabberd 0.9.8 2005-08-01 @@ -2853,9 +2877,9 @@ END-C.4 ejabberd 1.0.0
+C.4 ejabberd 1.0.0
-+Release Notes ejabberd 1.0.0 14 December 2005 @@ -2979,16 +3003,17 @@ END-C.5 ejabberd 1.1.0
+C.5 ejabberd 1.1.0
-+Release Notes ejabberd 1.1.0 24 April 2006 This document describes the main changes in ejabberd 1.1.0. This version - introduce new features, new JEPs (Jabber Enhancement Proposal) support, and - many performance improvements for large scale deployments. + introduce new features including support for new Jabber Enhancement + Proposals and several performance improvements enabling deployments on an + even larger scale than already possible. ejabberd can be downloaded from the Process-one website: http://www.process-one.net/en/projects/ejabberd/ @@ -3006,22 +3031,20 @@ END New Jabber Enhancement Proposal support: - - JEP-0050: adhoc commands support. - - JEP-0138: Stream compression support. + - JEP-0050: Ad-Hoc Commands. + - JEP-0138: Stream Compression. - JEP-0175: SASL anonymous. Anonymous login - - SASL anonymous is fully supported. - - Login anonymous is supported for client that do not yet support SASL - anonymous. + - SASL anonymous. + - Anonymous login for clients that do not yet support SASL Anonymous. Relational database Support - - MySQL is now fully supported through ODBC or in native mode. - - Various improvements to the native database features. - - The Jabber migration tool can now use relational databases and not only - the internal Mnesia database. + - MySQL is now fully supported through ODBC and in native mode. + - Various improvements to the native database interfaces. + - The migration tool can use relational databases. Multi-User Chat improvements @@ -3038,33 +3061,36 @@ Performance scalability improvements for large clusters - Speed improvement on logger. - TCP/IP packet reception change for better network throttling and regulation. - As a result, load on large installation should be reduced. + As a result, these improvements will reduce load on large scale deployments. XMPP Protocol related improvements - - The size of the XML stanza is now limited. - - Messages are now send to all resources that have a priority equal to the - highest priority currently used by the user. + - XML stanza size can be limited. + - Messages are send to all resources with the same highest priority. Documentation and Internationalization - - Documentation has been extended to cover more topics and updated. + - Documentation has been extended to cover more topics. - Translations have been updated. +Web interface + + - XHTML 1.0 compliance. + Bugfixes - - This release contains many bugfixes on various other areas: pubsub, build - chain, installers, IRC gateway, ejabberdctl, ... + - This release contains many bugfixes on various areas such as Publish-Subscribe, build + chain, installers, IRC gateway, ejabberdctl, amongst others. - Please refer to the ChangeLog file supplied with this release regarding all improvements in ejabberd. - Installation Notes + Installation Notes Supported Erlang Version - - You need at least Erlang/OTP R9C to run ejabberd 1.1.0. + - You need at least Erlang/OTP R9C-2 to run ejabberd 1.1.0. Installation @@ -3076,8 +3102,133 @@ Migration Notes - Before any migration, ejabberd system and database must be properly backed up. - - The database schema has not been changed and consequently it does not - require any migration. + - The database schema has not been changed comparing to version 1.0.0 and + consequently it does not require any migration. + + +References + + Contributed tutorials and documents of interest are: + - Migration from Jabberd1.4, Jabberd2 and WPJabber to ejabberd: + http://ejabberd.jabber.ru/migrate-to-ejabberd + - Transport configuration for connecting to other networks: + http://ejabberd.jabber.ru/tutorials-transports + - Using ejabberd with MySQL native driver: + http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver + - Anonymous User Support: + http://support.process-one.net/doc/display/MESSENGER/Anonymous+users+support + - Frequently Asked Questions: + http://ejabberd.jabber.ru/faq + +END ++ + +C.6 ejabberd 1.1.1
+ ++ Release Notes + ejabberd 1.1.1 + 28 April 2006 + + This document describes the main changes in ejabberd 1.1.x. This version + introduce new features including support for new Jabber Enhancement + Proposals and several performance improvements enabling deployments on an + even larger scale than already possible. + + This release fix a security issue introduced in ejabberd 1.1.0. In SASL + mode, anonymous login was enabled as a default. Upgrading ejabberd 1.1.0 to + ejabberd 1.1.1 is highly recommanded. + + ejabberd can be downloaded from the Process-one website: + http://www.process-one.net/en/projects/ejabberd/ + + Detailed information can be found in the ejabberd Feature Sheet and User + Guide which are available on the Process-one website: + http://www.process-one.net/en/projects/ejabberd/docs.html + + A complete list of changes is available from: + http://support.process-one.net/secure/ReleaseNote.jspa?projectId=10011&styleName=Html&version=10025 + + + Recent changes include: + + +New Jabber Enhancement Proposal support: + + - JEP-0050: Ad-Hoc Commands. + - JEP-0138: Stream Compression. + - JEP-0175: SASL anonymous. + +Anonymous login + + - SASL anonymous. + - Anonymous login for clients that do not yet support SASL Anonymous. + +Relational database Support + + - MySQL is now fully supported through ODBC and in native mode. + - Various improvements to the native database interfaces. + - The migration tool can use relational databases. + +Multi-User Chat improvements + + - Logging of room discussion to text file is now supported. + - Better reconfiguration support. + - Security oriented fixes. + - Several improvements and updates to latest JEP-0045. + +Performance scalability improvements for large clusters + + - Improved session synchronisation management between cluster nodes. + - Internal architecture has been reworked to use generalize Erlang/OTP + framework usage. + - Speed improvement on logger. + - TCP/IP packet reception change for better network throttling and + regulation. + As a result, these improvements will reduce load on large scale deployments. + +XMPP Protocol related improvements + + - XML stanza size can be limited. + - Messages are send to all resources with the same highest priority. + +Documentation and Internationalization + + - Documentation has been extended to cover more topics. + - Translations have been updated. + +Web interface + + - XHTML 1.0 compliance. + +Bugfixes + + - This release contains many bugfixes on various areas such as Publish-Subscribe, build + chain, installers, IRC gateway, ejabberdctl, amongst others. + - Please refer to the ChangeLog file supplied with this release regarding + all improvements in ejabberd. + + + + Installation Notes + +Supported Erlang Version + + - You need at least Erlang/OTP R9C-2 to run ejabberd 1.1.0. + +Installation + + Installers are provided for Microsoft Windows, Linux/x86 and MacOSX/PPC. + Installers can be retrieved from: + http://www.process-one.net/en/projects/ejabberd/download.html + +Migration Notes + + - Before any migration, ejabberd system and database must be properly + backed up. + - The database schema has not been changed comparing to version 1.0.0 and + consequently it does not require any migration. References @@ -3098,26 +3249,23 @@ END-D Acknowledgements
+D Acknowledgements
Thanks to all people who contributed to this guide: -
- +
-
- Alexey Shchepin (xmpp:aleksey@jabber.ru) -
- Florian Zumbiehl (xmpp:florz@florz.de) -
- Michael Grigutsch (xmpp:migri@jabber.i-pobox.net) -
- Mickael Remond (xmpp:mremond@erlang-projects.org) -
- Sander Devrieze (xmpp:sander@devrieze.dyndns.org) -
- Sergei Golovan (xmpp:sgolovan@nes.ru) -
- Vsevolod Pelipas (xmpp:vsevoload@jabber.ru) +
- Florian Zumbiehl (xmpp:florz@florz.de) +
- Michael Grigutsch (xmpp:migri@jabber.i-pobox.net) +
- Mickael Remond (xmpp:mremond@erlang-projects.org) +
- Sander Devrieze (xmpp:sander@devrieze.dyndns.org) +
- Sergei Golovan (xmpp:sgolovan@nes.ru) +
- Vsevolod Pelipas (xmpp:vsevoload@jabber.ru)
-This document was translated from LATEX by -HEVEA. -- +This document was translated from LATEX by +HEVEA.
