| ejabberd |
| Installation and Operation Guide |
@@ -116,111 +116,109 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;}
-
3.1 Basic Configuration
- -3.1.1 Host Names -
- 3.1.2 Virtual Hosting -
- 3.1.3 Listening Ports -
- 3.1.4 Authentication -
- 3.1.5 Access Rules -
- 3.1.6 Shapers -
- 3.1.7 Default Language -
- 3.1.8 CAPTCHA -
- 3.1.9 STUN -
- 3.1.10 Include Additional Configuration Files -
- 3.1.11 Option Macros in Configuration File +3.1.1 Legacy Configuration File +
- 3.1.2 Host Names +
- 3.1.3 Virtual Hosting +
- 3.1.4 Listening Ports +
- 3.1.5 Authentication +
- 3.1.6 Access Rules +
- 3.1.7 Shapers +
- 3.1.8 Default Language +
- 3.1.9 CAPTCHA +
- 3.1.10 STUN +
- 3.1.11 Include Additional Configuration Files +
- 3.1.12 Option Macros in Configuration File
- 3.2 Database and LDAP Configuration +
- 3.2 Database and LDAP Configuration -
- 3.3 Modules Configuration +
- 3.3 Modules Configuration
- -3.3.1 Modules Overview -
- 3.3.2 Common Options -
- 3.3.3 mod_announce -
- 3.3.4 mod_disco -
- 3.3.5 mod_echo -
- 3.3.6 mod_http_bind -
- 3.3.7 mod_http_fileserver -
- 3.3.8 mod_irc -
- 3.3.9 mod_last -
- 3.3.10 mod_muc -
- 3.3.11 mod_muc_log -
- 3.3.12 mod_offline -
- 3.3.13 mod_ping -
- 3.3.14 mod_pres_counter -
- 3.3.15 mod_privacy -
- 3.3.16 mod_private -
- 3.3.17 mod_proxy65 -
- 3.3.18 mod_pubsub -
- 3.3.19 mod_register -
- 3.3.20 mod_register_web -
- 3.3.21 mod_roster -
- 3.3.22 mod_service_log -
- 3.3.23 mod_shared_roster -
- 3.3.24 mod_shared_roster_ldap -
- 3.3.25 mod_sic -
- 3.3.26 mod_stats -
- 3.3.27 mod_time -
- 3.3.28 mod_vcard -
- 3.3.29 mod_vcard_ldap -
- 3.3.30 mod_vcard_xupdate -
- 3.3.31 mod_version +3.3.1 Modules Overview +
- 3.3.2 Common Options +
- 3.3.3 mod_announce +
- 3.3.4 mod_disco +
- 3.3.5 mod_echo +
- 3.3.6 mod_http_bind +
- 3.3.7 mod_http_fileserver +
- 3.3.8 mod_irc +
- 3.3.9 mod_last +
- 3.3.10 mod_muc +
- 3.3.11 mod_muc_log +
- 3.3.12 mod_offline +
- 3.3.13 mod_ping +
- 3.3.14 mod_pres_counter +
- 3.3.15 mod_privacy +
- 3.3.16 mod_private +
- 3.3.17 mod_proxy65 +
- 3.3.18 mod_pubsub +
- 3.3.19 mod_register +
- 3.3.20 mod_register_web +
- 3.3.21 mod_roster +
- 3.3.22 mod_service_log +
- 3.3.23 mod_shared_roster +
- 3.3.24 mod_shared_roster_ldap +
- 3.3.25 mod_sic +
- 3.3.26 mod_stats +
- 3.3.27 mod_time +
- 3.3.28 mod_vcard +
- 3.3.29 mod_vcard_ldap +
- 3.3.30 mod_vcard_xupdate +
- 3.3.31 mod_version
Chapter 1 Introduction
ejabberd is a free and open source instant messaging server written in Erlang/OTP.
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.
@@ -308,7 +306,10 @@ copy ejabberd.init from the ’bin’ directory to something Create a system user called ejabberd, give it write access to the directories database/ and logs/, and set that as home; the script will start the server with that user. -Then you can call /etc/inid.d/ejabberd start as root to start the server.If ejabberd doesn’t start correctly in Windows, +Then you can call /etc/inid.d/ejabberd start as root to start the server.
When ejabberd is started, the processes that are started in the system +are beam or beam.smp, and also epmd. +In Microsoft Windows, the processes are erl.exe and epmd.exe. +For more information regarding epmd consult the section 5.2.
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". @@ -348,22 +349,20 @@ as long as your system have all the dependencies.
Released versions of ejabberd are available in the ProcessOne ejabberd downloads page:
http://www.process-one.net/en/ejabberd/downloads
Alternatively, the latest development source code can be retrieved from the Git repository using the commands:
-2.4.2 Download Source Code
git clone git://git.process-one.net/ejabberd/mainline.git ejabberd
+
git clone git://github.com/processone/ejabberd.git ejabberd cd ejabberd git checkout -b 2.1.x origin/2.1.x@@ -388,15 +387,21 @@ To get the full list run the command: before running make install. This account doesn’t need an explicit HOME directory, because /var/lib/ejabberd/ will be used by default.
2.4.4 Install
To install ejabberd in the destination directories, run the command: @@ -406,7 +411,7 @@ to install ejabberd.
The files and directories created are, by de
- /etc/ejabberd/
- Configuration directory:
- - ejabberd.cfg
- ejabberd configuration file
+ ejabberd.yml
- ejabberd configuration file
- ejabberdctl.cfg
- Configuration file of the administration script
- inetrc
- Network DNS configuration file
- 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.ymland runwerl -s ejabberd -name ejabberd
2.5 Create an XMPP Account for Administration
You need an XMPP account and grant him administrative privileges @@ -525,8 +530,13 @@ Using ejabberdctl (see section 4.1):
- Using an XMPP client and In-Band Registration (see section 3.3.19).
- Edit the ejabberd configuration file to give administration rights to the XMPP account you created: -
{acl, admin, {user, "admin1", "example.org"}}. -{access, configure, [{allow, admin}]}. +acl: + admin: + user: + - "admin1": "example.org" +access: + configure: + admin: allow
You can grant administrative privileges to many XMPP accounts, and also to accounts in other XMPP servers.- Restart ejabberd to load the new configuration. @@ -544,119 +554,157 @@ check if the release notes of the new ejabberd version indicates you need to also update those tables.
Chapter 3 Configuring ejabberd
-3.1 Basic Configuration
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 beginning of 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.
-3.1.1 Host Names
3.1 Basic Configuration
The configuration file will be loaded the first time you start ejabberd. +The configuration file name MUST have “.yml” extension. This helps ejabberd +to differentiate between the new and legacy file formats (see section 3.1.1).
Note that ejabberd never edits the configuration file.
The configuration file is written in +YAML. +However, different scalars are treated as different types: +
-
+unquoted or single-quoted strings. The type is called
atom()+in this document. +Examples:dog,'Jupiter','3.14159',YELLOW. + - numeric literals. The type is called
integer(),float()or, +if both are allowed,number(). +Examples:3,-45.0,.0+ - double-quoted or folded strings. The type is called
string(). +Examples of a double-quoted string: +"Lizzard","orange","3.14159". +Examples of a folded string: +> Art thou not Romeo, + and a Montague? +
| Neither, fair saint, + if either thee dislike. +
For associative arrays ("mappings") and lists you can use both outline +indentation and compact syntax (aka “JSON style”). For example, the following is equivalent: +{param1: ["val1", "val2"], param2: ["val3", "val4"]} +and +param1: + - "val1" + - "val2" +param2: + - "val3" + - "val4" +
Note that both styles are used in this document. +
3.1.1 Legacy Configuration File
+In previous ejabberd version the configuration file should be written +in Erlang terms. The format is still supported, but it is highly recommended +to convert it to the new YAML format using convert_to_yaml command +from ejabberdctl (see 4.1 for details).
+3.1.2 Host Names
The option hosts defines a list containing one or more domains that ejabberd will serve.
The syntax is: -
- {hosts, [HostName, ...]}.
Examples: +
- [HostName]
Examples:
-
Serving one domain:
-
{hosts, ["example.org"]}. +hosts: ["example.org"]
- Serving three domains:
-
{hosts, ["example.net", "example.com", "jabber.somesite.org"]}. +hosts: + - "example.net" + - "example.com" + - "jabber.somesite.org"
3.1.2 Virtual Hosting
3.1.3 Virtual Hosting
Options can be defined separately for every virtual host using the host_config option.
The syntax is: -
- {host_config, HostName, [Option, ...]}
Examples: +
- {HostName: [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}, - {ldap_servers, ["localhost"]}, - {ldap_uids, [{"uid"}]}, - {ldap_rootdn, "dc=localdomain"}, - {ldap_rootdn, "dc=example,dc=com"}, - {ldap_password, ""}]}. +host_config: + "example.net" + auth_method: internal + "example.com": + auth_method: ldap + ldap_servers: + - "localhost" + ldap_uids: + - "uid" + ldap_rootdn: "dc=localdomain" + ldap_rootdn: "dc=example,dc=com" + ldap_password: ""
- Domain example.net is using ODBC to perform authentication
while domain example.com is using the LDAP servers running on the domains
localhost and otherhost:
-
{host_config, "example.net", [{auth_method, odbc}, - {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, ""}]}. +host_config: + "example.net": + auth_method: odbc + odbc_type: odbc + odbc_server: "DSN=ejabberd;UID=ejabberd;PWD=ejabberd" + "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 general syntax -
- {OptionName, OptionValue}
-use this syntax: -
- {{add, OptionName}, OptionValue}
In this example three virtual hosts have some similar modules, but there are also +To accomplish that, instead of defining each option in host_config +use append_host_config with the same syntax.
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"]}. +## 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, []} - ]}. +## 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 some modules to vhost one: +append_host_config: + "one.example.org": + 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"}]} - ] - } - ]}. +## Add a module just to vhost two: +append_host_config: + "two.example.org": + modules: + mod_echo: + host: "mirror.two.example.org"-3.1.3 Listening Ports
3.1.4 Listening Ports
The option listen defines for which ports, addresses and network protocols ejabberd -will listen and what services will be run on them. Each element of the list is a -tuple with the following elements: +will listen and what services will be run on them. Each element of the list is an +associative array with the following elements:
- Port number. Optionally also the IP address and/or a transport protocol.
- Listening module that serves this port.
- Options for the TCP socket and for the listening module.
The option syntax is: -
- {listen, [Listener, ...]}.
To define a listener there are several syntax. -
- {PortNumber, Module, [Option, ...]}
- {{PortNumber, IPaddress}, Module, [Option, ...]}
- {{PortNumber, TransportProtocol}, Module, [Option, ...]}
- {{PortNumber, IPaddress, TransportProtocol}, Module, [Option, ...]}
- [Listener, ...]
+Example: +
listen: + - + port: 5222 + module: ejabberd_c2s + starttls: true + certfile: "/path/to/certfile.pem" + - + port: 5269 + module: ejabberd_s2s_in + transport: tcp +
Port Number, IP Address and Transport Protocol
The port number defines which port to listen for incoming connections. It can be a Jabber/XMPP standard port -(see section 5.1) or any other valid port number.
The IP address can be represented with a string -or an Erlang tuple with decimal or hexadecimal numbers. +(see section 5.1) or any other valid port number.
The IP address can be represented as a string. The socket will listen only in that network interface. It is possible to specify a generic address, so ejabberd will listen in all addresses. @@ -667,9 +715,6 @@ When not specified the IP address, it will listen on all IPv4 network addresses.
"::"to listen in all IPv6 network interfaces"10.11.12.13"is the IPv4 address10.11.12.13"::FFFF:127.0.0.1"is the IPv6 address::FFFF:127.0.0.1/128-{10, 11, 12, 13}is the IPv4 address10.11.12.13-{0, 0, 0, 0, 0, 65535, 32512, 1}is the IPv6 address::FFFF:127.0.0.1/128-{16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}is the IPv6 addressFDCA:8AB6:A243:75EF::1/128The transport protocol can be tcp or udp. Default is tcp.
Listening Module
@@ -680,15 +725,15 @@ Handles c2s connections.
Options: access, certfile, max_fsm_queue, max_stanza_size, shaper, starttls, starttls_required, tls, -zlib +zlib, tls_compression - ejabberd_s2s_in
-
Handles incoming s2s connections.
- Options: max_stanza_size, shaper + Options: max_stanza_size, shaper, tls_compression - ejabberd_service
-
Interacts with an external component
(as defined in the Jabber Component Protocol (XEP-0114).
Options: access, hosts, max_fsm_queue, -service_check_from, shaper +service_check_from, shaper_rule - ejabberd_stun
-
Handles STUN Binding requests as defined in
RFC 5389.
@@ -696,37 +741,37 @@ Handles STUN Binding requests as defined in - ejabberd_http
-
Handles incoming HTTP connections.
Options: captcha, certfile, default_host, http_bind, http_poll, -request_handlers, tls, trusted_proxies, web_admin
+request_handlers, tls, tls_compression, trusted_proxies, web_admin
Options
This is a detailed description of each option allowed by the listening modules:
- -{access, AccessName}
- This option defines
+access: AccessName
- This option defines access to the port. The default value is all. -
- {backlog, Value}
- The backlog value +
- backlog: Value
- The backlog value defines the maximum length that the queue of pending connections may grow to. This should be increased if the server is going to handle lots of new incoming connections as they may be dropped if there is no space in the queue (and ejabberd was not able to accept them immediately). Default value is 5. -
- captcha
- -Simple web page that allows a user to fill a CAPTCHA challenge (see section 3.1.8). -
- {certfile, Path}
- Full path to a file containing the default SSL certificate. +
- captcha: true|false
- +Simple web page that allows a user to fill a CAPTCHA challenge (see section 3.1.9). +
- certfile: Path
- Full path to a file containing the default SSL certificate. To define a certificate file specific for a given domain, use the global option domain_certfile. -
- {default_host, undefined|HostName}
- +
- default_host: undefined|HostName}
- If the HTTP request received by ejabberd contains the HTTP header Host -with an ambiguous virtual host that doesn’t match any one defined in ejabberd (see 3.1.1), +with an ambiguous virtual host that doesn’t match any one defined in ejabberd (see 3.1.2), then this configured HostName is set as the request Host. The default value of this option is: undefined. -
- {hosts, [Hostname, ...], [HostOption, ...]}
- +
- hosts: {Hostname: [HostOption, ...]}
- The external Jabber component that connects to this ejabberd_service can serve one or more hostnames. As HostOption you can define options for the component; currently the only allowed option is the password required to the component -when attempt to connect to ejabberd: {password, Secret}. +when attempt to connect to ejabberd: password: Secret. Note that you cannot define in a single ejabberd_service components of different services: add an ejabberd_service for each service, as seen in an example below. -
- http_bind
- +
- http_bind: true|false
-
This option enables HTTP Binding (XEP-0124 and XEP-0206) support. HTTP Bind
enables access via HTTP requests to ejabberd from behind firewalls which
do not allow outgoing sockets on port 5222.
Remember that you must also install and enable the module mod_http_bind.
If HTTP Bind is enabled, it will be available at @@ -737,7 +782,7 @@ interesting to host a web-based XMPP client such as (check the tutorials to install JWChat with ejabberd and an embedded local web server or Apache). -
- http_poll
- +
- http_poll: true|false
-
This option enables HTTP Polling (XEP-0025) support. HTTP Polling
enables access via HTTP requests to ejabberd from behind firewalls which
do not allow outgoing sockets on port 5222.
If HTTP Polling is enabled, it will be available at @@ -747,9 +792,9 @@ interesting to host a web-based XMPP client such as JWChat.
The maximum period of time to keep a client session active without an incoming POST request can be configured with the global option http_poll_timeout. The default value is five minutes. -The option can be defined in ejabberd.cfg, expressing the time +The option can be defined in ejabberd.yml, expressing the time in seconds:
{http_poll_timeout, 300}.- - {max_fsm_queue, Size}
- +
- max_fsm_queue: Size
- This option specifies the maximum number of elements in the queue of the FSM (Finite State Machine). Roughly speaking, each message in such queues represents one XML @@ -767,7 +812,7 @@ If the option is not specified for ejabberd_service or the globally configured value is used. The allowed values are integers and ’undefined’. Default value: ’undefined’. -
- {max_stanza_size, Size}
- +
- max_stanza_size: Size
- This option specifies an approximate maximum size in bytes of XML stanzas. Approximate, because it is calculated with the precision of one block of read @@ -776,12 +821,15 @@ 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. -
- {request_handlers, [ {Path, Module}, ...]}
- To define one or several handlers that will serve HTTP requests. -The Path is a list of strings; so the URIs that start with that Path will be served by Module. +
- request_handlers: {Path: Module}
- To define one or several handlers that will serve HTTP requests. +The Path is a string; so the URIs that start with that Path will be served by Module. For example, if you want mod_foo to serve the URIs that start with /a/b/, and you also want mod_http_bind to serve the URIs /http-bind/, -use this option: {request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]} -
- {service_check_from, true|false}
-
+use this option:
+
request_handlers: + /"a"/"b": mod_foo + /"http-bind": mod_http_bind +
- service_check_from: true|false
- This option can be used with ejabberd_service only. XEP-0114 requires that the domain must match the hostname of the component. @@ -789,19 +837,25 @@ If this option is set to false, ejabberd will allow the compon to send stanzas with any arbitrary domain in the ’from’ attribute. Only use this option if you are completely sure about it. The default value is true, to be compliant with XEP-0114. -
- {shaper, none|ShaperName}
- This option defines a -shaper for the port (see section 3.1.6). The default value +
- shaper: none|ShaperName
- This option defines a +shaper for the port (see section 3.1.7). The default value is none. -
- starttls
- This option +
- shaper_rule: none|ShaperRule
- This option defines a +shaper rule for the ejabberd_service (see section 3.1.7). The recommended value +is fast. +
- starttls: true|false
- This option specifies that STARTTLS encryption is available on connections to the port. You should also set the certfile option. You can define a certificate file for a specific domain using the global option domain_certfile. -
- starttls_required
- This option +
- starttls_required: true|false
- 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. You can define a certificate file for a specific domain using the global option domain_certfile. -
- tls
- This option specifies that traffic on +
- timeout: Integer
- +Timeout of the connections, expressed in milliseconds. +Default: 5000 +
- tls: true|false
- This option specifies that traffic on the port will be encrypted using SSL immediately after connecting. This was the traditional encryption method in the early Jabber software, commonly on port 5223 for client-to-server communications. @@ -811,49 +865,51 @@ The preferable encryption method is STARTTLS on port 5222, as defined which can be enabled in ejabberd with the option starttls. If this option is set, you should also set the certfile option. The option tls can also be used in ejabberd_http to support HTTPS. -
- {trusted_proxies, all | [IpString]}
- +
- tls_compression: true|false
- +Whether to enable or disable TLS compression. The default value is true. +
- trusted_proxies: all | [IpString]
- Specify what proxies are trusted when an HTTP request contains the header X-Forwarded-For You can specify all to allow all proxies, or specify a list of IPs in string format. The default value is: ["127.0.0.1"] -
- web_admin
- This option +
- web_admin: true|false
- This option
enables the Web Admin 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. - - zlib
- This +
- zlib: true|false
- This option specifies that Zlib stream compression (as defined in XEP-0138) is available on connections to the port.
There are some additional global options that can be specified in the ejabberd configuration file (outside listen):
- -{s2s_use_starttls, false|optional|required|required_trusted}
-
+s2s_use_starttls: false|optional|required|required_trusted
- This option defines if s2s connections don’t use STARTTLS encryption; if STARTTLS can be used optionally; if STARTTLS is required to establish the connection; or if STARTTLS is required and the remote certificate must be valid and trusted. The default value is to not use STARTTLS: false. -
- {s2s_certfile, Path}
- Full path to a +
- s2s_certfile: Path
- Full path to a file containing a SSL certificate. -
- {domain_certfile, Domain, Path}
- +
- domain_certfile: Path
- Full path to the file containing the SSL certificate for a specific domain. -
- {outgoing_s2s_options, [Family, ...], Timeout}
- -Specify which address families to try, in what order, and connect timeout in milliseconds. -By default it first tries connecting with IPv4, if that fails it tries using IPv6, -with a timeout of 10000 milliseconds. -
- {s2s_dns_options, [ {Property, Value}, ...]}
- -Define properties to use for DNS resolving. -Allowed Properties are: timeout in seconds which default value is 10 -and retries which default value is 2. -
- {s2s_default_policy, allow|deny}
- -The default policy for incoming and outgoing s2s connections to other XMPP servers. -The default value is allow. -
- {{s2s_host, Host}, allow|deny}
- -Defines if incoming and outgoing s2s connections with a specific remote host are allowed or denied. -This allows to restrict ejabberd to only establish s2s connections -with a small list of trusted servers, or to block some specific servers. -
- {s2s_max_retry_delay, Seconds}
- +
- outgoing_s2s_families: [Family, ...]
- +Specify which address families to try, in what order. +By default it first tries connecting with IPv4, if that fails it tries using IPv6. +
- outgoing_s2s_timeout: Timeout
- +The timeout in milliseconds for outgoing S2S connection attempts. +
- s2s_dns_timeout: Timeout
- +The timeout in seconds for DNS resolving. The default value is 10. +
- s2s_dns_retries: Number
- +DNS resolving retries in seconds. The default value is 2. +
- s2s_policy: Access
- +The policy for incoming and outgoing s2s connections to other XMPP servers. +The default value is all. +
- s2s_max_retry_delay: Seconds
- The maximum allowed delay for retry to connect after a failed connection attempt. Specified in seconds. The default value is 300 seconds (5 minutes). -
- {max_fsm_queue, Size}
- +
- s2s_tls_compression: true|false
- +Whether to enable or disable TLS compression for s2s connections. +The default value is true. +
- max_fsm_queue: Size
- This option specifies the maximum number of elements in the queue of the FSM (Finite State Machine). Roughly speaking, each message in such queues represents one XML @@ -871,7 +927,7 @@ If the option is not specified for ejabberd_service or the globally configured value is used. The allowed values are integers and ’undefined’. Default value: ’undefined’. -
- {route_subdomains, local|s2s}
- +
- route_subdomains: local|s2s
-
Defines if ejabberd must route stanzas directed to subdomains locally (compliant with
RFC 3920: XMPP Core),
or to foreign server using S2S (compliant with
@@ -889,40 +945,60 @@ and also allows plain connections for old clients.
- Port 5280 listens for HTTP requests, and serves the HTTP Poll service.
- Port 5281 listens for HTTP requests, using HTTPS to serve HTTP-Bind (BOSH) and the Web Admin as explained in section 4.3. The socket only listens connections to the IP address 127.0.0.1. -
{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} - ]}, - {{3478, udp}, ejabberd_stun, []}, - {5280, ejabberd_http, [ - http_poll - ]}, - {{5281, "127.0.0.1"}, ejabberd_http, [ - web_admin, - http_bind, - tls, {certfile, "/etc/ejabberd/server.pem"}, - ]} - ] -}. -{s2s_use_starttls, optional}. -{s2s_certfile, "/etc/ejabberd/server.pem"}. -{domain_certfile, "example.com", "/etc/ejabberd/example_com.pem"}. -{outgoing_s2s_options, [ipv4, ipv6], 10000}. +hosts: + - "example.com" + - "example.org" + - "example.net" + +listen: + - + port: 5222 + module: ejabberd_c2s + access: c2s + shaper: c2s_shaper + starttls: true + certfile: "/etc/ejabberd/server.pem" + max_stanza_size: 65536 + - + port: 5223 + module: ejabberd_c2s + access: c2s + shaper: c2s_shaper + tls: true + certfile: "/etc/ejabberd/server.pem" + max_stanza_size: 65536 + - + port: 5269 + ip: "::" + module: ejabberd_s2s_in + shaper: s2s_shaper + max_stanza_size: 131072 + - + port: 3478 + transport: udp + module: ejabberd_stun + - + port: 5280 + module: ejabberd_http + http_poll: true + - + port: 5281 + ip: "127.0.0.1" + module: ejabberd_http + web_admin: true + http_bind: true + tls: true + certfile: "/etc/ejabberd/server.pem" + +s2s_use_starttls: optional +s2s_certfile: "/etc/ejabberd/server.pem" +host_config: + "example.com": + domain_certfile: "/etc/ejabberd/example_com.pem" +outgoing_s2s_families: + - ipv4 + - ipv6 +outgoing_s2s_timeout: 10000
In this example, the following configuration defines that:
- c2s connections are listened for on port 5222 (all IPv4 addresses) and @@ -960,59 +1036,117 @@ connected to port 5237 with password ‘ggsecret’. jmc.example.org is connected to port 5238 with password ‘jmcsecret’.
- The service custom has enabled the special option to avoiding checking the from attribute in the packets send by this component. The component can send packets in behalf of any users from the server, or even on behalf of any server. -
{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, {192, 168, 0, 1}}, ejabberd_c2s, [ - {access, c2s}, - ssl, {certfile, "/path/to/ssl.pem"} - ]}, - {{5223, {16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}}, - ejabberd_c2s, [ - {access, c2s}, - ssl, {certfile, "/path/to/ssl.pem"} - ]}, - {5269, ejabberd_s2s_in, []}, - {{5280, {0, 0, 0, 0}}, ejabberd_http, [ - http_poll, - web_admin - ]}, - {{5233, {127, 0, 0, 1}}, ejabberd_service, [ - {hosts, ["aim.example.org"], - [{password, "aimsecret"}]} - ]}, - {{5233, "::1"}, 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, required_trusted}. -{s2s_certfile, "/path/to/ssl.pem"}. -{s2s_default_policy, deny}. -{{s2s_host,"jabber.example.org"}, allow}. -{{s2s_host,"example.com"}, allow}. +acl: + blocked: + user: "bad" + trusted_servers: + server: + - "example.com" + - "jabber.example.org" + xmlrpc_bot: + user: + - "xmlrpc-robot": "example.org" +shaper: + normal: 1000 +access: + c2s: + blocked: deny + all: allow + c2s_shaper: + admin: none + all: normal + xmlrpc_access: + xmlrpc_bot: allow + s2s_access: + trusted_servers: allow + all: deny +s2s_certfile: "/path/to/ssl.pem" +s2s_policy: s2s_access +s2s_use_starttls: required_trusted +listen: + - + port: 5222 + module: ejabberd_c2s + shaper: c2s_shaper + access: c2s + - + ip: "192.168.0.1" + port: 5223 + module: ejabberd_c2s + certfile: "/path/to/ssl.pem" + tls: true + access: c2s + - + ip: "FDCA:8AB6:A243:75EF::1" + port: 5223 + module: ejabberd_c2s + certfile: "/path/to/ssl.pem" + tls: true + access: c2s + - + port: 5269 + module: ejabberd_s2s_in + - + port: 5280 + module: ejabberd_http + web_admin: true + http_poll: true + - + port: 4560 + module: ejabberd_xmlrpc + - + ip: "127.0.0.1" + port: 5233 + module: ejabberd_service + hosts: + "aim.example.org": + password: "aimsecret" + - + ip: "::1" + port: 5233 + module: ejabberd_service + hosts: + "aim.example.org": + password: "aimsecret" + - + port: 5234 + module: ejabberd_service + hosts: + "icq.example.org": + password: "jitsecret" + "sms.example.org": + password: "jitsecret" + - + port: 5235 + module: ejabberd_service + hosts: + "msn.example.org": + password: "msnsecret" + - + port: 5236 + module: ejabberd_service + hosts: + "yahoo.example.org": + password: "yahoosecret" + - + port: 5237 + module: ejabberd_service + hosts: + "gg.example.org": + password: "ggsecret" + - + port: 5238 + module: ejabberd_service + hosts: + "jmc.example.org": + password: "jmcsecret" + - + port: 5239 + module: ejabberd_service + service_check_from: false + hosts: + "custom.example.org": + password: "customsecret"
Note, that for services based in jabberd14 or WPJabber you have to make the transports log and do XDB by themselves:
<!-- @@ -1044,22 +1178,21 @@ you have to make the transports log and do XDB by themselves: </xdb_file> </xdb>-3.1.4 Authentication
3.1.5 Authentication
The option auth_method defines the authentication methods that are used for user authentication. The syntax is: -
- {auth_method, [Method, ...]}.
The following authentication methods are supported by ejabberd: +
- [Method, ...]
The following authentication methods are supported by ejabberd:
- -internal (default) — See section 3.1.4. -
- external — See section 3.1.4. -
- ldap — See section 3.2.5. -
- odbc — See section 3.2.1, 3.2.3, -3.2.2 and 3.2.4. -
- anonymous — See section 3.1.4. -
- pam — See section 3.1.4. +internal (default) — See section 3.1.5. +
- external — See section 3.1.5. +
- ldap — See section 3.2.2. +
- odbc — See section 3.2.1. +
- anonymous — See section 3.1.5. +
- pam — See section 3.1.5.
Account creation is only supported by internal, external and odbc methods.
The option resource_conflict defines the action when a client attempts to login to an account with a resource that is already connected. The option syntax is: -
- {resource_conflict, setresource|closenew|closeold}.
+
- resource_conflict: setresource|closenew|closeold
The possible values match exactly the three possibilities described in XMPP Core: section 7.7.2.2. The default value is closeold. @@ -1068,10 +1201,10 @@ then this option is not respected, and the action performed is closeold of the machine, in case it isn’t detected automatically. The FQDN is used to authenticate some clients that use the DIGEST-MD5 SASL mechanism. The option syntax is: -
- {fqdn, undefined|FqdnString|[FqdnString]}.
- fqdn: undefined|FqdnString|[FqdnString]
Internal
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} +The value internal will enable the internal authentication method.
The option auth_password_format: plain|scram defines in what format the users passwords are stored:
- plain
-
@@ -1089,11 +1222,14 @@ This format allows clients to authenticate using: SASL PLAIN and SA
-
To use internal authentication on example.org and LDAP
authentication on example.net:
-
{host_config, "example.org", [{auth_method, [internal]}]}. -{host_config, "example.net", [{auth_method, [ldap]}]}. +host_config: + "example.org": + auth_method: [internal] + "example.net": + auth_method: [ldap]
- To use internal authentication with hashed passwords on all virtual hosts:
-
{auth_method, internal}. -{auth_password_format, scram}. +auth_method: internal +auth_password_format: scram
External Script
In this authentication method, when ejabberd starts, @@ -1103,11 +1239,11 @@ The details on the interface between ejabberd and the script are described in the ejabberd Developers Guide. There are also several example authentication scripts.
These are the specific options:
- -{extauth_program, PathToScript}
-
+extauth_program: PathToScript
- Indicate in this option the full path to the external authentication script. -The script must be executable by ejabberd.
- {extauth_instances, Integer}
- +The script must be executable by ejabberd.
- extauth_instances: Integer
- Indicate how many instances of the script to run simultaneously to serve authentication in the virtual host. -The default value is the minimum number: 1.
- {extauth_cache, false|CacheTimeInteger}
- +The default value is the minimum number: 1.
- extauth_cache: false|CacheTimeInteger
- The value false disables the caching feature, this is the default. The integer 0 (zero) enables caching for statistics, but doesn’t use that cached information to authenticate users. If another integer value is set, caching is enabled both for statistics and for authentication: @@ -1118,51 +1254,78 @@ Note: caching should not be enabled in a host if internal auth is also enabled. 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]}. -{extauth_program, "/etc/ejabberd/JabberAuth.class.php"}. -{extauth_cache, 600}. -{extauth_instances, 3}. --SASL Anonymous and Anonymous Login
The value anonymous will enable the internal authentication method.
The anonymous authentication method can be configured with the following +
auth_method: [external] +extauth_program: "/etc/ejabberd/JabberAuth.class.php" +extauth_cache: 600 +extauth_instances: 3 +
+Anonymous Login and SASL Anonymous
The anonymous authentication method enables two modes for anonymous authentication: +
- +Anonymous login:
- This is a standard login, that use the +classical login and password mechanisms, but where password is +accepted or preconfigured for all anonymous users. This login is +compliant with SASL authentication, password and digest non-SASL +authentication, so this option will work with almost all XMPP +clients
- SASL Anonymous:
- This is a special SASL authentication +mechanism that allows to login without providing username or +password (see XEP-0175). The main advantage of SASL Anonymous +is that the protocol was designed to give the user a login. This is +useful to avoid in some case, where the server has many users +already logged or registered and when it is hard to find a free +username. The main disavantage is that you need a client that +specifically supports the SASL Anonymous protocol. +
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.
- -{allow_multiple_connections, false|true}
- This option is only used
+host specific options (see section 3.1.3).
- +allow_multiple_connections: false|true
- This option is only used when the anonymous mode is enabled. Setting it to true means that the same username can be taken multiple times in anonymous login mode if different resource are used to connect. This option is only useful in very special occasions. The default value is false. -
- {anonymous_protocol, sasl_anon | login_anon | both}
- -sasl_anon means -that the SASL Anonymous method will be used. login_anon means that the -anonymous login method will be used. both means that SASL Anonymous and -login anonymous are both enabled. +
- anonymous_protocol: login_anon | sasl_anon | both
- +login_anon means that the anonymous login method will be used. +sasl_anon means that the SASL Anonymous method will be used. +both means that SASL Anonymous and login anonymous are both enabled.
Those options are defined for each virtual host with the host_config -parameter (see section 3.1.2).
Examples: +parameter (see section 3.1.3).
Examples:
-
To enable anonymous login on all virtual hosts:
-
{auth_method, [anonymous]}. -{anonymous_protocol, login_anon}. +auth_method: [anonymous] +anonymous_protocol: login_anon
- Similar as previous example, but limited to public.example.org:
-
{host_config, "public.example.org", [{auth_method, [anonymous]}, - {anonymous_protocol, login_anon}]}. +host_config: + "public.example.org": + auth_method: [anonymous] + anonymous_protoco: login_anon
- To enable anonymous login and internal authentication on a virtual host:
-
{host_config, "public.example.org", [{auth_method, [internal,anonymous]}, - {anonymous_protocol, login_anon}]}. +host_config: + "public.example.org": + auth_method: + - internal + - anonymous + anonymous_protocol: login_anon
- To enable SASL Anonymous on a virtual host:
-
{host_config, "public.example.org", [{auth_method, [anonymous]}, - {anonymous_protocol, sasl_anon}]}. +host_config: + "public.example.org": + auth_method: [anonymous] + anonymous_protocol: sasl_anon
- To enable SASL Anonymous and anonymous login on a virtual host:
-
{host_config, "public.example.org", [{auth_method, [anonymous]}, - {anonymous_protocol, both}]}. +host_config: + "public.example.org": + auth_method: [anonymous] + anonymous_protocol: both
- To enable SASL Anonymous, anonymous login, and internal authentication on
a virtual host:
-
{host_config, "public.example.org", [{auth_method, [internal,anonymous]}, - {anonymous_protocol, both}]}. -
host_config: + "public.example.org": + auth_method: + - internal + - anonymous + anonymous_protocol: both +
There are more configuration examples and XMPP client example stanzas in +Anonymous users support.
PAM Authentication
ejabberd supports authentication via Pluggable Authentication Modules (PAM). PAM is currently supported in AIX, FreeBSD, HP-UX, Linux, Mac OS X, NetBSD and Solaris. @@ -1171,16 +1334,16 @@ PAM authentication is disabled by default, so you have to configure and compile
./configure --enable-pam && make install
Options:
- -{pam_service, Name}
- This option defines the PAM service name.
+pam_service: Name
- This option defines the PAM service name. Default is "ejabberd". Refer to the PAM documentation of your operation system for more information. -
- {pam_userinfotype, username|jid}
- +
- pam_userinfotype: username|jid
- This option defines what type of information about the user ejabberd provides to the PAM service: only the username, or the user JID. Default is username.
Example: -
{auth_method, [pam]}. -{pam_service, "ejabberd"}. +auth_method: [pam] +pam_service: "ejabberd"
Though it is quite easy to set up PAM support in ejabberd, PAM itself introduces some security issues:
- To perform PAM authentication ejabberd uses external C-program called @@ -1212,52 +1375,85 @@ module provides such functionality.
- If you use pam_winbind to authorise against a Windows Active Directory, then /etc/nsswitch.conf must be configured to use winbind as well.
3.1.5 Access Rules
3.1.6 Access Rules
ACL Definition
Access control in ejabberd is performed via Access Control Lists (ACLs). The declarations of ACLs in the configuration file have the following syntax: -
- {acl, ACLName, ACLValue}.
ACLValue can be one of the following: +
- acl: { ACLName: { ACLType: ACLValue } }
ACLType: ACLValue can be one of the following:
- all
- Matches all JIDs. Example:
-
{acl, all, all}. - - {user, Username}
- Matches the user with the name
+
acl: + world: all +
- user: Username
- Matches the user with the name
Username at the first virtual host. Example:
-
{acl, admin, {user, "yozhik"}}. - - {user, Username, Server}
- Matches the user with the JID
+
acl: + admin: + user: "yozhik" +
- user: {Username: Server}
- Matches the user with the JID
Username@Server and any resource. Example:
-
{acl, admin, {user, "yozhik", "example.org"}}. - - {server, Server}
- Matches any JID from server
+
acl: + admin: + user: + "yozhik": "example.org" +
- server: Server
- Matches any JID from server
Server. Example:
-
{acl, exampleorg, {server, "example.org"}}. - - {resource, Resource}
- Matches any JID with a resource
+
acl: + exampleorg: + server: "example.org" +
- resource: Resource
- Matches any JID with a resource
Resource. Example:
-
{acl, mucklres, {resource, "muckl"}}. - - {shared_group, Groupname}
- Matches any member of a Shared Roster Group with name Groupname in the virtual host. Example:
-
{acl, techgroupmembers, {shared_group, "techteam"}}. - - {shared_group, Groupname, Server}
- Matches any member of a Shared Roster Group with name Groupname in the virtual host Server. Example:
-
{acl, techgroupmembers, {shared_group, "techteam", "example.org"}}. - - {user_regexp, Regexp}
- Matches any local user with a name that
+
acl: + mucklres: + resource: "muckl" +
- shared_group: Groupname
- Matches any member of a Shared Roster Group with name Groupname in the virtual host. Example:
+
acl: + techgroupmembers: + shared_group: "techteam" +
- shared_group: {Groupname: Server}
- Matches any member of a Shared Roster Group with name Groupname in the virtual host Server. Example:
+
acl: + techgroupmembers: + shared_group: + "techteam": "example.org" +
- ip: Network
- Matches any IP address from the Network. Example:
+
acl: + loopback: + ip: + - "127.0.0.0/8" + - "::" +
- user_regexp: Regexp
- Matches any local user with a name that
matches Regexp on local virtual hosts. Example:
-
{acl, tests, {user_regexp, "^test[0-9]*$"}}. - - {user_regexp, Regexp, Server}
- Matches any user with a name
+
acl: + tests: + user_regexp: "^test[0-9]*$" +
- user_regexp: {Regexp: Server}
- Matches any user with a name
that matches Regexp at server Server. Example:
-
{acl, tests, {user_regexp, "^test", "example.org"}}. - - {server_regexp, Regexp}
- Matches any JID from the server that
+
acl: + tests: + user_regexp: + "^test": "example.org" +
- server_regexp: Regexp
- Matches any JID from the server that
matches Regexp. Example:
-
{acl, icq, {server_regexp, "^icq\\."}}. - - {resource_regexp, Regexp}
- Matches any JID with a resource that
+
acl: + icq: + server_regexp: "^icq\\." +
- resource_regexp: Regexp
- Matches any JID with a resource that
matches Regexp. Example:
-
{acl, icq, {resource_regexp, "^laptop\\."}}. - - {node_regexp, UserRegexp, ServerRegexp}
- Matches any user
+
acl: + icq: + resource_regexp: "^laptop\\." +
- node_regexp: {UserRegexp: ServerRegexp}
- Matches any user
with a name that matches UserRegexp at any server that matches
ServerRegexp. Example:
-
{acl, yozhik, {node_regexp, "^yozhik$", "^example.(com|org)$"}}. - - {user_glob, Glob}
- -
- {user_glob, Glob, Server}
- -
- {server_glob, Glob}
- -
- {resource_glob, Glob}
- -
- {node_glob, UserGlob, ServerGlob}
- This is the same as
+
acl: + yozhik: + node_regexp: + "^yozhik$": "^example.(com|org)$" +
- user_glob: Glob}
- +
- user_glob: {Glob: Server}
- +
- server_glob: Glob
- +
- resource_glob: Glob
- +
- node_glob: {UserGlob: ServerGlob}
- This is the same as
above. However, it uses shell glob patterns instead of regexp. These patterns
can have the following special characters:
-
@@ -1276,7 +1472,7 @@ character not enclosed is matched.
Access Rights
An entry allowing or denying access to different services. The syntax is: -
- {access, AccessName, [ {allow|deny, ACLName}, ...]}.
- access: { AccessName: { ACLName: allow|deny } }
- all
- Always returns the value ‘allow’.
@@ -1300,26 +1499,28 @@ 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}, ...]}.
This example limits the number of sessions per user to 5 for all users, and to 10 for admins: -
{access, max_user_sessions, [{10, admin}, {5, all}]}. +- { max_user_sessions: { ACLName: MaxNumber } }
This example limits the number of sessions per user to 5 for all users, and to 10 for admins: +
access: + max_user_sessions: + admin: 10 + all: 5
Several connections to a remote XMPP server with ACL
The special access max_s2s_connections specifies how many simultaneous S2S connections can be established to a specific remote XMPP 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: +
- { max_s2s_connections: { ACLName: MaxNumber } }
Examples:
-
Allow up to 3 connections with each remote server:
-
{access, max_s2s_connections, [{3, all}]}. +access: + max_s2s_connections: + all: 3
3.1.6 Shapers
3.1.7 Shapers
Shapers enable you to limit connection traffic. The syntax is: -
- {shaper, ShaperName, Kind}.
-Currently only one kind of shaper called maxrate is available. It has the -following syntax: -
- {maxrate, Rate}
+
- shaper: { ShaperName: 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 @@ -1327,30 +1528,32 @@ until the average rate is again below the allowed maximum.
Examples:
-
To define a shaper named ‘normal’ with traffic speed limited to
1,000 bytes/second:
-
{shaper, normal, {maxrate, 1000}}. +shaper: + normal: 1000
- To define a shaper named ‘fast’ with traffic speed limited to
50,000 bytes/second:
-
{shaper, fast, {maxrate, 50000}}. +shaper: + fast: 50000
3.1.7 Default Language
3.1.8 Default Language
The option language defines the default language of server strings that can be seen by XMPP clients. If a XMPP client does not support xml:lang, the specified language is used.
The option syntax is: -
- {language, Language}.
The default value is en. +
- language: Language
The default value is en. In order to take effect there must be a translation file Language.msg in ejabberd’s msgs directory.
For example, to set Russian as default language: -
{language, "ru"}. +language: "ru"
Appendix A provides more details about internationalization and localization.
-3.1.8 CAPTCHA
3.1.9 CAPTCHA
Some ejabberd modules can be configured to require a CAPTCHA challenge on certain actions. If the client does not support CAPTCHA Forms (XEP-0158), a web link is provided so the user can fill the challenge in a web browser.
An example script is provided that generates the image using ImageMagick’s Convert program.
The configurable options are:
- -{captcha_cmd, Path}
-
+captcha_cmd: Path
- Full path to a script that generates the image. The default value disables the feature: undefined -
- {captcha_host, ProtocolHostPort}
- +
- captcha_host: ProtocolHostPort
- ProtocolHostPort is a string with the host, and optionally the Protocol and Port number. It must identify where ejabberd listens for CAPTCHA requests. The URL sent to the user is formed by: Protocol://Host:Port/captcha/ @@ -1359,44 +1562,46 @@ If you specify a port number that does not match exactly an ejabberd listener (because you are using a reverse proxy or other port-forwarding tool), then you must specify the transfer protocol, as seen in the example below.
Additionally, an ejabberd_http listener must be enabled with the captcha option. -See section 3.1.3.
Example configuration: -
{hosts, ["example.org"]}. +See section 3.1.4.Example configuration: +
hosts: ["example.org"] -{captcha_cmd, "/lib/ejabberd/priv/bin/captcha.sh"}. -{captcha_host, "example.org:5280"}. -%% {captcha_host, "https://example.org:443"}. -%% {captcha_host, "http://example.com"}. +captcha_cmd: "/lib/ejabberd/priv/bin/captcha.sh" +captcha_host: "example.org:5280" +## captcha_host: "https://example.org:443" +## captcha_host: "http://example.com" -{listen, - [ +listen: + ... + - + port: 5280 + module: ejabberd_http + captcha: true ... - {5280, ejabberd_http, [ - captcha, - ... - ] - } - -]}.-3.1.9 STUN
3.1.10 STUN
ejabberd is able to act as a stand-alone STUN server (RFC 5389). Currently only Binding usage -is supported. In that role ejabberd helps clients with Jingle ICE (XEP-0176) support to discover their external addresses and ports.
You should configure ejabberd_stun listening module as described in 3.1.3 section. +is supported. In that role ejabberd helps clients with Jingle ICE (XEP-0176) support to discover their external addresses and ports.
You should configure ejabberd_stun listening module as described in 3.1.4 section. If certfile option is defined, ejabberd multiplexes TCP and TLS over TCP connections on the same port. Obviously, certfile option is defined for tcp only. Note however that TCP or TLS over TCP support is not required for Binding usage and is reserved for TURN functionality. Feel free to configure udp transport only.
Example configuration: -
{listen, - [ +-listen: ... - {{3478, udp}, ejabberd_stun, []}, - {3478, ejabberd_stun, []}, - {5349, ejabberd_stun, [{certfile, "/etc/ejabberd/server.pem"}]}, + - + port: 3478 + transport: udp + module: ejabberd_stun + - + port: 3478 + module: ejabberd_stun + - + port: 5349 + module: ejabberd_stun + certfile: "/etc/ejabberd/server.pem" ... - ] -}.You also need to configure DNS SRV records properly so clients can easily discover a STUN server serving your XMPP domain. Refer to section DNS Discovery of a Server @@ -1405,41 +1610,55 @@ of RFC 5389 for details.
_stun._tcp IN SRV 0 0 3478 stun.example.com. _stuns._tcp IN SRV 0 0 5349 stun.example.com.
3.1.10 Include Additional Configuration Files
3.1.11 Include Additional Configuration Files
The option include_config_file in a configuration file instructs ejabberd to include other configuration files immediately.
The basic syntax is: -
- {include_config_file, Filename}.
+
- include_config_file: [Filename]
It is possible to specify suboptions using the full syntax: -
- {include_config_file, Filename, [Suboption, ...]}.
The filename can be indicated either as an absolute path, +
- include_config_file: { Filename: [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:
- -{disallow, [Optionname, ...]}
- Disallows the usage of those options in the included configuration file.
+disallow: [Optionname, ...]
- Disallows the usage of those options in the included configuration file. The options that match this criteria are not accepted. The default value is an empty list: [] -
- {allow_only, [Optionname, ...]}
- Allows only the usage of those options in the included configuration file. +
- allow_only: [Optionname, ...]
- Allows only the usage of those options in the included configuration file. The options that do not match this criteria are not accepted. The default value is: all
This is a basic example: -
{include_config_file, "/etc/ejabberd/additional.cfg"}. +include_config_file: "/etc/ejabberd/additional.yml"
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, +
include_config_file: + "./example.org/additional_not_listen.yml": + disallow: [listen] +
In this example, ejabberd.yml 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"}}. +acl: + admin: + user: + - "admin": "localhost" +access: + announce: + admin: allow +include_config_file: + "/etc/ejabberd/acl_and_access.yml": + allow_only: + - acl + - access +
and content of the file acl_and_access.yml can be, for example: +
acl: + admin: + user: + - "bob": "localhost" + - "jan": "localhost"
-3.1.11 Option Macros in Configuration File
3.1.12 Option Macros in Configuration File
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}.
+
- 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, @@ -1447,44 +1666,43 @@ and additional definitions of the same macro are forgotten.
Macros are pro 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: -
- ’MACRO’
- -You can put this instead of a value in an ejabberd option, -and will be replaced with the value previously defined. -If the macro is not defined previously, -the program will crash and report an error.
- {use_macro, ’MACRO’, Defaultvalue}
-
-Use a macro even if it may not be defined.
-If the macro is not defined previously,
-the provided defaultvalue is used.
-This usage behaves as if it were defined and used this way:
-
{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, []} - ] -}. +of another 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 + 'NUMBER_PORT_HTTP': 5280 +listen: + - + port: 'NUMBER_PORT_C2S' + module: ejabberd_c2s + - + port: 'NUMBER_PORT_HTTP' + module: ejabberd_http
produces this result after being interpreted: -
{listen, - [ - {5222, ejabberd_c2s, []}, - {5269, ejabberd_s2s_in, []}, - {5280, ejabberd_http, []} - ] -}. +listen: + - + port: 5222 + module: ejabberd_c2s + - + port: 5280 + module: ejabberd_http
-3.2 Database and LDAP Configuration
3.2 Database and LDAP Configuration
ejabberd uses its internal Mnesia database by default. However, it is possible to use a relational database or an LDAP server to store persistent, @@ -1493,206 +1711,70 @@ 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:
- Active Directory -(see section 3.2.5) +(see section 3.2.2)
- OpenLDAP
- CommuniGate Pro
- Normally any LDAP compatible server should work; inform us about your success with a not-listed server so that we can list it here.
Important note about virtual hosting: -if you define several domains in ejabberd.cfg (see section 3.1.1), +if you define several domains in ejabberd.yml (see section 3.1.2), 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_config for each vhost (see section 3.1.2). +must be set inside a host_config for each vhost (see section 3.1.3). For example: -
{host_config, "public.example.org", [ - {odbc_server, {pgsql, "localhost", "database-public-example-org", "ejabberd", "password"}}, - {auth_method, [odbc]} -]}. --3.2.1 MySQL
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.
-Driver Compilation
You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for MySQL.
- -First, install the Erlang -MySQL library. Make sure the compiled files are in your Erlang path; you can -put them for example in the same directory as your ejabberd .beam files. -
- Then, configure and install ejabberd with ODBC support enabled (this is
-also needed for native MySQL support!). This can be done, by using next
-commands:
-
./configure --enable-odbc && make install -
Database Connection
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. +
host_config: + "public.example.org": + odbc_type: pgsql + odbc_server: "localhost" + odbc_database: "database-public-example-org" + odbc_username: "ejabberd" + odbc_password: "password" + auth_method: [odbc] +
+3.2.1 ODBC
The actual database access is defined in the options with odbc_ prefix. The +values are used to define if we want to use ODBC, or one of the two native +interface available, PostgreSQL or MySQL.
The following paramaters are available: +
- +odbc_type: mysql | pgsql | odbc
- The type of an ODBC connection. +The default is odbc. +
- odbc_server: String
- A hostname of the ODBC server. The default is +‘‘localhost’’. +
- odbc_port: Port
- The port where the ODBC server is accepting connections. +The option is only valid for mysql and pgsql. The default is +3306 and 5432 respectively. +
- odbc_database: String
- The database name. The default is ‘‘ejabberd’’. +The option is only valid for mysql and pgsql. +
- odbc_username: String
- The username. The default is ‘‘ejabberd’’. +The option is only valid for mysql and pgsql. +
- odbc_password: String
- The password. The default is empty string. +The option is only valid for mysql and pgsql. +
- odbc_pool_size: N
- By default ejabberd opens 10 connections to +the database for each virtual host. You can change this number by using this option. +
- odbc_keepalive_interval: N
- 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}. --Authentication
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]}. --Storage
MySQL also can be used to store information into from 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}.
-3.2.2 Microsoft SQL Server
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.
-Driver Compilation
You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for ODBC.
If you want to use Microsoft SQL Server with ODBC, you need to configure, -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 -
-Database Connection
The configuration of Database Connection for a Microsoft SQL Server -is the same as the configuration for -ODBC compatible servers (see section 3.2.4).
-Authentication
The configuration of Authentication for a Microsoft SQL Server -is the same as the configuration for -ODBC compatible servers (see section 3.2.4).
-Storage
Microsoft SQL Server also can be used to store information into from several -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}.
-3.2.3 PostgreSQL
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.
-Driver Compilation
You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for -PostgreSQL.
- -First, install the Erlang pgsql library from -ejabberd-modules SVN repository. -Make sure the compiled -files are in your Erlang path; you can put them for example in the same -directory as your ejabberd .beam files. -
- Then, configure, compile and install ejabberd with ODBC support enabled
-(this is also needed for native PostgreSQL support!). This can be done, by
-using next commands:
-
./configure --enable-odbc && make install -
Database Connection
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}. --Authentication
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]}. --Storage
PostgreSQL also can be used to store information into from 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}.
-3.2.4 ODBC Compatible
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.
-Driver Compilation
You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for -ODBC.
- -First, install the Erlang -MySQL library. Make sure the compiled files are in your Erlang path; you can -put them for example in the same directory as your ejabberd .beam files. -
- Then, configure, compile and install ejabberd with ODBC support
-enabled. This can be done, by using next commands:
-
./configure --enable-odbc && make install -
Database Connection
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}. --Authentication
The first configuration step is to define the odbc auth_method. For -example: -
{auth_method, [odbc]}. + - odbc_start_interval: N
- If the connection to the database fails, +ejabberd waits 30 seconds before retrying. +You can modify this interval with this option. +
Example of plain ODBC connection: +
odbc_server: "DSN=database;UID=ejabberd;PWD=password" +
Example of MySQL connection: +
odbc_type: mysql +odbc_server: "server.company.com" +odbc_port: 3306 # the default +odbc_database: "mydb" +odbc_username: "user1" +odbc_password: "**********" +odbc_pool_size: 5
Storage
An ODBC compatible database also can be used to store information into from @@ -1700,8 +1782,8 @@ 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}.
-3.2.5 LDAP
+3.2.2 LDAP
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: it is possible to consult data, but not possible to @@ -1712,50 +1794,51 @@ and LDAP server supports
Connection
Two connections are established to the LDAP server per vhost, one for authentication and other for regular calls.
Parameters:
- -{ldap_servers, [Servers, ...]}
- List of IP addresses or DNS names of your
+ldap_servers: [Servers, ...]
- List of IP addresses or DNS names of your LDAP servers. This option is required. -
- {ldap_encrypt, none|tls}
- Type of connection encryption to the LDAP server. +
- ldap_encrypt: none|tls
- Type of connection encryption to the LDAP server. Allowed values are: none, tls. The value tls enables encryption by using LDAP over SSL. Note that STARTTLS encryption is not supported. The default value is: none. -
- {ldap_tls_verify, false|soft|hard}
- +
- ldap_tls_verify: false|soft|hard
- This option specifies whether to verify LDAP server certificate or not when TLS is enabled. When hard is enabled ejabberd doesn’t proceed if a certificate is invalid. When soft is enabled ejabberd proceeds even if check fails. The default is false which means no checks are performed. -
- {ldap_tls_cacertfile, Path}
- +
- ldap_tls_cacertfile: Path
- Path to file containing PEM encoded CA certificates. This option is needed (and required) when TLS verification is enabled. -
- {ldap_tls_depth, Number}
- +
- ldap_tls_depth: Number
- Specifies the maximum verification depth when TLS verification is enabled, i.e. how far in a chain of certificates the verification process can proceed before the verification is considered to fail. Peer certificate = 0, CA certificate = 1, higher level CA certificate = 2, etc. The value 2 thus means that a chain can at most contain peer cert, CA cert, next CA cert, and an additional CA cert. The default value is 1. -
- {ldap_port, Number}
- Port to connect to your LDAP server. +
- ldap_port: Number
- Port to connect to your LDAP server. The default port is 389 if encryption is disabled; and 636 if encryption is enabled. If you configure a value, it is stored in ejabberd’s database. Then, if you remove that value from the configuration file, the value previously stored in the database will be used instead of the default port. -
- {ldap_rootdn, RootDN}
- Bind DN. The default value +
- ldap_rootdn: RootDN
- Bind DN. The default value is "" which means ‘anonymous connection’. -
- {ldap_password, Password}
- Bind password. The default +
- ldap_password: Password
- Bind password. The default value is "". -
- {ldap_deref_aliases, never|always|finding|searching}
- Whether or not to dereference aliases. The default is never. +
- ldap_deref_aliases: never|always|finding|searching
- Whether or not to dereference aliases. The default is never.
Example: -
{auth_method, ldap}. -{ldap_servers, ["ldap.example.org"]}. -{ldap_port, 389}. -{ldap_rootdn, "cn=Manager,dc=domain,dc=org"}. -{ldap_password, "secret"}. +auth_method: [ldap] +ldap_servers: + - "ldap1.example.org" +ldap_port: 389 +ldap_rootdn: "cn=Manager,dc=domain,dc=org" +ldap_password: "**********"
Authentication
You can authenticate users against an LDAP directory. Note that current LDAP implementation does not support SASL authentication.
Available options are:
- -{ldap_base, Base}
- LDAP base directory which stores
+ldap_base: Base
- LDAP base directory which stores users accounts. This option is required. -
- {ldap_uids, [ {ldap_uidattr} | {ldap_uidattr, ldap_uidattr_format}, ...]}
- +
- ldap_uids: [ ldap_uidattr | {ldap_uidattr: ldap_uidattr_format} ]
- LDAP attribute which holds a list of attributes to use as alternatives for getting the JID. The default attributes are [{"uid", "%u"}]. The attributes are of the form: @@ -1772,14 +1855,14 @@ only one pattern variable "%u" which will be replaced by the user’s part of a JID. For example, "%u@example.org". The default value is "%u".
- {ldap_filter, Filter}
- +
- ldap_filter: Filter
- RFC 4515 LDAP filter. The default Filter value is: undefined. Example: "(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, do not forget to close brackets and do not use superfluous whitespaces. Also you must not use ldap_uidattr attribute in filter because this attribute will be substituted in LDAP filter automatically. -
- {ldap_dn_filter, { Filter, FilterAttrs }}
- +
- ldap_dn_filter: { Filter: FilterAttrs }
-
This filter is applied on the results returned by the main filter. This filter
performs additional LDAP lookup to make the complete result. This is useful
when you are unable to define all filter rules in ldap_filter. You
@@ -1790,7 +1873,8 @@ all "%s" variables are consecutively replaced by values of FilterAttrs
attributes and "%D" is replaced by Distinguished Name. By default
ldap_dn_filter is undefined.
Example:
-
{ldap_dn_filter, {"(&(name=%s)(owner=%D)(user=%u@%d))", ["sn"]}}. +ldap_dn_filter: + "(&(name=%s)(owner=%D)(user=%u@%d))": ["sn"]
Since this filter makes additional LDAP lookups, use it only in the last resort: try to define all filter rules in ldap_filter if possible. - {ldap_local_filter, Filter}
-
@@ -1812,140 +1896,130 @@ Also we have addressbook, which contains users emails and their additional
infos in "ou=AddressBook,dc=example,dc=org" directory.
The connection to the LDAP server is encrypted using TLS,
and using the custom port 6123.
-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"}. -{ldap_encrypt, tls}. -{ldap_port, 6123}. -%% 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)"}. +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" +ldap_encrypt: tls +ldap_port: 6123 +## 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, - [ +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"}]} - ]}, + 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
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=*)"}. +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, - [ +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"}]} - ]}, + 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" ... - ]}.-3.3 Modules Configuration
3.3 Modules Configuration
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.
The syntax is: -
- {modules, [ {ModuleName, ModuleOptions}, ...]}.
Examples: +
- modules: { ModuleName: ModuleOptions }
Examples:
-
In this example only the module mod_echo is loaded and no module
options are specified between the square brackets:
-
{modules, - [ - {mod_echo, []} - ]}. +modules: + mod_echo: {} - In the second example the modules mod_echo, mod_time, and
mod_version are loaded without options. Remark that, besides the last entry,
all entries end with a comma:
-
{modules, - [ - {mod_echo, []}, - {mod_time, []}, - {mod_version, []} - ]}. +modules: + mod_echo: {} + mod_time: {} + mod_version: {}
3.3.1 Modules Overview
3.3.1 Modules Overview
The following table lists all modules included in ejabberd.
-Module Feature Dependencies mod_adhoc Ad-Hoc Commands (XEP-0050) 3.3.2 Common Options
The following options are used by many modules. Therefore, they are described in +
3.3.2 Common Options
The following options are used by many modules. Therefore, they are described in this separate section.
iqdisc
Many modules define handlers for processing IQ queries of different namespaces to this server or to a user (e. g. to example.org or to user@example.org). This option defines processing discipline for these queries.
The syntax is: -
- {iqdisc, Value}
Possible Value are: +
- iqdisc: Value
Possible Value are:
- no_queue
- All queries of a namespace with this processing discipline are processed directly. This means that the XMPP connection that sends this IQ query gets blocked: @@ -2013,7 +2087,7 @@ recommended if the processing of a query can take a relatively long time. 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. -
- {queues, N}
- N separate queues are created to process the +
- N
- N separate queues are created to process the queries. The queries are thus processed in parallel, but in a controlled way.
- parallel
- For every packet with this discipline a separate Erlang process @@ -2022,35 +2096,32 @@ Although spawning of Erlang process has a relatively low cost, this can break the server’s normal work, because the Erlang emulator has a limit on the number of processes (32000 by default).
Example: -
{modules, - [ +modules: ... - {mod_time, [{iqdisc, no_queue}]}, + mod_time: + iqdisc: no_queue ... - ]}.host
This option defines the Jabber ID of a service provided by an ejabberd module.
The syntax is: -
- {host, HostName}
If you include the keyword "@HOST@" in the HostName, +
- host: HostName
If you include the keyword "@HOST@" in the HostName, it is replaced at start time with the real virtual host string.
This example configures the echo module to provide its echoing service in the Jabber ID mirror.example.org: -
{modules, - [ +modules: ... - {mod_echo, [{host, "mirror.example.org"}]}, + mod_echo: + host: "mirror.example.org" ... - ]}.However, if there are several virtual hosts and this module is enabled in all of them, the "@HOST@" keyword must be used: -
{modules, - [ +modules: ... - {mod_echo, [{host, "mirror.@HOST@"}]}, + mod_echo: + host: "mirror.@HOST@" ... - ]}.-3.3.3 mod_announce
3.3.3 mod_announce
This module enables configured users to broadcast announcements and to set the message of the day (MOTD). Configured users can perform these actions with a @@ -2081,44 +2152,50 @@ 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:
- -{db_type, mnesia|odbc}
-
+db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2. -
- {access, AccessName}
- This option specifies who is allowed to +
- access: AccessName
- This option specifies who is allowed to send announcements and to set the message of the day (by default, nobody is able to send such messages).
Examples:
-
Only administrators can send announcements:
-
{access, announce, [{allow, admin}]}. +access: + announce: + admin: allow -{modules, - [ +modules: ... - {mod_adhoc, []}, - {mod_announce, [{access, announce}]}, + mod_adhoc: {} + mod_announce: + access: announce ... - ]}. - Administrators as well as the direction can send announcements:
-
{acl, direction, {user, "big_boss", "example.org"}}. -{acl, direction, {user, "assistant", "example.org"}}. -{acl, admin, {user, "admin", "example.org"}}. +acl: + direction: + user: + "big_boss": "example.org" + "assistant": "example.org" + admin: + user: + "admin": "example.org" +access: + announce: + admin: allow + direction: allow -{access, announce, [{allow, admin}, - {allow, direction}]}. - -{modules, - [ +modules: ... - {mod_adhoc, []}, - {mod_announce, [{access, announce}]}, + mod_adhoc: {} + mod_announce: + access: announce ... - ]}.
Note that mod_announce can be resource intensive on large deployments as it can broadcast lot of messages. This module should be disabled for instances of ejabberd with hundreds of thousands users.
-3.3.4 mod_disco
3.3.4 mod_disco
@@ -2131,162 +2208,163 @@ for the superseded Jabber Browsing (
- -{iqdisc, Discipline}
- This specifies +iqdisc: Discipline
- 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 3.3.2). -
- {extra_domains, [Domain, ...]}
- With this option, +
- extra_domains: [Domain, ...]
- With this option, you can specify a list of extra domains that are added to the Service Discovery item list. -
- {server_info, [ {Modules, Field, [Value, ...]}, ... ]}
- +
- server_info: [ { modules: Modules, name: Name, urls: [URL, ...] } ]
- Specify additional information about the server, as described in Contact Addresses for XMPP Services (XEP-0157). Modules can be the keyword ‘all’, in which case the information is reported in all the services; or a list of ejabberd modules, in which case the information is only specified for the services provided by those modules. -Any arbitrary Field and Value can be specified, not only contact addresses. +Any arbitrary Name and URL can be specified, not only contact addresses.
Examples:
-
To serve a link to the Jabber User Directory on jabber.org:
-
{modules, - [ +modules: ... - {mod_disco, [{extra_domains, ["users.jabber.org"]}]}, + mod_disco: + extra_domains: ["users.jabber.org"] ... - ]}. - To serve a link to the transports on another server:
-
{modules, - [ +modules: ... - {mod_disco, [{extra_domains, ["icq.example.com", - "msn.example.com"]}]}, + mod_disco: + extra_domains: + - "icq.example.com" + - "msn.example.com" ... - ]}. - To serve a link to a few friendly servers:
-
{modules, - [ +modules: ... - {mod_disco, [{extra_domains, ["example.org", - "example.com"]}]}, + mod_disco: + extra_domains: + - "example.org" + - "example.com" ... - ]}. - With this configuration, all services show abuse addresses,
feedback address on the main server,
and admin addresses for both the main server and the vJUD service:
-
{modules, - [ +modules: ... - {mod_disco, [{server_info, [ - {all, - "abuse-addresses", - ["mailto:abuse@shakespeare.lit"]}, - {[mod_muc], - "Web chatroom logs", - ["http://www.example.org/muc-logs"]}, - {[mod_disco], - "feedback-addresses", - ["http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit"]}, - {[mod_disco, mod_vcard], - "admin-addresses", - ["mailto:xmpp@shakespeare.lit", "xmpp:admins@shakespeare.lit"]} - ]}]}, + mod_disco: + server_info: + - + modules: all + name: "abuse-addresses" + urls: ["mailto:abuse@shakespeare.lit"] + - + modules: [mod_muc] + name: "Web chatroom logs" + urls: ["http://www.example.org/muc-logs"] + - + modules: [mod_disco] + name: "feedback-addresses" + urls: + - "http://shakespeare.lit/feedback.php" + - "mailto:feedback@shakespeare.lit" + - "xmpp:feedback@shakespeare.lit" + - + modules: + - mod_disco + - mod_vcard + name: "admin-addresses" + urls: + - "mailto:xmpp@shakespeare.lit" + - "xmpp:admins@shakespeare.lit" ... - ]}.
3.3.5 mod_echo
3.3.5 mod_echo
This module simply echoes any XMPP packet back to the sender. This mirror can be of interest for ejabberd and XMPP client debugging.
Options:
- -{host, HostName}
- This option defines the Jabber ID of the
+host: HostName
- This option defines the Jabber ID of the service. If the host option is not specified, the Jabber ID will be the hostname of the virtual host with the prefix ‘echo.’. The keyword "@HOST@" is replaced at start time with the real virtual host name.
Example: Mirror, mirror, on the wall, who is the most beautiful of them all? -
{modules, - [ +modules: ... - {mod_echo, [{host, "mirror.example.org"}]}, + mod_echo: + host: "mirror.example.org" ... - ]}.-3.3.6 mod_http_bind
3.3.6 mod_http_bind
This module implements XMPP over Bosh (formerly known as HTTP Binding) as defined in XEP-0124 and XEP-0206. It extends ejabberd’s built in HTTP service with a configurable resource at which this service will be hosted.
To use HTTP-Binding, enable the module: -
{modules, - [ +modules: ... - {mod_http_bind, []}, + mod_http_bind: {} ... -]}.and add
http_bindin the HTTP service. For example: -{listen, - [ +listen: ... - {5280, ejabberd_http, [ - http_bind, - http_poll, - web_admin - ] - }, + - + port: 5280 + module: ejabberd_http + http_bind: true + http_poll: true + web_admin: true ... -]}.With this configuration, the module will serve the requests sent to
http://example.org:5280/http-bind/Remember that this page is not designed to be used by web browsers, it is used by XMPP clients that support XMPP over Bosh.If you want to set the service in a different URI path or use a different module, you can configure it manually using the option
request_handlers. For example: -{listen, - [ +listen: ... - {5280, ejabberd_http, [ - {request_handlers, [{["http-bind"], mod_http_bind}]}, - http_poll, - web_admin - ] - }, + - + port: 5280 + module: ejabberd_http + request_handlers: + "/http-bind": mod_http_bind + http_poll: true + web_admin: true ... -]}.Options:
- {max_inactivity, Seconds}
-
Define the maximum inactivity period in seconds.
Default value is 30 seconds.
For example, to set 50 seconds:
-
{modules, - [ +modules: ... - {mod_http_bind, [ {max_inactivity, 50} ]}, + mod_http_bind: + max_inactivity: 50 ... -]}.
3.3.7 mod_http_fileserver
3.3.7 mod_http_fileserver
This simple module serves files from the local disk over HTTP.
Options:
- -{docroot, Path}
-
+docroot: Path
- Directory to serve the files. -
- {accesslog, Path}
- +
- accesslog: Path
- File to log accesses using an Apache-like format. No log will be recorded if this option is not specified. -
- {directory_indices, [Index, ...]}
- +
- directory_indices: [Index, ...]
- Indicate one or more directory index files, similarly to Apache’s DirectoryIndex variable. When a web request hits a directory instead of a regular file, those directory indices are looked in order, and the first one found is returned. -
- {custom_headers, [ {Name, Value}, ...]}
- +
- custom_headers: {Name: Value}
- Indicate custom HTTP headers to be included in all responses. Default value is: [] -
- {content_types, [ {Name, Type}, ...]}
- +
- content_types: {Name: Type}
- Specify mappings of extension to content type. There are several content types already defined, with this option you can add new definitions, modify or delete existing ones. To delete an existing definition, simply define it with a value: ‘undefined’. -
- {default_content_type, Type}
- +
- default_content_type: Type
- Specify the content type to use for unknown extensions. Default value is ‘application/octet-stream’.
This example configuration will serve the files from @@ -2295,44 +2373,36 @@ in the address
http://example.org:5280/pub/archive/. In this example a new content type ogg is defined, png is redefined, and jpg definition is deleted. To use this module you must enable it: -{modules, - [ +modules: ... - {mod_http_fileserver, [ - {docroot, "/var/www"}, - {accesslog, "/var/log/ejabberd/access.log"}, - {directory_indices, ["index.html", "main.htm"]}, - {custom_headers, [{"X-Powered-By", "Erlang/OTP"}, - {"X-Fry", "It's a widely-believed fact!"} - ]}, - {content_types, [{".ogg", "audio/ogg"}, - {".png", "image/png"}, - {".jpg", undefined} - ]}, - {default_content_type, "text/html"} - ] - }, + mod_http_fileserver: + docroot: "/var/www" + accesslog: "/var/log/ejabberd/access.log" + directory_indices: + - "index.html" + - "main.htm" + custom_headers: + "X-Powered-By": "Erlang/OTP" + "X-Fry": "It's a widely-believed fact!" + content_types: + ".ogg": "audio/ogg" + ".png": "image/png" + ".jpg": undefined + default_content_type: "text/html" ... -]}.And define it as a handler in the HTTP service: -
{listen, - [ +listen: ... - {5280, ejabberd_http, [ - ... - {request_handlers, [ - ... - {["pub", "archive"], mod_http_fileserver}, - ... - ] - }, - ... - ] - }, + - + port: 5280 + module: ejabberd_http + request_handlers: + ... + "/pub/archive": mod_http_fileserver + ... ... -]}.-3.3.8 mod_irc
3.3.8 mod_irc
This module is an IRC transport that can be used to join channels on IRC servers.
End user information: @@ -2356,61 +2426,66 @@ number of connections from one IP.
Options:
- -{host, HostName}
- This option defines the Jabber ID of the
+host: HostName
- This option defines the Jabber ID of the 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. -
- {db_type, mnesia|odbc}
- +
- db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2. -
- {access, AccessName}
- This option can be used to specify who +
- access: AccessName
- This option can be used to specify who may use the IRC transport (default value: all). -
- {default_encoding, Encoding}
- Set the default IRC encoding. +
- default_encoding: Encoding
- Set the default IRC encoding. Default value: "iso8859-1"
Examples:
-
In the first example, the IRC transport is available on (all) your
virtual host(s) with the prefix ‘irc.’. Furthermore, anyone is
able to use the transport. The default encoding is set to "iso8859-15".
-
{modules, - [ +modules: ... - {mod_irc, [{access, all}, {default_encoding, "iso8859-15"}]}, + mod_irc: + access: all + default_encoding: "iso8859-15" ... - ]}. - In next example the IRC transport is available with JIDs with prefix irc-t.net.
Moreover, the transport is only accessible to two users
of example.org, and any user of example.com:
-
{acl, paying_customers, {user, "customer1", "example.org"}}. -{acl, paying_customers, {user, "customer2", "example.org"}}. -{acl, paying_customers, {server, "example.com"}}. +acl: + paying_customers: + user: + - "customer1": "example.org" + - "customer2": "example.org" + server: "example.com" -{access, irc_users, [{allow, paying_customers}, {deny, all}]}. +access: + irc_users: + paying_customers: allow + all: deny -{modules, - [ +modules: ... - {mod_irc, [{access, irc_users}, - {host, "irc.example.net"}]}, + mod_irc: + access: irc_users + host: "irc.example.net" ... - ]}.
3.3.9 mod_last
3.3.9 mod_last
This module adds support for Last Activity (XEP-0012). It can be used to discover when a disconnected user last accessed the server, to know when a connected user was last active on the server, or to query the uptime of the ejabberd server.
Options:
- -{iqdisc, Discipline}
- This specifies
+iqdisc: Discipline
- This specifies the processing discipline for Last activity (jabber:iq:last) IQ queries (see section 3.3.2). -
- {db_type, mnesia|odbc}
- +
- db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2.
3.3.10 mod_muc
3.3.10 mod_muc
This module provides a Multi-User Chat (XEP-0045) service. Users can discover existing rooms, join or create them. Occupants of a room can chat in public or have private chats.
Some of the features of Multi-User Chat: @@ -2432,24 +2507,24 @@ set of rooms goes down, the rooms disappear and they will be recreated on an available node on first connection attempt.
Module options:
- -{host, HostName}
- This option defines the Jabber ID of the
+host: HostName
- This option defines the Jabber ID of the 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. -
- {db_type, mnesia|odbc}
- +
- db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2. -
- {access, AccessName}
- You can specify who is allowed to use +
- access: AccessName
- You can specify who is allowed to use the Multi-User Chat service. By default everyone is allowed to use it. -
- {access_create, AccessName}
- To configure who is +
- access_create: AccessName
- To configure who is allowed to create new rooms at the Multi-User Chat service, this option can be used. By default any account in the local ejabberd server is allowed to create rooms. -
- {access_persistent, AccessName}
- To configure who is +
- access_persistent: AccessName
- To configure who is allowed to modify the ’persistent’ room option. By default any account in the local ejabberd server is allowed to modify that option. -
- {access_admin, AccessName}
- This option specifies +
- access_admin: AccessName
- 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. @@ -2457,7 +2532,7 @@ The administrators can send a normal message to the service JID, and it will be shown in all active rooms as a service message. The administrators can send a groupchat message to the JID of an active room, and the message will be shown in the room as a service message. -
- {history_size, Size}
- A small history of +
- history_size: Size
- A small history of the current discussion is sent to users when they enter the room. With this option you can define the number of history messages to keep and send to users joining the room. The value is an @@ -2465,35 +2540,35 @@ integer. Setting the value to 0 disables the history feature and, as a result, nothing is kept in memory. The default value is 20. This value is global and thus affects all rooms on the service. -
- {max_users, Number}
- This option defines at +
- max_users: Number
- This option defines at the service level, the maximum number of users allowed per room. It can be lowered in each room configuration but cannot be increased in individual room configuration. The default value is 200. -
- {max_users_admin_threshold, Number}
- +
- max_users_admin_threshold: Number
- This option defines the number of service admins or room owners allowed to enter the room when the maximum number of allowed occupants was reached. The default limit is 5. -
- {max_user_conferences, Number}
- +
- max_user_conferences: Number
- This option defines the maximum number of rooms that any given user can join. The default value is 10. This option is used to prevent possible abuses. Note that this is a soft limit: some users can sometimes join more conferences in cluster configurations. -
- {max_room_id, Number}
- +
- max_room_id: Number
- This option defines the maximum number of characters that Room ID can have when creating a new room. The default value is to not limit: infinite. -
- {max_room_name, Number}
- +
- max_room_name: Number
- This option defines the maximum number of characters that Room Name can have when configuring the room. The default value is to not limit: infinite. -
- {max_room_desc, Number}
- +
- max_room_desc: Number
- This option defines the maximum number of characters that Room Description can have when configuring the room. The default value is to not limit: infinite. -
- {min_message_interval, Number}
- +
- min_message_interval: Number
- This option defines the minimum interval between two messages send by an occupant in seconds. This option is global and valid for all rooms. A decimal value can be used. When this option is not defined, @@ -2503,7 +2578,7 @@ be broadcasted by the service. A good value for this minimum message interval is 0.4 second. If an occupant tries to send messages faster, an error is send back explaining that the message has been discarded and describing the reason why the message is not acceptable. -
- {min_presence_interval, Number}
- +
- min_presence_interval: Number
- This option defines the minimum of time between presence changes coming from a given occupant in seconds. This option is global and valid for all rooms. A @@ -2515,41 +2590,41 @@ presence is cached by ejabberd and only the last presence is broadcasted to all occupants in the room after expiration of the interval delay. Intermediate presence packets are silently discarded. A good value for this option is 4 seconds. -
- {default_room_options, [ {OptionName, OptionValue}, ...]}
- +
- default_room_options: {OptionName: OptionValue}
-
This module option allows to define the desired default room options.
Note that the creator of a room can modify the options of his room
at any time using an XMPP client with MUC capability.
The available room options and the default values are:
- -{allow_change_subj, true|false}
- Allow occupants to change the subject. -
- {allow_private_messages, true|false}
- Occupants can send private messages to other occupants. -
- {allow_private_messages_from_visitors, anyone|moderators|nobody}
- Visitors can send private messages to other occupants. -
- {allow_query_users, true|false}
- Occupants can send IQ queries to other occupants. -
- {allow_user_invites, false|true}
- Allow occupants to send invitations. -
- {allow_visitor_nickchange, true|false}
- Allow visitors to
+allow_change_subj: true|false
- Allow occupants to change the subject. +
- allow_private_messages: true|false
- Occupants can send private messages to other occupants. +
- allow_private_messages_from_visitors: anyone|moderators|nobody
- Visitors can send private messages to other occupants. +
- allow_query_users: true|false
- Occupants can send IQ queries to other occupants. +
- allow_user_invites: false|true
- Allow occupants to send invitations. +
- allow_visitor_nickchange: true|false
- Allow visitors to change nickname. -
- {allow_visitor_status, true|false}
- Allow visitors to send +
- allow_visitor_status: true|false
- Allow visitors to send status text in presence updates. If disallowed, the status text is stripped before broadcasting the presence update to all the room occupants. -
- {anonymous, true|false}
- The room is anonymous: +
- anonymous: true|false
- The room is anonymous: occupants don’t see the real JIDs of other occupants. Note that the room moderators can always see the real JIDs of the occupants. -
- {captcha_protected, false}
- +
- captcha_protected: false
- When a user tries to join a room where he has no affiliation (not owner, admin or member), -the room requires him to fill a CAPTCHA challenge (see section 3.1.8) +the room requires him to fill a CAPTCHA challenge (see section 3.1.9) in order to accept her join in the room. -
- {logging, false|true}
- The public messages are logged using mod_muc_log. -
- {max_users, 200}
- Maximum number of occupants in the room. -
- {members_by_default, true|false}
- The occupants that enter the room are participants by default, so they have ’voice’. -
- {members_only, false|true}
- Only members of the room can enter. -
- {moderated, true|false}
- Only occupants with ’voice’ can send public messages. -
- {password, "roompass123"}
- Password of the room. You may want to enable the next option too. -
- {password_protected, false|true}
- The password is required to enter the room. -
- {persistent, false|true}
- The room persists even if the last participant leaves. -
- {public, true|false}
- The room is public in the list of the MUC service, so it can be discovered. -
- {public_list, true|false}
- The list of participants is public, without requiring to enter the room. -
- {title, "Room Title"}
- A human-readable title of the room. +
- logging: false|true
- The public messages are logged using mod_muc_log. +
- max_users: 200
- Maximum number of occupants in the room. +
- members_by_default: true|false
- The occupants that enter the room are participants by default, so they have ’voice’. +
- members_only: false|true
- Only members of the room can enter. +
- moderated: true|false
- Only occupants with ’voice’ can send public messages. +
- password: "roompass123"
- Password of the room. You may want to enable the next option too. +
- password_protected: false|true
- The password is required to enter the room. +
- persistent: false|true
- The room persists even if the last participant leaves. +
- public: true|false
- The room is public in the list of the MUC service, so it can be discovered. +
- public_list: true|false
- The list of participants is public, without requiring to enter the room. +
- title: "Room Title"
- A human-readable title of the room.
{acl, admin, {user, "admin", "example.org"}}. +acl: + admin: + user: + - "admin": "example.org" -{access, muc_admin, [{allow, admin}]}. +access: + muc_admin: + admin: allow -{modules, - [ +modules: ... - {mod_muc, [{access, all}, - {access_create, all}, - {access_admin, muc_admin}, - {history_size, 0}]}, + mod_muc: + access: all + access_create: all + access_admin: muc_admin + history_size: 0 ... - ]}.- In the second example the Multi-User Chat service is only accessible by paying customers registered on our domains and on other servers. Of course the administrator is also allowed to access rooms. In addition, he is the @@ -2588,61 +2667,64 @@ around 23:00 UMT. We apologise for this inconvenience.’ to conference.example.org, it will be displayed in all active rooms. No history_size option is used, this means that the feature is enabled and the default value of 20 history messages will be send to the users. -
{acl, paying_customers, {user, "customer1", "example.net"}}. -{acl, paying_customers, {user, "customer2", "example.com"}}. -{acl, paying_customers, {user, "customer3", "example.org"}}. -{acl, admin, {user, "admin", "example.org"}}. +acl: + paying_customers: + user: + - "customer1": "example.net" + - "customer2": "example.com" + - "customer3": "example.org" + admin: + user: + - "admin": "example.org" -{access, muc_admin, [{allow, admin}, - {deny, all}]}. -{access, muc_access, [{allow, paying_customers}, - {allow, admin}, - {deny, all}]}. +access: + muc_admin + admin: allow + all: deny + muc_access: + paying_customers: allow + admin: allow + all: deny -{modules, - [ +modules: ... - {mod_muc, [{access, muc_access}, - {access_create, muc_admin}, - {access_admin, muc_admin}]}, + mod_muc: + access: muc_access + access_create: muc_admin + access_admin: muc_admin ... - ]}.- In the following example, MUC anti abuse options are used. An occupant cannot send more than one message every 0.4 seconds and cannot change its presence more than once every 4 seconds. The length of Room IDs and Room Names are limited to 20 characters, and Room Description to 300 characters. No ACLs are -defined, but some user restriction could be added as well:
{modules, - [ +defined, but some user restriction could be added as well:modules: ... - {mod_muc, [{min_message_interval, 0.4}, - {min_presence_interval, 4}, - {max_room_id, 20}, - {max_room_name, 20}, - {max_room_desc, 300}]}, + mod_muc: + min_message_interval: 0.4 + min_presence_interval: 4 + max_room_id: 20 + max_room_name: 20 + max_room_desc: 300 ... - ]}.- This example shows how to use default_room_options to make sure the newly created rooms have by default those options. -
-{modules, - [ +modules: ... - {mod_muc, [{access, muc_access}, - {access_create, muc_admin}, - {default_room_options, - [ - {allow_change_subj, false}, - {allow_query_users, true}, - {allow_private_messages, true}, - {members_by_default, false}, - {title, "New chatroom"}, - {anonymous, false} - ]}, - {access_admin, muc_admin}]}, + mod_muc: + access: muc_access + access_create: muc_admin + default_room_options: + allow_change_subj: false + allow_query_users: true + allow_private_messages: true + members_by_default: false + title: "New chatroom" + anonymous: false + access_admin: muc_admin ... - ]}.3.3.11 mod_muc_log
3.3.11 mod_muc_log
This module enables optional logging of Multi-User Chat (MUC) public conversations to HTML. Once you enable this module, users can join a room using a MUC capable XMPP client, and if they have enough privileges, they can request the @@ -2665,54 +2747,54 @@ displayed, including the reason if available.
- A custom link can be added on top of each page.
Options:
- -{access_log, AccessName}
-
+access_log: AccessName
- This option restricts which occupants are allowed to enable or disable room logging. The default value is muc_admin. Note for this default setting you need to have an access rule for muc_admin in order to take effect. -
- {cssfile, false|URL}
- +
- cssfile: false|URL
- With this option you can set whether the HTML files should have a custom CSS file or if they need to use the embedded CSS file. Allowed values are false and an URL to a CSS file. With the first value, HTML files will include the embedded CSS code. With the latter, you can specify the URL of the custom CSS file (for example: "http://example.com/my.css"). The default value is false. -
- {dirname, room_jid|room_name}
- +
- dirname: room_jid|room_name
- Allows to configure the name of the room directory. Allowed values are room_jid and room_name. With the first value, the room directory name will be the full room JID. With the latter, the room directory name will be only the room name, not including the MUC service name. The default value is room_jid. -
- {dirtype, subdirs|plain}
- +
- dirtype: subdirs|plain
- The type of the created directories can be specified with this option. Allowed values are subdirs and plain. With the first value, subdirectories are created for each year and month. With the latter, the names of the log files contain the full date, and there are no subdirectories. The default value is subdirs. -
- {file_format, html|plaintext}
- +
- file_format: html|plaintext
- Define the format of the log files: html stores in HTML format, plaintext stores in plain text. The default value is html. -
- {file_permissions, {Mode, Group}}
- +
- file_permissions: {mode: Mode, group: Group}
- Define the permissions that must be used when creating the log files: the number of the mode, and the numeric id of the group that will own the files. The default value is {644, 33}. -
- {outdir, Path}
- +
- outdir: Path
- This option sets the full path to the directory in which the HTML files should be stored. Make sure the ejabberd daemon user has write access on that directory. The default value is "www/muc". -
- {spam_prevention true|false}
- +
- spam_prevention: true|false
- To prevent spam, the spam_prevention option adds a special attribute to links that prevent their indexation by search engines. The default value is true, which mean that nofollow attributes will be added to user submitted links. -
- {timezone, local|universal}
- +
- timezone: local|universal
- The time zone for the logs is configurable with this option. Allowed values are local and universal. With the first value, the local time, as reported to Erlang by the operating system, will be used. With the latter, GMT/UTC time will be used. The default value is local. -
- {top_link, {URL, Text}}
- +
- top_link: {URL: Text}
- With this option you can customize the link on the top right corner of each log file. The default value is {"/", "Home"}.
Examples: @@ -2723,120 +2805,131 @@ of the log files will contain the full date, and there will be no subdirectories. The log files will be stored in /var/www/muclogs, and the time zone will be GMT/UTC. Finally, the top link will be
<a href="http://www.jabber.ru/">Jabber.ru</a>. -{access, muc, [{allow, all}]}. +access: + muc: + all: allow -{modules, - [ +modules: ... - {mod_muc_log, [ - {access_log, muc}, - {cssfile, "http://example.com/my.css"}, - {dirtype, plain}, - {dirname, room_jid}, - {outdir, "/var/www/muclogs"}, - {timezone, universal}, - {spam_prevention, true}, - {top_link, {"http://www.jabber.ru/", "Jabber.ru"}} - ]}, + mod_muc_log: + access_log: muc + cssfile: "http://example.com/my.css" + dirtype: plain + dirname: room_jid + outdir: "/var/www/muclogs" + timezone: universal + spam_prevention: true + top_link: + "http://www.jabber.ru/": "Jabber.ru" ... - ]}.- In the second example only admin1@example.org and admin2@example.net can enable logging, and the embedded CSS file will be used. The names of the log files will only contain the day (number), and there will be subdirectories for each year and month. The log files will be stored in /var/www/muclogs, and the local time will be used. Finally, the top link will be the default
-<a href="/">Home</a>. -{acl, admin, {user, "admin1", "example.org"}}. -{acl, admin, {user, "admin2", "example.net"}}. +acl: + admin: + user: + - "admin1": "example.org" + - "admin2": "example.net" +access: + muc_log: + admin: allow + all: deny -{access, muc_log, [{allow, admin}, - {deny, all}]}. - -{modules, - [ +modules: ... - {mod_muc_log, [ - {access_log, muc_log}, - {cssfile, false}, - {dirtype, subdirs}, - {dirtype, subdirs}, - {file_permissions, {644, 33}}, - {outdir, "/var/www/muclogs"}, - {timezone, local} - ]}, + mod_muc_log: + access_log: muc_log + cssfile: false + dirtype: subdirs + file_permissions: + mode: 644 + group: 33 + outdir: "/var/www/muclogs" + timezone: local ... - ]}.3.3.12 mod_offline
3.3.12 mod_offline
This module implements offline message storage (XEP-0160). This means that all messages sent to an offline user will be stored on the server until that user comes online again. Thus it is very similar to how email works. Note that ejabberdctl has a command to delete expired messages (see section 4.1).
- -{db_type, mnesia|odbc}
-
+db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2. -
- {access_max_user_messages, AccessName}
- +
- access_max_user_messages: AccessName
- This option defines which access rule will be enforced to limit the maximum number of offline messages that a user can have (quota). When a user has too many offline messages, any new messages that he receive are discarded, and a resource-constraint error is returned to the sender. The default value is max_user_offline_messages. Then you can define an access rule with a syntax similar to -max_user_sessions (see 3.1.5). +max_user_sessions (see 3.1.6).
This example allows power users to have as much as 5000 offline messages, administrators up to 2000, and all the other users up to 100. -
{acl, admin, {user, "admin1", "localhost"}}. -{acl, admin, {user, "admin2", "example.org"}}. -{acl, poweruser, {user, "bob", "example.org"}}. -{acl, poweruser, {user, "jane", "example.org"}}. +acl: + admin: + user: + - "admin1": "localhost" + - "admin2": "example.org" + poweruser: + user: + - "bob": "example.org" + - "jane": "example.org" -{access, max_user_offline_messages, [ {5000, poweruser}, {2000, admin}, {100, all} ]}. +access: + max_user_offline_messages: + poweruser: 5000 + admin: 2000 + all: 100 -{modules, - [ +modules: ... - {mod_offline, [ {access_max_user_messages, max_user_offline_messages} ]}, + mod_offline: + access_max_user_messages: max_user_offline_messages ... - ]}.-3.3.13 mod_ping
3.3.13 mod_ping
This module implements support for XMPP Ping (XEP-0199) and periodic keepalives. When this module is enabled ejabberd responds correctly to ping requests, as defined in the protocol.
Configuration options:
- -{send_pings, true|false}
-
+send_pings: true|false
- If this option is set to true, the server sends pings to connected clients that are not active in a given interval ping_interval. This is useful to keep client connections alive or checking availability. By default this option is disabled. -
- {ping_interval, Seconds}
- +
- ping_interval: Seconds
- How often to send pings to connected clients, if the previous option is enabled. If a client connection does not send or receive any stanza in this interval, a ping request is sent to the client. The default value is 60 seconds. -
- {timeout_action, none|kill}
- +
- timeout_action: none|kill
- What to do when a client does not answer to a server ping request in less than 32 seconds. The default is to do nothing.
This example enables Ping responses, configures the module to send pings to client connections that are inactive for 4 minutes, and if a client does not answer to the ping in less than 32 seconds, its connection is closed: -
{modules, - [ +modules: ... - {mod_ping, [{send_pings, true}, {ping_interval, 240}, {timeout_action, kill}]}, + mod_ping: + send_pings: true + ping_interval: 240 + timeout_action: kill ... - ]}.-3.3.14 mod_pres_counter
3.3.14 mod_pres_counter
This module detects flood/spam in presence subscription stanza traffic. If a user sends or receives more of those stanzas in a time interval, the exceeding stanzas are silently dropped, and warning is logged.
Configuration options:
- -{count, StanzaNumber}
-
+count: StanzaNumber
- The number of subscription presence stanzas (subscribe, unsubscribe, subscribed, unsubscribed) allowed for any direction (input or output) @@ -2844,19 +2937,19 @@ per time interval. Please note that two users subscribing to each other usually generate 4 stanzas, so the recommended value is 4 or more. The default value is: 5. -
- {interval, Seconds}
- +
- interval: Seconds
- The time interval defined in seconds. The default value is 60.
This example enables the module, and allows up to 5 presence subscription stanzas to be sent or received by the users in 60 seconds: -
{modules, - [ +modules: ... - {mod_pres_counter, [{count, 5}, {interval, 60}]}, + mod_pres_counter: + count: 5 + interval: 60 ... - ]}.-3.3.15 mod_privacy
3.3.15 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 XMPP client, they will be able to: @@ -2881,14 +2974,14 @@ subscription type (or globally). (from http://xmpp.org/rfcs/rfc3921.html#privacy)
Options:
- -{iqdisc, Discipline}
- This specifies
+iqdisc: Discipline
- This specifies the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section 3.3.2). -
- {db_type, mnesia|odbc}
- +
- db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2.
3.3.16 mod_private
3.3.16 mod_private
This module adds support for Private XML Storage (XEP-0049):
Using this method, XMPP entities can store private data on the server and @@ -2897,78 +2990,87 @@ it is valid XML. One typical usage for this namespace is the server-side storage of client-specific preferences; another is Bookmark Storage (XEP-0048).
Options:
- -{iqdisc, Discipline}
- This specifies
+iqdisc: Discipline
- This specifies the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section 3.3.2). -
- {db_type, mnesia|odbc}
- +
- db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2.
3.3.17 mod_proxy65
3.3.17 mod_proxy65
This module implements SOCKS5 Bytestreams (XEP-0065). It allows ejabberd to act as a file transfer proxy between two XMPP clients.
Options:
- -{host, HostName}
- This option defines the Jabber ID of the
+host: HostName
- This option defines the Jabber ID of the service. If the host option is not specified, the Jabber ID will be the hostname of the virtual host with the prefix ‘proxy.’. The keyword "@HOST@" is replaced at start time with the real virtual host name. -
- {name, Text}
- Defines Service Discovery name of the service. +
- name: Text
- Defines Service Discovery name of the service. Default is "SOCKS5 Bytestreams". -
- {ip, IPTuple}
- This option specifies which network interface +
- ip: IP
- This option specifies which network interface
to listen for. Default is an IP address of the service’s DNS name, or,
-if fails,
{127,0,0,1}. - - {port, Number}
- This option defines port to listen for
+if fails,
"127.0.0.1". + - port: Number
- This option defines port to listen for incoming connections. Default is 7777. -
- {hostname, HostName}
- Defines a hostname advertised +
- hostname: HostName
- Defines a hostname advertised by the service when establishing a session with clients. This is useful when you run the service behind a NAT. The default is the value of ip option. Examples: "proxy.mydomain.org", "200.150.100.50". Note that not all clients understand domain names in stream negotiation, so you should think twice before setting domain name in this option. -
- {auth_type, anonymous|plain}
- SOCKS5 authentication type. +
- auth_type: anonymous|plain
- SOCKS5 authentication type. Possible values are anonymous and plain. Default is anonymous. -
- {access, AccessName}
- Defines ACL for file transfer initiators. +
- access: AccessName
- Defines ACL for file transfer initiators. Default is all. -
- {max_connections, Number}
- Maximum number of +
- max_connections: Number
- Maximum number of active connections per file transfer initiator. No limit by default. -
- {shaper, none|ShaperName}
- This option defines shaper for +
- shaper: none|ShaperName
- This option defines shaper for the file transfer peers. Shaper with the maximum bandwidth will be selected. Default is none.
Examples:
-
The simpliest configuration of the module:
-
{modules, - [ +modules: ... - {mod_proxy65, []}, + mod_proxy65: {} ... - ]}. - More complicated configuration.
-
{acl, proxy_users, {server, "example.org"}}. -{access, proxy65_access, [{allow, proxy_users}, {deny, all}]}. +acl: + admin: + user: + - "admin": "example.org" + proxy_users: + server: + - "example.org" -{acl, admin, {user, "admin", "example.org"}}. -{shaper, proxyrate, {maxrate, 10240}}. %% 10 Kbytes/sec -{access, proxy65_shaper, [{none, admin}, {proxyrate, proxy_users}]}. +access: + proxy65_access: + proxy_users: allow + all: deny + proxy65_shaper: + admin: none + proxy_users: proxyrate -{modules, - [ +shaper: + proxyrate: 10240 + +modules: ... - {mod_proxy65, [{host, "proxy1.example.org"}, - {name, "File Transfer Proxy"}, - {ip, {200,150,100,1}}, - {port, 7778}, - {max_connections, 5}, - {access, proxy65_access}, - {shaper, proxy65_shaper}]}, + mod_proxy65: + host: "proxy1.example.org" + name: "File Transfer Proxy" + ip: "200.150.100.1" + port: 7778 + max_connections: 5 + access: proxy65_access + shaper: proxy65_shaper ... - ]}.
3.3.18 mod_pubsub
3.3.18 mod_pubsub
This module offers a Publish-Subscribe Service (XEP-0060). The functionality in mod_pubsub can be extended using plugins. The plugin that implements PEP (Personal Eventing via Pubsub) (XEP-0163) @@ -2976,27 +3078,27 @@ is enabled in the default ejabberd configuration file, and it requires mod_caps.
Options:
- -{host, HostName}
- This option defines the Jabber ID of the
+host: HostName
- This option defines the Jabber ID of the service. If the host option is not specified, the Jabber ID will be the hostname of the virtual host with the prefix ‘pubsub.’. The keyword "@HOST@" is replaced at start time with the real virtual host name. If you use mod_pubsub_odbc, please ensure the prefix contains only one dot, for example ‘pubsub.’, or ‘publish.’,. -
- {access_createnode, AccessName}
- +
- access_createnode: AccessName
- This option restricts which users are allowed to create pubsub nodes using ACL and ACCESS. By default any account in the local ejabberd server is allowed to create pubsub nodes. -
- {max_items_node, MaxItems}
- +
- max_items_node: MaxItems
- Define the maximum number of items that can be stored in a node. Default value is 10. -
- {plugins, [ Plugin, ...]}
- +
- plugins: [ Plugin, ...]
- To specify which pubsub node plugins to use. The first one in the list is used by default. If this option is not defined, the default plugins list is: ["flat"]. PubSub clients can define which plugin to use when creating a node: add type=’plugin-name’ attribute to the create stanza element. -
- {nodetree, Nodetree}
- +
- nodetree: Nodetree
-
To specify which nodetree to use.
If not defined, the default pubsub nodetree is used: "tree".
Only one nodetree can be used per host, and is shared by all node plugins.
The "virtual" nodetree does not store nodes on database. @@ -3010,43 +3112,48 @@ and this can not be changed. Using "virtual" nodetree requires to start from a clean database, it will not work if you used the default "tree" nodetree before.
The "dag" nodetree provides experimental support for PubSub Collection Nodes (XEP-0248). In that case you should also add "dag" node plugin as default, for example: -{plugins, ["dag","flat","hometree","pep"]} -
- {ignore_pep_from_offline, false|true}
- +plugins: ["dag","flat","hometree","pep"] +
- ignore_pep_from_offline: false|true
- To specify whether or not we should get last published PEP items from users in our roster which are offline when we connect. Value is true or false. If not defined, pubsub assumes true so we only get last items of online contacts. -
- {last_item_cache, false|true}
- +
- last_item_cache: false|true
- To specify whether or not pubsub should cache last items. Value is true or false. If not defined, pubsub do not cache last items. On systems with not so many nodes, caching last items speeds up pubsub and allows to raise user connection rate. The cost is memory usage, as every item is stored in memory. -
- {pep_mapping, [ {Key, Value}, ...]}
- +
- pep_mapping: {Key, Value}
-
This allow to define a Key-Value list to choose defined node plugins on given PEP namespace.
The following example will use node_tune instead of node_pep for every PEP node with tune namespace:
-
{mod_pubsub, [{pep_mapping, [{"http://jabber.org/protocol/tune", "tune"}]}]} +modules: + ... + mod_pubsub: + pep_mapping: + "http://jabber.org/protocol/tune": "tune" + ...
Example of configuration that uses flat nodes as default, and allows use of flat, nodetree and pep nodes: -
{modules, - [ +modules: ... - {mod_pubsub, [ - {access_createnode, pubsub_createnode}, - {plugins, ["flat", "hometree", "pep"]} - ]}, + mod_pubsub: + access_createnode: pubsub_createnode + plugins: + - "flat" + - "hometree" + - "pep" ... - ]}.Using ODBC database requires using mod_pubsub_odbc without option changes. Only flat, hometree and pep plugins supports ODBC. The following example shows previous configuration with ODBC usage: -
{modules, - [ +modules: ... - {mod_pubsub_odbc, [ - {access_createnode, pubsub_createnode}, - {plugins, ["flat", "hometree", "pep"]} - ]}, + mod_pubsub_odbc: + access_createnode: pubsub_createnode + plugins: + - "flat" + - "hometree" + - "pep" ... - ]}.-3.3.19 mod_register
3.3.19 mod_register
This module adds support for In-Band Registration (XEP-0077). This protocol enables end users to use a XMPP client to:
- @@ -3055,37 +3162,35 @@ Register a new account on the server.
- Delete an existing account on the server.
Options:
- -{access, AccessName}
-
+access: AccessName
- Specify rules to restrict what usernames can be registered and unregistered. If a rule returns ‘deny’ on the requested username, registration and unregistration of that user name is denied. There are no restrictions by default. -
- {access_from, AccessName}
- By default, ejabberd +
- access_from: AccessName
- By default, ejabberd doesn’t allow to register new accounts from s2s or existing c2s sessions. You can change it by defining access rule in this option. Use with care: allowing registration from s2s leads to uncontrolled massive accounts creation by rogue users. -
- {captcha_protected, false|true}
- -Protect registrations with CAPTCHA (see section 3.1.8). The default is false. -
- {ip_access, [ {allow|deny, IPaddress}, ...]}
- +
- captcha_protected: false|true
- +Protect registrations with CAPTCHA (see section 3.1.9). The default is false. +
- ip_access: AccessName
- Define rules to allow or deny account registration depending -in the IP address of the XMPP client. -If there is no matching IP mask, the default rule is “allow”. -IPv6 addresses are supported, but not tested. -The default option value is an empty list: []. -
- {password_strength, Entropy}
- +on the IP address of the XMPP client. The AccessName should be +of type ip. The default value is all. +
- password_strength: Entropy
- This option sets the minimum informational entropy for passwords. The value Entropy is a number of bits of entropy. The recommended minimum is 32 bits. The default is 0, i.e. no checks are performed. -
- {welcome_message, {Subject, Body}}
- Set a welcome message that +
- welcome_message: {subject: Subject, body: Body}
-
+ Set a welcome message that
is sent to each newly registered account. The first string is the subject, and
the second string is the message body.
-In the body you can set a newline with the characters:
\n- - {registration_watchers, [ JID, ...]}
- This option defines a +
- registration_watchers: [ JID, ...]
- This option defines a list of JIDs which will be notified each time a new account is registered. -
- {iqdisc, Discipline}
- This specifies +
- iqdisc: Discipline
- This specifies the processing discipline for In-Band Registration (jabber:iq:register) IQ queries (see section 3.3.2).
This module reads also another option defined globally for the server: -{registration_timeout, Timeout}. +registration_timeout: Timeout. This option limits the frequency of registration from a given IP or username. So, a user that tries to register a new account from the same IP address or JID during this number of seconds after his previous registration @@ -3098,57 +3203,69 @@ Default value: 600 seconds.
Examples:
-
Next example prohibits the registration of too short account names,
and allows to create accounts only to clients of the local network:
-
{acl, shortname, {user_glob, "?"}}. -{acl, shortname, {user_glob, "??"}}. -%% The same using regexp: -%%{acl, shortname, {user_regexp, "^..?$"}}. +acl: + loopback: + ip: + - "127.0.0.0/8" + - "::" + shortname: + user_glob: + - "?" + - "??" + ## The same using regexp: + ##user_regexp: "^..?$" -{access, register, [{deny, shortname}, - {allow, all}]}. +access: + mynetworks: + loopback: allow + all: deny + register: + shortname: deny + all: allow -{modules, - [ - ... - {mod_register, [{access, register}, - {ip_access, [{allow, "127.0.0.0/8"}, - {deny, "0.0.0.0/0"}]} - ]}, - ... - ]}. +modules: + mod_register: + ip_access: mynetworks + access: register - This configuration prohibits usage of In-Band Registration
to create or delete accounts,
but allows existing accounts to change the password:
-
{access, register, [{deny, all}]}. +access: + register: + all: deny -{modules, - [ +modules: ... - {mod_register, [{access, register}]}, + mod_register: + access: register ... - ]}. - This configuration disables all In-Band Registration
functionality: create, delete accounts and change password:
-
{modules, - [ +modules: ... - %% {mod_register, [{access, register}]}, + ## mod_register: + ## access: register ... - ]}. - Define the welcome message and two registration watchers.
Also define a registration timeout of one hour:
-
{registration_timeout, 3600}. -{modules, - [ +registration_timeout: 3600 +modules: ... - {mod_register, - [ - {welcome_message, {"Welcome!", "Hi.\nWelcome to this Jabber server.\n Check http://www.jabber.org\n\nBye"}}, - {registration_watchers, ["admin1@example.org", "boss@example.net"]} - ]}, + mod_register: + welcome_message: + subject: "Welcome!" + body: |- + Hi. + Welcome to this Jabber server. + Check http://www.jabber.org + + Bye + registration_watchers: + - "admin1@example.org" + - "boss@example.net" ... - ]}.
3.3.20 mod_register_web
3.3.20 mod_register_web
This module provides a web page where people can:
- Register a new account on the server. @@ -3157,46 +3274,46 @@ Register a new account on the server.
This module supports CAPTCHA image to register a new account. To enable this feature, configure the options captcha_cmd and captcha_host.
Options:
- -{registration_watchers, [ JID, ...]}
- This option defines a
+registration_watchers: [ JID, ...]
- This option defines a list of JIDs which will be notified each time a new account is registered.
This example configuration shows how to enable the module and the web handler: -
{hosts, ["localhost", "example.org", "example.com"]}. +hosts: + - "localhost" + - "example.org" + - "example.com" +listen: + ... + - + port: 5281 + module: ejabberd_http + register: true + certfile: "/etc/ejabberd/certificate.pem" + tls: true + ... -{listen, [ +modules: ... - {5281, ejabberd_http, [ - tls, - {certfile, "/etc/ejabberd/certificate.pem"}, - register - ]}, + mod_register_web: {} ... -]}. - -{modules, - [ - ... - {mod_register_web, []}, - ... - ]}.For example, the users of the host example.org can visit the page: https://example.org:5281/register/ It is important to include the last / character in the URL, otherwise the subpages URL will be incorrect.
-3.3.21 mod_roster
3.3.21 mod_roster
This module implements roster management as defined in RFC 3921: XMPP IM. It also supports Roster Versioning (XEP-0237).
Options:
- -{iqdisc, Discipline}
- This specifies
+iqdisc: Discipline
- This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section 3.3.2). -
- {db_type, mnesia|odbc}
- +
- db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2. -
- {versioning, false|true}
- Enables +
- versioning: false|true
- Enables Roster Versioning. This option is disabled by default. -
- {store_current_id, false|true}
- +
- store_current_id: false|true
- If this option is enabled, the current version number is stored on the database. If disabled, the version number is calculated on the fly each time. Enabling this option reduces the load for both ejabberd and the database. @@ -3206,44 +3323,43 @@ This option is disabled by default. Important: if you use mod_shared_roster or mod_shared_roster_ldap, you must disable this option.
This example configuration enables Roster Versioning with storage of current id: -
{modules, - [ +modules: ... - {mod_roster, [{versioning, true}, {store_current_id, true}]}, + mod_roster: + versioning: true + store_current_id: true ... - ]}.-3.3.22 mod_service_log
3.3.22 mod_service_log
This module adds support for logging end user packets via a XMPP message auditing service such as Bandersnatch. All user packets are encapsulated in a
<route/>element and sent to the specified service(s).Options:
- -{loggers, [Names, ...]}
- With this option a (list of) service(s)
+loggers: [Names, ...]
- With this option a (list of) service(s) that will receive the packets can be specified.
Examples:
-
To log all end user packets to the Bandersnatch service running on
bandersnatch.example.com:
-
{modules, - [ +modules: ... - {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]}, + mod_service_log: + loggers: ["bandersnatch.example.com"] ... - ]}. - To log all end user packets to the Bandersnatch service running on
bandersnatch.example.com and the backup service on
bandersnatch.example.org:
-
{modules, - [ +modules: ... - {mod_service_log, [{loggers, ["bandersnatch.example.com", - "bandersnatch.example.org"]}]}, + mod_service_log: + loggers: + - "bandersnatch.example.com" + - "bandersnatch.example.org" ... - ]}.
3.3.23 mod_shared_roster
3.3.23 mod_shared_roster
This module enables you to create shared roster groups. This means that you can create groups of people that can see members from (other) groups in their rosters. The big advantages of this feature are that end users do not need to @@ -3253,7 +3369,7 @@ 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.
Options:
- -{db_type, mnesia|odbc}
-
+db_type: internal|odbc
- Define the type of storage where the module will create the tables and store user information. The default is to store in the internal Mnesia database. If odbc value is defined, make sure you have defined the database, see 3.2. @@ -3327,7 +3443,7 @@ roster groups as shown in the following table:
3.3.24 mod_shared_roster_ldap
3.3.24 mod_shared_roster_ldap
This module lets the server administrator automatically populate users’ rosters (contact lists) with entries based on users and groups defined in an LDAP-based directory.
@@ -3438,7 +3554,7 @@ fresh after retrieval. 300 by default. See sectionConnection parameters
The module also accepts the connection parameters, all of which default to the -top-level parameter of the same name, if unspecified. See 3.2.5 +top-level parameter of the same name, if unspecified. See 3.2.2 for more information about them.
Retrieving the roster
When the module is called to retrieve the shared roster for a user, the following algorithm is used:
- @@ -3496,14 +3612,16 @@ information duplication – the group name is repeated in every member obje centralized, but distributed between member objects
- inefficiency – the list of unique group names has to be computed by iterating over all users
This however seems to be a common DIT layout, so the module keeps supporting it. -You can use the following configuration…
{mod_shared_roster_ldap,[ - {ldap_base, "ou=flat,dc=nodomain"}, - {ldap_rfilter, "(objectClass=inetOrgPerson)"}, - {ldap_groupattr, "ou"}, - {ldap_memberattr, "cn"}, - {ldap_filter, "(objectClass=inetOrgPerson)"}, - {ldap_userdesc, "displayName"} - ]}, +You can use the following configuration…modules: + ... + mod_shared_roster_ldap: + ldap_base: "ou=flat,dc=nodomain" + ldap_rfilter: "(objectClass=inetOrgPerson)" + ldap_groupattr: "ou" + ldap_memberattr: "cn" + ldap_filter: "(objectClass=inetOrgPerson)" + ldap_userdesc: "displayName" + ...
…to be provided with a roster as shown in figure 3.2 upon connecting as user czesio.
@@ -3523,17 +3641,19 @@ They are shown separated into different subtrees, but it’s not a requirem
When a JID is checked to have access to Accessname, the server +
When a JID is checked to have access to Accessname, the server sequentially checks if that JID 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 @@ -1284,9 +1480,12 @@ returned.
If you define specific Access rights in a virtual host, remember that the globally defined Access rights have precedence over those. This means that, in case of conflict, the Access granted or denied in the global server is used and the Access of a virtual host doesn’t have effect.
Example: -
{access, configure, [{allow, admin}]}. -{access, something, [{deny, badmans}, - {allow, all}]}. +access: + configure: + admin: allow + something + badmans: deny + all: allow
The following AccessName are pre-defined:
-
@@ -1276,7 +1472,7 @@ character not enclosed is matched.
-
To use internal authentication on example.org and LDAP
authentication on example.net:
-