diff --git a/ChangeLog b/ChangeLog index 56d7490bc..9d95293f5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2008-07-15 Badlop + + * doc/guide.tex: Improve explanation of option 'hosts' in + ejabberd_service + * doc/guide.html: Likewise + 2008-07-14 Badlop * doc/guide.tex: Update what permissions does enable-user grant diff --git a/doc/guide.html b/doc/guide.html index 735fc1f8c..02ea12132 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -637,9 +637,14 @@ 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. -
{hosts, [Hostnames], [HostOptions]}
This option -defines one or more hostnames of connected services and enables you to -specify additional options including {password, Secret}. +
{hosts, [Hostnames], [HostOptions]}
+This option of ejabberd_service allows to define one or more hostnames +of external Jabber components that provide a service. +In HostOptions it is possible to define the password required to those components +when attempt to connect to ejabberd: {password, Secret}. +Note that you cannot define in a single ejabberd_service components of +different services: add an ejabberd_service for each service, +as seen in an example below.
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 @@ -818,19 +823,19 @@ connected to port 5237 with password ‘ggsecret’. ssl, {certfile, "/path/to/ssl.pem"}]}, {5269, ejabberd_s2s_in, []}, {5280, ejabberd_http, [http_poll, web_admin]}, - {5233, ejabberd_service, [{host, "aim.example.org", + {5233, ejabberd_service, [{hosts, ["aim.example.org"], [{password, "aimsecret"}]}]}, {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], [{password, "jitsecret"}]}]}, - {5235, ejabberd_service, [{host, "msn.example.org", + {5235, ejabberd_service, [{hosts, ["msn.example.org"], [{password, "msnsecret"}]}]}, - {5236, ejabberd_service, [{host, "yahoo.example.org", + {5236, ejabberd_service, [{hosts, ["yahoo.example.org"], [{password, "yahoosecret"}]}]}, - {5237, ejabberd_service, [{host, "gg.example.org", + {5237, ejabberd_service, [{hosts, ["gg.example.org"], [{password, "ggsecret"}]}]}, - {5238, ejabberd_service, [{host, "jmc.example.org", + {5238, ejabberd_service, [{hosts, ["jmc.example.org"], [{password, "jmcsecret"}]}]}, - {5239, ejabberd_service, [{host, "custom.example.org", + {5239, ejabberd_service, [{hosts, ["custom.example.org"], [{password, "customsecret"}]}, {service_check_from, false}]} ] diff --git a/doc/guide.tex b/doc/guide.tex index 3831ac024..17cfbeb80 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -748,9 +748,14 @@ This is a detailed description of each option allowed by the listening modules: used to disable control on the from field on packets send by an external components. The option can be either \term{true} or \term{false}. The default value is \term{true} which conforms to \xepref{0114}. - \titem{\{hosts, [Hostnames], [HostOptions]\}} \ind{options!hosts}This option - defines one or more hostnames of connected services and enables you to - specify additional options including \poption{\{password, Secret\}}. + \titem{\{hosts, [Hostnames], [HostOptions]\}} \ind{options!hosts} + This option of \term{ejabberd\_service} allows to define one or more hostnames + of external Jabber components that provide a service. + In \term{HostOptions} it is possible to define the password required to those components + when attempt to connect to ejabberd: \poption{\{password, Secret\}}. + Note that you cannot define in a single \term{ejabberd\_service} components of + different services: add an \term{ejabberd\_service} for each service, + as seen in an example below. \titem{http\_bind} \ind{options!http\_bind}\ind{protocols!XEP-0206: HTTP Binding}\ind{JWChat}\ind{web-based Jabber client} This option enables HTTP Binding (\xepref{0124} and \xepref{0206}) support. HTTP Bind enables access via HTTP requests to \ejabberd{} from behind firewalls which @@ -945,19 +950,19 @@ In this example, the following configuration defines that: ssl, {certfile, "/path/to/ssl.pem"}]}, {5269, ejabberd_s2s_in, []}, {5280, ejabberd_http, [http_poll, web_admin]}, - {5233, ejabberd_service, [{host, "aim.example.org", + {5233, ejabberd_service, [{hosts, ["aim.example.org"], [{password, "aimsecret"}]}]}, {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], [{password, "jitsecret"}]}]}, - {5235, ejabberd_service, [{host, "msn.example.org", + {5235, ejabberd_service, [{hosts, ["msn.example.org"], [{password, "msnsecret"}]}]}, - {5236, ejabberd_service, [{host, "yahoo.example.org", + {5236, ejabberd_service, [{hosts, ["yahoo.example.org"], [{password, "yahoosecret"}]}]}, - {5237, ejabberd_service, [{host, "gg.example.org", + {5237, ejabberd_service, [{hosts, ["gg.example.org"], [{password, "ggsecret"}]}]}, - {5238, ejabberd_service, [{host, "jmc.example.org", + {5238, ejabberd_service, [{hosts, ["jmc.example.org"], [{password, "jmcsecret"}]}]}, - {5239, ejabberd_service, [{host, "custom.example.org", + {5239, ejabberd_service, [{hosts, ["custom.example.org"], [{password, "customsecret"}]}, {service_check_from, false}]} ]