From 7a4e0cffe42ad9f499d00698452e1ebdf9d58f3a Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 19 May 2008 09:47:19 +0000 Subject: * doc/guide.html: Updated * doc/features.html: Likewise * doc/dev.html: Likewise * doc/version.tex: Likewise * src/ejabberd.hrl: Version is 2.0.1 SVN Revision: 1337 --- doc/guide.html | 389 ++++++++++++++++++++++++++------------------------------- 1 file changed, 178 insertions(+), 211 deletions(-) (limited to 'doc/guide.html') diff --git a/doc/guide.html b/doc/guide.html index 24cb80fa8..0aeaddbe4 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -6,7 +6,7 @@ - ejabberd 2.0.0 + ejabberd 2.0.1 Installation and Operation Guide @@ -83,7 +83,7 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}


- +
ejabberd 2.0.0
ejabberd 2.0.1
 
Installation and Operation Guide

@@ -162,73 +162,71 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
  • 3.3.3  mod_announce
  • 3.3.4  mod_disco
  • 3.3.5  mod_echo -
  • 3.3.6  mod_http_bind -
  • 3.3.7  mod_http_fileserver -
  • 3.3.8  mod_irc -
  • 3.3.9  mod_last -
  • 3.3.10  mod_muc -
  • 3.3.11  mod_muc_log -
  • 3.3.12  mod_offline -
  • 3.3.13  mod_privacy -
  • 3.3.14  mod_private -
  • 3.3.15  mod_proxy65 -
  • 3.3.16  mod_pubsub -
  • 3.3.17  mod_register -
  • 3.3.18  mod_roster -
  • 3.3.19  mod_service_log -
  • 3.3.20  mod_shared_roster -
  • 3.3.21  mod_stats -
  • 3.3.22  mod_time -
  • 3.3.23  mod_vcard -
  • 3.3.24  mod_vcard_ldap -
  • 3.3.25  mod_version +
  • 3.3.6  mod_irc +
  • 3.3.7  mod_last +
  • 3.3.8  mod_muc +
  • 3.3.9  mod_muc_log +
  • 3.3.10  mod_offline +
  • 3.3.11  mod_privacy +
  • 3.3.12  mod_private +
  • 3.3.13  mod_proxy65 +
  • 3.3.14  mod_pubsub +
  • 3.3.15  mod_register +
  • 3.3.16  mod_roster +
  • 3.3.17  mod_service_log +
  • 3.3.18  mod_shared_roster +
  • 3.3.19  mod_stats +
  • 3.3.20  mod_time +
  • 3.3.21  mod_vcard +
  • 3.3.22  mod_vcard_ldap +
  • 3.3.23  mod_version
    • -
  • Chapter 4  Managing an ejabberd server +
  • Chapter 4  Managing an ejabberd server -
  • Chapter 5  Securing ejabberd +
  • Chapter 5  Securing ejabberd -
  • Chapter 6  Clustering +
  • Chapter 6  Clustering -
  • Chapter 7  Debugging +
  • Chapter 7  Debugging -
  • Appendix A  Internationalization and Localization -
  • Appendix B  Release Notes -
  • Appendix C  Acknowledgements -
  • Appendix D  Copyright Information +
  • Appendix A  Internationalization and Localization +
  • Appendix B  Release Notes +
  • Appendix C  Acknowledgements +
  • Appendix D  Copyright Information

    • Chapter 1  Introduction

    ejabberd is a free and open source instant messaging server written in Erlang.

    ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

    ejabberd is designed to be a rock-solid and feature rich XMPP server.

    ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.

    @@ -342,7 +340,7 @@ as long as your system have all the dependencies.

    +

    Several connections to a remote Jabber server with ACL

    + +

    The special access max_s2s_connections specifies how many +simultaneus S2S connections can be stablished to a specific remote Jabber server. +The default value is 1. +There’s also available the access max_s2s_connections_per_node.

    The syntax is: +

      {access, max_s2s_connections, [{<maxnumber>, <aclname>},
+                                 ...
+                                ]}.
+

    Examples: +

    3.1.6  Shapers

    @@ -1608,6 +1623,9 @@ 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 +queries. The queries are thus process in parallel, but in a +controlled way.
    parallel
    For every packet with this discipline a separate Erlang process is spawned. Consequently, all these packets are processed in parallel. Although spawning of Erlang process has a relatively low cost, this can break @@ -1659,7 +1677,7 @@ message is sent to all registered users. If the user is online and connected to several resources, only the resource with the highest priority will receive the message. If the registered user is not connected, the message will be stored offline in assumption that offline storage -(see section 3.3.12) is enabled. +(see section 3.3.10) is enabled.
    example.org/announce/online (example.org/announce/all-hosts/online)
    The message is sent to all connected users. If the user is online and connected to several resources, all resources will receive the message. @@ -1768,91 +1786,8 @@ of them all? {mod_echo, [{host, "mirror.example.org"}]}, ... ]}. - -

    3.3.6  mod_http_bind

    - -

    This module implements XMPP over Bosh (formerly known as HTTP Binding) -as outlined by XEP-0206. -It extends ejabberd’s built in HTTP service with a configurable -resource at which this service will be hosted.

    To use HTTP-Binding, enable the module: -

    {modules,
- [
-  ...
-  {mod_http_bind, []},
-  ...
-]}.
-

    and add http_bind in the HTTP service. For example: -

    {listen, 
- [
-  ...
-  {5280, ejabberd_http, [
-                         http_bind,
-                         http_poll,
-                         web_admin
-                        ]
-  },
-  ...
-]}.
-

    With this configuration, the module will serve the requests sent to -http://example.org:5280/http-bind/ -Remember that this page is not designed to be used by web browsers, -it is used by Jabber clients that support XMPP over Bosh.

    If you want to set the service in a different URI path or use a different module, -you can configure it manually using the option request_handlers. -For example: -

    {listen, 
- [
-  ...
-  {5280, ejabberd_http, [
-                         {request_handlers, [{["http-bind"], mod_http_bind}]},
-                         http_poll,
-                         web_admin
-                        ]
-  },
-  ...
-]}.
-
    -

    3.3.7  mod_http_fileserver

    - -

    This simple module serves files from the local disk over HTTP.

    Options: -

    -docroot
    -Directory to serve the files. -
    accesslog
    -File to log accesses using an Apache-like format. -No log will be recorded if this option is not specified. -

    This example configuration will serve the files from -the local directory /var/www -in the address http://example.org:5280/pub/archive/. -To use this module you must enable it: -

    {modules,
- [
-  ...
-  {mod_http_fileserver, [
-                         {docroot, "/var/www"}, 
-                         {accesslog, "/var/log/ejabberd/access.log"}
-                        ]
-  },
-  ...
-]}.
-

    And define it as a handler in the HTTP service: -

    {listen, 
- [
-  ...
-  {5280, ejabberd_http, [
-                         ...
-                         {request_handlers, [
-                                             ...
-                                             {["pub", "archive"], mod_http_fileserver},
-                                             ...
-                                            ]
-                         },
-                         ...
-                        ]
-  },
-  ...
-]}.
    -

    3.3.8  mod_irc

    +

    3.3.6  mod_irc

    This module is an IRC transport that can be used to join channels on IRC servers.

    End user information: @@ -1912,7 +1847,7 @@ our domains and on other servers. ... ]}. -

    3.3.9  mod_last

    +

    3.3.7  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 @@ -1922,7 +1857,7 @@ 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.8  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: @@ -1943,7 +1878,7 @@ distributed at creation time on all available MUC module instances. The multi-user chat module is clustered but the room themselves are not clustered nor fault-tolerant: if the node managing a set of rooms goes down, the rooms disappear and they will be recreated -on an available node on first connection attempt.

    Options: +on an available node on first connection attempt.

    Module options:

    host
    This option defines the Jabber ID of the @@ -1964,27 +1899,32 @@ who is allowed to administrate the Multi-User Chat service (the default value is none, which means that only the room creator can administer his room). By sending a message to the service JID, administrators can send service messages that will be displayed in every -active room.
    history_size
    A small history of +active room. +
    history_size
    A small history of the current discussion is sent to users when they enter the room. With this option you can define the number of history messages to keep and send to users joining the room. The value is an integer. Setting the value to 0 disables the history feature and, as a result, nothing is kept in memory. The default value is 20. This value is global and thus affects all rooms on the -server.
    max_users
    This option defines at +server. +
    max_users
    This option defines at the server level, the maximum number of users allowed per MUC room. It can be lowered in each room configuration but cannot be increased in individual MUC room configuration. The default value is -200.
    max_users_admin_threshold
    +200. +
    max_users_admin_threshold
    This option defines the number of MUC admins or owners to allow to enter the room even if the maximum number of allowed users is reached. The default limits -is 5. In most cases this default value is the best setting.
    max_user_conferences
    +is 5. In most cases this default value is the best setting. +
    max_user_conferences
    This option define the maximum number of chat room any given user will be able to join. The default is 10. This option is used to prevent possible abuses. Note that this is a soft limits: Some users can sometime join more conferences -in cluster configurations.
    min_message_interval
    +in cluster configurations. +
    min_message_interval
    This option defines the minimum interval between two messages send by a user in seconds. This option is global and valid for all chat rooms. A decimal value can be used. When this option is not defined, @@ -1993,7 +1933,8 @@ MUC service from users abuses and limit number of messages that will be broadcasted by the service. A good value for this minimum message interval is 0.4 second. If a user tries to send messages faster, an error is send back explaining that the message have been discarded -and describing the reason why the message is not acceptable.
    min_presence_interval
    +and describing the reason why the message is not acceptable. +
    min_presence_interval
    This option defines the minimum of time between presence changes coming from a given user in seconds. This option is global and valid for all chat rooms. A @@ -2005,18 +1946,33 @@ to change its presence more often than the specified interval, the presence is cached by ejabberd and only the last presence is broadcasted to all users in the room after expiration of the interval delay. Intermediate presence packets are silently -discarded. A good value for this option is 4 seconds.
    default_room_options
    This -option allow to define the desired default room options. Obviously, -the room creator can modify the room options at any time. The -available room options are: allow_change_subj, -allow_private_messages, allow_query_users, -allow_user_invites, anonymous, logging, -members_by_default, members_only, -moderated, password, password_protected, -persistent, public, public_list, -title. All of them can be set to true or -false, except password and title which -are strings. +discarded. A good value for this option is 4 seconds. +
    default_room_options
    +This module option allows to define the desired default room options. +Note that the creator of a room can modify the options of his room +at any time using a Jabber client with MUC capability. +The available room options and the default values are: +
    +{allow_change_subj, true}
    Allow occupants to change the subject. +
    {allow_private_messages, true}
    Occupants can send private messages to other occupants. +
    {allow_query_users, true}
    Occupants can send IQ queries to other occupants. +
    {allow_user_invites, false}
    Allow occupants to send invitations. +
    {anonymous, true}
    Occupants are allowed to see the real JIDs of other occupants. +
    {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. +
    {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. +
    {persistent, false}
    The room persists even if the last participant leaves. +
    {public, true}
    The room is public in the list of the MUC service, so it can be discovered. +
    {public_list, true}
    The list of participants is public, without requiring to enter the room. +
    {title, ""}
    A human-readable title of the room. +
    +All of those room options can be set to true or false, +except password and title which are strings, +and max_users that is integer.

    Examples:

    -

    3.3.11  mod_muc_log

    +

    3.3.9  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 @@ -2208,7 +2164,7 @@ top link will be the default <a href="/">Home</a>. ... ]}. -

    3.3.12  mod_offline

    +

    3.3.10  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 @@ -2220,7 +2176,7 @@ 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.11  mod_privacy

    This module implements Blocking Communication (also known as Privacy Rules) as defined in section 10 from XMPP IM. If end users have support for it in @@ -2249,7 +2205,7 @@ 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.12  mod_private

    This module adds support for Private XML Storage (XEP-0049):

    @@ -2262,7 +2218,7 @@ of client-specific preferences; another is Bookmark Storage ( 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.13  mod_proxy65

    This module implements SOCKS5 Bytestreams (XEP-0065). It allows ejabberd to act as a file transfer proxy between two @@ -2318,12 +2274,13 @@ The simpliest configuration of the module: ... ]}. -

    3.3.16  mod_pubsub

    +

    3.3.14  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) -is enabled by default, and requires mod_caps.

    Options: +is enabled in the default ejabberd configuration file, +and it requires mod_caps.

    Options:

    host
    This option defines the Jabber ID of the @@ -2349,7 +2306,7 @@ and is shared by all node plugins. ... ]}. -

    3.3.17  mod_register

    +

    3.3.15  mod_register

    This module adds support for In-Band Registration (XEP-0077). This protocol enables end users to use a Jabber client to: @@ -2370,7 +2327,15 @@ the second string is the message body. list of JIDs which will be notified each time a new account is registered.

    iqdisc
    This specifies the processing discipline for In-Band Registration (jabber:iq:register) IQ queries (see section 3.3.2). -

    Examples: +

    This module reads also another option defined globably for the server: +{registration_timeout, Timeout}. +This option limits the frequency of registration from a given IP or username. +So, a user can’t register a new account from the same IP address or JID during +this number of seconds after previous registration. +Timeout is expressed in seconds, and must be an integer. +To disable this limitation, +instead of an integer put a word like: infinity. +Default value: 600 seconds.

    Examples:

    -

    3.3.18  mod_roster

    +

    3.3.16  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.17  mod_service_log

    This module adds support for logging end user packets via a Jabber message auditing service such as @@ -2449,7 +2416,7 @@ To log all end user packets to the Bandersnatch service running on ... ]}. -

    3.3.20  mod_shared_roster

    +

    3.3.18  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 @@ -2525,7 +2492,7 @@ roster groups as shown in the following table:

    -

    3.3.21  mod_stats

    +

    3.3.19  mod_stats

    This module adds support for Statistics Gathering (XEP-0039). This protocol allows you to retrieve next statistics from your ejabberd deployment: @@ -2558,7 +2525,7 @@ by sending: </query> </iq> -

    3.3.22  mod_time

    +

    3.3.20  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: @@ -2566,7 +2533,7 @@ you are able to discover the time at another entity’s location.

    Opt 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.21  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 @@ -2622,7 +2589,7 @@ and that all virtual hosts will be searched instead of only the current one: ... ]}. -

    3.3.24  mod_vcard_ldap

    +

    3.3.22  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 @@ -2797,7 +2764,7 @@ searching his info in LDAP.

  • ldap_vcard_map
    • -

    3.3.25  mod_version

    +

    3.3.23  mod_version

    This module implements Software Version (XEP-0092). Consequently, it answers ejabberd’s version when queried.

    Options: @@ -2807,10 +2774,10 @@ 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

    +

    Chapter 4  Managing an ejabberd server

    +

    4.1  ejabberdctl

    -

    4.1.1  Commands

    +

    4.1.1  Commands

    The ejabberdctl command line 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, @@ -2838,7 +2805,7 @@ is very high.

    The ejabberdctl script also allows the argument --node NODENAME. This allows to administer a remote node.

    The ejabberdctl administration script can be configured in the file ejabberdctl.cfg. This file provides detailed information about each configurable option.

    -

    4.1.2  Erlang runtime system

    +

    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. @@ -2902,7 +2869,7 @@ Starts the Erlang system detached from the system console.

    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

    +

    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 @@ -2964,14 +2931,14 @@ web browser to https://192.168.1.1:5280/admin/: ] }. -

    4.3  Ad-hoc Commands

    +

    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

    +

    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. @@ -2988,8 +2955,8 @@ you must follow these instructions: 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:

    @@ -3001,7 +2968,7 @@ you must follow these instructions: port rangeUsed for connections between Erlang nodes. This range is configurable.
    -

    5.2  epmd

    +

    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. @@ -3026,7 +2993,7 @@ 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

    +

    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. @@ -3040,7 +3007,7 @@ 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

    +

    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). @@ -3050,10 +3017,10 @@ 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

    +

    Chapter 6  Clustering

    -

    6.1  How it Works

    +

    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 @@ -3068,33 +3035,33 @@ 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

    +

    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

    +

    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

    +

    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

    +

    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 @@ -3129,11 +3096,11 @@ and ‘access’ options — they will be taken from 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  Service Load-Balancing

    +

    6.3.1  Components Load-Balancing

    -

    6.3.2  Domain Load-Balancing Algorithm

    +

    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: @@ -3143,15 +3110,15 @@ domain.

  • 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

    +

    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

    +

    Chapter 7  Debugging

    -

    7.1  Watchdog Alerts

    +

    7.1  Watchdog Alerts

    ejabberd includes a watchdog mechanism. If a process in the ejabberd server consumes too much memory, @@ -3161,7 +3128,7 @@ a message is sent to the Jabber accounts defined with the option Example configuration: 

    {watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
    -

    7.2  Log Files

    +

    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 @@ -3179,13 +3146,13 @@ The possible levels are: For example, the default configuration is: 

    {loglevel, 4}.
    -

    7.3  Debug Console

    +

    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

    +

    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: @@ -3213,10 +3180,10 @@ HTTP header ‘Accept-Language: ru’

    -

    Appendix B  Release Notes

    +

    Appendix B  Release Notes

    Release notes are available from ejabberd Home Page

    -

    Appendix C  Acknowledgements

    +

    Appendix C  Acknowledgements

    Thanks to all people who contributed to this guide:

    -

    Appendix D  Copyright Information

    +

    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 -- cgit v1.2.3