|
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.
ejabberd is:
Moreover, ejabberd comes with a wide range of other state-of-the-art features:
Probably the easiest way to install an ejabberd instant messaging server is using the binary installer published by ProcessOne. The binary installers of released ejabberd versions are available in the ProcessOne ejabberd downloads page: 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 dependencies.
In *nix systems, remember to set executable the binary installer before starting it. For example:
chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin ./ejabberd-2.0.0_1-linux-x86-installer.bin
ejabberd can be started manually at any time, or automatically by the operating system at system boot time.
To start and stop ejabberd manually, use the desktop shortcuts created by the installer. If the machine doesn’t have a graphical system, use the scripts ’start’ and ’stop’ in the ’bin’ directory where ejabberd is installed.
The Windows installer also adds ejabberd as a system service, and a shortcut to a debug console for experienced administrators. If you want ejabberd to be started automatically at boot time, go to the Windows service settings and set ejabberd to be automatically started. Note that the Windows service is a feature still in development, and for example it doesn’t read the file ejabberdctl.cfg.
On a *nix system, if you want ejabberd to be started as daemon at boot time, copy ejabberd.init from the ’bin’ directory to something like /etc/init.d/ejabberd (depending on your distribution) and call /etc/inid.d/ejabberd start to start it.
If ejabberd doesn’t start correctly in Windows, try to start it using the shortcut in desktop or start menu. If the window shows error 14001, the solution is to install: "Microsoft Visual C++ 2005 SP1 Redistributable Package". You can download it from www.microsoft.com. Then uninstall ejabberd and install it again.
If ejabberd doesn’t start correctly and a crash dump is generated, there was a severe problem. You can try starting ejabberd with the script bin/live.bat in Windows, or with the command bin/ejabberdctl live in other Operating Systems. This way you see the error message provided by Erlang and can identify what is exactly the problem.
The ejabberdctl administration script is included in the bin directory. Please refer to the section 4.1 for details about ejabberdctl, and configurable options to fine tune the Erlang runtime system.
Some Operating Systems provide a specific ejabberd package adapted to the system architecture and libraries. It usually also checks dependencies and performs basic configuration tasks like creating the initial administrator account. Some examples are Debian and Gentoo. Consult the resources provided by your Operating System for more information.
Usually those packages create a script like /etc/init.d/ejabberd to start and stop ejabberd as a service at boot time.
CEAN (Comprehensive Erlang Archive Network) is a repository that hosts binary packages from many Erlang programs, including ejabberd and all its dependencies. The binaries are available for many different system architectures, so this is an alternative to the binary installer and Operating System’s ejabberd packages.
You will have to create your own ejabberd start script depending of how you handle your CEAN installation. The default ejabberdctl script is located into ejabberd’s priv directory and can be used as an example.
The canonical form for distribution of ejabberd stable releases is the source code package. Compiling ejabberd from source code is quite easy in *nix systems, as long as your system have all the dependencies.
To compile ejabberd on a ‘Unix-like’ operating system, you need:
Released versions of ejabberd are available in the ProcessOne ejabberd downloads page: http://www.process-one.net/en/ejabberd/downloads
Alternatively, the latest development version can be retrieved from the Subversion repository using this command:
svn co http://svn.process-one.net/ejabberd/trunk ejabberd
To compile ejabberd execute the commands:
./configure make
The build configuration script allows several options. To get the full list run the command:
./configure --help
Some options that you may be interested in modifying:
To install ejabberd in the destination directories, run the command:
make install
Note that you probably need administrative privileges in the system to install ejabberd.
The files and directories created are, by default:
You can use the ejabberdctl command line administration script to start and stop ejabberd. If you provided the configure option --enable-user=USER (see 2.4.3), you can execute ejabberdctl with either that system account or root.
Usage example:
ejabberdctl start ejabberdctl status The node ejabberd@localhost is started with status: started ejabberd is running in that node ejabberdctl stop
If ejabberd doesn’t start correctly and a crash dump is generated, there was a severe problem. You can try starting ejabberd with the command ejabberdctl live to see the error message provided by Erlang and can identify what is exactly the problem.
Please refer to the section 4.1 for details about ejabberdctl, and configurable options to fine tune the Erlang runtime system.
The command to compile ejabberd in BSD systems is:
gmake
You need to have GNU install, but it isn’t included in Solaris. It can be easily installed if your Solaris system is set up for blastwave.org package repository. Make sure /opt/csw/bin is in your PATH and run:
pkg-get -i fileutils
If that program is called ginstall, modify the ejabberd Makefile script to suit your system, for example:
cat Makefile | sed s/install/ginstall/ > Makefile.gi
And finally install ejabberd with:
gmake -f Makefile.gi ginstall
To compile ejabberd on a Microsoft Windows system, you need:
We assume that we will try to put as much library as possible into C:\sdk\ to make it easier to track what is install for ejabberd.
C:\sdk\erl5.5.5).
C:\sdk\Expat-2.0.0
directory.Copy file C:\sdk\Expat-2.0.0\Libs\libexpat.dll
to your Windows system directory (for example, C:\WINNT or
C:\WINNT\System32)
C:\sdk\GnuWin32.Copy file C:\sdk\GnuWin32\bin\lib*.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:\sdk\Expat-2.0.0\Libs and
C:\sdk\GnuWin32\bin to the PATH environment
variable.
C:\sdk\OpenSSL and add C:\sdk\OpenSSL\lib\VC to your path or copy the binaries to your system directory.
C:\sdk\gnuWin32. Copy
C:\sdk\GnuWin32\bin\zlib1.dll to your system directory. If you change your path it should already be set after libiconv install.
set PATH=%PATH%;"C:\sdk\erl5.5.5\bin"
ejabberd\src run:
configure.bat nmake -f Makefile.win32
ejabberd\src\ejabberd.cfg and run
werl -s ejabberd -name ejabberd
You need a Jabber account and grant him administrative privileges to enter the ejabberd Web Admin:
{acl, admins, {user, "admin1", "example.org"}}.
{access, configure, [{allow, admins}]}.
You can grant administrative privileges to many Jabber accounts,
and also to accounts in other Jabber servers.
http://server:port/admin/) in your
favourite browser. Make sure to enter the full JID as username (in this
example: admin1@example.org. The reason that you also need to enter the
suffix, is because ejabberd’s virtual hosting support.
To upgrade an ejabberd installation to a new version, simply uninstall the old version, and then install the new one. Of course, it is important that the configuration file and Mnesia database spool directory are not removed.
ejabberd automatically updates the Mnesia table definitions at startup when needed. If you also use an external database for storage of some modules, check if the release notes of the new ejabberd version indicates you need to also update those tables.
The configuration file will be loaded the first time you start ejabberd. The content from this file will be parsed and stored in the internal ejabberd 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.
Note that ejabberd never edits the configuration file. So, the configuration changes done using the Web Admin are stored in the database, but are not reflected in the configuration file. If you want those changes to be use after ejabberd restart, you can either edit the configuration file, or remove all its content.
The configuration file contains a sequence of Erlang terms. Lines beginning with a ‘%’ sign are ignored. Each term is a tuple of which the first element is the name of an option, and any further elements are that option’s values. If the configuration file do not contain for instance the ‘hosts’ option, the old host name(s) stored in the database will be used.
You can override the old values stored in the database by adding next lines to the configuration file:
override_global. override_local. override_acls.
With these lines the old global options (shared between all ejabberd nodes in a cluster), local options (which are specific for this particular ejabberd node) and ACLs will be removed before new ones are added.
The option hosts defines a list containing one or more domains that ejabberd will serve.
Examples:
{hosts, ["example.org"]}.
{host, "example.org"}.
{hosts, ["example.net", "example.com"]}.
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, "example.net", [{auth_method, internal}]}.
{host_config, "example.com", [{auth_method, ldap},
{ldap_servers, ["localhost"]},
{ldap_uids, [{"uid"}]},
{ldap_rootdn, "dc=localdomain"},
{ldap_rootdn, "dc=example,dc=com"},
{ldap_password, ""}]}.
{host_config, "example.net", [{auth_method, odbc},
{odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}.
{host_config, "example.com", [{auth_method, ldap},
{ldap_servers, ["localhost", "otherhost"]},
{ldap_uids, [{"uid"}]},
{ldap_rootdn, "dc=localdomain"},
{ldap_rootdn, "dc=example,dc=com"},
{ldap_password, ""}]}.
To define specific ejabberd modules in a virtual host, you can define the global modules option with the common modules, and later add specific modules to certain virtual hosts. To accomplish that, instead of defining each option in host_config with the syntax
{<option-name>, <option-value>}
use this syntax:
{{add, <option-name>}, <option-value>}
In this example three virtual hosts have some similar modules, but there are also other different modules for some specific virtual hosts:
%% This ejabberd server has three vhosts:
{hosts, ["one.example.org", "two.example.org", "three.example.org"]}.
%% Configuration of modules that are common to all vhosts
{modules,
[
{mod_roster, []},
{mod_configure, []},
{mod_disco, []},
{mod_private, []},
{mod_time, []},
{mod_last, []},
{mod_version, []}
]}.
%% Add some modules to vhost one:
{host_config, "one.example.org",
[{{add, modules}, [
{mod_echo, [{host, "echo-service.one.example.org"}]}
{mod_http_bind, []},
{mod_logxml, []}
]
}
]}.
%% Add a module just to vhost two:
{host_config, "two.example.org",
[{{add, modules}, [
{mod_echo, [{host, "mirror.two.example.org"}]}
]
}
]}.
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:
The available modules, their purpose and the options allowed by each one are:
This is a detailed description of each option allowed by the listening modules:
Remember that you must also install and enable the module mod_http_bind.
If HTTP Bind is enabled, it will be available at
http://server:port/http-bind/. Be aware that support for HTTP Bind
is also needed in the Jabber client. Remark also that HTTP Bind can be
interesting to host a web-based Jabber client such as
JWChat
(check the tutorials to install JWChat with ejabberd and an
embedded local web server
or Apache).
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.
{ip, {192, 168, 1, 1}}.
{max_stanza_size, 65536}. The default
value is infinity. Recommended values are 65536 for c2s
connections and 131072 for s2s connections. s2s max stanza size
must always much higher than c2s limit. Change this value with
extreme care as it can cause unwanted disconnect if set too low.
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.
There are some additional global options:
For example, the following simple configuration defines:
{hosts, ["example.com", "example.org", "example.net"]}.
{listen,
[
{5222, ejabberd_c2s, [
{access, c2s},
{shaper, c2s_shaper},
starttls, {certfile, "/etc/ejabberd/server.pem"},
{max_stanza_size, 65536}
]},
{5223, ejabberd_c2s, [
{access, c2s},
{shaper, c2s_shaper},
tls, {certfile, "/etc/ejabberd/server.pem"},
{max_stanza_size, 65536}
]},
{5269, ejabberd_s2s_in, [
{shaper, s2s_shaper},
{max_stanza_size, 131072}
]},
{5280, ejabberd_http, [
http_poll
]},
{5281, ejabberd_http, [
web_admin,
tls, {certfile, "/etc/ejabberd/server.pem"},
]}
]
}.
{s2s_use_starttls, true}.
{s2s_certfile, "/etc/ejabberd/server.pem"}.
{domain_certfile, "example.com", "/etc/ejabberd/example_com.pem"}.
In this example, the following configuration defines that:
{acl, blocked, {user, "bad"}}.
{access, c2s, [{deny, blocked},
{allow, all}]}.
{shaper, normal, {maxrate, 1000}}.
{access, c2s_shaper, [{none, admin},
{normal, all}]}.
{listen,
[{5222, ejabberd_c2s, [{access, c2s}, {shaper, c2s_shaper}]},
{5223, ejabberd_c2s, [{access, c2s},
ssl, {certfile, "/path/to/ssl.pem"}]},
{5269, ejabberd_s2s_in, []},
{5280, ejabberd_http, [http_poll, web_admin]},
{5233, ejabberd_service, [{hosts, ["aim.example.org"],
[{password, "aimsecret"}]}]},
{5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
[{password, "jitsecret"}]}]},
{5235, ejabberd_service, [{hosts, ["msn.example.org"],
[{password, "msnsecret"}]}]},
{5236, ejabberd_service, [{hosts, ["yahoo.example.org"],
[{password, "yahoosecret"}]}]},
{5237, ejabberd_service, [{hosts, ["gg.example.org"],
[{password, "ggsecret"}]}]},
{5238, ejabberd_service, [{hosts, ["jmc.example.org"],
[{password, "jmcsecret"}]}]},
{5239, ejabberd_service, [{hosts, ["custom.example.org"],
[{password, "customsecret"}]},
{service_check_from, false}]}
]
}.
{s2s_use_starttls, true}.
{s2s_certfile, "/path/to/ssl.pem"}.
{s2s_default_policy, deny}.
{{s2s_host,"jabber.example.org"}, allow}.
{{s2s_host,"example.com"}, allow}.
Note, that for jabberd 1.4- or WPJabber-based services you have to make the transports log and do XDB by themselves:
<!--
You have to add elogger and rlogger entries here when using ejabberd.
In this case the transport will do the logging.
-->
<log id='logger'>
<host/>
<logtype/>
<format>%d: [%t] (%h): %s</format>
<file>/var/log/jabber/service.log</file>
</log>
<!--
Some Jabber server implementations do not provide
XDB services (for example, jabberd2 and ejabberd).
xdb_file.so is loaded in to handle all XDB requests.
-->
<xdb id="xdb">
<host/>
<load>
<!-- this is a lib of wpjabber or jabberd -->
<xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file>
</load>
<xdb_file xmlns="jabber:config:xdb_file">
<spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
</xdb_file>
</xdb>
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:
ejabberd uses its internal Mnesia database as the default authentication method.
Examples:
{host_config, "example.org", [{auth_method, [internal]}]}.
{host_config, "example.net", [{auth_method, [ldap]}]}.
{auth_method, internal}.
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.1.2). Note that there also is a detailed tutorial regarding SASL Anonymous and anonymous login configuration.
Those options are defined for each virtual host with the host_config parameter (see section 3.1.2).
Examples:
{auth_method, [anonymous]}.
{anonymous_protocol, login_anon}.
{host_config, "public.example.org", [{auth_method, [anonymous]},
{anonymous_protocol, login_anon}]}.
{host_config, "public.example.org", [{auth_method, [internal,anonymous]},
{anonymous_protocol, login_anon}]}.
{host_config, "public.example.org", [{auth_method, [anonymous]},
{anonymous_protocol, sasl_anon}]}.
{host_config, "public.example.org", [{auth_method, [anonymous]},
{anonymous_protocol, both}]}.
{host_config, "public.example.org", [{auth_method, [internal,anonymous]},
{anonymous_protocol, both}]}.
ejabberd supports authentication via Pluggable Authentication Modules (PAM). PAM is currently supported in AIX, FreeBSD, HP-UX, Linux, Mac OS X, NetBSD and Solaris. PAM authentication is disabled by default, so you have to configure and compile ejabberd with PAM support enabled:
./configure --enable-pam && make install
Options:
Example:
{auth_method, [pam]}.
{pam_service, "ejabberd"}.
Though it is quite easy to set up PAM support in ejabberd, PAM itself introduces some security issues:
/var/lib/ejabberd/priv/bin/
directory. You have to set it root on execution in the case when your PAM module
requires root privileges (pam_unix.so for example). Also you have to grant access
for ejabberd to this file and remove all other permissions from it.
Execute with root privileges:
chown root:ejabberd /var/lib/ejabberd/priv/bin/epam chmod 4750 /var/lib/ejabberd/priv/bin/epam
#%PAM-1.0 auth sufficient pam_unix.so likeauth nullok nodelay account sufficient pam_unix.soThat is not a ready to use configuration file: you must use it as a hint when building your own PAM configuration instead. Note that if you want to disable delays on authentication failures in the PAM configuration file, you have to restrict access to this file, so a malicious user can’t use your configuration to perform brute-force attacks.
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:
{acl, all, all}.
{acl, admin, {user, "yozhik"}}.
{acl, admin, {user, "yozhik", "example.org"}}.
{acl, exampleorg, {server, "example.org"}}.
{acl, mucklres, {resource, "muckl"}}.
{acl, techgroupmembers, {shared_group, "techteam"}}.
{acl, techgroupmembers, {shared_group, "techteam", "example.org"}}.
{acl, tests, {user_regexp, "^test[0-9]*$"}}.
{acl, tests, {user_regexp, "^test", "example.org"}}.
{acl, icq, {server_regexp, "^icq\\."}}.
{acl, icq, {resource_regexp, "^laptop\\."}}.
{acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}.
The following ACLs are pre-defined:
An entry allowing or denying access to different services looks similar to this:
{access, <accessname>, [{allow, <aclname>},
{deny, <aclname>},
...
]}.
When a JID is checked to have access to <accessname>, the server sequentially checks if that JID matches 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}]}.
{access, something, [{deny, badmans},
{allow, all}]}.
The following access rules are pre-defined:
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>},
...
]}.
Examples:
{access, max_user_sessions, [{10, all}]}.
The special access max_s2s_connections specifies how many simultaneus S2S connections can be established to a specific remote Jabber server. The default value is 1. There’s also available the access max_s2s_connections_per_node.
The syntax is:
{access, max_s2s_connections, [{<maxnumber>, <aclname>},
...
]}.
Examples:
{access, max_s2s_connections, [{3, all}]}.
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 incoming rate in bytes per second. When a connection exceeds this limit, ejabberd stops reading from the socket until the average rate is again below the allowed maximum.
Examples:
{shaper, normal, {maxrate, 1000}}.
{shaper, fast, {maxrate, 50000}}.
The option language defines the default language of server strings that can be seen by Jabber clients. If a Jabber client does 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, "ru"}.
{language, "es"}.
Appendix A provides more details about internationalization and localization.
The option include_config_file in a configuration file instructs ejabberd to include other configuration files immediately.
The basic usage is:
{include_config_file, <filename>}.
It is also possible to specify suboptions:
{include_config_file, <filename>, [<suboption>, <suboption>, ...]}.
The filename can be indicated either as an absolute path, or relative to the main ejabberd configuration file. It isn’t possible to use wildcards. The file must exist and be readable.
The allowed suboptions are:
This is a basic example:
{include_config_file, "/etc/ejabberd/additional.cfg"}.
In this example, the included file is not allowed to contain a listen option. If such an option is present, the option will not be accepted. The file is in a subdirectory from where the main configuration file is.
{include_config_file, "./example.org/additional_not_listen.cfg", [{disallow, [listen]}]}.
In this example, ejabberd.cfg defines some ACL and Access rules, and later includes another file with additional rules:
{acl, admin, {user, "admin", "localhost"}}.
{access, announce, [{allow, admin}]}.
{include_config_file, "/etc/ejabberd/acl_and_access.cfg", [{allow_only, [acl, access]}]}.
and content of the file acl_and_access.cfg can be, for example:
{acl, admin, {user, "bob", "localhost"}}.
{acl, admin, {user, "jan", "localhost"}}.
In the ejabberd configuration file, it is possible to define a macro for a value and later use this macro when defining an option.
A macro is defined with this syntax:
{define_macro, '<MACRO>', <value>}.
The MACRO must be surrounded by single quotation marks, and all letters in uppercase; check the examples bellow. The value can be any valid arbitrary Erlang term.
The first definition of a macro is preserved, and additional definitions of the same macro are forgotten.
Macros are processed after additional configuration files have been included, so it is possible to use macros that are defined in configuration files included before the usage.
It isn’t possible to use a macro in the definition of another macro.
There are two ways to use a macro:
{define_macro, '<MACRO>', <defaultvalue>}.
'<MACRO>'
This example shows the basic usage of a macro:
{define_macro, 'LOG_LEVEL_NUMBER', 5}.
{loglevel, 'LOG_LEVEL_NUMBER'}.
The resulting option interpreted by ejabberd is: {loglevel, 5}.
This example shows that values can be any arbitrary Erlang term:
{define_macro, 'USERBOB', {user, "bob", "localhost"}}.
{acl, admin, 'USERBOB'}.
The resulting option interpreted by ejabberd is: {acl, admin, {user, "bob", "localhost"}}.
This complex example:
{define_macro, 'NUMBER_PORT_C2S', 5222}.
{define_macro, 'PORT_S2S_IN', {5269, ejabberd_s2s_in, []}}.
{listen,
[
{'NUMBER_PORT_C2S', ejabberd_c2s, []},
'PORT_S2S_IN',
{{use_macro, 'NUMBER_PORT_HTTP', 5280}, ejabberd_http, []}
]
}.
produces this result after being interpreted:
{listen,
[
{5222, ejabberd_c2s, []},
{5269, ejabberd_s2s_in, []},
{5280, ejabberd_http, []}
]
}.
ejabberd uses its internal Mnesia database by default. However, it is possible to use a relational database or an LDAP server to store persistent, 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:
The following LDAP servers are tested with ejabberd:
Important note about virtual hosting: if you define several domains in ejabberd.cfg (see section 3.1.1), you probably want that each virtual host uses a different configuration of database, authentication and storage, so that usernames do not conflict and mix between different virtual hosts. For that purpose, the options described in the next sections must be set inside a host_cofig for each vhost (see section 3.1.2). For example:
{host_config, "public.example.org", [
{odbc_server, {pgsql, "localhost", "database-public-example-org", "ejabberd", "password"}},
{auth_method, [odbc]}
]}.
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 you. This file contains the ejabberd schema for MySQL. At the end of the file you can find information to update your database schema.
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.
./configure --enable-odbc && make install
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 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"}}.
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"}}.
By default ejabberd opens 10 connections to the database for each virtual host. Use this option to modify the value:
{odbc_pool_size, 10}.
You can configure an interval to make a dummy SQL request to keep alive the connections to the database. The default value is ’undefined’, so no keepalive requests are made. Specify in seconds: for example 28800 means 8 hours.
{odbc_keepalive_interval, undefined}.
If the connection to the database fails, ejabberd waits 30 seconds before retrying. You can modify this interval with this option:
{odbc_start_interval, 30}.
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:
{auth_method, [odbc]}.
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!
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 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.
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
By default ejabberd opens 10 connections to the database for each virtual host. Use this option to modify the value:
{odbc_pool_size, 10}.
You can configure an interval to make a dummy SQL request to keep alive the connections to the database. The default value is ’undefined’, so no keepalive requests are made. Specify in seconds: for example 28800 means 8 hours.
{odbc_keepalive_interval, undefined}.
The configuration of Microsoft SQL Server is the same as the configuration of ODBC compatible servers (see section 3.2.4).
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!
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. This file contains the ejabberd schema for PostgreSQL. At the end of the file you can find information to update your database schema.
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.
./configure --enable-odbc && make install
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 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"}}.
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"}}.
By default ejabberd opens 10 connections to the database for each virtual host. Use this option to modify the value:
{odbc_pool_size, 10}.
You can configure an interval to make a dummy SQL request to keep alive the connections to the database. The default value is ’undefined’, so no keepalive requests are made. Specify in seconds: for example 28800 means 8 hours.
{odbc_keepalive_interval, undefined}.
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:
{auth_method, [odbc]}.
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!
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.
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.
./configure --enable-odbc && make install
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 string as odbc_server parameter. For example:
{odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.
By default ejabberd opens 10 connections to the database for each virtual host. Use this option to modify the value:
{odbc_pool_size, 10}.
You can configure an interval to make a dummy SQL request to keep alive the connections to the database. The default value is ’undefined’, so no keepalive requests are made. Specify in seconds: for example 28800 means 8 hours.
{odbc_keepalive_interval, undefined}.
The first configuration step is to define the odbc auth_method. For example:
{auth_method, [odbc]}.
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!
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.
Note that ejabberd treats LDAP as a read-only storage: it is possible to consult data, but not possible to create accounts, change password or edit vCard that is stored in LDAP.
Parameters:
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.
You can authenticate users against an LDAP directory. Available options are:
{ldap_local_filter, {notequal, {"accountStatus",["disabled"]}}}.
{ldap_local_filter, {equal, {"accountStatus",["enabled"]}}}.
{ldap_local_filter, undefined}.
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
{auth_method, ldap}.
%% DNS name of our LDAP server
{ldap_servers, ["ldap.example.org"]}.
%% Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret"
{ldap_rootdn, "cn=Manager,dc=example,dc=org"}.
{ldap_password, "secret"}.
%% Define the user's base
{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,
[
...
{mod_vcard_ldap,
[
%% We use the same server and port, but want to bind anonymously because
%% our LDAP server accepts anonymous requests to
%% "ou=AddressBook,dc=example,dc=org" subtree.
{ldap_rootdn, ""},
{ldap_password, ""},
%% define the addressbook's base
{ldap_base, "ou=AddressBook,dc=example,dc=org"},
%% uidattr: user's part of JID is located in the "mail" attribute
%% uidattr_format: common format for our emails
{ldap_uids, [{"mail", "%u@mail.example.org"}]},
%% We have to define empty filter here, because entries in addressbook does not
%% belong to shadowAccount object class
{ldap_filter, ""},
%% Now we want to define vCard pattern
{ldap_vcard_map,
[{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
{"GIVEN", "%s", ["givenName"]},
{"FAMILY", "%s", ["sn"]},
{"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John"
{"EMAIL", "%s", ["mail"]},
{"BDAY", "%s", ["birthDay"]}]},
%% Search form
{ldap_search_fields,
[{"User", "%u"},
{"Name", "givenName"},
{"Family Name", "sn"},
{"Email", "mail"},
{"Birthday", "birthDay"}]},
%% vCard fields to be reported
%% Note that JID is always returned with search results
{ldap_search_reported,
[{"Full Name", "FN"},
{"Nickname", "NICKNAME"},
{"Birthday", "BDAY"}]}
]},
...
]}.
Note that mod_vcard_ldap module checks for the existence of the user before searching in his information in LDAP.
Active Directory is just an LDAP-server with predefined attributes. A sample configuration is shown 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
{ldap_password, "*******"}. % Password to LDAP manager
{ldap_uids, [{"sAMAccountName"}]}.
{ldap_filter, "(memberOf=*)"}.
{modules,
[
...
{mod_vcard_ldap,
[{ldap_vcard_map,
[{"NICKNAME", "%u", []},
{"GIVEN", "%s", ["givenName"]},
{"MIDDLE", "%s", ["initials"]},
{"FAMILY", "%s", ["sn"]},
{"FN", "%s", ["displayName"]},
{"EMAIL", "%s", ["mail"]},
{"ORGNAME", "%s", ["company"]},
{"ORGUNIT", "%s", ["department"]},
{"CTRY", "%s", ["c"]},
{"LOCALITY", "%s", ["l"]},
{"STREET", "%s", ["streetAddress"]},
{"REGION", "%s", ["st"]},
{"PCODE", "%s", ["postalCode"]},
{"TITLE", "%s", ["title"]},
{"URL", "%s", ["wWWHomePage"]},
{"DESC", "%s", ["description"]},
{"TEL", "%s", ["telephoneNumber"]}]},
{ldap_search_fields,
[{"User", "%u"},
{"Name", "givenName"},
{"Family Name", "sn"},
{"Email", "mail"},
{"Company", "company"},
{"Department", "department"},
{"Role", "title"},
{"Description", "description"},
{"Phone", "telephoneNumber"}]},
{ldap_search_reported,
[{"Full Name", "FN"},
{"Nickname", "NICKNAME"},
{"Email", "EMAIL"}]}
]},
...
]}.
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:
{modules,
[
{mod_echo, []}
]}.
{modules,
[
{mod_echo, []},
{mod_time, []},
{mod_version, []}
]}.
The following table lists all modules included in ejabberd.
Module Feature Dependencies mod_adhoc Ad-Hoc Commands (XEP-0050) mod_announce Manage announcements recommends mod_adhoc mod_caps Entity Capabilities (XEP-0115) mod_configure Server configuration using Ad-Hoc mod_adhoc mod_disco Service Discovery (XEP-0030) mod_echo Echoes Jabber packets mod_irc IRC transport mod_last Last Activity (XEP-0012) mod_last_odbc Last Activity (XEP-0012) supported DB (*) mod_muc Multi-User Chat (XEP-0045) mod_muc_log Multi-User Chat room logging mod_muc mod_offline Offline message storage (XEP-0160) mod_offline_odbc Offline message storage (XEP-0160) supported DB (*) mod_privacy Blocking Communication (XMPP IM) mod_privacy_odbc Blocking Communication (XMPP IM) supported DB (*) mod_private Private XML Storage (XEP-0049) mod_private_odbc Private XML Storage (XEP-0049) supported DB (*) mod_proxy65 SOCKS5 Bytestreams (XEP-0065) mod_pubsub Pub-Sub (XEP-0060), PEP (XEP-0163) mod_caps mod_register In-Band Registration (XEP-0077) mod_roster Roster management (XMPP IM) mod_roster_odbc Roster management (XMPP IM) supported DB (*) mod_service_log Copy user messages to logger service mod_shared_roster Shared roster management mod_roster or mod_roster_odbc mod_stats Statistics Gathering (XEP-0039) mod_time Entity Time (XEP-0090) mod_vcard vcard-temp (XEP-0054) mod_vcard_ldap vcard-temp (XEP-0054) LDAP server mod_vcard_odbc vcard-temp (XEP-0054) supported DB (*) mod_version Software Version (XEP-0092)
You can see which database backend each module needs by looking at the suffix:
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:
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!
The following options are used by many modules. Therefore, they are described in this separate section.