From 7006402cd7d550eaa72b60cd8e8f7bd505852cd6 Mon Sep 17 00:00:00 2001 From: Badlop Date: Wed, 20 Feb 2008 16:04:36 +0000 Subject: [PATCH] * src/ejabberd.hrl: Updated version number * doc/dev.html: Likewise * doc/features.html: Likewise * doc/guide.html: Likewise * doc/version.tex: Likewise * doc/guide.tex: Mentioned the problems about Windows service * doc/guide.html: Likewise SVN Revision: 1203 --- ChangeLog | 9 ++ doc/dev.html | 30 ++--- doc/features.html | 30 ++--- doc/guide.html | 293 ++++++++++++++++++++++++++++++---------------- doc/guide.tex | 4 +- doc/version.tex | 2 +- src/ejabberd.hrl | 2 +- 7 files changed, 234 insertions(+), 136 deletions(-) diff --git a/ChangeLog b/ChangeLog index d443bf8a8..5e8994d77 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,14 @@ 2008-02-20 Badlop + * src/ejabberd.hrl: Updated version number + * doc/dev.html: Likewise + * doc/features.html: Likewise + * doc/guide.html: Likewise + * doc/version.tex: Likewise + + * doc/guide.tex: Mentioned the problems about Windows service + * doc/guide.html: Likewise + * src/msgs/ru.msg: Updated (thanks to Konstantin Khomoutov) * src/msgs/zh.msg: Updated (thanks to Mike Wang and Zhan Caibao) diff --git a/doc/dev.html b/doc/dev.html index 694c2e82a..91c1ae5e8 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/REC-html40/loose.dtd"> -Ejabberd 2.0.0-beta1 Developers Guide +<TITLE>Ejabberd 2.0.0 Developers Guide @@ -49,7 +49,7 @@ TD P{margin:0px;}

-

Ejabberd 2.0.0-beta1 Developers Guide

Alexey Shchepin
+

Ejabberd 2.0.0 Developers Guide

Alexey Shchepin
mailto:alexey@sevcom.net
xmpp:aleksey@jabber.ru

@@ -92,13 +92,13 @@ Kevin Smith, Current maintainer of the Psi project

3  How it Works

diff --git a/doc/features.html b/doc/features.html index 54b333817..dee52f0c7 100644 --- a/doc/features.html +++ b/doc/features.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/REC-html40/loose.dtd"> -Ejabberd 2.0.0-beta1 Feature Sheet +<TITLE>Ejabberd 2.0.0 Feature Sheet @@ -50,7 +50,7 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}

-

Ejabberd 2.0.0-beta1 Feature Sheet

Sander Devrieze
+

Ejabberd 2.0.0 Feature Sheet

Sander Devrieze
mailto:s.devrieze@pandora.be
xmpp:sander@devrieze.dyndns.org

@@ -70,13 +70,13 @@ Peter Saint-André, Executive Director of the Jabber Software Foundation Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
  • Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
  • Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.
  • Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
    • Comprehensive documentation. -
    • Straightforward installers for Linux, Mac OS X, and Windows.
    • Web interface for administration tasks. +
    • Straightforward installers for Linux, Mac OS X, and Windows.
    • Web Administration.
    • Shared Roster Groups.
    • Command line administration tool.
    • Can integrate with existing authentication mechanisms.
    • Capability to send announce messages.
  • Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
    • -Translated in 17 languages.
    • Support for IDNA. +Translated to 24 languages.
    • Support for IDNA.
  • Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
    • Fully XMPP compliant. @@ -97,31 +97,31 @@ Load only the modules you want.
      • SASL and STARTTLS for c2s and s2s connections.
      • STARTTLS and Dialback s2s connections. -
      • Web interface accessible via HTTPS secure access. +
      • Web Admin accessible via HTTPS secure access.
    • Databases
      • -Native MySQL support. +Internal database for fast deployment (Mnesia). +
      • Native MySQL support.
      • Native PostgreSQL support. -
      • Mnesia.
      • ODBC data storage support.
      • Microsoft SQL Server support.
    • Authentication
      • -PAM, LDAP and ODBC.
      • External Authentication script. -
      • Internal Authentication. +Internal Authentication. +
      • PAM, LDAP and ODBC.
      • External Authentication script.
    • Others
      • -Compressing XML streams with Stream Compression (XEP-0138). -
      • Interface with networks such as AIM, ICQ and MSN. +Support for virtual hosting. +
      • Compressing XML streams with Stream Compression (XEP-0138).
      • Statistics via Statistics Gathering (XEP-0039).
      • IPv6 support both for c2s and s2s connections. -
      • Multi-User Chat module with logging.
      • Users Directory based on users vCards. -
      • Publish-Subscribe component. -
      • Support for virtual hosting. -
      • HTTP Polling service. +
      • 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. +
      • 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 d617bed1c..bd17372c6 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -6,7 +6,7 @@ - ejabberd 2.0.0-rc1 + ejabberd 2.0.0 Installation and Operation Guide @@ -83,7 +83,7 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}


    - +
    ejabberd 2.0.0-rc1
    ejabberd 2.0.0
     
    Installation and Operation Guide

    @@ -162,71 +162,73 @@ 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_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 +
  • 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
    • -
  • 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.

    @@ -302,8 +304,10 @@ server and does not require any extra dependencies.

    In *nix systems, remem

    The installer generates desktop shortcuts to start and stop ejabberd.

    The Windows installer also adds ejabberd as a system service, and a shortcut to a debug console for experienced administrators. You can start ejabberd using the shortcut or the Windows service. +Note that the Windows service is a feature still in development, +and for example it doesn’t keep track of changes made manually in ejabberdctl.cfg. If you want ejabberd to be started automatically at boot time, -go to service settings and set ejabberd to be automatic started.

    On a Linux system, if you want ejabberd to start as daemon at boot time, +go to the Windows service settings and set ejabberd to be automatic started.

    On a Linux system, if you want ejabberd to start as daemon at boot time, copy ejabberd.init from the bin directory to something like /etc/init.d/ejabberd (depending on your distribution) and call /etc/inid.d/ejabberd start to start it.

    The ejabberdctl administration script is included in the bin directory. Please refer to the section 4.1 for details about ejabberdctl, @@ -464,7 +468,7 @@ There are two ways to register a Jabber account:

    1. Using ejabberdctl (see section 4.1): 
      % ejabberdctl register admin1 example.org FgT5bk3
-
    2. Using a Jabber client and In-Band Registration (see section 3.3.15). +
    3. Using a Jabber client and In-Band Registration (see section 3.3.17).
  • Edit the ejabberd configuration file to give administration rights to the Jabber account you created: 
      {acl, admins, {user, "admin1", "example.org"}}.
@@ -1632,7 +1636,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.10) is enabled.
+(see section 3.3.12) 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.
@@ -1739,8 +1743,91 @@ 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.6  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: @@ -1800,7 +1887,7 @@ our domains and on other servers. ... ]}.

    • -

    3.3.7  mod_last

    +

    3.3.9  mod_last

    This module adds support for Last Activity (XEP-0012). It can be used to discover when a disconnected user last accessed the server, to know when a @@ -1810,7 +1897,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.8  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: @@ -1988,7 +2075,7 @@ newly created chatrooms have by default those options. ... ]}. -

    3.3.9  mod_muc_log

    +

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

    3.3.10  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 @@ -2108,7 +2195,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.11  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 @@ -2137,7 +2224,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.12  mod_private

    +

    3.3.14  mod_private

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

    @@ -2150,7 +2237,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.13  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 @@ -2206,7 +2293,7 @@ The simpliest configuration of the module: ... ]}. -

    3.3.14  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. @@ -2237,7 +2324,7 @@ and is shared by all node plugins. ... ]}. -

    3.3.15  mod_register

    +

    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: @@ -2299,14 +2386,14 @@ example all In-Band Registration functionality is disabled: ... ]}. -

    3.3.16  mod_roster

    +

    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.17  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 @@ -2337,7 +2424,7 @@ To log all end user packets to the Bandersnatch service running on ... ]}. -

    3.3.18  mod_shared_roster

    +

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

    -

    3.3.19  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: @@ -2446,7 +2533,7 @@ by sending: </query> </iq> -

    3.3.20  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: @@ -2454,7 +2541,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.21  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 @@ -2509,7 +2596,7 @@ and that all virtual hosts will be searched instead of only the current one: ... ]}. -

    3.3.22  mod_vcard_ldap

    +

    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 @@ -2681,7 +2768,7 @@ searching his info in LDAP.

  • ldap_vcard_map
    • -

    3.3.23  mod_version

    +

    3.3.25  mod_version

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

    Options: @@ -2691,10 +2778,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, @@ -2722,7 +2809,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. @@ -2786,7 +2873,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 @@ -2848,14 +2935,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. @@ -2872,8 +2959,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:

    @@ -2885,7 +2972,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. @@ -2910,7 +2997,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. @@ -2924,7 +3011,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). @@ -2934,10 +3021,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 @@ -2952,33 +3039,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 @@ -3013,11 +3100,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: @@ -3027,15 +3114,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, @@ -3045,7 +3132,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 @@ -3063,13 +3150,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: @@ -3098,10 +3185,10 @@ figure A.2 with figure 

    -

    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 diff --git a/doc/guide.tex b/doc/guide.tex index e172448fe..293ed81ac 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -204,8 +204,10 @@ The installer generates desktop shortcuts to start and stop ejabberd. The Windows installer also adds ejabberd as a system service, and a shortcut to a debug console for experienced administrators. You can start ejabberd using the shortcut or the Windows service. +Note that the Windows service is a feature still in development, +and for example it doesn't keep track of changes made manually in ejabberdctl.cfg. If you want ejabberd to be started automatically at boot time, -go to service settings and set ejabberd to be automatic started. +go to the Windows service settings and set ejabberd to be automatic started. On a Linux system, if you want ejabberd to start as daemon at boot time, copy \term{ejabberd.init} from the bin directory to something like \term{/etc/init.d/ejabberd} diff --git a/doc/version.tex b/doc/version.tex index 4a7ddfe7e..bbec028c2 100644 --- a/doc/version.tex +++ b/doc/version.tex @@ -1,2 +1,2 @@ % ejabberd version (automatically generated). -\newcommand{\version}{2.0.0-rc1} +\newcommand{\version}{2.0.0} diff --git a/src/ejabberd.hrl b/src/ejabberd.hrl index 578c99cf3..2820c84fd 100644 --- a/src/ejabberd.hrl +++ b/src/ejabberd.hrl @@ -22,7 +22,7 @@ %-define(ejabberd_debug, true). %-define(DBGFSM, true). --define(VERSION, "2.0.0-rc1"). +-define(VERSION, "2.0.0"). %% --------------------------------- %% Logging mechanism