diff options
author | Badlop <badlop@process-one.net> | 2008-07-15 21:03:48 +0000 |
---|---|---|
committer | Badlop <badlop@process-one.net> | 2008-07-15 21:03:48 +0000 |
commit | 6c0f497281099bdeec3091bfa566b23163b96a92 (patch) | |
tree | 995663819e961e0f93640c367908e60b71431f71 /doc | |
parent | Removed testing code (diff) |
* doc/guide.tex: Improve explanation of option 'hosts' in
ejabberd_service
* doc/guide.html: Likewise
SVN Revision: 1446
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guide.html | 23 | ||||
-rw-r--r-- | doc/guide.tex | 23 |
2 files changed, 28 insertions, 18 deletions
diff --git a/doc/guide.html b/doc/guide.html index 735fc1f8..02ea1213 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -637,9 +637,14 @@ This option can be used with <TT>ejabberd_service</TT> only. It is used to disable control on the from field on packets send by an external components. The option can be either <TT>true</TT> or <TT>false</TT>. The default value is <TT>true</TT> which conforms to <A HREF="http://www.xmpp.org/extensions/xep-0114.html">XEP-0114</A>. -</DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B></DT><DD CLASS="dd-description"> This option -defines one or more hostnames of connected services and enables you to -specify additional options including <TT>{password, Secret}</TT>. +</DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B></DT><DD CLASS="dd-description"> +This option of <TT>ejabberd_service</TT> allows to define one or more hostnames +of external Jabber components that provide a service. +In <TT>HostOptions</TT> it is possible to define the password required to those components +when attempt to connect to ejabberd: <TT>{password, Secret}</TT>. +Note that you cannot define in a single <TT>ejabberd_service</TT> components of +different services: add an <TT>ejabberd_service</TT> for each service, +as seen in an example below. </DD><DT CLASS="dt-description"><B><TT>http_bind</TT></B></DT><DD CLASS="dd-description"> This option enables HTTP Binding (<A HREF="http://www.xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">XEP-0206</A>) support. HTTP Bind enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which @@ -818,19 +823,19 @@ connected to port 5237 with password ‘<TT>ggsecret</TT>’. 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 3831ac02..17cfbeb8 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}]} ] |