diff --git a/ChangeLog b/ChangeLog index d6df32eca..de112f5df 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2008-06-13 Badlop + + * doc/guide.tex: Table of listener modules converted to + description. Table of modules overview simplified, and module + names link to their sections. + * doc/guide.html: Regenerated with all the latest changes + 2008-06-12 Badlop * doc/guide.tex: Permanent reference URL for sections (EJAB-651). diff --git a/doc/dev.html b/doc/dev.html index 8b8db8886..ccdd1eee4 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -139,7 +139,7 @@ Support for virtual hosting.
  • Statistics via Statistics Gathering (XEP-0039).
  • IPv6 support both for c2s and s2s connections.
  • Multi-User Chat module with support for clustering and HTML logging.
  • Users Directory based on users vCards. -
  • Publish-Subscribe component with support for Personal Eventing via Pubsub. +
  • Publish-Subscribe component with support for Personal Eventing via Pubsub.
  • Support for web clients: HTTP Polling and HTTP Binding (BOSH) services.
  • IRC transport.
  • Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. diff --git a/doc/features.html b/doc/features.html index cea27449e..e95f68fff 100644 --- a/doc/features.html +++ b/doc/features.html @@ -118,7 +118,7 @@ Support for virtual hosting.
  • Statistics via Statistics Gathering (XEP-0039).
  • IPv6 support both for c2s and s2s connections.
  • Multi-User Chat module with support for clustering and HTML logging.
  • Users Directory based on users vCards. -
  • Publish-Subscribe component with support for Personal Eventing via Pubsub. +
  • Publish-Subscribe component with support for Personal Eventing via Pubsub.
  • Support for web clients: HTTP Polling and HTTP Binding (BOSH) services.
  • IRC transport.
  • Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. diff --git a/doc/guide.html b/doc/guide.html index 7a2aa95a4..6170f7929 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -75,7 +75,14 @@ TD P{margin:0px;} .marginparright{float:right; margin-left:1ex; margin-right:0ex;} .theorem{text-align:left;margin:1ex auto 1ex 0ex;} .part{margin:2ex auto;text-align:center} -SPAN{width:20%; float:right; text-align:left; margin-left:auto;} +.SPAN{width:20%; float:right; text-align:left; margin-left:auto;} +H1 A, H2 A, H3 A, H4 A{color:#000000; text-decoration:none;} +pre.verbatim{margin:1ex 2ex;border:1px dashed lightgrey;background-color:#f9f9f9;padding:0.5ex;} +.dt-description{margin:0ex 2ex;} +table[border="1"]{border-collapse:collapse;margin-bottom:1em;} +table[border="1"] td{border:1px solid #aaa;padding:2px} +BLOCKQUOTE.table DIV.center DIV.center HR{display:none;} +BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;} @@ -116,7 +123,8 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}

    ejabberd Development Team

    - +

    +

    Contents

    -

    Chapter 2  Installing ejabberd

    -

    2.1  Installing ejabberd with Binary Installer

    Probably the easiest way to install an ejabberd instant messaging server +

    • +

    Chapter 2  Installing ejabberd

    +

    2.1  Installing ejabberd with Binary Installer

    Probably the easiest way to install an ejabberd instant messaging server is using the binary installer published by Process-one. The binary installers of released ejabberd versions are available in the Process-one ejabberd downloads page: http://www.process-one.net/en/ejabberd/downloads

    The installer will deploy and configure a full featured ejabberd server and does not require any extra dependencies.

    In *nix systems, remember to set executable the binary installer before starting it. For example: -

      chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin
-  ./ejabberd-2.0.0_1-linux-x86-installer.bin
+
    chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin
+./ejabberd-2.0.0_1-linux-x86-installer.bin
 
    ejabberd can be started manually at any time,
 or automatically by the operating system at system boot time.
    To start and stop ejabberd manually,
 use the desktop shortcuts created by the installer.
@@ -320,29 +328,27 @@ and for example it doesn’t read the file ejabberdctl.cfg.
    On a *nix
 copy ejabberd.init from the ’bin’ directory to something like /etc/init.d/ejabberd
 (depending on your distribution) and call /etc/inid.d/ejabberd start to start it.
    The ejabberdctl administration script is included in the bin directory.
 Please refer to the section 4.1 for details about ejabberdctl,
-and configurable options to fine tune the Erlang runtime system.
    
-
    2.2  Installing ejabberd with Operating System specific packages
    Some Operating Systems provide a specific ejabberd package adapted to 
+and configurable options to fine tune the Erlang runtime system.
      
    
+
    2.2  Installing ejabberd with Operating System specific packages
      
    Some Operating Systems provide a specific ejabberd package adapted to 
 the system architecture and libraries.
 It usually also checks dependencies 
 and performs basic configuration tasks like creating the initial
 administrator account. Some examples are Debian and Gentoo. Consult the
 resources provided by your Operating System for more information.
    Usually those packages create a script like /etc/init.d/ejabberd
-to start and stop ejabberd as a service at boot time.
    
-
    2.3  Installing ejabberd with CEAN
    CEAN
+to start and stop ejabberd as a service at boot time.
      
    
+
    2.3  Installing ejabberd with CEAN
      
    CEAN
 (Comprehensive Erlang Archive Network) is a repository that hosts binary
 packages from many Erlang programs, including ejabberd and all its dependencies.
 The binaries are available for many different system architectures, so this is an
 alternative to the binary installer and Operating System’s ejabberd packages.
    You will have to create your own ejabberd start
 script depending of how you handle your CEAN installation. 
 The default ejabberdctl script is located
-into ejabberd’s priv directory and can be used as an example.
    
-
    2.4  Installing ejabberd from Source Code
    
-
+into ejabberd’s priv directory and can be used as an example.
      
    
+
    2.4  Installing ejabberd from Source Code
      
 
    The canonical form for distribution of ejabberd stable releases is the source code package.
 Compiling ejabberd from source code is quite easy in *nix systems, 
-as long as your system have all the dependencies.
    
-
    2.4.1  Requirements
    
-
+as long as your system have all the dependencies.
      
    
+
    2.4.1  Requirements
      
 
    To compile ejabberd on a ‘Unix-like’ operating system, you need:
 
    • 
 GNU Make
@@ -352,22 +358,20 @@ GNU Make
 
    • OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
 
    • Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional.
 
    • GNU Iconv 1.8 or higher, for the IRC Transport (mod_irc). Optional. Not needed on systems with GNU Libc.
-
    
-
    2.4.2  Download Source Code
    
-
+
      
    
+
    2.4.2  Download Source Code
      
 
    Released versions of ejabberd are available in the Process-one ejabberd downloads page:
 http://www.process-one.net/en/ejabberd/downloads
    
 Alternatively, the latest development version can be retrieved from the Subversion repository using this command:
-
      svn co http://svn.process-one.net/ejabberd/trunk ejabberd
-
    
-
    2.4.3  Compile
    
-
+
    svn co http://svn.process-one.net/ejabberd/trunk ejabberd
+
      
    
+
    2.4.3  Compile
      
 
    To compile ejabberd execute the commands:
-
      ./configure
-  make
+
    ./configure
+make
 
    The build configuration script provides several parameters.
 To get the full list run the command:
-
      ./configure --help
+
    ./configure --help
 
    Some options that you may be interested in modifying:
 
    
 	--prefix=/
     
@@ -379,11 +383,10 @@ To get the full list run the command:
 	It will for example use CDATA to escape characters in the XMPP stream. 
 	Use this option only if you are sure your Jabber clients include a fully compliant XML parser.
    	
    --disable-transient-supervisors
    
 	Disable the use of Erlang/OTP supervision for transient processes. 
-
    
-
    2.4.4  Install
    
-
+
      
    
+
    2.4.4  Install
      
 
    To install ejabberd in the destination directories, run the command:
-
      make install
+
    make install
 
    Note that you may need to have administrative privileges in the system.
    The files and directories created are, by default:
 
    
 	/etc/ejabberd/
     Configuration files:
@@ -409,29 +412,25 @@ To get the full list run the command:
 			ejabberd.log
     ejabberd service log
 			
    sasl.log
     Erlang/OTP system log
 		
    
-
-
    2.4.5  Start
    
-
+
      
    
+
    2.4.5  Start
      
 
    You can use the ejabberdctl command line administration script to start and stop ejabberd.
    Usage example:
-
    $ ejabberdctl start
+
    ejabberdctl start
 
-$ ejabberdctl status
+ejabberdctl status
 Node ejabberd@localhost is started. Status: started
 ejabberd is running
 
-$ ejabberdctl stop
+ejabberdctl stop
 
    Please refer to the section 4.1 for details about ejabberdctl,
-and configurable options to fine tune the Erlang runtime system.
    
-
    2.4.6  Specific Notes for BSD
    
-
+and configurable options to fine tune the Erlang runtime system.
      
    
+
    2.4.6  Specific Notes for BSD
      
 
    The command to compile ejabberd in BSD systems is:
-
      gmake
-
    
-
    2.4.7  Specific Notes for Microsoft Windows
    
-
-
    
-
    Requirements
    
-
    To compile ejabberd on a Microsoft Windows system, you need:
+
    gmake
+
      
    
+
    2.4.7  Specific Notes for Microsoft Windows
      
+
      
    
+
    Requirements
      
    To compile ejabberd on a Microsoft Windows system, you need:
 
    
-
    Compilation
    
-
    We assume that we will try to put as much library as possible into C:\sdk\ to make it easier to track what is install for ejabberd.
    1. 
+
      2.   
      
+
      Compilation
        
      We assume that we will try to put as much library as possible into C:\sdk\ to make it easier to track what is install for ejabberd.
      1. 
 Install Erlang emulator (for example, into C:\sdk\erl5.5.5).
 
      2. Install Expat library into C:\sdk\Expat-2.0.0
 directory.
        Copy file C:\sdk\Expat-2.0.0\Libs\libexpat.dll
@@ -467,21 +465,20 @@ variable.
 nmake -f Makefile.win32
 
  • Edit the file ejabberd\src\ejabberd.cfg and run
 
    werl -s ejabberd -name ejabberd
-
    • 
-
    2.5  Create a Jabber Account for Administration
    
-
    You need a Jabber account and grant him administrative privileges
+
      
    
+
    2.5  Create a Jabber Account for Administration
      
    You need a Jabber account and grant him administrative privileges
 to enter the ejabberd Web Admin:
 
    1. 
 Register a Jabber account on your ejabberd server, for example admin1@example.org. 
 There are two ways to register a Jabber account:
 
      1. 
 Using ejabberdctl (see section 4.1):
-
        % ejabberdctl register admin1 example.org FgT5bk3
+
        ejabberdctl register admin1 example.org FgT5bk3
 
      2. Using a Jabber client and In-Band Registration (see section 3.3.17).
 
      
 
    2. Edit the ejabberd configuration file to give administration rights to the Jabber account you created:
-
        {acl, admins, {user, "admin1", "example.org"}}.
-  {access, configure, [{allow, admins}]}.
+
      {acl, admins, {user, "admin1", "example.org"}}.
+{access, configure, [{allow, admins}]}.
 
      You can grant administrative privileges to many Jabber accounts,
 and also to accounts in other Jabber servers.
 
    3. Restart ejabberd to load the new configuration.
@@ -489,18 +486,17 @@ and also to accounts in other Jabber servers.
 favourite browser. Make sure to enter the full JID as username (in this
 example: admin1@example.org. The reason that you also need to enter the
 suffix, is because ejabberd’s virtual hosting support.
-
    
-
    2.6  Upgrading ejabberd
    To upgrade an ejabberd installation to a new version,
+
      
    
+
    2.6  Upgrading ejabberd
      
    To upgrade an ejabberd installation to a new version,
 simply uninstall the old version, and then install the new one.
 Of course, it is important that the configuration file 
 and Mnesia database spool directory are not removed.
    ejabberd automatically updates the Mnesia table definitions at startup when needed.
 If you also use an external database for storage of some modules,
 check if the release notes of the new ejabberd version
-indicates you need to also update those tables.
    
-
    Chapter 3  Configuring ejabberd
    
-
    3.1  Basic Configuration
    
-
-
    The configuration file will be loaded the first time you start ejabberd. The
+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. 
@@ -513,43 +509,41 @@ the name of an option, and any further elements are that option’s values.
 configuration file do not contain for instance the ‘hosts’ option, the old
 host name(s) stored in the database will be used.
    You can override the old values stored in the database by adding next lines to
 the configuration file:
-
      override_global.
-  override_local.
-  override_acls.
+
    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
    
-
+and ACLs will be removed before new ones are added.
      
    
+
    3.1.1  Host Names
      
 
    The option hosts defines a list containing one or more domains that
 ejabberd will serve.
    Examples:
 
    • 
 Serving one domain:
-
        {hosts, ["example.org"]}.
+
      {hosts, ["example.org"]}.
 
    • Serving one domain, and backwards compatible with older ejabberd
 versions:
-
        {host, "example.org"}.
+
      {host, "example.org"}.
 
    • Serving two domains:
-
        {hosts, ["example.net", "example.com"]}.
-
    
-
    3.1.2  Virtual Hosting
    
-
+
    {hosts, ["example.net", "example.com"]}.
+
      
    
+
    3.1.2  Virtual Hosting
      
 
    Options can be defined separately for every virtual host using the
 host_config option. It has the following
 syntax:
-
      {host_config, <hostname>, [<option>, <option>, ...]}.
+
    {host_config, <hostname>, [<option>, <option>, ...]}.
 
    Examples:
 
    • 
 Domain example.net is using the internal authentication method while
 domain example.com is using the LDAP server running on the
 domain localhost to perform authentication:
-
      {host_config, "example.net", [{auth_method, internal}]}.
+
      {host_config, "example.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"},
+{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, ""}]}.
 
    • Domain example.net is using ODBC to perform authentication
 while domain example.com is using the LDAP servers running on the domains
@@ -557,25 +551,25 @@ while domain example.com is using the LDAP servers running on the domai
 
      {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"},
+{host_config, "example.com", [{auth_method,   ldap},
+                              {ldap_servers,  ["localhost", "otherhost"]},
+                              {ldap_uids,     [{"uid"}]},
+                              {ldap_rootdn,   "dc=localdomain"},
+                              {ldap_rootdn,   "dc=example,dc=com"},
                               {ldap_password, ""}]}.
 
    To define specific ejabberd modules in a virtual host,
 you can define the global modules option with the common modules,
 and later add specific modules to certain virtual hosts.
 To accomplish that, instead of defining each option in host_config with the syntax
-
      {<option-name>, <option-value>}
+
    {<option-name>, <option-value>}
 
    use this syntax:
-
      {{add, <option-name>}, <option-value>}
+
    {{add, <option-name>}, <option-value>}
 
    In this example three virtual hosts have some similar modules, but there are also
 other different modules for some specific virtual hosts:
-
    % This ejabberd server has three vhosts:
+
    %% 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
+%% Configuration of modules that are common to all vhosts
 {modules,
  [
   {mod_roster,     []},
@@ -587,20 +581,25 @@ other different modules for some specific virtual hosts:
   {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:
+{host_config, "one.example.org",
+ [{{add, modules}, [
+                    {mod_echo,       [{host, "echo-service.one.example.org"}]}
+                    {mod_http_bind,  []},
+                    {mod_logxml,     []}
+                   ]
+  }
+ ]}.
 
-% Add a module just to vhost two:
-{host_config, "two.example.org", [{{add, modules}, [
-  {mod_echo,       [{host, "mirror.two.example.org"}]}
-]}]}.
-
    
-
    3.1.3  Listening Ports
    
-
+%% Add a module just to vhost two:
+{host_config, "two.example.org",
+ [{{add, modules}, [
+                    {mod_echo,       [{host, "mirror.two.example.org"}]}
+                   ]
+  }
+ ]}.
+
      
    
+
    3.1.3  Listening Ports
      
 
    The option listen defines for which addresses and ports ejabberd
 will listen and what services will be run on them. Each element of the list is a
 tuple with the following elements:
@@ -610,28 +609,26 @@ Port number.
 
  • Options to this module.
 
    • 
 The available modules, their purpose and the options allowed by each one are:
-
    
-
-
-
-
-
-
-
-
-
-
    ejabberd_c2sDescriptionHandles c2s connections.
     Optionsaccess, certfile, inet6,
+
    
+ejabberd_c2s
     
+Handles c2s connections.
    
+ Options: access, certfile, inet6,
 ip, max_stanza_size, shaper,
 starttls, starttls_required, tls,
-zlib
    ejabberd_s2s_inDescriptionHandles incoming s2s
-connections.
     Optionsinet6, ip,
-max_stanza_size
    ejabberd_serviceDescriptionInteracts with 
-external components 
-(as defined in the Jabber Component Protocol (XEP-0114).
     Optionsaccess, hosts, inet6,
-ip, shaper, service_check_from
    ejabberd_httpDescriptionHandles incoming HTTP
-connections.
     Optionscertfile, http_bind, http_poll,
-inet6, ip, request_handlers, tls, web_admin
    
-
    This is a detailed description of each option allowed by the listening modules:
+zlib
+
    ejabberd_s2s_in
    
+Handles incoming s2s connections.
    
+ Options: inet6, ip, max_stanza_size
+
    ejabberd_service
    
+Interacts with external components 
+(as defined in the Jabber Component Protocol (XEP-0114).
    
+ Options: access, hosts, inet6,
+ip, shaper, service_check_from
+
    ejabberd_http
    
+Handles incoming HTTP connections.
    
+ Options: certfile, http_bind, http_poll,
+inet6, ip, request_handlers, tls, web_admin
    
+
    This is a detailed description of each option allowed by the listening modules:
 
    
 {access, <access rule>}
     This option defines
 access to the port. The default value is all.
@@ -808,40 +805,40 @@ 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, ejabberd_c2s,     [{access, c2s},
-                              ssl, {certfile, "/path/to/ssl.pem"}]},
-    {5269, ejabberd_s2s_in,  []},
-    {5280, ejabberd_http,    [http_poll, web_admin]},
-    {5233, ejabberd_service, [{host, "aim.example.org",
-                               [{password, "aimsecret"}]}]},
-    {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
-                               [{password, "jitsecret"}]}]},
-    {5235, ejabberd_service, [{host, "msn.example.org",
-                               [{password, "msnsecret"}]}]},
-    {5236, ejabberd_service, [{host, "yahoo.example.org",
-                               [{password, "yahoosecret"}]}]},
-    {5237, ejabberd_service, [{host, "gg.example.org",
-                               [{password, "ggsecret"}]}]},
-    {5238, ejabberd_service, [{host, "jmc.example.org",
-                               [{password, "jmcsecret"}]}]},
-    {5239, ejabberd_service, [{host, "custom.example.org",
-                               [{password, "customsecret"}]},
-                              {service_check_from, false}]}
-   ]
-  }.
-  {s2s_use_starttls, true}.
-  {s2s_certfile, "/path/to/ssl.pem"}.
-  {s2s_default_policy, deny}.
-  {{s2s_host,"jabber.example.org"}, allow}.
-  {{s2s_host,"example.com"}, allow}.
+
    {acl, blocked, {user, "bad"}}.
+{access, c2s, [{deny, blocked},
+               {allow, all}]}.
+{shaper, normal, {maxrate, 1000}}.
+{access, c2s_shaper, [{none, admin},
+                      {normal, all}]}.
+{listen,
+ [{5222, ejabberd_c2s,     [{access, c2s}, {shaper, c2s_shaper}]},
+  {5223, ejabberd_c2s,     [{access, c2s},
+                            ssl, {certfile, "/path/to/ssl.pem"}]},
+  {5269, ejabberd_s2s_in,  []},
+  {5280, ejabberd_http,    [http_poll, web_admin]},
+  {5233, ejabberd_service, [{host, "aim.example.org",
+                             [{password, "aimsecret"}]}]},
+  {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
+                             [{password, "jitsecret"}]}]},
+  {5235, ejabberd_service, [{host, "msn.example.org",
+                             [{password, "msnsecret"}]}]},
+  {5236, ejabberd_service, [{host, "yahoo.example.org",
+                             [{password, "yahoosecret"}]}]},
+  {5237, ejabberd_service, [{host, "gg.example.org",
+                             [{password, "ggsecret"}]}]},
+  {5238, ejabberd_service, [{host, "jmc.example.org",
+                             [{password, "jmcsecret"}]}]},
+  {5239, ejabberd_service, [{host, "custom.example.org",
+                             [{password, "customsecret"}]},
+                            {service_check_from, false}]}
+ ]
+}.
+{s2s_use_starttls, true}.
+{s2s_certfile, "/path/to/ssl.pem"}.
+{s2s_default_policy, deny}.
+{{s2s_host,"jabber.example.org"}, allow}.
+{{s2s_host,"example.com"}, allow}.
 
    Note, that for jabberd 1.4- or WPJabber-based
 services you have to make the transports log and do XDB by themselves:
 
      <!--
@@ -872,12 +869,11 @@ services you have to make the transports log and do XDB by themselves:
       <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
     </xdb_file>
   </xdb>
-
    
-
    3.1.4  Authentication
    
-
+
      
    
+
    3.1.4  Authentication
      
 
    The option auth_method defines the authentication method that is used
 for user authentication:
-
      {auth_method, [<method>]}.
+
    {auth_method, [<method>]}.
 
    The following authentication methods are supported by ejabberd:
 
    • 
 internal (default) — See section 3.1.4.
@@ -888,9 +884,8 @@ example authentication scripts.
 3.2.2 and 3.2.4.
 
    • anonymous — See section 3.1.4.
 
    • pam — See section 3.1.4.
-
    
-
    Internal
    
-
+
      
    
+
    Internal
      
 
    ejabberd uses its internal Mnesia database as the default authentication method.
    • 
 auth_method: The value internal will enable the internal
 authentication method.
@@ -902,9 +897,8 @@ authentication on example.net:
 {host_config, "example.net", [{auth_method, [ldap]}]}.
 
  • To use internal authentication on all virtual hosts:
 
    {auth_method, internal}.
-
    • 
-
    SASL Anonymous and Anonymous Login
    
-
+
      
    
+
    SASL Anonymous and Anonymous Login
      
 
    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
@@ -929,7 +923,7 @@ parameter (see section 3.1.2).
    Examples:
 To enable anonymous login on all virtual hosts:
 
    {auth_method, [anonymous]}.
 {anonymous_protocol, login_anon}.
-  
  • Similar as previous example, but limited to public.example.org:
+
  • Similar as previous example, but limited to public.example.org:
 
    {host_config, "public.example.org", [{auth_method, [anonymous]},
                                      {anonymous_protocol, login_anon}]}.
 
  • To enable anonymous login and internal authentication on a virtual host:
@@ -945,9 +939,8 @@ To enable anonymous login on all virtual hosts:
 a virtual host:
 
    {host_config, "public.example.org", [{auth_method, [internal,anonymous]},
                                      {anonymous_protocol, both}]}.
-
    • 
-
    PAM Authentication
    
-
+
      
    
+
    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.
 PAM authentication is disabled by default, so you have to configure and compile
@@ -959,17 +952,18 @@ PAM authentication is disabled by default, so you have to configure and compile
 Default is "ejabberd". Refer to the PAM documentation of your operation system
 for more information.
 
    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
 epam. By default, it is located in /var/lib/ejabberd/priv/lib/
 directory. You have to set it root on execution in the case when your PAM module
 requires root privileges (pam_unix.so for example). Also you have to grant access
-for ejabberd to this file and remove all other permissions from it:
-
      # chown root:ejabberd /var/lib/ejabberd/priv/bin/epam
-# chmod 4750 /var/lib/ejabberd/priv/bin/epam
+for ejabberd to this file and remove all other permissions from it.
+Execute with root privileges:
+
      chown root:ejabberd /var/lib/ejabberd/priv/bin/epam
+chmod 4750 /var/lib/ejabberd/priv/bin/epam
 
    • Make sure you have the latest version of PAM installed on your system.
 Some old versions of PAM modules cause memory leaks. If you are not able to use the latest
 version, you can kill(1) epam process periodically to reduce its memory
@@ -984,15 +978,13 @@ to this file, so a malicious user can’t use your configuration to perform
 attacks.
 
    • You may want to allow login access only for certain users. pam_listfile.so
 module provides such functionality.
-
    
-
    3.1.5  Access Rules
    
-
-
    
-
    ACL Definition
    
-
+
      
    
+
    3.1.5  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>, {<acltype>, ...}}.
+
    {acl, <aclname>, {<acltype>, ...}}.
 
    <acltype> can be one of the following:
 
    
 all
     Matches all JIDs. Example:
@@ -1037,30 +1029,28 @@ character not enclosed is matched.
 
    
 all
     Matches any JID.
 
    none
     Matches no JID.
-
    
-
    Access Rights
    
-
+
      
    
+
    Access Rights
      
 
    An entry allowing or denying access to different services looks similar to
 this:
-
      {access, <accessname>, [{allow, <aclname>},
-                          {deny, <aclname>},
-                          ...
-                         ]}.
+
    {access, <accessname>, [{allow, <aclname>},
+                        {deny, <aclname>},
+                        ...
+                       ]}.
 
    When a JID is checked to have access to <accessname>, the server
 sequentially checks if that JID matches any of the ACLs that are named in the
 second elements of the tuples in the list. If it matches, the first element of
 the first matched tuple is returned, otherwise the value ‘deny’ is
 returned.
    Example:
-
      {access, configure, [{allow, admin}]}.
-  {access, something, [{deny, badmans},
-                       {allow, all}]}.
+
    {access, configure, [{allow, admin}]}.
+{access, something, [{deny, badmans},
+                     {allow, all}]}.
 
    The following access rules are pre-defined:
 
    
 all
     Always returns the value ‘allow’.
 
    none
     Always returns the value ‘deny’.
-
    
-
    Limiting Opened Sessions with ACL
    
-
+
      
    
+
    Limiting Opened Sessions with ACL
      
 
    The special access max_user_sessions specifies the maximum
 number of sessions (authenticated connections) per user. If a user
 tries to open more sessions by using different resources, the first
@@ -1068,36 +1058,34 @@ 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>},
-                               ...
-                              ]}.
+
    {access, max_user_sessions, [{<maxnumber>, <aclname>},
+                             ...
+                            ]}.
 
    Examples:
 
    • 
 To limit the number of sessions per user to 10 for all users:
-
        {access, max_user_sessions, [{10, all}]}.
-
    
-
    Several connections to a remote Jabber server with ACL
    
-
+
    {access, max_user_sessions, [{10, all}]}.
+
      
    
+
    Several connections to a remote Jabber server with ACL
      
 
    The special access max_s2s_connections specifies how many
 simultaneus S2S connections can be established to a specific remote Jabber server.
 The default value is 1.
 There’s also available the access max_s2s_connections_per_node.
    The syntax is:
-
      {access, max_s2s_connections, [{<maxnumber>, <aclname>},
-                                 ...
-                                ]}.
+
    {access, max_s2s_connections, [{<maxnumber>, <aclname>},
+                               ...
+                              ]}.
 
    Examples:
 
    • 
 Allow up to 3 connections with each remote server:
-
        {access, max_s2s_connections, [{3, all}]}.
-
    
-
    3.1.6  Shapers
    
-
+
    {access, max_s2s_connections, [{3, all}]}.
+
      
    
+
    3.1.6  Shapers
      
 
    Shapers enable you to limit connection traffic. The syntax of
 shapers is like this:
-
      {shaper, <shapername>, <kind>}.
+
    {shaper, <shapername>, <kind>}.
 
    Currently only one kind of shaper called maxrate is available. It has the
 following syntax:
-
      {maxrate, <rate>}
+
    {maxrate, <rate>}
 
    where <rate> stands for the maximum allowed incoming rate in bytes per
 second.
 When a connection exceeds this limit, ejabberd stops reading from the socket 
@@ -1105,13 +1093,12 @@ 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, {maxrate, 1000}}.
 
    • To define a shaper named ‘fast’ with traffic speed limited to
 50,000 bytes/second:
-
        {shaper, fast, {maxrate, 50000}}.
-
    
-
    3.1.7  Default Language
    
-
+
    {shaper, fast, {maxrate, 50000}}.
+
      
    
+
    3.1.7  Default Language
      
 
    The option language defines the default language of server strings that
 can be seen by Jabber clients. If a Jabber client do not support
 xml:lang, the specified language is used. The default value is
@@ -1119,12 +1106,11 @@ can be seen by Jabber clients. If a Jabber client do not support
 <language>.msg in ejabberd’s msgs directory.
    Examples:
 
    • 
 To set Russian as default language:
-
        {language, "ru"}.
+
      {language, "ru"}.
 
    • To set Spanish as default language:
-
        {language, "es"}.
-
    
-
    3.2  Database and LDAP Configuration
    
-
+
    {language, "es"}.
+
      
    
+
    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,
@@ -1145,9 +1131,8 @@ different storage systems for modules, and so forth.
    The following databas
 
  • OpenLDAP
 
  • Normally any LDAP compatible server should work; inform us about your
 success with a not-listed server so that we can list it here.
-
    • 
-
    3.2.1  MySQL
    
-
+
      
    
+
    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.
@@ -1162,9 +1147,8 @@ 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}.
-
    
-
    Driver Compilation
    
-
+
      
    
+
    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.
    1. 
 First, install the Erlang
@@ -1174,9 +1158,8 @@ put them for example in the same directory as your ejabberd .beam files
 also needed for native MySQL support!). This can be done, by using next
 commands:
 
      ./configure --enable-odbc && make install
-
    
-
    Authentication
    
-
+
      
    
+
    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
@@ -1196,18 +1179,16 @@ 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"}}.
-
    
-
    Storage
    
-
+
      
    
+
    Storage
      
 
    MySQL also can be used to store information into from several ejabberd
 modules. See section 3.3.1 to see which modules have a version
 with the ‘_odbc’. This suffix indicates that the module can be used with
 relational databases like MySQL. To enable storage to your database, just make
 sure that your database is running well (see previous sections), and replace the
 suffix-less or ldap module variant with the odbc module variant. Keep in mind
-that you cannot have several variants of the same module loaded!
    
-
    3.2.2  Microsoft SQL Server
    
-
+that you cannot have several variants of the same module loaded!
      
    
+
    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
@@ -1223,21 +1204,18 @@ 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}.
-
    
-
    Driver Compilation
    
-
+
      
    
+
    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
-
    
-
    Authentication
    
-
+
      
    
+
    Authentication
      
 
    The configuration of Microsoft SQL Server is the same as the configuration of
-ODBC compatible servers (see section 3.2.4).
    
-
    Storage
    
-
+ODBC compatible servers (see section 3.2.4).
      
    
+
    Storage
      
 
    Microsoft SQL Server also can be used to store information into from several
 ejabberd modules. See section 3.3.1 to see which modules have
 a version with the ‘_odbc’. This suffix indicates that the module can be used
@@ -1245,9 +1223,8 @@ with relational databases like Microsoft SQL Server. To enable storage to your
 database, just make sure that your database is running well (see previous
 sections), and replace the suffix-less or ldap module variant with the odbc
 module variant. Keep in mind that you cannot have several variants of the same
-module loaded!
    
-
    3.2.3  PostgreSQL
    
-
+module loaded!
      
    
+
    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.
@@ -1262,9 +1239,8 @@ 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}.
-
    
-
    Driver Compilation
    
-
+
      
    
+
    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.
    1. 
@@ -1277,9 +1253,8 @@ directory as your ejabberd .beam files.
 (this is also needed for native PostgreSQL support!). This can be done, by
 using next commands:
 
      ./configure --enable-odbc && make install
-
    
-
    Authentication
    
-
+
      
    
+
    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
@@ -1299,18 +1274,16 @@ 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"}}.
-
    
-
    Storage
    
-
+
      
    
+
    Storage
      
 
    PostgreSQL also can be used to store information into from several ejabberd
 modules. See section 3.3.1 to see which modules have a version
 with the ‘_odbc’. This suffix indicates that the module can be used with
 relational databases like PostgreSQL. To enable storage to your database, just
 make sure that your database is running well (see previous sections), and
 replace the suffix-less or ldap module variant with the odbc module variant.
-Keep in mind that you cannot have several variants of the same module loaded!
    
-
    3.2.4  ODBC Compatible
    
-
+Keep in mind that you cannot have several variants of the same module loaded!
      
    
+
    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
@@ -1323,9 +1296,8 @@ 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}.
-
    
-
    Driver Compilation
    
-
    You can skip this step if you installed ejabberd using a binary installer or
+
      
    
+
    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.
    1. 
 First, install the Erlang
@@ -1334,9 +1306,8 @@ put them for example in the same directory as your ejabberd .beam files
 
    2. Then, configure, compile and install ejabberd with ODBC support
 enabled. This can be done, by using next commands:
 
      ./configure --enable-odbc && make install
-
    
-
    Authentication
    
-
+
      
    
+
    Authentication
      
 
    The first configuration step is to define the odbc auth_method. For
 example:
 
    {host_config, "public.example.org", [{auth_method, [odbc]}]}.
@@ -1345,9 +1316,8 @@ 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"}.
-
    
-
    Storage
    
-
+
      
    
+
    Storage
      
 
    An ODBC compatible database also can be used to store information into from
 several ejabberd modules. See section 3.3.1 to see which
 modules have a version with the ‘_odbc’. This suffix indicates that the module
@@ -1355,14 +1325,12 @@ can be used with ODBC compatible relational databases. To enable storage to your
 database, just make sure that your database is running well (see previous
 sections), and replace the suffix-less or ldap module variant with the odbc
 module variant. Keep in mind that you cannot have several variants of the same
-module loaded!
    
-
    3.2.5  LDAP
    
-
+module loaded!
      
    
+
    3.2.5  LDAP
      
 
    ejabberd has built-in LDAP support. You can authenticate users against LDAP
 server and use LDAP directory as vCard storage. Shared rosters are not supported
-yet.
    
-
    Connection
    
-
    Parameters:
+yet.
      
    
+
    Connection
      
    Parameters:
 
    
 ldap_servers
     List of IP addresses or DNS names of your
 LDAP servers. This option is required.
@@ -1377,15 +1345,14 @@ is "" which means ‘anonymous connection’.
 
    ldap_password
     Bind password. The default
 value is "".
 
    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, ["ldap.example.org"]}.
+{ldap_port, 389}.
+{ldap_rootdn, "cn=Manager,dc=domain,dc=org"}.
+{ldap_password, "secret"}.
 
    Note that current LDAP implementation does not support SSL secured communication
-and SASL authentication.
    
-
    Authentication
    
-
    You can authenticate users against an LDAP directory. Available options are:
    
+and SASL authentication.
      
    
+
    Authentication
      
    You can authenticate users against an LDAP directory. Available options are:
    
 ldap_base
    LDAP base directory which stores
 users accounts. This option is required.
 
    ldap_uids
    LDAP attribute which holds a list
@@ -1412,122 +1379,121 @@ default is none. Example:
 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.
-
    
-
    Examples
    
-
    
-
    Common example
    Let’s say ldap.example.org is the name of our LDAP server. We have
+
      
    
+
    Examples
      
      
    
+
    Common example
      
    Let’s say ldap.example.org is the name of our LDAP server. We have
 users with their passwords in "ou=Users,dc=example,dc=org" directory.
 Also we have addressbook, which contains users emails and their additional
 infos in "ou=AddressBook,dc=example,dc=org" directory. Corresponding
-authentication section should looks like this:
      %% authentication method
-  {auth_method, ldap}.
-  %% DNS name of our LDAP server
-  {ldap_servers, ["ldap.example.org"]}.
-  %% Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret"
-  {ldap_rootdn, "cn=Manager,dc=example,dc=org"}.
-  {ldap_password, "secret"}.
-  %% define the user's base
-  {ldap_base, "ou=Users,dc=example,dc=org"}.
-  %% We want to authorize users from 'shadowAccount' object class only
-  {ldap_filter, "(objectClass=shadowAccount)"}.
+authentication section should looks like this:
    %% Authentication method
+{auth_method, ldap}.
+%% DNS name of our LDAP server
+{ldap_servers, ["ldap.example.org"]}.
+%% Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret"
+{ldap_rootdn, "cn=Manager,dc=example,dc=org"}.
+{ldap_password, "secret"}.
+%% Define the user's base
+{ldap_base, "ou=Users,dc=example,dc=org"}.
+%% We want to authorize users from 'shadowAccount' object class only
+{ldap_filter, "(objectClass=shadowAccount)"}.
 
    Now we want to use users LDAP-info as their vCards. We have four attributes
 defined in our LDAP schema: "mail" — email address, "givenName"
 — first name, "sn" — second name, "birthDay" — birthday.
-Also we want users to search each other. Let’s see how we can set it up:
      {modules,
-    ...
-    {mod_vcard_ldap,
-     [
-      %% We use the same server and port, but want to bind anonymously because
-      %% our LDAP server accepts anonymous requests to
-      %% "ou=AddressBook,dc=example,dc=org" subtree.
-      {ldap_rootdn, ""},
-      {ldap_password, ""},
-      %% define the addressbook's base
-      {ldap_base, "ou=AddressBook,dc=example,dc=org"},
-      %% uidattr: user's part of JID is located in the "mail" attribute
-      %% uidattr_format: common format for our emails
-      {ldap_uids, [{"mail", "%u@mail.example.org"}]},
-      %% We have to define empty filter here, because entries in addressbook does not
-      %% belong to shadowAccount object class
-      {ldap_filter, ""},
-      %% Now we want to define vCard pattern
-      {ldap_vcard_map,
-       [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
-        {"GIVEN", "%s", ["givenName"]},
-        {"FAMILY", "%s", ["sn"]},
-        {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John"
-        {"EMAIL", "%s", ["mail"]},
-        {"BDAY", "%s", ["birthDay"]}]},
-      %% Search form
-      {ldap_search_fields,
-       [{"User", "%u"},
-        {"Name", "givenName"},
-        {"Family Name", "sn"},
-        {"Email", "mail"},
-        {"Birthday", "birthDay"}]},
-      %% vCard fields to be reported
-      %% Note that JID is always returned with search results
-      {ldap_search_reported,
-       [{"Full Name", "FN"},
-        {"Nickname", "NICKNAME"},
-        {"Birthday", "BDAY"}]}
-    ]},
-    ...
-  }.
+Also we want users to search each other. Let’s see how we can set it up:
    {modules,
+ [
+  ...
+  {mod_vcard_ldap,
+   [
+    %% We use the same server and port, but want to bind anonymously because
+    %% our LDAP server accepts anonymous requests to
+    %% "ou=AddressBook,dc=example,dc=org" subtree.
+    {ldap_rootdn, ""},
+    {ldap_password, ""},
+    %% define the addressbook's base
+    {ldap_base, "ou=AddressBook,dc=example,dc=org"},
+    %% uidattr: user's part of JID is located in the "mail" attribute
+    %% uidattr_format: common format for our emails
+    {ldap_uids, [{"mail", "%u@mail.example.org"}]},
+    %% We have to define empty filter here, because entries in addressbook does not
+    %% belong to shadowAccount object class
+    {ldap_filter, ""},
+    %% Now we want to define vCard pattern
+    {ldap_vcard_map,
+     [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
+      {"GIVEN", "%s", ["givenName"]},
+      {"FAMILY", "%s", ["sn"]},
+      {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John"
+      {"EMAIL", "%s", ["mail"]},
+      {"BDAY", "%s", ["birthDay"]}]},
+    %% Search form
+    {ldap_search_fields,
+     [{"User", "%u"},
+      {"Name", "givenName"},
+      {"Family Name", "sn"},
+      {"Email", "mail"},
+      {"Birthday", "birthDay"}]},
+    %% vCard fields to be reported
+    %% Note that JID is always returned with search results
+    {ldap_search_reported,
+     [{"Full Name", "FN"},
+      {"Nickname", "NICKNAME"},
+      {"Birthday", "BDAY"}]}
+  ]},
+  ...
+ ]}.
 
    Note that mod_vcard_ldap module checks for the existence of the user before
-searching in his information in LDAP.
    
-
    Active Directory
    
-
+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,
-    ...
-    {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
    
-
+{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"}]}
+  ]},
+  ...
+ ]}.
+
      
    
+
    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
@@ -1535,58 +1501,57 @@ module.
    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,   []}
-   ]}.
-
    
-
    3.3.1  Overview
    
-
+
    {modules,
+ [
+  {mod_echo,      []},
+  {mod_time,      []},
+  {mod_version,   []}
+ ]}.
+
      
    
+
    3.3.1  Modules Overview
      
 
    The following table lists all modules included in ejabberd.
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
    ModuleFeatureDependenciesNeeded for XMPP?
    mod_adhocAd-Hoc Commands (XEP-0050) No
    mod_announceManage announcementsrecommends mod_adhocNo
    mod_capsRequest and cache Entity Capabilities (XEP-0115) No
    mod_configureServer configuration using Ad-Hocmod_adhocNo
    mod_discoService Discovery (XEP-0030) No
    mod_echoEchoes Jabber packets No
    mod_ircIRC transport No
    mod_lastLast Activity (XEP-0012) No
    mod_last_odbcLast Activity (XEP-0012)supported database (*)No
    mod_mucMulti-User Chat (XEP-0045) No
    mod_muc_logMulti-User Chat room loggingmod_mucNo
    mod_offlineOffline message storage No
    mod_offline_odbcOffline message storagesupported database (*)No
    mod_privacyBlocking Communications Yes
    mod_privacy_odbcBlocking Communicationssupported database (*)Yes
    mod_privatePrivate XML Storage (XEP-0049) No
    mod_private_odbcPrivate XML Storage (XEP-0049)supported database (*)No
    mod_proxy65SOCKS5 Bytestreams (XEP-0065) No
    mod_pubsubPublish-Subscribe (XEP-0060) and PEP (XEP-0163)mod_capsNo
    mod_registerIn-Band Registration (XEP-0077) No
    mod_rosterRoster management Yes (**)
    mod_roster_odbcRoster managementsupported database (*)Yes (**)
    mod_service_logCopy user messages to logger service No
    mod_shared_rosterShared roster managementmod_roster orNo
      mod_roster_odbc 
    mod_statsStatistics Gathering (XEP-0039) No
    mod_timeEntity Time (XEP-0090) No
    mod_vcardvcard-temp (XEP-0054) No
    mod_vcard_ldapvcard-temp (XEP-0054)LDAP serverNo
    mod_vcard_odbcvcard-temp (XEP-0054)supported database (*)No
    mod_versionSoftware Version (XEP-0092) No
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    ModuleFeatureDependencies
    mod_adhocAd-Hoc Commands (XEP-0050) 
    mod_announceManage announcementsrecommends mod_adhoc
    mod_capsEntity Capabilities (XEP-0115) 
    mod_configureServer configuration using Ad-Hocmod_adhoc
    mod_discoService Discovery (XEP-0030) 
    mod_echoEchoes Jabber packets 
    mod_ircIRC transport 
    mod_lastLast Activity (XEP-0012) 
    mod_last_odbcLast Activity (XEP-0012)supported DB (*)
    mod_mucMulti-User Chat (XEP-0045) 
    mod_muc_logMulti-User Chat room loggingmod_muc
    mod_offlineOffline message storage (XEP-0160) 
    mod_offline_odbcOffline message storage (XEP-0160)supported DB (*)
    mod_privacyBlocking Communication (XMPP IM) 
    mod_privacy_odbcBlocking Communication (XMPP IM)supported DB (*)
    mod_privatePrivate XML Storage (XEP-0049) 
    mod_private_odbcPrivate XML Storage (XEP-0049)supported DB (*)
    mod_proxy65SOCKS5 Bytestreams (XEP-0065) 
    mod_pubsubPub-Sub (XEP-0060), PEP (XEP-0163)mod_caps
    mod_registerIn-Band Registration (XEP-0077) 
    mod_rosterRoster management (XMPP IM) 
    mod_roster_odbcRoster management (XMPP IM)supported DB (*)
    mod_service_logCopy user messages to logger service 
    mod_shared_rosterShared roster managementmod_roster or
      mod_roster_odbc
    mod_statsStatistics Gathering (XEP-0039) 
    mod_timeEntity Time (XEP-0090) 
    mod_vcardvcard-temp (XEP-0054) 
    mod_vcard_ldapvcard-temp (XEP-0054)LDAP server
    mod_vcard_odbcvcard-temp (XEP-0054)supported DB (*)
    mod_versionSoftware Version (XEP-0092) 
    
 
    
 
    • 
-(*) For a list of supported databases, see section 3.2.
-
    • (**) This module or a similar one with another database backend is needed for
-XMPP compliancy.
+(*) This module requires a supported database. For a list of supported databases, see section 3.2.
 
    You can see which database backend each module needs by looking at the suffix:
 
    • 
 No suffix, this means that the modules uses Erlang’s built-in database
@@ -1611,12 +1576,10 @@ Last connection date and time: Use mod_last_odbc instead of
 contributed modules on the
 ejabberd website. Please remember that these contributions might not work or
 that they can contain severe bugs and security leaks. Therefore, use them at
-your own risk!
      
-
      3.3.2  Common Options
      
-
      The following options are used by many modules. Therefore, they are described in
-this separate section.
      
-
      iqdisc
      
-
+your own risk!
        
      
+
      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
@@ -1630,7 +1593,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
+
      {queues, N}
       N separate queues are created to process the
 queries. The queries are thus process in parallel, but in a
 controlled way.
 
      parallel
       For every packet with this discipline a separate Erlang process
@@ -1639,36 +1602,34 @@ 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,
-   [
-    ...
-    {mod_time, [{iqdisc, no_queue}]},
-    ...
-   ]}.
-
      
-
      host
      
-
+
      {modules,
+ [
+  ...
+  {mod_time, [{iqdisc, no_queue}]},
+  ...
+ ]}.
+
        
      
+
      host
        
 
      This option defines the Jabber ID of a service provided by an ejabberd module.
 The keyword "@HOST@" 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,
-   [
-    ...
-    {mod_echo, [{host, "mirror.example.org"}]},
-    ...
-   ]}.
+
      {modules,
+ [
+  ...
+  {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,
-   [
-    ...
-    {mod_echo, [{host, "mirror.@HOST@"}]},
-    ...
-   ]}.
-
      
-
      3.3.3  mod_announce
      
-
+
      {modules,
+ [
+  ...
+  {mod_echo, [{host, "mirror.@HOST@"}]},
+  ...
+ ]}.
+
        
      
+
      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
@@ -1705,35 +1666,37 @@ able to send such messages).
 
      Examples:
 
      • 
 Only administrators can send announcements:
-
          {access, announce, [{allow, admins}]}.
+
        {access, announce, [{allow, admins}]}.
 
-  {modules,
-   [
-    ...
-    {mod_adhoc, []},
-    {mod_announce, [{access, announce}]},
-    ...
-   ]}.
+{modules,
+ [
+  ...
+  {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, admins, {user, "admin", "example.org"}}.
+
        {acl, direction, {user, "big_boss", "example.org"}}.
+{acl, direction, {user, "assistant", "example.org"}}.
+{acl, admins, {user, "admin", "example.org"}}.
+
+{access, announce, [{allow, admins},
+                    {allow, direction}]}.
+
+{modules,
+ [
   ...
-  {access, announce, [{allow, admins},
-                      {allow, direction}]}.
+  {mod_adhoc, []},
+  {mod_announce, [{access, announce}]},
   ...
-  {modules,
-   [
-    ...
-    {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
      
-
+disabled for instances of ejabberd with hundreds of thousands users.
        
      
+
      3.3.4  mod_disco
        
+
+
+
 
      This module adds support for Service Discovery (XEP-0030). With
 this module enabled, services on your server can be discovered by
 Jabber clients. Note that ejabberd has no modules with support
@@ -1750,31 +1713,30 @@ extra domains can be added to the Service Discovery item list.
 
      Examples:
 
      • 
 To serve a link to the Jabber User Directory on jabber.org:
-
          {modules,
-   [
-    ...
-    {mod_disco, [{extra_domains, ["users.jabber.org"]}]},
-    ...
-   ]}.
+
        {modules,
+ [
+  ...
+  {mod_disco, [{extra_domains, ["users.jabber.org"]}]},
+  ...
+ ]}.
 
      • To serve a link to the transports on another server:
-
          {modules,
-   [
-    ...
-    {mod_disco, [{extra_domains, ["icq.example.com",
-                                  "msn.example.com"]}]},
-    ...
-   ]}.
+
        {modules,
+ [
+  ...
+  {mod_disco, [{extra_domains, ["icq.example.com",
+                                "msn.example.com"]}]},
+  ...
+ ]}.
 
      • To serve a link to a few friendly servers:
-
          {modules,
-   [
-    ...
-    {mod_disco, [{extra_domains, ["example.org",
-                                  "example.com"]}]},
-    ...
-   ]}.
-
      
-
      3.3.5  mod_echo
      
-
+
      {modules,
+ [
+  ...
+  {mod_disco, [{extra_domains, ["example.org",
+                                "example.com"]}]},
+  ...
+ ]}.
+
      
    
+
    3.3.5  mod_echo
      
 
    This module simply echoes any Jabber
 packet back to the sender. This mirror can be of interest for
 ejabberd and Jabber client debugging.
    Options:
@@ -1787,12 +1749,12 @@ 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,
-   [
-    ...
-    {mod_echo, [{host, "mirror.example.org"}]},
-    ...
-   ]}.
+
    {modules,
+ [
+  ...
+  {mod_echo, [{host, "mirror.example.org"}]},
+  ...
+ ]}.
 
    
 
    3.3.6  mod_http_bind
    
 
@@ -1876,9 +1838,8 @@ To use this module you must enable it:
   },
   ...
 ]}.
-
    
-
    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:
 
@@ -1913,32 +1874,31 @@ may use the IRC transport (default value: all).
 In the first example, the IRC transport is available on (all) your
 virtual host(s) with the prefix ‘irc.’. Furthermore, anyone is
 able to use the transport. The default encoding is set to "iso8859-15".
-
      {modules,
-   [
-    ...
-    {mod_irc, [{access, all}, {default_encoding, "iso8859-15"}]},
-    ...
-   ]}.
+
    {modules,
+ [
+  ...
+  {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 by paying customers registered on
 our domains and on other servers.
-
      {acl, paying_customers, {user, "customer1", "example.net"}}.
-  {acl, paying_customers, {user, "customer2", "example.com"}}.
-  {acl, paying_customers, {user, "customer3", "example.org"}}.
-  ...
-  {access, paying_customers, [{allow, paying_customers},
+
    {acl, paying_customers, {user, "customer1", "example.net"}}.
+{acl, paying_customers, {user, "customer2", "example.com"}}.
+{acl, paying_customers, {user, "customer3", "example.org"}}.
+
+{access, paying_customers, [{allow, paying_customers},
                               {deny, all}]}.
+
+{modules,
+ [
   ...
-  {modules,
-   [
-    ...
-    {mod_irc, [{access, paying_customers},
-               {host, "irc.example.net"}]},
-    ...
-   ]}.
-
    • 
-
    3.3.9  mod_last
    
-
+  {mod_irc, [{access, paying_customers},
+             {host, "irc.example.net"}]},
+  ...
+ ]}.
+
      
    
+
    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
@@ -1946,9 +1906,8 @@ connected user was last active on the server, or to query the uptime of the
 
    
 iqdisc
     This specifies 
 the processing discipline for Last activity (jabber:iq:last) IQ queries (see section 3.3.2).
-
    
-
    3.3.10  mod_muc
    
-
+
      
    
+
    3.3.10  mod_muc
      
 
    With this module enabled, your server will support Multi-User Chat
 (XEP-0045). End users will be able to join text conferences.
    Some of the features of Multi-User Chat:
 
    • 
@@ -2051,7 +2010,7 @@ The available room options and the default values are:
 
      {logging, false}
       The public messages are logged using mod_muc_log.
 
      {max_users, 200}
       Maximum number of occupants in the room.
 
      {members_by_default, true}
       The occupants that enter the room are participants by default, so they have ’voice’.
-
      {members_only, false}
       Only members of the room can	enter.
+
      {members_only, false}
       Only members of the room can enter.
 
      {moderated, true}
       Only occupants with ’voice’ can send public messages.
 
      {password, ""}
       Password of the room. You may want to enable the next option too.
 
      {password_protected, false}
       The password is required to enter the room.
@@ -2074,19 +2033,19 @@ to new hardware. This will involve service breakdowns around 23:00 UMT.
 We apologise for this inconvenience.’ to conference.example.org,
 it will be displayed in all active rooms. In this example the history
 feature is disabled.
-
        {acl, admins, {user, "admin", "example.org"}}.
+
      {acl, admins, {user, "admin", "example.org"}}.
+
+{access, muc_admins, [{allow, admins}]}.
+
+{modules,
+ [
   ...
-  {access, muc_admins, [{allow, admins}]}.
+  {mod_muc, [{access, all},
+             {access_create, all},
+             {access_admin, muc_admins},
+             {history_size, 0}]},
   ...
-  {modules,
-   [
-    ...
-    {mod_muc, [{access, all},
-               {access_create, all},
-               {access_admin, muc_admins},
-               {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
@@ -2097,57 +2056,56 @@ 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, admins, {user, "admin", "example.org"}}.
+
      {acl, paying_customers, {user, "customer1", "example.net"}}.
+{acl, paying_customers, {user, "customer2", "example.com"}}.
+{acl, paying_customers, {user, "customer3", "example.org"}}.
+{acl, admins, {user, "admin", "example.org"}}.
+
+{access, muc_admins, [{allow, admins},
+                      {deny, all}]}.
+{access, muc_access, [{allow, paying_customers},
+                      {allow, admins},
+                      {deny, all}]}.
+
+{modules,
+ [
   ...
-  {access, muc_admins, [{allow, admins},
-                        {deny, all}]}.
-  {access, muc_access, [{allow, paying_customers},
-                        {allow, admins},
-                        {deny, all}]}.
+  {mod_muc, [{access, muc_access},
+             {access_create, muc_admins},
+             {access_admin, muc_admins}]},
   ...
-  {modules,
-   [
-    ...
-    {mod_muc, [{access, muc_access},
-               {access_create, muc_admins},
-               {access_admin, muc_admins}]},
-    ...
-   ]}.
+ ]}.
 
    • In the following example, MUC anti abuse options are used. A
 user cannot send more than one message every 0.4 seconds and cannot
 change its presence more than once every 4 seconds. No ACLs are
-defined, but some user restriction could be added as well:
        ...
-  {modules,
-   [
-    ...
-    {mod_muc, [{min_message_interval, 0.4},
-               {min_presence_interval, 4}]},
-    ...
-   ]}.
+defined, but some user restriction could be added as well:
      {modules,
+ [
+  ...
+  {mod_muc, [{min_message_interval, 0.4},
+             {min_presence_interval, 4}]},
+  ...
+ ]}.
 
    • This example shows how to use default_room_options to make sure
 newly created chatrooms have by default those options.
-
        {modules,
-   [
-    ...
-    {mod_muc, [{access, muc_access},
-               {access_create, muc_admins},
-               {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_admins}]},
-    ...
-   ]}.
-
    
-
    3.3.11  mod_muc_log
    
-
+
    {modules,
+ [
+  ...
+  {mod_muc, [{access, muc_access},
+             {access_create, muc_admins},
+             {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_admins}]},
+  ...
+ ]}.
+
      
    
+
    3.3.11  mod_muc_log
      
 
    This module enables optional logging of Multi-User Chat (MUC) conversations to
 HTML. Once you enable this module, users can join a chatroom using a MUC capable
 Jabber client, and if they have enough privileges, they can request the
@@ -2213,49 +2171,48 @@ 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, [{allow, all}]}.
+
+{modules,
+ [
   ...
-  {modules,
-   [
-    ...
-    {mod_muc_log, [
-               {access_log, muc},
-               {cssfile, "http://example.com/my.css"},
-               {dirtype, plain},
-               {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},
+                 {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. Further, 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, admins, {user, "admin1", "example.org"}}.
-  {acl, admins, {user, "admin2", "example.net"}}.
+
    {acl, admins, {user, "admin1", "example.org"}}.
+{acl, admins, {user, "admin2", "example.net"}}.
+
+{access, muc_log, [{allow, admins},
+                   {deny, all}]}.
+
+{modules,
+ [
   ...
-  {access, muc_log, [{allow, admins},
-                     {deny, all}]}.
+  {mod_muc_log, [
+                 {access_log, muc_log},
+                 {cssfile, false},
+                 {dirtype, subdirs},
+                 {outdir, "/var/www/muclogs"},
+                 {timezone, local}
+                ]},
   ...
-  {modules,
-   [
-    ...
-    {mod_muc_log, [
-               {access_log, muc_log},
-               {cssfile, false},
-               {dirtype, subdirs},
-               {outdir, "/var/www/muclogs"},
-               {timezone, local}
-    ]},
-    ...
-   ]}.
-
    • 
-
    3.3.12  mod_offline
    
-
+ ]}.
+
      
    
+
    3.3.12  mod_offline
      
 
    This module implements offline message storage. 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
@@ -2265,9 +2222,8 @@ online again. Thus it is very similar to how email works. Note that
 is use to set a max number of offline messages per user (quota). Its
 value can be either infinity or a strictly positive
 integer. The default value is infinity.
-
-
    3.3.13  mod_privacy
    
-
+
      
    
+
    3.3.13  mod_privacy
      
 
    This module implements Blocking Communication (also known as Privacy Rules)
 as defined in section 10 from XMPP IM. If end users have support for it in
 their Jabber client, they will be able to:
@@ -2294,9 +2250,8 @@ subscription type (or globally).
 
    
 iqdisc
     This specifies 
 the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section 3.3.2).
-
    
-
    3.3.14  mod_private
    
-
+
      
    
+
    3.3.14  mod_private
      
 
    This module adds support for Private XML Storage (XEP-0049):
 
    
 Using this method, Jabber entities can store private data on the server and
@@ -2307,9 +2262,8 @@ of client-specific preferences; another is Bookmark Storage (
    
 iqdisc
     This specifies 
 the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section 3.3.2).
-
    
-
    3.3.15  mod_proxy65
    
-
+
      
    
+
    3.3.15  mod_proxy65
      
 
    This module implements SOCKS5 Bytestreams (XEP-0065).
 It allows ejabberd to act as a file transfer proxy between two
 XMPP clients.
    Options:
@@ -2337,35 +2291,34 @@ Default is none.
 
    Examples:
 
    • 
 The simpliest configuration of the module:
-
        {modules,
-   [
-    ...
-    {mod_proxy65, []},
-    ...
-  ]}.
+
      {modules,
+ [
+  ...
+  {mod_proxy65, []},
+  ...
+ ]}.
 
    • More complicated configuration.
-
        {acl, proxy_users, {server, "example.org"}}.
-  {access, proxy65_access, [{allow, proxy_users}, {deny, all}]}.
+
      {acl, proxy_users, {server, "example.org"}}.
+{access, proxy65_access, [{allow, proxy_users}, {deny, all}]}.
+
+{acl, admin, {user, "admin", "example.org"}}.
+{shaper, normal, {maxrate, 10240}}. %% 10 Kbytes/sec
+{access, proxy65_shaper, [{none, admin}, {normal, all}]}.
+
+{modules,
+ [
   ...
-  {acl, admin, {user, "admin", "example.org"}}.
-  {shaper, normal, {maxrate, 10240}}. %% 10 Kbytes/sec
-  {access, proxy65_shaper, [{none, admin}, {normal, all}]}.
+  {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}]},
   ...
-  {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}]},
-    ...
-  ]}.
-
    
-
    3.3.16  mod_pubsub
    
-
+ ]}.
+
      
    
+
    3.3.16  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)
@@ -2386,18 +2339,17 @@ pubsub plugin is always used.
 nodetree is used. Nodetrees are default and virtual. Only one nodetree can be used
 and is shared by all node plugins. 
 
    Example:
-
      {modules,
-   [
-    ...
-    {mod_pubsub, [
-                  {access_createnode, pubsub_createnode},
-                  {plugins, ["default", "pep"]}
-                 ]}
-    ...
-   ]}.
-
    
-
    3.3.17  mod_register
    
-
+
    {modules,
+ [
+  ...
+  {mod_pubsub, [
+                {access_createnode, pubsub_createnode},
+                {plugins, ["default", "pep"]}
+               ]}
+  ...
+ ]}.
+
      
    
+
    3.3.17  mod_register
      
 
    This module adds support for In-Band Registration (XEP-0077). This protocol
 enables end users to use a Jabber client to:
 
    • 
@@ -2428,55 +2380,54 @@ instead of an integer put a word like: infinity.
 Default value: 600 seconds.
      Examples:
 
      • 
 Next example prohibits the registration of too short account names:
-
          {acl, shortname, {user_glob, "?"}}.
-  {acl, shortname, {user_glob, "??"}}.
-  % The same using regexp:
-  %{acl, shortname, {user_regexp, "^..?$"}}.
+
        {acl, shortname, {user_glob, "?"}}.
+{acl, shortname, {user_glob, "??"}}.
+%% The same using regexp:
+%%{acl, shortname, {user_regexp, "^..?$"}}.
+
+{access, register, [{deny, shortname},
+                    {allow, all}]}.
+
+{modules,
+ [
   ...
-  {access, register, [{deny, shortname},
-                      {allow, all}]}.
+  {mod_register, [{access, register}]},
   ...
-  {modules,
-   [
-    ...
-    {mod_register, [{access, register}]},
-    ...
-   ]}.
+ ]}.
 
      • The in-band registration of new accounts can be prohibited by changing the
 access option. If you really want to disable all In-Band Registration
 functionality, that is changing passwords in-band and deleting accounts
 in-band, you have to remove mod_register from the modules list. In this
 example all In-Band Registration functionality is disabled:
-
          {access, register, [{deny, all}]}.
+
        {access, register, [{deny, all}]}.
 
-  {modules,
-   [
-    ...
-%    {mod_register, [{access, register}]},
-    ...
-   ]}.
-
      • Define the welcome message and three registration watchers.
+{modules,
+ [
+  ...
+  %% {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,
    [
-    ...
-     {mod_register, [
-        {welcome_message, {"Welcome!", "Welcome to this Jabber server. For information about Jabber visit http://www.jabber.org"}},
-        {registration_watchers, ["admin1@example.org", "admin2@example.org", "boss@example.net"]}
-     ]},
-    ...
-   ]}.
-
    • 
-
    3.3.18  mod_roster
    
-
+    {welcome_message, {"Welcome!", "Welcome to this Jabber server. Check http://www.jabber.org"}},
+    {registration_watchers, ["admin1@example.org", "boss@example.net"]}
+   ]},
+  ...
+ ]}.
+
      
    
+
    3.3.18  mod_roster
      
 
    This module implements roster management as defined in RFC 3921: XMPP IM.
    Options:
 
    
 iqdisc
     This specifies 
 the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section 3.3.2).
-
    
-
    3.3.19  mod_service_log
    
-
+
      
    
+
    3.3.19  mod_service_log
      
 
    This module adds support for logging end user packets via a Jabber message
 auditing service such as
 Bandersnatch. All user
@@ -2489,25 +2440,24 @@ that will receive the packets can be specified.
 
    • 
 To log all end user packets to the Bandersnatch service running on
 bandersnatch.example.com:
-
        {modules,
-   [
-    ...
-    {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]},
-    ...
-   ]}.
+
      {modules,
+ [
+  ...
+  {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,
-   [
-    ...
-    {mod_service_log, [{loggers, ["bandersnatch.example.com",
-                                  "bandersnatch.example.org"]}]},
-    ...
-   ]}.
-
    
-
    3.3.20  mod_shared_roster
    
-
+
    {modules,
+ [
+  ...
+  {mod_service_log, [{loggers, ["bandersnatch.example.com",
+                                "bandersnatch.example.org"]}]},
+  ...
+ ]}.
+
      
    
+
    3.3.20  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
@@ -2581,9 +2531,8 @@ roster groups as shown in the following table:
 
 
 
    
-
-
    3.3.21  mod_stats
    
-
+
      
    
+
    3.3.21  mod_stats
      
 
    This module adds support for Statistics Gathering (XEP-0039). This protocol
 allows you to retrieve next statistics from your ejabberd deployment:
 
    • 
@@ -2614,17 +2563,15 @@ by sending:
     <stat name='users/all-hosts/total'/>
   </query>
 </iq>
-
    -

    3.3.22  mod_time

    - +

    +

    3.3.22  mod_time

    This module features support for Entity Time (XEP-0090). By using this XEP, you are able to discover the time at another entity’s location.

    Options:

    iqdisc
    This specifies the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section 3.3.2). -
    -

    3.3.23  mod_vcard

    - +

    +

    3.3.23  mod_vcard

    This module allows end users to store and retrieve their vCard, and to retrieve other users vCards, as defined in vcard-temp (XEP-0054). The module also implements an uncomplicated Jabber User Directory based on the vCards of @@ -2659,28 +2606,27 @@ This option is available in mod_vcard, but not available in mod_vca In this first situation, search results are limited to twenty items, every user who added information to their vCard will be listed when people do an empty search, and only users from the current host will be returned: -

      {modules,
-   [
-    ...
-    {mod_vcard, [{search, true},
-                 {matches, 20},
-                 {allow_return_all, true},
-                 {search_all_hosts, false}]},
-    ...
-   ]}.
+
    {modules,
+ [
+  ...
+  {mod_vcard, [{search, true},
+               {matches, 20},
+               {allow_return_all, true},
+               {search_all_hosts, false}]},
+  ...
+ ]}.
 
  • The second situation differs in a way that search results are not limited,
 and that all virtual hosts will be searched instead of only the current one:
-
      {modules,
-   [
-    ...
-    {mod_vcard, [{search, true},
-                 {matches, infinity},
-                 {allow_return_all, true}]},
-    ...
-   ]}.
-
    • 
-
    3.3.24  mod_vcard_ldap
    
-
+
    {modules,
+ [
+  ...
+  {mod_vcard, [{search, true},
+               {matches, infinity},
+               {allow_return_all, true}]},
+  ...
+ ]}.
+
      
    
+
    3.3.24  mod_vcard_ldap
      
 
    ejabberd can map LDAP attributes to vCard fields. This behaviour is
 implemented in the mod_vcard_ldap module. This module does not depend on the
 authentication method (see 3.2.5).
    The mod_vcard_ldap module has
@@ -2719,44 +2665,44 @@ attributes. The pattern variables "%s" will be sequentially replaced
 with the values of LDAP attributes from List_of_LDAP_attributes,
 "%u" will be replaced with the user part of a JID, and "%d"
 will be replaced with the domain part of a JID. The default is:
-
      [{"NICKNAME", "%u", []},
-   {"FN", "%s", ["displayName"]},
-   {"LAST", "%s", ["sn"]},
-   {"FIRST", "%s", ["givenName"]},
-   {"MIDDLE", "%s", ["initials"]},
-   {"ORGNAME", "%s", ["o"]},
-   {"ORGUNIT", "%s", ["ou"]},
-   {"CTRY", "%s", ["c"]},
-   {"LOCALITY", "%s", ["l"]},
-   {"STREET", "%s", ["street"]},
-   {"REGION", "%s", ["st"]},
-   {"PCODE", "%s", ["postalCode"]},
-   {"TITLE", "%s", ["title"]},
-   {"URL", "%s", ["labeleduri"]},
-   {"DESC", "%s", ["description"]},
-   {"TEL", "%s", ["telephoneNumber"]},
-   {"EMAIL", "%s", ["mail"]},
-   {"BDAY", "%s", ["birthDay"]},
-   {"ROLE", "%s", ["employeeType"]},
-   {"PHOTO", "%s", ["jpegPhoto"]}]
+
    [{"NICKNAME", "%u", []},
+ {"FN", "%s", ["displayName"]},
+ {"LAST", "%s", ["sn"]},
+ {"FIRST", "%s", ["givenName"]},
+ {"MIDDLE", "%s", ["initials"]},
+ {"ORGNAME", "%s", ["o"]},
+ {"ORGUNIT", "%s", ["ou"]},
+ {"CTRY", "%s", ["c"]},
+ {"LOCALITY", "%s", ["l"]},
+ {"STREET", "%s", ["street"]},
+ {"REGION", "%s", ["st"]},
+ {"PCODE", "%s", ["postalCode"]},
+ {"TITLE", "%s", ["title"]},
+ {"URL", "%s", ["labeleduri"]},
+ {"DESC", "%s", ["description"]},
+ {"TEL", "%s", ["telephoneNumber"]},
+ {"EMAIL", "%s", ["mail"]},
+ {"BDAY", "%s", ["birthDay"]},
+ {"ROLE", "%s", ["employeeType"]},
+ {"PHOTO", "%s", ["jpegPhoto"]}]
 
    ldap_search_fields
    This option
 defines the search form and the LDAP attributes to search within. The format
 is: [Name, Attribute, ...]. Name is the name of a search form
 field which will be automatically translated by using the translation
 files (see msgs/*.msg for available words). Attribute is the
 LDAP attribute or the pattern "%u". The default is:
-
      [{"User", "%u"},
-   {"Full Name", "displayName"},
-   {"Given Name", "givenName"},
-   {"Middle Name", "initials"},
-   {"Family Name", "sn"},
-   {"Nickname", "%u"},
-   {"Birthday", "birthDay"},
-   {"Country", "c"},
-   {"City", "l"},
-   {"Email", "mail"},
-   {"Organization Name", "o"},
-   {"Organization Unit", "ou"}]
+
    [{"User", "%u"},
+ {"Full Name", "displayName"},
+ {"Given Name", "givenName"},
+ {"Middle Name", "initials"},
+ {"Family Name", "sn"},
+ {"Nickname", "%u"},
+ {"Birthday", "birthDay"},
+ {"Country", "c"},
+ {"City", "l"},
+ {"Email", "mail"},
+ {"Organization Name", "o"},
+ {"Organization Unit", "ou"}]
 
    ldap_search_reported
    This option
 defines which search fields should be reported. The format is:
 [Name, vCard_Name, ...]. Name is the name of a search form
@@ -2764,98 +2710,97 @@ field which will be automatically translated by using the translation
 files (see msgs/*.msg for available words). vCard_Name is the
 vCard field name defined in the ldap_vcard_map option. The default
 is:
-
      [{"Full Name", "FN"},
-   {"Given Name", "FIRST"},
-   {"Middle Name", "MIDDLE"},
-   {"Family Name", "LAST"},
-   {"Nickname", "NICKNAME"},
-   {"Birthday", "BDAY"},
-   {"Country", "CTRY"},
-   {"City", "LOCALITY"},
-   {"Email", "EMAIL"},
-   {"Organization Name", "ORGNAME"},
-   {"Organization Unit", "ORGUNIT"}]
+
    [{"Full Name", "FN"},
+ {"Given Name", "FIRST"},
+ {"Middle Name", "MIDDLE"},
+ {"Family Name", "LAST"},
+ {"Nickname", "NICKNAME"},
+ {"Birthday", "BDAY"},
+ {"Country", "CTRY"},
+ {"City", "LOCALITY"},
+ {"Email", "EMAIL"},
+ {"Organization Name", "ORGNAME"},
+ {"Organization Unit", "ORGUNIT"}]
 
    Examples:
 
    • 
 
      Let’s say ldap.example.org is the name of our LDAP server. We have
 users with their passwords in "ou=Users,dc=example,dc=org" directory.
 Also we have addressbook, which contains users emails and their additional
 infos in "ou=AddressBook,dc=example,dc=org" directory. Corresponding
-authentication section should looks like this:
        %% authentication method
-  {auth_method, ldap}.
-  %% DNS name of our LDAP server
-  {ldap_servers, ["ldap.example.org"]}.
-  %% We want to authorize users from 'shadowAccount' object class only
-  {ldap_filter, "(objectClass=shadowAccount)"}.
+authentication section should looks like this:
      %% authentication method
+{auth_method, ldap}.
+%% DNS name of our LDAP server
+{ldap_servers, ["ldap.example.org"]}.
+%% We want to authorize users from 'shadowAccount' object class only
+{ldap_filter, "(objectClass=shadowAccount)"}.
 
      Now we want to use users LDAP-info as their vCards. We have four attributes
 defined in our LDAP schema: "mail" — email address, "givenName"
 — first name, "sn" — second name, "birthDay" — birthday.
-Also we want users to search each other. Let’s see how we can set it up:
        {modules,
-    ...
-    {mod_vcard_ldap,
-     [
-      %% We use the same server and port, but want to bind anonymously because
-      %% our LDAP server accepts anonymous requests to
-      %% "ou=AddressBook,dc=example,dc=org" subtree.
-      {ldap_rootdn, ""},
-      {ldap_password, ""},
-      %% define the addressbook's base
-      {ldap_base, "ou=AddressBook,dc=example,dc=org"},
-      %% uidattr: user's part of JID is located in the "mail" attribute
-      %% uidattr_format: common format for our emails
-      {ldap_uids, [{"mail","%u@mail.example.org"}]},
-      %% We have to define empty filter here, because entries in addressbook does not
-      %% belong to shadowAccount object class
-      {ldap_filter, ""},
-      %% Now we want to define vCard pattern
-      {ldap_vcard_map,
-       [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
-        {"FIRST", "%s", ["givenName"]},
-        {"LAST", "%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"}]}
-    ]}
-    ...
-  }.
+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
+      {"FIRST", "%s", ["givenName"]},
+      {"LAST", "%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 an existence of the user before
 searching his info in LDAP.
    • ldap_vcard_map example:
-
        {ldap_vcard_map,
-   [{"NICKNAME", "%u", []},
-    {"FN", "%s", ["displayName"]},
-    {"CTRY", "Russia", []},
-    {"EMAIL", "%u@%d", []},
-    {"DESC", "%s\n%s", ["title", "description"]}
-   ]},
+
      {ldap_vcard_map,
+ [{"NICKNAME", "%u", []},
+  {"FN", "%s", ["displayName"]},
+  {"CTRY", "Russia", []},
+  {"EMAIL", "%u@%d", []},
+  {"DESC", "%s\n%s", ["title", "description"]}
+ ]},
 
    • ldap_search_fields example:
-
        {ldap_search_fields,
-   [{"User", "uid"},
-    {"Full Name", "displayName"},
-    {"Email", "mail"}
-   ]},
+
      {ldap_search_fields,
+ [{"User", "uid"},
+  {"Full Name", "displayName"},
+  {"Email", "mail"}
+ ]},
 
    • ldap_search_reported example:
-
        {ldap_search_reported,
-   [{"Full Name", "FN"},
-    {"Email", "EMAIL"},
-    {"Birthday", "BDAY"},
-    {"Nickname", "NICKNAME"}
-   ]},
-
    
-
    3.3.25  mod_version
    
-
+
    {ldap_search_reported,
+ [{"Full Name", "FN"},
+  {"Email", "EMAIL"},
+  {"Birthday", "BDAY"},
+  {"Nickname", "NICKNAME"}
+ ]},
+
      
    
+
    3.3.25  mod_version
      
 
    This module implements Software Version (XEP-0092). Consequently, it
 answers ejabberd’s version when queried.
    Options:
 
    
@@ -2863,12 +2808,10 @@ answers ejabberd’s version when queried.
    Options:
 The default value is true.
 
    iqdisc
     This specifies 
 the processing discipline for Software Version (jabber:iq:version) IQ queries (see section 3.3.2).
-
    
-
    Chapter 4  Managing an ejabberd server
    
-
    4.1  ejabberdctl
    
-
    
-
    4.1.1  Commands
    
-
    The ejabberdctl command line administration script allows to start, stop and perform 
+
      
    
+
    Chapter 4  Managing an ejabberd server
      
      
    
+
    4.1  ejabberdctl
      
      
    
+
    4.1.1  Commands
      
    The ejabberdctl command line administration script allows to start, stop and perform 
 many other administrative tasks in a local or remote ejabberd server.
    When ejabberdctl is executed without any parameter,
 it displays the available options. If there isn’t an ejabberd server running, 
 the available parameters are:
@@ -2900,9 +2843,8 @@ error is represented by 1,
 and other codes may be used for specifical results.
 This can be used by other scripts to determine automatically
 if a command succedded or failed,
-for example using: echo $?
    
-
    4.1.2  Erlang runtime system
    
-
    ejabberd is an Erlang/OTP application that runs inside an Erlang runtime system.
+for example using: echo $?
      
    
+
    4.1.2  Erlang runtime system
      
    ejabberd is an Erlang/OTP application that runs inside an Erlang runtime system.
 This system is configured using environment variables and command line parameters.
 The ejabberdctl administration script uses many of those possibilities.
 You can configure some of them with the file ejabberdctl.cfg, 
@@ -2964,9 +2906,8 @@ Starts the Erlang system detached from the system console.
 	Open an Erlang shell in a remote Erlang node.
 
    
 Note that some characters need to be escaped when used in shell scripts, for instance " and {}.
-You can find other options in the Erlang manual page (erl -man erl).
    
-
    4.2  Web Admin
    
-
+You can find other options in the Erlang manual page (erl -man erl).
      
    
+
    4.2  Web Admin
      
 
    The ejabberd Web Admin allows to administer most of ejabberd using a web browser.
    This feature is enabled by default:
 a ejabberd_http listener with the option web_admin (see
 section 3.1.3) is included in the listening ports. Then you can open 
@@ -2998,44 +2939,41 @@ username ‘admin@example.net’ to administer all virtual ho
 URL). If you log in with ‘admin@example.com’ on
    
  http://example.org:5280/admin/server/example.com/ you can only
 administer the virtual host example.com.
-
      ...
-  {acl, admins, {user, "admin", "example.net"}}.
-  {host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}.
-  {access, configure, [{allow, admins}]}.
+
    {acl, admins, {user, "admin", "example.net"}}.
+{host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}.
+{access, configure, [{allow, admins}]}.
+
+{hosts, ["example.org"]}.
+
+{listen,
+ [
   ...
-  {hosts, ["example.org"]}.
+  {5280, ejabberd_http, [http_poll, web_admin]},
   ...
-  {listen,
-   [...
-    {5280, ejabberd_http, [http_poll, web_admin]},
-    ...
-   ]
-  }.
+ ]}.
 
  • For security reasons, you can serve the Web Admin on a secured
 connection, on a port differing from the HTTP Polling interface, and bind it
 to the internal LAN IP. The Web Admin will be accessible by pointing your
 web browser to https://192.168.1.1:5280/admin/:
-
      ...
-  {hosts, ["example.org"]}.
+
    +{hosts, ["example.org"]}.
+
+{listen,
+ [
   ...
-  {listen,
-   [...
-    {5270, ejabberd_http,    [http_poll]},
-    {5280, ejabberd_http,    [web_admin, {ip, {192, 168, 1, 1}},
-                              tls, {certfile, "/usr/local/etc/server.pem"}]},
-    ...
-   ]
-  }.
-
    • 
-
    4.3  Ad-hoc Commands
    
-
    If you enable mod_configure and mod_adhoc,
+  {5270, ejabberd_http,    [http_poll]},
+  {5280, ejabberd_http,    [web_admin, {ip, {192, 168, 1, 1}},
+                            tls, {certfile, "/usr/local/etc/server.pem"}]},
+  ...
+ ]}.
+
      
    
+
    4.3  Ad-hoc Commands
      
    If you enable mod_configure and mod_adhoc,
 you can perform several administrative tasks in ejabberd
 with a Jabber client.
 The client must support Ad-Hoc Commands (XEP-0050),
 and you must login in the Jabber server with
-an account with proper privileges.
    
-
    4.4  Change Computer Hostname
    
-
    ejabberd uses the distributed Mnesia database. 
+an account with proper privileges.
      
    
+
    4.4  Change Computer Hostname
      
    ejabberd uses the distributed Mnesia database. 
 Being distributed, Mnesia enforces consistency of its file,
 so it stores the name of the Erlang node in it.
 The name of an Erlang node includes the hostname of the computer.
@@ -3050,22 +2988,20 @@ you must follow these instructions:
 
    	
  • In the new server, restore the backup file using the Web Admin or ejabberdctl.
 	For example:
 
    ejabberdctl restore /tmp/ejabberd-oldhost.backup
-
    • 
-
    Chapter 5  Securing ejabberd
    
-
    5.1  Firewall Settings
    
-
+

    +

    Chapter 5  Securing ejabberd

    +

    5.1  Firewall Settings

    You need to take the following TCP ports in mind when configuring your firewall:

    - +
    PortDescription
    PortDescription
    5222Standard port for Jabber/XMPP client connections, plain or STARTTLS.
    5223Standard port for Jabber client connections using the old SSL method.
    5269Standard port for Jabber/XMPP server connections.
    4369Port used by EPMD for communication between Erlang nodes.
    port rangeUsed for connections between Erlang nodes. This range is configurable.
    -
    -

    5.2  epmd

    -

    epmd (Erlang Port Mapper Daemon) +

    +

    5.2  epmd

    epmd (Erlang Port Mapper Daemon) is a small name server included in Erlang/OTP and used by Erlang programs when establishing distributed Erlang communications. ejabberd needs epmd to use ejabberdctl and also when clustering ejabberd nodes. @@ -3088,9 +3024,8 @@ the nodes communicate directly. The ports used in this case are random. You can limit the range of ports when starting Erlang with a command-line parameter, for example: 

    erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
-
    -

    5.3  Erlang Cookie

    -

    The Erlang cookie is a string with numbers and letters. +

    +

    5.3  Erlang Cookie

    The Erlang cookie is a string with numbers and letters. An Erlang node reads the cookie at startup from the command-line parameter -setcookie or from a cookie file. Two Erlang nodes communicate only if they have the same cookie. @@ -3102,9 +3037,8 @@ However, the cookie system is not ultimately effective to prevent unauthorized access or intrusion to an Erlang node. The communication between Erlang nodes are not encrypted, so the cookie could be read sniffing the traffic on the network. -The recommended way to secure the Erlang node is to block the port 4369.

    -

    5.4  Erlang node name

    -

    An Erlang node may have a node name. +The recommended way to secure the Erlang node is to block the port 4369.

    +

    5.4  Erlang node name

    An Erlang node may have a node name. The name can be short (if indicated with the command-line parameter -sname) or long (if indicated with the parameter -name). Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.

    Using the option -sname instead of -name is a simple method @@ -3112,12 +3046,10 @@ to difficult unauthorized access to your Erlang node. However, it is not ultimately effective to prevent access to the Erlang node, because it may be possible to fake the fact that you are on another network using a modified version of Erlang epmd. -The recommended way to secure the Erlang node is to block the port 4369.

    -

    Chapter 6  Clustering

    - -

    -

    6.1  How it Works

    - +The recommended way to secure the Erlang node is to block the port 4369.

    +

    Chapter 6  Clustering

    +

    +

    6.1  How it Works

    A Jabber domain is served by one or more ejabberd nodes. These nodes can be run on different machines that are connected via a network. They all must have the ability to connect to port 4369 of all another nodes, and must @@ -3130,35 +3062,30 @@ router,

  • local router,
  • session manager,
  • s2s manager. -
    • -

    6.1.1  Router

    - +

    +

    6.1.1  Router

    This module is the main router of Jabber packets on each node. It routes them based on their destination’s domains. It uses a global routing table. The domain of the packet’s destination is searched in the routing table, and if it is found, the packet is routed to the -appropriate process. If not, it is sent to the s2s manager.

    -

    6.1.2  Local Router

    - +appropriate process. If not, it is sent to the s2s manager.

    +

    6.1.2  Local Router

    This module routes packets which have a destination domain equal to one of this server’s host names. If the destination JID has a non-empty user part, it is routed to the session manager, otherwise it is processed depending -on its content.

    -

    6.1.3  Session Manager

    - +on its content.

    +

    6.1.3  Session Manager

    This module routes packets to local users. It looks up to which user resource a packet must be sent via a presence table. Then the packet is either routed to the appropriate c2s process, or stored in offline -storage, or bounced back.

    -

    6.1.4  s2s Manager

    - +storage, or bounced back.

    +

    6.1.4  s2s Manager

    This module routes packets to other Jabber servers. First, it checks if an opened s2s connection from the domain of the packet’s source to the domain of the packet’s destination exists. If that is the case, the s2s manager routes the packet to the process -serving this connection, otherwise a new connection is opened.

    -

    6.2  Clustering Setup

    - +serving this connection, otherwise a new connection is opened.

    +

    6.2  Clustering Setup

    Suppose you already configured ejabberd on one machine named (first), and you need to setup another one to make an ejabberd cluster. Then do following steps:

    1. @@ -3191,31 +3118,26 @@ and ‘access’ options — they will be taken from first, and mod_muc and mod_irc should be enabled only on one machine in the cluster).

    You can repeat these steps for other machines supposed to serve this -domain.

    -

    6.3  Service Load-Balancing

    -

    6.3.1  Components Load-Balancing

    - -

    -

    6.3.2  Domain Load-Balancing Algorithm

    - -

    ejabberd includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.

    The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.

    If you need a different behaviour, you can change the load balancing behaviour with the option domain_balancing. The syntax of the option is the following:

     {domain_balancing, "component.example.com", <balancing_criterium>}.                                   
+domain.
      
    
+
    6.3  Service Load-Balancing
      
+
      
    
+
    6.3.1  Components Load-Balancing
      
      
    
+
    6.3.2  Domain Load-Balancing Algorithm
      
+
    ejabberd includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
    The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.
    If you need a different behaviour, you can change the load balancing behaviour with the option domain_balancing. The syntax of the option is the following:
    {domain_balancing, "component.example.com", <balancing_criterium>}.                                   
 
    Several balancing criteria are available:
 
    • 
 destination: the full JID of the packet to attribute is used.
 
    • source: the full JID of the packet from attribute is used.
 
    • bare_destination: the bare JID (without resource) of the packet to attribute is used.
 
    • bare_source: the bare JID (without resource) of the packet from attribute is used.
-
    If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.
    
-
    6.3.3  Load-Balancing Buckets
    
-
+
    If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.
      
    
+
    6.3.3  Load-Balancing Buckets
      
 
    When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.
    In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the domain_balancing_component_number option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.
    The syntax is the following:
-
        {domain_balancing_component_number, "component.example.com", N}
-
    
-
    Chapter 7  Debugging
    
-
-
    
-
    7.1  Watchdog Alerts
    
-
+
    {domain_balancing_component_number, "component.example.com", N}
+
      
    
+
    Chapter 7  Debugging
      
+
      
    
+
    7.1  Watchdog Alerts
      
 
    ejabberd includes a watchdog mechanism.
 If a process in the ejabberd server consumes too much memory,
 a message is sent to the Jabber accounts defined with the option
@@ -3223,9 +3145,11 @@ a message is sent to the Jabber accounts defined with the option
  in the ejabberd configuration file.
 Example configuration:
 
    {watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
-
    
-
    7.2  Log Files
    
-
    An ejabberd node writes two log files:
+

    To remove watchdog admins, remove them in the option. +To remove all watchdog admins, set the option with an empty list: +

    {watchdog_admins, []}.
+

    +

    7.2  Log Files

    An ejabberd node writes two log files:

    ejabberd.log
    is the ejabberd service log, with the messages reported by ejabberd code
    sasl.log
    is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries) @@ -3241,23 +3165,21 @@ The possible levels are:

    For example, the default configuration is: 

    {loglevel, 4}.
-
    -

    7.3  Debug Console

    -

    The Debug Console is an Erlang shell attached to an already running ejabberd server. +

    +

    7.3  Debug Console

    The Debug Console is an Erlang shell attached to an already running ejabberd server. With this Erlang shell, an experienced administrator can perform complex tasks.

    This shell gives complete control over the ejabberd server, so it is important to use it with extremely care. There are some simple and safe examples in the article -Interconnecting Erlang Nodes

    To exit the shell, close the window or press the keys: control+c control+c.

    -

    Appendix A  Internationalization and Localization

    - +Interconnecting Erlang Nodes

    To exit the shell, close the window or press the keys: control+c control+c.

    +

    Appendix A  Internationalization and Localization

    All built-in modules support the xml:lang attribute inside IQ queries. Figure A.1, for example, shows the reply to the following query: -

      <iq id='5'
-      to='example.org'
-      type='get'
-      xml:lang='ru'>
-    <query xmlns='http://jabber.org/protocol/disco#items'/>
-  </iq>
+
    <iq id='5'
+    to='example.org'
+    type='get'
+    xml:lang='ru'>
+  <query xmlns='http://jabber.org/protocol/disco#items'/>
+</iq>
 
    
 
 discorus.png
@@ -3275,13 +3197,10 @@ Figure A.1, for example, shows the reply to the
 HTTP header ‘Accept-Language: ru’
 
    
 
-
    
-
    Appendix B  Release Notes
    
-
-
    Release notes are available from ejabberd Home Page
    
-
    Appendix C  Acknowledgements
    
-
-Thanks to all people who contributed to this guide:
+
      
    
+
    Appendix B  Release Notes
      
+
    Release notes are available from ejabberd Home Page
      
    
+
    Appendix C  Acknowledgements
      
    Thanks to all people who contributed to this guide:
 
    
-
    Appendix D  Copyright Information
    
-
    Ejabberd Installation and Operation Guide.
    
+
      
    
+
    Appendix D  Copyright Information
      
    Ejabberd Installation and Operation Guide.
    
 Copyright © 2003 — 2008 Process-one
    This document is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
diff --git a/doc/guide.tex b/doc/guide.tex
index 903171e2f..63e164cb8 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -660,31 +660,26 @@ tuple with the following elements:
 
 \ind{modules!ejabberd\_c2s}\ind{modules!ejabberd\_s2s\_in}\ind{modules!ejabberd\_service}\ind{modules!ejabberd\_http}\ind{protocols!XEP-0114: Jabber Component Protocol}
 The available modules, their purpose and the options allowed by each one are:
-\begin{table}[H]
-  \centering
-  \def\arraystretch{1.4}
-  \begin{tabular}{|l|l|p{87mm}|}
-  \hline \texttt{ejabberd\_c2s}& Description& Handles c2s connections.\\
-    \cline{2-3} & Options& \texttt{access}, \texttt{certfile}, \texttt{inet6},
+\begin{description}
+  \titem{\texttt{ejabberd\_c2s}} 
+    Handles c2s connections.\\
+    Options: \texttt{access}, \texttt{certfile}, \texttt{inet6},
     \texttt{ip}, \texttt{max\_stanza\_size}, \texttt{shaper},
     \texttt{starttls}, \texttt{starttls\_required}, \texttt{tls},
-    \texttt{zlib}\\
-  \hline \texttt{ejabberd\_s2s\_in}& Description& Handles incoming s2s
-  connections.\\
-    \cline{2-3} & Options& \texttt{inet6}, \texttt{ip},
-    \texttt{max\_stanza\_size}\\
-  \hline \texttt{ejabberd\_service}& Description& Interacts with 
-    \footahref{http://www.ejabberd.im/tutorials-transports}{external components} 
+    \texttt{zlib}
+  \titem{\texttt{ejabberd\_s2s\_in}}
+    Handles incoming s2s connections.\\
+    Options: \texttt{inet6}, \texttt{ip}, \texttt{max\_stanza\_size}
+  \titem{\texttt{ejabberd\_service}}
+    Interacts with \footahref{http://www.ejabberd.im/tutorials-transports}{external components} 
     (as defined in the Jabber Component Protocol (\xepref{0114}).\\
-    \cline{2-3} & Options& \texttt{access}, \texttt{hosts}, \texttt{inet6},
-    \texttt{ip}, \texttt{shaper}, \texttt{service\_check\_from}\\
-  \hline \texttt{ejabberd\_http}& Description& Handles incoming HTTP
-  connections.\\
-    \cline{2-3} & Options& \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll},
+    Options: \texttt{access}, \texttt{hosts}, \texttt{inet6},
+    \texttt{ip}, \texttt{shaper}, \texttt{service\_check\_from}
+  \titem{\texttt{ejabberd\_http}}
+    Handles incoming HTTP connections.\\
+    Options: \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll},
     \texttt{inet6}, \texttt{ip}, \texttt{request\_handlers}, \texttt{tls}, \texttt{web\_admin}\\
-  \hline
-  \end{tabular}
-\end{table}
+\end{description}
 
 This is a detailed description of each option allowed by the listening modules:
 \begin{description}
@@ -1910,54 +1905,53 @@ Examples:
 \end{verbatim}
 \end{itemize}
 
-\makesubsection{modoverview}{Overview}
+\makesubsection{modoverview}{Modules Overview}
 \ind{modules!overview}\ind{XMPP compliancy}
 
 The following table lists all modules included in \ejabberd{}.
 
 \begin{table}[H]
   \centering
-  \begin{tabular}{|l|l|l|l|}
-    \hline Module & Feature & Dependencies & Needed for XMPP? \\ 
-    \hline \hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) &  & No \\ 
-    \hline \modannounce{} & Manage announcements & recommends \modadhoc{} & No \\ 
-    \hline \modcaps{} &  Request and cache Entity Capabilities (\xepref{0115}) & & No \\ 
-    \hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} & No \\ 
-    \hline \moddisco{} & Service Discovery (\xepref{0030}) &  & No \\ 
-    \hline \modecho{} & Echoes Jabber packets &  & No \\ 
-    \hline \modirc{} & IRC transport &  & No \\ 
-    \hline \modlast{} & Last Activity (\xepref{0012}) &  & No \\ 
-    \hline \modlastodbc{} & Last Activity (\xepref{0012}) & supported database (*) & No \\ 
-    \hline \modmuc{} & Multi-User Chat (\xepref{0045}) &  & No \\ 
-    \hline \modmuclog{} & Multi-User Chat room logging & \modmuc{} & No \\ 
-    \hline \modoffline{} & Offline message storage &  & No \\ 
-    \hline \modofflineodbc{} & Offline message storage & supported database (*) & No \\ 
-    \hline \modprivacy{} & Blocking Communications &  & Yes \\ 
-    \hline \modprivacyodbc{} & Blocking Communications & supported database (*) & Yes \\ 
-    \hline \modprivate{} & Private XML Storage (\xepref{0049}) &  & No \\ 
-    \hline \modprivateodbc{} & Private XML Storage (\xepref{0049}) & supported database (*) & No \\ 
-    \hline \modproxy{} & SOCKS5 Bytestreams (\xepref{0065}) &  & No\\
-    \hline \modpubsub{} & Publish-Subscribe (\xepref{0060}) and PEP (\xepref{0163}) & \modcaps{} & No \\ 
-    \hline \modregister{} & In-Band Registration (\xepref{0077}) &  & No \\ 
-    \hline \modroster{} & Roster management &  & Yes (**) \\ 
-    \hline \modrosterodbc{} & Roster management & supported database (*) & Yes (**) \\ 
-    \hline \modservicelog{} & Copy user messages to logger service &  & No \\ 
-    \hline \modsharedroster{} & Shared roster management & \modroster{} or & No \\ 
-    & & \modrosterodbc{} & \\ 
-    \hline \modstats{} & Statistics Gathering (\xepref{0039}) &  & No \\ 
-    \hline \modtime{} & Entity Time (\xepref{0090}) &  & No \\ 
-    \hline \modvcard{} & vcard-temp (\xepref{0054}) &  & No \\ 
-    \hline \modvcardldap{} & vcard-temp (\xepref{0054}) & LDAP server & No \\ 
-    \hline \modvcardodbc{} & vcard-temp (\xepref{0054}) & supported database (*) & No \\ 
-    \hline \modversion{} & Software Version (\xepref{0092}) &  & No\\
+  \begin{tabular}{|l|l|l|}
+    \hline {\bf Module} & {\bf Feature} & {\bf Dependencies} \\ 
+    \hline
+    \hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) &  \\ 
+    \hline \ahrefloc{modannounce}{\modannounce{}} & Manage announcements & recommends \modadhoc{} \\ 
+    \hline \modcaps{} &  Entity Capabilities (\xepref{0115}) & \\ 
+    \hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} \\ 
+    \hline \ahrefloc{moddisco}{\moddisco{}} & Service Discovery (\xepref{0030}) &  \\ 
+    \hline \ahrefloc{modecho}{\modecho{}} & Echoes Jabber packets &  \\ 
+    \hline \ahrefloc{modirc}{\modirc{}} & IRC transport &  \\ 
+    \hline \ahrefloc{modlast}{\modlast{}} & Last Activity (\xepref{0012}) &  \\ 
+    \hline \ahrefloc{modlast}{\modlastodbc{}} & Last Activity (\xepref{0012}) & supported DB (*) \\ 
+    \hline \ahrefloc{modmuc}{\modmuc{}} & Multi-User Chat (\xepref{0045}) &  \\ 
+    \hline \ahrefloc{modmuclog}{\modmuclog{}} & Multi-User Chat room logging & \modmuc{} \\ 
+    \hline \ahrefloc{modoffline}{\modoffline{}} & Offline message storage (\xepref{0160}) &  \\ 
+    \hline \ahrefloc{modoffline}{\modofflineodbc{}} & Offline message storage (\xepref{0160}) & supported DB (*) \\ 
+    \hline \ahrefloc{modprivacy}{\modprivacy{}} & Blocking Communication (XMPP IM) &  \\ 
+    \hline \ahrefloc{modprivacy}{\modprivacyodbc{}} & Blocking Communication (XMPP IM) & supported DB (*) \\ 
+    \hline \ahrefloc{modprivate}{\modprivate{}} & Private XML Storage (\xepref{0049}) &  \\ 
+    \hline \ahrefloc{modprivate}{\modprivateodbc{}} & Private XML Storage (\xepref{0049}) & supported DB (*) \\ 
+    \hline \ahrefloc{modproxy}{\modproxy{}} & SOCKS5 Bytestreams (\xepref{0065}) &  \\
+    \hline \ahrefloc{modpubsub}{\modpubsub{}} & Pub-Sub (\xepref{0060}), PEP (\xepref{0163}) & \modcaps{} \\ 
+    \hline \ahrefloc{modregister}{\modregister{}} & In-Band Registration (\xepref{0077}) &  \\ 
+    \hline \ahrefloc{modroster}{\modroster{}} & Roster management (XMPP IM) &  \\ 
+    \hline \ahrefloc{modroster}{\modrosterodbc{}} & Roster management (XMPP IM) & supported DB (*) \\ 
+    \hline \ahrefloc{modservicelog}{\modservicelog{}} & Copy user messages to logger service &  \\ 
+    \hline \ahrefloc{modsharedroster}{\modsharedroster{}} & Shared roster management & \modroster{} or \\ 
+    & & \modrosterodbc\\ 
+    \hline \ahrefloc{modstats}{\modstats{}} & Statistics Gathering (\xepref{0039}) &  \\ 
+    \hline \ahrefloc{modtime}{\modtime{}} & Entity Time (\xepref{0090}) &  \\ 
+    \hline \ahrefloc{modvcard}{\modvcard{}} & vcard-temp (\xepref{0054}) &  \\ 
+    \hline \ahrefloc{modvcardldap}{\modvcardldap{}} & vcard-temp (\xepref{0054}) & LDAP server \\ 
+    \hline \ahrefloc{modvcard}{\modvcardodbc{}} & vcard-temp (\xepref{0054}) & supported DB (*) \\ 
+    \hline \ahrefloc{modversion}{\modversion{}} & Software Version (\xepref{0092}) &  \\
     \hline
   \end{tabular}
 \end{table}
 
 \begin{itemize}
-\item (*) For a list of supported databases, see section~\ref{database}.
-\item (**) This module or a similar one with another database backend is needed for
-XMPP compliancy.
+\item (*) This module requires a supported database. For a list of supported databases, see section~\ref{database}.
 \end{itemize}
 
 You can see which database backend each module needs by looking at the suffix:
@@ -3637,7 +3631,7 @@ You need to take the following TCP ports in mind when configuring your firewall:
 \begin{table}[H]
   \centering
   \begin{tabular}{|l|l|}
-    \hline Port& Description\\
+    \hline {\bf Port} & {\bf Description} \\
     \hline \hline 5222& Standard port for Jabber/XMPP client connections, plain or STARTTLS.\\
     \hline 5223& Standard port for Jabber client connections using the old SSL method.\\
     \hline 5269& Standard port for Jabber/XMPP server connections.\\