From 208ec6c076f7aa248d8df6458eabf8c582740a4c Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 11 Aug 2009 11:41:15 +0000 Subject: [PATCH] Update URLs of IETF and XMPP protocol documents SVN Revision: 2455 --- doc/guide.html | 130 +++++++++++++++++++++---------------------- doc/guide.tex | 18 +++--- doc/introduction.tex | 2 +- 3 files changed, 75 insertions(+), 75 deletions(-) diff --git a/doc/guide.html b/doc/guide.html index 59091eb2d..e8cc5922e 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -270,12 +270,12 @@ Internal Authentication.
  • Others @@ -342,13 +342,13 @@ GNU Make
  • Libexpat 1.95 or higher
  • Erlang/OTP R10B-9 or higher. The recommended version is R12B-5. Support for R13 is experimental.
  • 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. +
  • Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional.
  • Erlang mysql library. Optional. For MySQL authentication or storage. See section 3.2.1.
  • Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section 3.2.3.
  • PAM library. Optional. For Pluggable Authentication Modules (PAM). See section 3.1.4.
  • GNU Iconv 1.8 or higher, for the IRC Transport (mod_irc). Optional. Not needed on systems with GNU Libc. See section 3.3.8.
  • ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section 3.1.8. -
  • exmpp 0.9.1 or higher. Optional. For import/export user data with XEP-0227 XML files. +
  • exmpp 0.9.1 or higher. Optional. For import/export user data with XEP-0227 XML files.

    • 2.4.2  Download Source Code

    Released versions of ejabberd are available in the ProcessOne ejabberd downloads page: @@ -681,7 +681,7 @@ Handles incoming s2s connections.
    Options: max_stanza_size

    ejabberd_service
    Interacts with an external component -(as defined in the Jabber Component Protocol (XEP-0114).
    +(as defined in the Jabber Component Protocol (XEP-0114).
    Options: access, hosts, shaper, service_check_from
    ejabberd_stun
    @@ -703,7 +703,7 @@ To define a certificate file specific for a given domain, use the global option This option can be used with ejabberd_service only. It is used to disable control on the from field on packets send by an external components. The option can be either true or -false. The default value is true which conforms to XEP-0114. +false. The default value is true which conforms to XEP-0114.
    {hosts, [Hostnames], [HostOptions]}
    The external Jabber component that connects to this ejabberd_service can serve one or more hostnames. @@ -716,7 +716,7 @@ as seen in an example below.
    captcha
    Simple web page that allows a user to fill a CAPTCHA challenge (see section 3.1.8).
    http_bind
    -This option enables HTTP Binding (XEP-0124 and XEP-0206) support. HTTP Bind +This option enables HTTP Binding (XEP-0124 and XEP-0206) support. HTTP Bind enables access via HTTP requests to ejabberd from behind firewalls which do not allow outgoing sockets on port 5222.

    Remember that you must also install and enable the module mod_http_bind.

    If HTTP Bind is enabled, it will be available at http://server:port/http-bind/. Be aware that support for HTTP Bind @@ -727,7 +727,7 @@ interesting to host a web-based Jabber client such as embedded local web server or Apache).

    http_poll
    -This option enables HTTP Polling (XEP-0025) support. HTTP Polling +This option enables HTTP Polling (XEP-0025) support. HTTP Polling enables access via HTTP requests to ejabberd from behind firewalls which do not allow outgoing sockets on port 5222.

    If HTTP Polling is enabled, it will be available at http://server:port/http-poll/. Be aware that support for HTTP Polling @@ -753,7 +753,7 @@ and you also want mod_http_bind to serve the URIs /http-bind/, use this option: {request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]}

    {service_check_from, true|false}
    By enabling this option, ejabberd allows the component to send packets with any arbitrary domain in the ’from’ attribute. -Note that XEP-0114 requires that the domain must match the hostname of the component. +Note that XEP-0114 requires that the domain must match the hostname of the component. Only enable this option if you are completely sure you need to enable it. Default value: false.
    {shaper, <access rule>}
    This option defines a @@ -774,7 +774,7 @@ This was the traditional encryption method in the early Jabber software, commonly on port 5223 for client-to-server communications. But this method is nowadays deprecated and not recommended. The preferable encryption method is STARTTLS on port 5222, as defined -RFC 3920: XMPP Core, +RFC 3920: XMPP Core, which can be enabled in ejabberd with the option starttls. If this option is set, you should also set the certfile option.
    web_admin
    This option @@ -783,7 +783,7 @@ at http://server:port/admin/. Login and password are the username a password of one of the registered users who are granted access by the ‘configure’ access rule.
    zlib
    This -option specifies that Zlib stream compression (as defined in XEP-0138) +option specifies that Zlib stream compression (as defined in XEP-0138) is available on connections to the port. Client connections cannot use stream compression and stream encryption simultaneously. Hence, if you specify both starttls (or tls) and zlib, the latter @@ -1236,7 +1236,7 @@ can be seen by Jabber clients. If a Jabber client does not support

    Appendix A provides more details about internationalization and localization.

    3.1.8  CAPTCHA

    Some ejabberd modules can be configured to require a CAPTCHA challenge on certain actions. -If the client does not support CAPTCHA Forms (XEP-0158), +If the client does not support CAPTCHA Forms (XEP-0158), a web link is provided so the user can fill the challenge in a web browser.

    An example script is provided that generates the image using ImageMagick’s Convert program.

    The configurable options are:

    @@ -1269,7 +1269,7 @@ See section 3.1.3.

    Example configuration:

    3.1.9  STUN

    ejabberd is able to act as a stand-alone STUN server (RFC 5389). Currently only Binding usage -is supported. In that role ejabberd helps clients with Jingle ICE (XEP-0176) support to discover their external addresses and ports.

    You should configure ejabberd_stun listening module as described in 3.1.3 section. +is supported. In that role ejabberd helps clients with Jingle ICE (XEP-0176) support to discover their external addresses and ports.

    You should configure ejabberd_stun listening module as described in 3.1.3 section. If certfile option is defined, ejabberd multiplexes TCP and TLS over TCP connections on the same port. Obviously, certfile option is defined for tcp only. Note however that TCP or TLS over TCP @@ -1663,7 +1663,7 @@ user’s part of a JID. For example, "%u@example.org". The default value is "%u".

    ldap_filter
    -RFC 2254 LDAP filter. The +RFC 4515 LDAP filter. The default is none. Example: "(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, do not forget to close brackets and do not use superfluous whitespaces. Also you @@ -1822,38 +1822,38 @@ all entries end with a comma:

    3.3.1  Modules Overview

    The following table lists all modules included in ejabberd.

    - + - + - + - - - + + + - - - + + + - - - - - + + + + + - - - - - - + + + + + +
    ModuleFeatureDependencies
    mod_adhocAd-Hoc Commands (XEP-0050) 
    mod_adhocAd-Hoc Commands (XEP-0050) 
    mod_announceManage announcementsrecommends mod_adhoc
    mod_capsEntity Capabilities (XEP-0115) 
    mod_capsEntity Capabilities (XEP-0115) 
    mod_configureServer configuration using Ad-Hocmod_adhoc
    mod_discoService Discovery (XEP-0030) 
    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_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_pingXMPP Ping and periodic keepalives (XEP-0199) 
    mod_offlineOffline message storage (XEP-0160) 
    mod_offline_odbcOffline message storage (XEP-0160)supported DB (*)
    mod_pingXMPP Ping and periodic keepalives (XEP-0199) 
    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_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-0202) 
    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) 
    mod_statsStatistics Gathering (XEP-0039) 
    mod_timeEntity Time (XEP-0202) 
    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) 
    {server_info, [ {Modules, Field, [Value]} ]}
    Specify additional information about the server, -as described in Contact Addresses for XMPP Services (XEP-0157). +as described in Contact Addresses for XMPP Services (XEP-0157). Modules can be the keyword ‘all’, in which case the information is reported in all the services; or a list of ejabberd modules, @@ -2094,7 +2094,7 @@ of them all?

    3.3.6  mod_http_bind

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

    To use HTTP-Binding, enable the module: 

    {modules,
@@ -2209,7 +2209,7 @@ servers.
    End user information:
 
 
    • 
 A Jabber client with ‘groupchat 1.0’ support or Multi-User
-Chat support (XEP-0045) is necessary to join IRC channels.
+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
 be ‘channel%irc.example.org’ in case irc.example.org is
@@ -2219,7 +2219,7 @@ to the IRC transport instead of the Multi-User Chat service.
  nickserver!irc.example.org@irc.jabberserver.org.
 
    • Entering your password is possible by sending ‘LOGIN nick password’
      
  to nickserver!irc.example.org@irc.jabberserver.org.
-
    • The IRC transport provides Ad-Hoc Commands (XEP-0050)
+
    • 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
 connection can be achieved with some IRC servers because they limit the
@@ -2264,7 +2264,7 @@ of example.org, and any user of example.com:
  ]}.

    3.3.9  mod_last

    -

    This module adds support for Last Activity (XEP-0012). It can be used to +

    This module adds support for Last Activity (XEP-0012). It can be used to discover when a disconnected user last accessed the server, to know when a connected user was last active on the server, or to query the uptime of the ejabberd server.

    Options: @@ -2273,7 +2273,7 @@ connected user was last active on the server, or to query the uptime of the the processing discipline for Last activity (jabber:iq:last) IQ queries (see section 3.3.2).

    3.3.10  mod_muc

    -

    This module provides a Multi-User Chat (XEP-0045) service. +

    This module provides a Multi-User Chat (XEP-0045) service. Users can discover existing rooms, join or create them. Occupants of a room can chat in public or have private chats.

    Some of the features of Multi-User Chat:

    3.3.12  mod_offline

    -

    This module implements offline message storage (XEP-0160). +

    This module implements offline message storage (XEP-0160). This means that all messages sent to an offline user will be stored on the server until that user comes online again. Thus it is very similar to how email works. Note that @@ -2648,7 +2648,7 @@ and all the other users up to 100. ]}.

    3.3.13  mod_ping

    -

    This module implements support for XMPP Ping (XEP-0199) and periodic keepalives. +

    This module implements support for XMPP Ping (XEP-0199) and periodic keepalives. When this module is enabled ejabberd responds correctly to ping requests, as defined in the protocol.

    Configuration options:

    @@ -2697,26 +2697,26 @@ or subscription type (or globally).
  • Allowing or blocking all communications based on JID, group, or subscription type (or globally).
    • -(from http://www.xmpp.org/specs/rfc3921.html#privacy) +(from http://xmpp.org/specs/rfc3921.html#privacy)

    Options:

    iqdisc
    This specifies the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section 3.3.2).

    3.3.15  mod_private

    -

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

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

    Using this method, Jabber 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). +of client-specific preferences; another is Bookmark Storage (XEP-0048).

    Options:

    iqdisc
    This specifies the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section 3.3.2).

    3.3.16  mod_proxy65

    -

    This module implements SOCKS5 Bytestreams (XEP-0065). +

    This module implements SOCKS5 Bytestreams (XEP-0065). It allows ejabberd to act as a file transfer proxy between two XMPP clients.

    Options:

    @@ -2771,9 +2771,9 @@ The simpliest configuration of the module: ]}.

    3.3.17  mod_pubsub

    -

    This module offers a Publish-Subscribe Service (XEP-0060). +

    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) +The plugin that implements PEP (Personal Eventing via Pubsub) (XEP-0163) is enabled in the default ejabberd configuration file, and it requires mod_caps.

    Options:

    @@ -2817,7 +2817,7 @@ The following example will use node_tune instead of node_pep for every PEP node ]}.

    3.3.18  mod_register

    -

    This module adds support for In-Band Registration (XEP-0077). This protocol +

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

    • Register a new account on the server. @@ -2891,8 +2891,8 @@ Also define a registration timeout of one hour:

    3.3.19  mod_roster

    This module implements roster management as defined in -RFC 3921: XMPP IM. -It also supports Roster Versioning (XEP-0237).

    Options: +RFC 3921: XMPP IM. +It also supports Roster Versioning (XEP-0237).

    Options:

    iqdisc
    This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section 3.3.2). @@ -3021,7 +3021,7 @@ roster groups as shown in the following table:

    3.3.22  mod_stats

    -

    This module adds support for Statistics Gathering (XEP-0039). This protocol +

    This module adds support for Statistics Gathering (XEP-0039). This protocol allows you to retrieve next statistics from your ejabberd deployment:

    • Total number of registered users on the current virtual host (users/total). @@ -3053,7 +3053,7 @@ by sending: </iq>

    3.3.23  mod_time

    -

    This module features support for Entity Time (XEP-0202). By using this XEP, +

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

    Options:

    iqdisc
    This specifies @@ -3061,7 +3061,7 @@ the processing discipline for Entity Time (jabber:iq:time) IQ queries (

    3.3.24  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 +other users vCards, as defined in vcard-temp (XEP-0054). The module also implements an uncomplicated Jabber User Directory based on the vCards of these users. Moreover, it enables the server to send its vCard when queried.

    Options:

    @@ -3148,7 +3148,7 @@ all search results are reported. The default value is 30. set the table that maps LDAP attributes to vCard fields. The format is: [Name_of_vCard_field, Pattern, List_of_LDAP_attributes, ...]. Name_of_vcard_field is the type name of the vCard as defined in -RFC 2426. Pattern is a +RFC 2426. Pattern is a string which contains pattern variables "%u", "%d" or "%s". List_of_LDAP_attributes is the list containing LDAP attributes. The pattern variables "%s" will be sequentially replaced @@ -3291,7 +3291,7 @@ searching his info in LDAP.

  • ldap_vcard_map

    • 3.3.26  mod_version

    -

    This module implements Software Version (XEP-0092). Consequently, it +

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

    Options:

    show_os
    Should the operating system be revealed or not. @@ -3464,7 +3464,7 @@ This is not recommended for big databases, as it will consume much time, memory and processor. In that case it’s preferable to use backup and install_fallback.
    import_piefxis, export_piefxis, export_piefxis_host
    These options can be used to migrate accounts -using XEP-0227 formatted XML files +using XEP-0227 formatted XML files from/to other Jabber/XMPP servers or move users of a vhost to another ejabberd installation. See also @@ -3600,7 +3600,7 @@ 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. -The client must support Ad-Hoc Commands (XEP-0050), +The client must support Ad-Hoc Commands (XEP-0050), and you must login in the Jabber server with an account with proper privileges.

    4.5  Change Computer Hostname

    ejabberd uses the distributed Mnesia database. diff --git a/doc/guide.tex b/doc/guide.tex index 9b291b688..aba77c4ad 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -170,7 +170,7 @@ ejabberd Development Team \gdef\ahrefurl#1{\href{#1}{\texttt{#1}}} \gdef\footahref#1#2{#2\footnote{\href{#1}{\texttt{#1}}}} \end{latexonly} -\newcommand{\txepref}[2]{\footahref{http://www.xmpp.org/extensions/xep-#1.html}{#2}} +\newcommand{\txepref}[2]{\footahref{http://xmpp.org/extensions/xep-#1.html}{#2}} \newcommand{\xepref}[1]{\txepref{#1}{XEP-#1}} \begin{document} @@ -912,7 +912,7 @@ This is a detailed description of each option allowed by the listening modules: commonly on port 5223 for client-to-server communications. But this method is nowadays deprecated and not recommended. The preferable encryption method is STARTTLS on port 5222, as defined - \footahref{http://www.xmpp.org/specs/rfc3920.html\#tls}{RFC 3920: XMPP Core}, + \footahref{http://xmpp.org/specs/rfc3920.html\#tls}{RFC 3920: XMPP Core}, which can be enabled in \ejabberd{} with the option \term{starttls}. If this option is set, you should also set the \option{certfile} option. \titem{web\_admin} \ind{options!web\_admin}\ind{web admin}This option @@ -2223,9 +2223,9 @@ You can authenticate users against an LDAP directory. Available options are: user's part of a JID. For example, \term{"\%u@example.org"}. The default value is \term{"\%u"}. \end{description} - \titem{ldap\_filter}\ind{options!ldap\_filter}\ind{protocols!RFC 2254: The - String Representation of LDAP Search Filters} - \footahref{http://www.faqs.org/rfcs/rfc2254.html}{RFC 2254} LDAP filter. The + \titem{ldap\_filter}\ind{options!ldap\_filter}\ind{protocols!RFC 4515: + LDAP String Representation of Search Filters} + \footahref{http://tools.ietf.org/html/rfc4515}{RFC 4515} LDAP filter. The default is \term{none}. Example: \term{"(\&(objectClass=shadowAccount)(memberOf=Jabber Users))"}. Please, do not forget to close brackets and do not use superfluous whitespaces. Also you @@ -3237,7 +3237,7 @@ Features: author, subject and configuration. \item \ind{protocols!RFC 5122: Internationalized Resource Identifiers (IRIs) and Uniform Resource Identifiers (URIs) for the Extensible Messaging and Presence Protocol (XMPP)} The room JID in the generated HTML is a link to join the room (using - \footahref{http://www.xmpp.org/rfcs/rfc5122.html}{XMPP URI}). + \footahref{http://xmpp.org/rfcs/rfc5122.html}{XMPP URI}). \item Subject and room configuration changes are tracked and displayed. \item Joins, leaves, nick changes, kicks, bans and `/me' are tracked and displayed, including the reason if available. @@ -3458,7 +3458,7 @@ their \Jabber{} client, they will be able to: \item Allowing or blocking all communications based on JID, group, or subscription type (or globally). \end{itemize} -(from \ahrefurl{http://www.xmpp.org/specs/rfc3921.html\#privacy}) +(from \ahrefurl{http://xmpp.org/specs/rfc3921.html\#privacy}) \end{quote} Options: @@ -3695,7 +3695,7 @@ Also define a registration timeout of one hour: \ind{modules!\modroster{}}\ind{roster management}\ind{protocols!RFC 3921: XMPP IM} This module implements roster management as defined in -\footahref{http://www.xmpp.org/specs/rfc3921.html\#roster}{RFC 3921: XMPP IM}. +\footahref{http://xmpp.org/specs/rfc3921.html\#roster}{RFC 3921: XMPP IM}. It also supports Roster Versioning (\xepref{0237}). Options: @@ -4026,7 +4026,7 @@ consists of the following \modvcardldap{}-specific options: set the table that maps LDAP attributes to vCard fields. The format is: \term{[{Name\_of\_vCard\_field, Pattern, List\_of\_LDAP\_attributes}, ...]}.\ind{protocols!RFC 2426: vCard MIME Directory Profile} \term{Name\_of\_vcard\_field} is the type name of the vCard as defined in - \footahref{http://www.ietf.org/rfc/rfc2426.txt}{RFC 2426}. \term{Pattern} is a + \footahref{http://tools.ietf.org/html/rfc2426}{RFC 2426}. \term{Pattern} is a string which contains pattern variables \term{"\%u"}, \term{"\%d"} or \term{"\%s"}. \term{List\_of\_LDAP\_attributes} is the list containing LDAP attributes. The pattern variables \term{"\%s"} will be sequentially replaced diff --git a/doc/introduction.tex b/doc/introduction.tex index 1991c93ec..7cbfe625e 100644 --- a/doc/introduction.tex +++ b/doc/introduction.tex @@ -8,7 +8,7 @@ Joeri} %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 (Jabber/XMPP). -\ejabberd{} is a \marking{free and open source} instant messaging server written in \footahref{http://www.erlang.org/}{Erlang}. +\ejabberd{} is a \marking{free and open source} instant messaging server written in \footahref{http://www.erlang.org/}{Erlang/OTP}. \ejabberd{} is \marking{cross-platform}, distributed, fault-tolerant, and based on open standards to achieve real-time communication. -- 2.40.0