Chapril/xmpp.chapril.org-ejabberd
24
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-06-12 21:52:07 +02:00
Code Releases Activity

* doc/guide.tex: Improve explanation of option 'hosts' in

Browse Source 
ejabberd_service
* doc/guide.html: Likewise

SVN Revision: 1448
This commit is contained in:
Badlop 2008-07-16 10:21:45 +00:00
parent b1ca88a5eb
commit 663f6f76a7
3 changed files with 37 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,9 @@
2008-07-16 Badlop <badlop@process-one.net>
* doc/guide.tex: Improve explanation of option 'hosts' in
ejabberd_service
* doc/guide.html: Likewise
2008-07-12 Badlop <badlop@process-one.net> 2008-07-12 Badlop <badlop@process-one.net>
* src/configure.ac: Improve legibility * src/configure.ac: Improve legibility

28
doc/guide.html
View File

@ -620,9 +620,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 used to disable control on the from field on packets send by an
external components. The option can be either <TT>true</TT> or 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>. <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 </DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B></DT><DD CLASS="dd-description">
defines one or more hostnames of connected services and enables you to This option of <TT>ejabberd_service</TT> allows to define one or more hostnames
specify additional options including <TT>{password, Secret}</TT>. 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"> </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 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 enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
@ -801,19 +806,19 @@ connected to port 5237 with password &#X2018;<TT>ggsecret</TT>&#X2019;.
ssl, {certfile, "/path/to/ssl.pem"}]}, ssl, {certfile, "/path/to/ssl.pem"}]},
{5269, ejabberd_s2s_in, []}, {5269, ejabberd_s2s_in, []},
{5280, ejabberd_http, [http_poll, web_admin]}, {5280, ejabberd_http, [http_poll, web_admin]},
{5233, ejabberd_service, [{host, "aim.example.org", {5233, ejabberd_service, [{hosts, ["aim.example.org"],
[{password, "aimsecret"}]}]}, [{password, "aimsecret"}]}]},
{5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
[{password, "jitsecret"}]}]}, [{password, "jitsecret"}]}]},
{5235, ejabberd_service, [{host, "msn.example.org", {5235, ejabberd_service, [{hosts, ["msn.example.org"],
[{password, "msnsecret"}]}]}, [{password, "msnsecret"}]}]},
{5236, ejabberd_service, [{host, "yahoo.example.org", {5236, ejabberd_service, [{hosts, ["yahoo.example.org"],
[{password, "yahoosecret"}]}]}, [{password, "yahoosecret"}]}]},
{5237, ejabberd_service, [{host, "gg.example.org", {5237, ejabberd_service, [{hosts, ["gg.example.org"],
[{password, "ggsecret"}]}]}, [{password, "ggsecret"}]}]},
{5238, ejabberd_service, [{host, "jmc.example.org", {5238, ejabberd_service, [{hosts, ["jmc.example.org"],
[{password, "jmcsecret"}]}]}, [{password, "jmcsecret"}]}]},
{5239, ejabberd_service, [{host, "custom.example.org", {5239, ejabberd_service, [{hosts, ["custom.example.org"],
[{password, "customsecret"}]}, [{password, "customsecret"}]},
{service_check_from, false}]} {service_check_from, false}]}
] ]
@ -2109,7 +2114,7 @@ Chatroom details are added on top of each page: room title, JID,
author, subject and configuration. author, subject and configuration.
</LI><LI CLASS="li-itemize"> </LI><LI CLASS="li-itemize">
The room JID in the generated HTML is a link to join the chatroom (using The room JID in the generated HTML is a link to join the chatroom (using
<A HREF="http://www.xmpp.org/rfc/rfc5122.html">XMPP URI</A>). <A HREF="http://www.xmpp.org/rfcs/rfc5122.html">XMPP URI</A>).
</LI><LI CLASS="li-itemize">Subject and chatroom configuration changes are tracked and displayed. </LI><LI CLASS="li-itemize">Subject and chatroom configuration changes are tracked and displayed.
</LI><LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and &#X2018;/me&#X2019; are tracked and </LI><LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and &#X2018;/me&#X2019; are tracked and
displayed, including the reason if available. displayed, including the reason if available.
@ -2359,6 +2364,7 @@ restrictions by default).
</DD><DT CLASS="dt-description"><B><TT>welcome_message</TT></B></DT><DD CLASS="dd-description"> Set a welcome message that </DD><DT CLASS="dt-description"><B><TT>welcome_message</TT></B></DT><DD CLASS="dd-description"> Set a welcome message that
is sent to each newly registered account. The first string is the subject, and is sent to each newly registered account. The first string is the subject, and
the second string is the message body. the second string is the message body.
In the body you can set a newline with the characters: <CODE>\n</CODE>
</DD><DT CLASS="dt-description"><B><TT>registration_watchers</TT></B></DT><DD CLASS="dd-description"> This option defines a </DD><DT CLASS="dt-description"><B><TT>registration_watchers</TT></B></DT><DD CLASS="dd-description"> This option defines a
list of JIDs which will be notified each time a new account is registered. list of JIDs which will be notified each time a new account is registered.
</DD><DT CLASS="dt-description"><B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies </DD><DT CLASS="dt-description"><B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
@ -2409,7 +2415,7 @@ Also define a registration timeout of one hour:
... ...
{mod_register, {mod_register,
[ [
{welcome_message, {"Welcome!", "Welcome to this Jabber server. Check http://www.jabber.org"}}, {welcome_message, {"Welcome!", "Hi.\nWelcome to this Jabber server.\n Check http://www.jabber.org\n\nBye"}},
{registration_watchers, ["admin1@example.org", "boss@example.net"]} {registration_watchers, ["admin1@example.org", "boss@example.net"]}
]}, ]},
... ...

23
doc/guide.tex
View File

@ -729,9 +729,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 used to disable control on the from field on packets send by an
external components. The option can be either \term{true} or external components. The option can be either \term{true} or
\term{false}. The default value is \term{true} which conforms to \xepref{0114}. \term{false}. The default value is \term{true} which conforms to \xepref{0114}.
\titem{\{hosts, [Hostnames], [HostOptions]\}} \ind{options!hosts}This option \titem{\{hosts, [Hostnames], [HostOptions]\}} \ind{options!hosts}
defines one or more hostnames of connected services and enables you to This option of \term{ejabberd\_service} allows to define one or more hostnames
specify additional options including \poption{\{password, Secret\}}. 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} \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 This option enables HTTP Binding (\xepref{0124} and \xepref{0206}) support. HTTP Bind
enables access via HTTP requests to \ejabberd{} from behind firewalls which enables access via HTTP requests to \ejabberd{} from behind firewalls which
@ -926,19 +931,19 @@ In this example, the following configuration defines that:
ssl, {certfile, "/path/to/ssl.pem"}]}, ssl, {certfile, "/path/to/ssl.pem"}]},
{5269, ejabberd_s2s_in, []}, {5269, ejabberd_s2s_in, []},
{5280, ejabberd_http, [http_poll, web_admin]}, {5280, ejabberd_http, [http_poll, web_admin]},
{5233, ejabberd_service, [{host, "aim.example.org", {5233, ejabberd_service, [{hosts, ["aim.example.org"],
[{password, "aimsecret"}]}]}, [{password, "aimsecret"}]}]},
{5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
[{password, "jitsecret"}]}]}, [{password, "jitsecret"}]}]},
{5235, ejabberd_service, [{host, "msn.example.org", {5235, ejabberd_service, [{hosts, ["msn.example.org"],
[{password, "msnsecret"}]}]}, [{password, "msnsecret"}]}]},
{5236, ejabberd_service, [{host, "yahoo.example.org", {5236, ejabberd_service, [{hosts, ["yahoo.example.org"],
[{password, "yahoosecret"}]}]}, [{password, "yahoosecret"}]}]},
{5237, ejabberd_service, [{host, "gg.example.org", {5237, ejabberd_service, [{hosts, ["gg.example.org"],
[{password, "ggsecret"}]}]}, [{password, "ggsecret"}]}]},
{5238, ejabberd_service, [{host, "jmc.example.org", {5238, ejabberd_service, [{hosts, ["jmc.example.org"],
[{password, "jmcsecret"}]}]}, [{password, "jmcsecret"}]}]},
{5239, ejabberd_service, [{host, "custom.example.org", {5239, ejabberd_service, [{hosts, ["custom.example.org"],
[{password, "customsecret"}]}, [{password, "customsecret"}]},
{service_check_from, false}]} {service_check_from, false}]}
] ]