Ejabberd 2.1.x Developers GuideAlexey Shchepin |
Ejabberd 2.1.12 Developers GuideAlexey Shchepin |
Ejabberd 2.1.x Feature SheetSander Devrieze |
Ejabberd 2.1.12 Feature SheetSander Devrieze |
| ejabberd 2.1.x |
| ejabberd 2.1.12 |
| Installation and Operation Guide |
ejabberd uses its internal Mnesia database as the default authentication method. The value internal will enable the internal authentication method.
The option {auth_password_format, plain|scram} @@ -1115,7 +1115,7 @@ the CacheTimeInteger indicates the number of seconds that ejabberd can reuse the authentication information since the user last disconnected, to verify again the user authentication without querying again the extauth script. Note: caching should not be enabled in a host if internal auth is also enabled. -If caching is enabled, mod_last or mod_last_odbc must be enabled also in that vhost. +If caching is enabled, mod_last must be enabled also in that vhost.
This example sets external authentication, the extauth script, enables caching for 10 minutes, and starts three instances of the script for each virtual host defined in ejabberd:
{auth_method, [external]}.
@@ -1569,12 +1569,10 @@ MySQL interface. Anyway, the first configuration step is to define the 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 +modules. See section 3.3.1 to see which modules 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!
+sure that your database is running well (see previous sections), and add the +module option {db_type, odbc}.Although this section will describe ejabberd’s configuration when you want to use Microsoft SQL Server, it does not describe Microsoft SQL Server’s @@ -1601,13 +1599,10 @@ is the same as the configuration for 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!
+modules. See section 3.3.1 to see which modules 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 add the +module option {db_type, odbc}.Although this section will describe ejabberd’s configuration when you want to use the native PostgreSQL driver, it does not describe PostgreSQL’s installation @@ -1659,12 +1654,10 @@ PostgreSQL interface. Anyway, the first configuration step is to define the 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!
+modules. See section 3.3.1 to see which modules 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 add the +module option {db_type, odbc}.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 @@ -1703,13 +1696,11 @@ example:
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!
+several ejabberd +modules. See section 3.3.1 to see which modules 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 add the +module option {db_type, odbc}.ejabberd has built-in LDAP support. You can authenticate users against LDAP server and use LDAP directory as vCard storage.
Usually ejabberd treats LDAP as a read-only storage: @@ -1959,10 +1950,7 @@ all entries end with a comma:
| Module | Feature | Dependencies |
| mod_adhoc | Ad-Hoc Commands (XEP-0050) | |
| mod_announce | Manage announcements | recommends mod_adhoc |
| mod_announce_odbc | Manage announcements | recommends mod_adhoc |
| supported DB (*) | ||
| mod_blocking | Simple Communications Blocking (XEP-0191) | mod_privacy |
| mod_blocking_odbc | Simple Communications Blocking (XEP-0191) | mod_privacy_odbc |
| mod_caps | Entity Capabilities (XEP-0115) | |
| mod_configure | Server configuration using Ad-Hoc | mod_adhoc |
| mod_disco | Service Discovery (XEP-0030) | |
| mod_http_bind | XMPP over Bosh service (HTTP Binding) | |
| mod_http_fileserver | Small HTTP file server | |
| mod_irc | IRC transport | |
| mod_irc_odbc | IRC transport | supported DB (*) |
| mod_last | Last Activity (XEP-0012) | |
| mod_last_odbc | Last Activity (XEP-0012) | supported DB (*) |
| mod_muc | Multi-User Chat (XEP-0045) | |
| mod_muc_odbc | Multi-User Chat (XEP-0045) | supported DB (*) |
| mod_muc_log | Multi-User Chat room logging | mod_muc or mod_muc_odbc |
| 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_ping | XMPP Ping and periodic keepalives (XEP-0199) | |
| mod_pres_counter | Detect presence subscription flood | |
| mod_privacy | Blocking Communication (XEP-0016) | |
| mod_privacy_odbc | Blocking Communication (XEP-0016) | 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_pubsub_odbc | Pub-Sub (XEP-0060), PEP (XEP-0163) | supported DB (*) and mod_caps |
| mod_register | In-Band Registration (XEP-0077) | |
| mod_register_web | Web for Account Registrations | |
| 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_shared_roster_odbc | Shared roster management | supported DB (*) and |
| mod_roster or mod_roster_odbc | ||
| mod_shared_roster_ldap | LDAP Shared roster management | mod_roster or |
| mod_roster_odbc | ||
| mod_shared_roster | Shared roster management | mod_roster |
| mod_shared_roster_ldap | LDAP Shared roster management | mod_roster |
| mod_sic | Server IP Check (XEP-0279) | |
| mod_stats | Statistics Gathering (XEP-0039) | |
| mod_time | Entity Time (XEP-0202) | |
| 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_vcard_xupdate | vCard-Based Avatars (XEP-0153) | mod_vcard or mod_vcard_odbc |
| mod_vcard_xupdate_odbc | vCard-Based Avatars (XEP-0153) | mod_vcard or mod_vcard_odbc |
| mod_vcard_xupdate | vCard-Based Avatars (XEP-0153) | mod_vcard |
| 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 the tables created by some ejabberd modules. -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 @@ -2128,7 +2081,11 @@ login. The message is not sent to any currently connected user. Any message sent to this JID removes the existing message of the day (MOTD).
Options:
Examples: @@ -2404,6 +2361,10 @@ service. If the host option is not specified, the Jabber ID will be the hostname of the virtual host with the prefix ‘irc.’. The keyword "@HOST@" is replaced at start time with the real virtual host name. +
This module provides a Multi-User Chat (XEP-0045) service. @@ -2472,6 +2437,10 @@ service. If the host option is not specified, the Jabber ID will be the hostname of the virtual host with the prefix ‘conference.’. The keyword "@HOST@" is replaced at start time with the real virtual host name. +
<a href="/">Home</a>.
{access_log, muc_log},
{cssfile, false},
{dirtype, subdirs},
+ {dirtype, subdirs},
+ {file_permissions, {644, 33}},
{outdir, "/var/www/muclogs"},
{timezone, local}
]},
@@ -2799,7 +2774,11 @@ sent to an offline user will be stored on the server until that user comes
online again. Thus it is very similar to how email works. Note that
ejabberdctl has a command to delete expired messages
(see section 4.1).This module adds support for Private XML Storage (XEP-0049):
@@ -2916,6 +2899,10 @@ of client-specific preferences; another is Bookmark Storage (
This module implements SOCKS5 Bytestreams (XEP-0065).
@@ -3202,6 +3189,10 @@ It also supports Roster Versioning ( This example configuration enables Roster Versioning with storage of current id:
{modules,
@@ -3260,7 +3251,13 @@ manually add all users to their rosters, and that they cannot permanently delete
users from the shared roster groups.
A shared roster group can have members from any XMPP server,
but the presence will only be available from and to members
-of the same virtual host where the group is created.
Shared roster groups can be edited only via the Web Admin. Each group +of the same virtual host where the group is created.
Options: +
Shared roster groups can be edited only via the Web Admin. Each group has a unique identification and the following parameters:
Examples:
By enabling this mo and each presence sent by a client produces hash retrieval and a presence stanza rewrite. For this reason, enabling this module will introduce a computational overhead -in servers with clients that change frequently their presence.
+in servers with clients that change frequently their presence.Options: +
This module implements Software Version (XEP-0092). Consequently, it answers ejabberd’s version when queried.
Options: @@ -3889,7 +3896,6 @@ Add the option to the file ejabberd.cfg. In this example there is no restriction:
{ejabberdctl_access_commands, []}.
If account robot1@example.org is registered in ejabberd with password abcdef -(which MD5 is E8B501798950FC58AAD83C8C14978E), and ejabberd.cfg contains this setting:
{hosts, ["example.org"]}.
{acl, bots, {user, "robot1", "example.org"}}.
@@ -3898,7 +3904,7 @@ and ejabberd.cfg contains this setting:
then you can do this in the shell:
$ ejabberdctl registered_users example.org Error: no_auth_provided -$ ejabberdctl --auth robot1 example.org E8B501798950FC58AAD83C8C14978E registered_users example.org +$ ejabberdctl --auth robot1 example.org abcdef registered_users example.org robot1 testuser1 testuser2 @@ -4038,6 +4044,8 @@ using jabberd1.4 formatted XML files. from other Jabber/XMPP servers There exist tutorials to migrate from other software to ejabberd. +
When one or several access restrictions are defined and the +because the information will be verified.
When one or several access restrictions are defined and the
authentication information is provided,
each restriction is verified until one matches completely:
the account matches the Access rule,
diff --git a/doc/version.tex b/doc/version.tex
index 905ac86f2..924b6afae 100644
--- a/doc/version.tex
+++ b/doc/version.tex
@@ -1,2 +1,2 @@
% ejabberd version (automatically generated).
-\newcommand{\version}{2.1.x}
+\newcommand{\version}{2.1.12}
diff --git a/src/configure b/src/configure
index 89e32a5f1..cd9f81e9e 100755
--- a/src/configure
+++ b/src/configure
@@ -1,6 +1,6 @@
#! /bin/sh
# Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.68 for ejabberd 2.1.x.
+# Generated by GNU Autoconf 2.68 for ejabberd 2.1.12.
#
# Report bugs to