From 8bf6a882790dc66c8ed07162f48f64bf638957d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20R=C3=A9mond?= Date: Wed, 29 Aug 2007 16:12:59 +0000 Subject: [PATCH] * doc/guide.tex: Documentation for XML based optimisation build time option (EJAB-298) SVN Revision: 897 --- ChangeLog | 7 ++- doc/guide.html | 114 ++++++++++++++++++++++--------------------------- doc/guide.tex | 8 +++- 3 files changed, 65 insertions(+), 64 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4e60f50a8..6f8e529d1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ -2007-08-29 Alexey Shchepin +2007-08-29 Mickael Remond + * doc/guide.tex: Documentation for XML based optimisation build + time option (EJAB-298) + +2007-08-29 Alexey Shchepin + * src/mod_muc/mod_muc_log.erl: Added missed HTMLization in a nickname change logging (thanks to Badlop) diff --git a/doc/guide.html b/doc/guide.html index a1f242aef..6dc451434 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -347,8 +347,12 @@ The latest development version can be retrieved from the Subversion repository. install ejabberd into the directory /var/lib/ejabberd,
  • install the configuration file into /etc/ejabberd,
  • create a directory called /var/log/ejabberd to store log files. -
    • -

    Compilation options

    If you want to use an external database, you need to execute the configure + +

    Build options

    If you want to enable the use of XML based optimisations, you can use +the option–enable-full-xml when running the configure +command. It will for example use CDATA to escape characters in the +XMPP stream. Do not use this option if all your clients are not using +a fully compliant XML parser.

    If you want to use an external database, you need to execute the configure script with the option(s) –enable-odbc or –enable-odbc –enable-mssql. See section 3.2 for more information.

    Windows

    @@ -1367,37 +1371,28 @@ number of processes (32000 by default). {mod_time, [{iqdisc, no_queue}]}, ... ]}. - -

    hosts

    - -

    A module acting as a service can have one or more hostnames. These hostnames -can be defined with the hosts option.

    Examples: -

    • -Serving the echo module on one domain: -
      • -
          {modules,
+
        +

        host

        + +

        This option defines the Jabber ID of a service provided by an ejabberd module. +The keyword "@HOST@" is replaced at start time with the real virtual host string.

        This example configures +the echo module to provide its echoing service +in the Jabber ID mirror.example.org: +

          {modules,
    [
     ...
-    {mod_echo, [{hosts, ["echo.example.org"]}]},
+    {mod_echo, [{host, "mirror.example.org"}]},
     ...
    ]}.
-
      • Backwards compatibility with older ejabberd versions can be retained -with: -
          {modules,
+

        However, if there are several virtual hosts and this module is enabled in all of them, +the "@HOST@" keyword must be used: +

          {modules,
    [
     ...
-    {mod_echo, [{host, "echo.example.org"}]},
+    {mod_echo, [{host, "mirror.@HOST@"}]},
     ...
    ]}.
-
      -
    • Serving the echo module on two domains: -
        {modules,
-   [
-    ...
-    {mod_echo, [{hosts, ["echo.example.net", "echo.example.com"]}]},
-    ...
-   ]}.
-
    +

    3.3.3  mod_announce

    This module enables configured users to broadcast announcements and to set @@ -1506,24 +1501,20 @@ packet back to the sender. This mirror can be of interest for ejabberd and Jabber client debugging.

    Options:

    -hosts
    This option defines the hostnames of the -service (see section 3.3.2). If neither hosts nor -the old host is present, the prefix `echo.' is added to all -ejabberd hostnames. +host
    This option defines the Jabber ID of the +service. If the host option is not specified, the Jabber ID will be the +hostname of the virtual host with the prefix `echo.'. The keyword "@HOST@" +is replaced at start time with the real virtual host name. -

    Examples: -

    • -Mirror, mirror, on the wall, who is the most beautiful +

      Example: Mirror, mirror, on the wall, who is the most beautiful of them all? -

        {modules,
+
        {modules,
    [
     ...
-    {mod_echo, [{hosts, ["mirror.example.org"]}]},
+    {mod_echo, [{host, "mirror.example.org"}]},
     ...
    ]}.
-
    • If you still do not understand the inner workings of mod_echo, -you can find a few more examples in section 3.3.2. -
    +

    3.3.6  mod_irc

    This module is an IRC transport that can be used to join channels on IRC @@ -1547,10 +1538,10 @@ number of conections from one IP.

    Options:

    -hosts
    This option defines the hostnames of the -service (see section 3.3.2). If neither hosts nor -the old host is present, the prefix `irc.' is added to all -ejabberd hostnames. +host
    This option defines the Jabber ID of the +service. If the host option is not specified, the Jabber ID will be the +hostname of the virtual host with the prefix `irc.'. The keyword "@HOST@" +is replaced at start time with the real virtual host name.
    access
    This option can be used to specify who may use the IRC transport (default value: all). @@ -1566,8 +1557,7 @@ able to use the transport. The default encoding is set to "iso8859-15". {mod_irc, [{access, all}, {default_encoding, "iso8859-15"}]}, ... ]}. -
  • In next example the IRC transport is available on the two virtual hosts -example.net and example.com with different prefixes on each host. +
  • In next example the IRC transport is available with JIDs with prefix irc-t.net. Moreover, the transport is only accessible by paying customers registered on our domains and on other servers. 
      {acl, paying_customers, {user, "customer1", "example.net"}}.
@@ -1581,7 +1571,7 @@ our domains and on other servers.
    [
     ...
     {mod_irc, [{access, paying_customers},
-               {hosts, ["irc.example.net", "irc-transport.example.com"]}]},
+               {host, "irc.example.net"}]},
     ...
    ]}.
    • @@ -1609,10 +1599,10 @@ Sending private messages to room participants.

    Options:

    -hosts
    This option defines the hostnames of the -service (see section 3.3.2). If neither hosts nor -the old host is present, the prefix `conference.' is added to all -ejabberd hostnames. +host
    This option defines the Jabber ID of the +service. If the host option is not specified, the Jabber ID will be the +hostname of the virtual host with the prefix `conference.'. The keyword "@HOST@" +is replaced at start time with the real virtual host name.
    access
    You can specify who is allowed to use the Multi-User Chat service (by default, everyone is allowed to use it). @@ -2000,10 +1990,10 @@ known as ESB, the Enterprise Service Bus). The J-EAI project builts upon ejabberd's codebase and has contributed several features to mod_pubsub.

    Options:

    -hosts
    This option defines the hostnames of the -service (see section 3.3.2). If neither hosts nor -the old host is present, the prefix `pubsub.' is added to all -ejabberd hostnames. +host
    This option defines the Jabber ID of the +service. If the host option is not specified, the Jabber ID will be the +hostname of the virtual host with the prefix `pubsub.'. The keyword "@HOST@" +is replaced at start time with the real virtual host name.
    served_hosts
    To specify which hosts needs to be served, you can use this option. If absent, only the main ejabberd @@ -2223,16 +2213,16 @@ 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:

    -hosts
    This option defines the hostnames of the -service (see section 3.3.2). If neither hosts nor -the old host is present, the prefix `vjud.' is added to all -ejabberd hostnames. +host
    This option defines the Jabber ID of the +service. If the host option is not specified, the Jabber ID will be the +hostname of the virtual host with the prefix `vjud.'. The keyword "@HOST@" +is replaced at start time with the real virtual host name.
    iqdisc
    This specifies the processing discipline for vcard-temp IQ queries (see section 3.3.2).
    search
    This option specifies whether the search functionality is enabled (value: true) or disabled (value: -false). If disabled, the option hosts will be ignored and the +false). If disabled, the option host will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true.
    matches
    With this option, the number of reported @@ -2284,16 +2274,16 @@ about these options. If one of these options is not set, ejabberd will for the top-level option with the same name. The second group of parameters consists of the following mod_vcard_ldap-specific options:

    -hosts
    This option defines the hostnames of the -service (see section 3.3.2). If neither hosts nor -the old host is present, the prefix `vjud.' is added to all -ejabberd hostnames. +host
    This option defines the Jabber ID of the +service. If the host option is not specified, the Jabber ID will be the +hostname of the virtual host with the prefix `vjud.'. The keyword "@HOST@" +is replaced at start time with the real virtual host name.
    iqdisc
    This specifies the processing discipline for vcard-temp IQ queries (see section 3.3.2).
    search
    This option specifies whether the search functionality is enabled (value: true) or disabled (value: -false). If disabled, the option hosts will be ignored and the +false). If disabled, the option host will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is true.
    ldap_vcard_map
    With this option you can diff --git a/doc/guide.tex b/doc/guide.tex index 387b57554..8ab25fd50 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -272,7 +272,13 @@ These commands will: \item create a directory called \verb|/var/log/ejabberd| to store log files. \end{itemize} -\subsubsection{Compilation options} +\subsubsection{Build options} + +If you want to enable the use of XML based optimisations, you can use +the option\term{--enable-full-xml} when running the \term{configure} +command. It will for example use CDATA to escape characters in the +XMPP stream. Do not use this option if all your clients are not using +a fully compliant XML parser. If you want to use an external database, you need to execute the configure script with the option(s) \term{--enable-odbc} or \term{--enable-odbc