From 3c3cd099dea0f20b9454c7b1176376da0746ba35 Mon Sep 17 00:00:00 2001 From: Badlop Date: Wed, 23 Sep 2009 15:28:53 +0000 Subject: =?UTF-8?q?Replace=20several=20mentions=20of=20Jabber=20to=20XMPP?= =?UTF-8?q?=20(thanks=20to=20Nicolas=20V=C3=A9rit=C3=A9)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit SVN Revision: 2613 --- doc/guide.html | 94 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 47 insertions(+), 47 deletions(-) (limited to 'doc/guide.html') diff --git a/doc/guide.html b/doc/guide.html index 3b9464c1e..2421bc16a 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -109,7 +109,7 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;}
  • 2.4.7  Specific Notes for Sun Solaris
  • 2.4.8  Specific Notes for Microsoft Windows
    • -
  • 2.5  Create a Jabber Account for Administration +
  • 2.5  Create a XMPP Account for Administration
  • 2.6  Upgrading ejabberd
  • Chapter 3  Configuring ejabberd @@ -385,7 +385,7 @@ To get the full list run the command: See section 3.2 for more information.

    --enable-full-xml
    Enable the use of XML based optimisations. 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
    + Use this option only if you are sure your XMPP clients include a fully compliant XML parser.

    --disable-transient-supervisors
    Disable the use of Erlang/OTP supervision for transient processes.

    2.4.4  Install

    @@ -503,22 +503,22 @@ 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 XMPP Account for Administration

    You need a XMPP 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: +Register a XMPP account on your ejabberd server, for example admin1@example.org. +There are two ways to register a XMPP 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.18). +
      3. Using a XMPP client and In-Band Registration (see section 3.3.18).
      -
    2. Edit the ejabberd configuration file to give administration rights to the Jabber account you created: +
    3. Edit the ejabberd configuration file to give administration rights to the XMPP account you created: 
      {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. +You can grant administrative privileges to many XMPP accounts, +and also to accounts in other XMPP servers.
    4. Restart ejabberd to load the new configuration.
    5. Open the Web Admin (http://server:port/admin/) in your favourite browser. Make sure to enter the full JID as username (in this @@ -715,8 +715,8 @@ This option enables HTTP Binding (JWChat (check the tutorials to install JWChat with ejabberd and an embedded local web server @@ -726,8 +726,8 @@ This option enables HTTP Polling (JWChat.

      The maximum period of time to keep a client session active without an incoming POST request can be configured with the global option http_poll_timeout. The default value is five minutes. @@ -798,7 +798,7 @@ Define properties to use for DNS resolving. Allowed Properties are: timeout in seconds which default value is 10 and retries which default value is 2.

      {s2s_default_policy, allow|deny}
      -The default policy for incoming and outgoing s2s connections to other Jabber servers. +The default policy for incoming and outgoing s2s connections to other XMPP servers. The default value is allow.
      {{s2s_host, Host}, allow|deny}
      Defines if incoming and outgoing s2s connections with a specific remote host are allowed or denied. @@ -859,7 +859,7 @@ on port 5223 (SSL, IP 192.168.0.1 and fdca:8ab6:a243:75ef::1) and denied for the user called ‘bad’.
    6. s2s connections are listened for on port 5269 (all IPv4 addresses) with STARTTLS for secured traffic enabled. -Incoming and outgoing connections of remote Jabber servers are denied, +Incoming and outgoing connections of remote XMPP servers are denied, only two servers can connect: "jabber.example.org" and "example.com".
    7. Port 5280 is serving the Web Admin and the HTTP Polling service in all the IPv4 addresses. Note @@ -957,7 +957,7 @@ you have to make the transports log and do XDB by themselves: </log> <!-- - Some Jabber server implementations do not provide + Some XMPP server implementations do not provide XDB services (for example, jabberd2 and ejabberd). xdb_file.so is loaded in to handle all XDB requests. --> @@ -1170,10 +1170,10 @@ can be either a number, or infinity. The default value is infinity.

      The syntax is:

      {access, max_user_sessions, [ {MaxNumber, ACLName}, ...]}.

      This example limits the number of sessions per user to 5 for all users, and to 10 for admins: 

      {access, max_user_sessions, [{10, admin}, {5, all}]}.
-

      -

      Several connections to a remote Jabber server with ACL

      +

      +

      Several connections to a remote XMPP server with ACL

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

      The syntax is:

      {access, max_s2s_connections, [ {MaxNumber, ACLName}, ...]}.

      Examples: @@ -1202,7 +1202,7 @@ To define a shaper named ‘normal’ with traffic speed limi

      8. 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 does not support +can be seen by XMPP clients. If a XMPP client does not support xml:lang, the specified language is used.

      The option syntax is:

      {language, Language}.

      The default value is en. In order to take effect there must be a translation file @@ -1794,7 +1794,7 @@ all entries end with a comma: mod_capsEntity Capabilities (XEP-0115)  mod_configureServer configuration using Ad-Hocmod_adhoc mod_discoService Discovery (XEP-0030)  -mod_echoEchoes Jabber packets  +mod_echoEchoes XMPP stanzas  mod_ircIRC transport  mod_lastLast Activity (XEP-0012)  mod_last_odbcLast Activity (XEP-0012)supported DB (*) @@ -1908,7 +1908,7 @@ the "@HOST@" keyword must be used:

      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 -Jabber client either using Ad-hoc commands +XMPP client either using Ad-hoc commands or sending messages to specific JIDs.

      The Ad-hoc commands are listed in the Server Discovery. For this feature to work, mod_adhoc must be enabled.

      The specific JIDs where messages can be sent are listed bellow. The first JID in each entry will apply only to the specified virtual host @@ -1975,9 +1975,9 @@ disabled for instances of ejabberd with hundreds of thousands users.

      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 +XMPP clients. Note that ejabberd has no modules with support for the superseded Jabber Browsing (XEP-0011) and Agent Information -(XEP-0094). Accordingly, Jabber clients need to have support for +(XEP-0094). Accordingly, XMPP clients need to have support for the newer Service Discovery protocol if you want them be able to discover the services you offer.

      Options:

      @@ -2043,9 +2043,9 @@ and admin addresses for both the main server and the vJUD service: ]}.

      3.3.5  mod_echo

      -

      This module simply echoes any Jabber +

      This module simply echoes any XMPP packet back to the sender. This mirror can be of interest for -ejabberd and Jabber client debugging.

      Options: +ejabberd and XMPP client debugging.

      Options:

      {host, HostName}
      This option defines the Jabber ID of the @@ -2088,7 +2088,7 @@ resource at which this service will be hosted.

      To use HTTP-Binding, enable

      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, +it is used by XMPP clients that support XMPP over Bosh.

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

      {listen, 
@@ -2180,10 +2180,10 @@ To use this module you must enable it:
 servers.
      End user information:
 
 
      • 
-A Jabber client with ‘groupchat 1.0’ support or Multi-User
+A XMPP client with ‘groupchat 1.0’ support or Multi-User
 Chat support (XEP-0045) is necessary to join IRC channels.
 
      • An IRC channel can be joined in nearly the same way as joining a
-Jabber Multi-User Chat room. The difference is that the room name will
+XMPP Multi-User Chat room. The difference is that the room name will
 be ‘channel%irc.example.org’ in case irc.example.org is
 the IRC server hosting ‘channel’. And of course the host should point
 to the IRC transport instead of the Multi-User Chat service.
@@ -2193,7 +2193,7 @@ to the IRC transport instead of the Multi-User Chat service.
  to nickserver!irc.example.org@irc.jabberserver.org.
 
      • The IRC transport provides Ad-Hoc Commands (XEP-0050)
 to join a channel, and to set custom IRC username and encoding.
-
      • When using a popular Jabber server, it can occur that no
+
      • When using a popular XMPP server, it can occur that no
 connection can be achieved with some IRC servers because they limit the
 number of conections from one IP.
 
      Options:
@@ -2258,7 +2258,7 @@ Sending public and private messages to room occupants.
 
      The MUC service allows any Jabber ID to register a nickname,
 so nobody else can use that nickname in any room in the MUC service.
 To register a nickname, open the Service Discovery in your
-Jabber client and register in the MUC service.
      This module supports clustering and load
+XMPP client and register in the MUC service.
      This module supports clustering and load
 balancing. One module can be started per cluster node. Rooms are
 distributed at creation time on all available MUC module
 instances. The multi-user chat module is clustered but the rooms
@@ -2349,7 +2349,7 @@ discarded. A good value for this option is 4 seconds.
      {default_room_options, [ {OptionName, OptionValue}, ...]}
      This module option allows to define the desired default room options. Note that the creator of a room can modify the options of his room -at any time using a Jabber client with MUC capability. +at any time using a XMPP client with MUC capability. The available room options and the default values are:
      {allow_change_subj, true|false}
      Allow occupants to change the subject. @@ -2386,7 +2386,7 @@ In the first example everyone is allowed to use the Multi-User Chat service. Everyone will also be able to create new rooms but only the user admin@example.org is allowed to administrate any room. In this example he is also a global administrator. When admin@example.org -sends a message such as ‘Tomorrow, the Jabber server will be moved +sends a message such as ‘Tomorrow, the XMPP server will be moved 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 @@ -2471,7 +2471,7 @@ the newly created rooms have by default those options.

      3.3.11  mod_muc_log

      This module enables optional logging of Multi-User Chat (MUC) public conversations to HTML. Once you enable this module, users can join a room using a MUC capable -Jabber client, and if they have enough privileges, they can request the +XMPP client, and if they have enough privileges, they can request the configuration form in which they can set the option to enable room logging.

      Features:

      • Room details are added on top of each page: room title, JID, @@ -2650,7 +2650,7 @@ and if a client does not answer to the ping in less than 32 seconds, its connect

        3.3.14  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: +their XMPP client, they will be able to:

        • Retrieving one’s privacy lists. @@ -2678,7 +2678,7 @@ the processing discipline for Blocking Communication (jabber:iq:privacy

          3.3.15  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 +Using this method, XMPP entities can store private data on the server and retrieve it whenever necessary. The data stored might be anything, as long as it is valid XML. One typical usage for this namespace is the server-side storage of client-specific preferences; another is Bookmark Storage (XEP-0048). @@ -2818,7 +2818,7 @@ with ODBC usage:

          3.3.18  mod_register

          This module adds support for In-Band Registration (XEP-0077). This protocol -enables end users to use a Jabber client to: +enables end users to use a XMPP client to:

          • Register a new account on the server.
          • Change the password from an existing account on the server. @@ -2922,7 +2922,7 @@ Important: if you use mod_shared_roster, you must disable this option. ]}.

            3.3.20  mod_service_log

            -

            This module adds support for logging end user packets via a Jabber message +

            This module adds support for logging end user packets via a XMPP message auditing service such as Bandersnatch. All user packets are encapsulated in a <route/> element and sent to the specified @@ -2957,7 +2957,7 @@ 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 manually add all users to their rosters, and that they cannot permanently delete users from the shared roster groups. -A shared roster group can have members from any Jabber server, +A shared roster group can have members from any XMPP server, but the presence will only be available from and to members of the same virtual host where the group is created.

            Shared roster groups can be edited only via the Web Admin. Each group has a unique identification and the following parameters: @@ -3507,7 +3507,7 @@ ArgumentValue = any()

            The default value is to not define any restriction: []. If at least one restriction is defined, then the frontend expects that authentication information is provided when executing a command. -The authentication information is Username, Hostname and Password of a local Jabber account +The authentication information is Username, Hostname and Password of a local XMPP account that has permission to execute the corresponding command. This means that the account must be registered in the local ejabberd, because the information will be verified. @@ -3613,9 +3613,9 @@ the environment variable EJABBERD_DOC_PATH. See section 4.1.2.

            4.4  Ad-hoc Commands

            If you enable mod_configure and mod_adhoc, you can perform several administrative tasks in ejabberd -with a Jabber client. +with a XMPP client. The client must support Ad-Hoc Commands (XEP-0050), -and you must login in the Jabber server with +and you must login in the XMPP server with an account with proper privileges.

            4.5  Change Computer Hostname

            ejabberd uses the distributed Mnesia database. Being distributed, Mnesia enforces consistency of its file, @@ -3737,7 +3737,7 @@ See section 5.3.

            Chapter 6  Clustering

            6.1  How it Works

            -

            A Jabber domain is served by one or more ejabberd nodes. These nodes can +

            A XMPP 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 have the same magic cookie (see Erlang/OTP documentation, in other words the @@ -3751,7 +3751,7 @@ router,

          • s2s manager.

          6.1.1  Router

          -

          This module is the main router of Jabber packets on each node. It +

          This module is the main router of XMPP 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 @@ -3767,7 +3767,7 @@ 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

          -

          This module routes packets to other Jabber servers. First, it +

          This module routes packets to other XMPP 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 @@ -3858,7 +3858,7 @@ There are some simple and safe examples in the article

          ejabberd includes a watchdog mechanism that may be useful to developers when troubleshooting a problem related to memory usage. If a process in the ejabberd server consumes more memory than the configured threshold, -a message is sent to the Jabber accounts defined with the option +a message is sent to the XMPP accounts defined with the option watchdog_admins in the ejabberd configuration file.

          The syntax is:

          {watchdog_admins, [JID, ...]}.

          The memory consumed is measured in words: -- cgit v1.2.3