* doc/guide.tex: Document service_check_from (EJAB-576)

* doc/guide.html: Likewise

SVN Revision: 1248

diff --git a/ChangeLog b/ChangeLog
index 70d04ce4c2b95fa2fd298f4b063f103fd51cdeab..9ed5bdbe93510b92ddef0f753590ac0636bffdb8 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-03-22  Badlop  <badlop@process-one.net>
+
+       * doc/guide.tex: Document service_check_from (EJAB-576)
+       * doc/guide.html: Likewise
+
 2008-03-21  Badlop  <badlop@process-one.net>
 
        * src/mod_caps.erl: Move two log calls ERROR_MSG to DEBUG

diff --git a/doc/guide.html b/doc/guide.html
index 9d0a1c1563230aa7a1018e08cd07e756370720ce..2a7a11661c616a0dff80ffaecf6df6d3f4db78a9 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -344,7 +344,7 @@ GNU Make
 </LI><LI CLASS="li-itemize">Libexpat 1.95 or higher
 </LI><LI CLASS="li-itemize">Erlang/OTP R10B-9 up to R11B-5. Erlang R12 releases are not yet officially supported, and are not recommended for production servers.
 </LI><LI CLASS="li-itemize">OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
-</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional.
+</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional.
 </LI><LI CLASS="li-itemize">GNU Iconv 1.8 or higher, for the IRC Transport (mod_irc). Optional. Not needed on systems with GNU Libc.
 </LI></UL><!--TOC subsection Download Source Code-->
 <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc10">2.4.2</A>&#XA0;&#XA0;Download Source Code</H3><!--SEC END --><P>
@@ -619,7 +619,7 @@ connections.</TD></TR>
 <A HREF="http://www.ejabberd.im/tutorials-transports">external components</A> 
 (as defined in the Jabber Component Protocol (<A HREF="http://www.xmpp.org/extensions/xep-0114.html">XEP-0114</A>).</TD></TR>
 <TR><TD VALIGN=top ALIGN=left NOWRAP>&nbsp;</TD><TD VALIGN=top ALIGN=left NOWRAP>Options</TD><TD VALIGN=top ALIGN=left><TT>access</TT>, <TT>hosts</TT>, <TT>inet6</TT>,
-<TT>ip</TT>, <TT>shaper</TT></TD></TR>
+<TT>ip</TT>, <TT>shaper</TT>, <TT>service_check_from</TT></TD></TR>
 <TR><TD VALIGN=top ALIGN=left NOWRAP><TT>ejabberd_http</TT></TD><TD VALIGN=top ALIGN=left NOWRAP>Description</TD><TD VALIGN=top ALIGN=left>Handles incoming HTTP
 connections.</TD></TR>
 <TR><TD VALIGN=top ALIGN=left NOWRAP>&nbsp;</TD><TD VALIGN=top ALIGN=left NOWRAP>Options</TD><TD VALIGN=top ALIGN=left><TT>certfile</TT>, <TT>http_bind</TT>, <TT>http_poll</TT>,
@@ -676,6 +676,11 @@ The Path is a list of strings; so the URIs that start with that Path will be ser
 For example, if you want <TT>mod_foo</TT> to serve the URIs that start with <TT>/a/b/</TT>,
 and you also want <TT>mod_http_bind</TT> to serve the URIs <TT>/http-bind/</TT>,
 use this option: <TT>{request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]}</TT>
+</DD><DT CLASS="dt-description"><B><TT>{service_check_from, true|false}</TT></B></DT><DD CLASS="dd-description">
+By enabling this option, <TT>ejabberd</TT> allows the component to send packets with any arbitrary domain in the &#X2019;from&#X2019; attribute.
+Note that <A HREF="http://www.xmpp.org/extensions/xep-0114.html">XEP-0114</A> 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.
 </DD><DT CLASS="dt-description"><B><TT>{shaper, &lt;access rule&gt;}</TT></B></DT><DD CLASS="dd-description"> This option defines a
 shaper for the port (see section&#XA0;<A HREF="#shapers">3.1.6</A>). The default value
 is <TT>none</TT>.

diff --git a/doc/guide.tex b/doc/guide.tex
index a9e3ba809ac69e5196d4d19829d164033e325d59..eb6f8a6601098ae7425f1b84b75e7dd31c8d8390 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -266,7 +266,7 @@ To compile \ejabberd{} on a `Unix-like' operating system, you need:
 \item Libexpat 1.95 or higher
 \item Erlang/OTP R10B-9 up to R11B-5. Erlang R12 releases are not yet officially supported, and are not recommended for production servers.
 \item OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
-\item Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional.
+\item Zlib 1.2.3 or higher, for Stream Compression support (\xepref{0138}). Optional.
 \item GNU Iconv 1.8 or higher, for the IRC Transport (mod\_irc). Optional. Not needed on systems with GNU Libc.
 \end{itemize}
 
@@ -671,7 +671,7 @@ The available modules, their purpose and the options allowed by each one are:
     \footahref{http://www.ejabberd.im/tutorials-transports}{external components} 
     (as defined in the Jabber Component Protocol (\xepref{0114}).\\
     \cline{2-3} & Options& \texttt{access}, \texttt{hosts}, \texttt{inet6},
-    \texttt{ip}, \texttt{shaper}\\
+    \texttt{ip}, \texttt{shaper}, \texttt{service\_check\_from}\\
   \hline \texttt{ejabberd\_http}& Description& Handles incoming HTTP
   connections.\\
     \cline{2-3} & Options& \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll},
@@ -737,6 +737,11 @@ This is a detailed description of each option allowed by the listening modules:
     For example, if you want \term{mod\_foo} to serve the URIs that start with \term{/a/b/},
     and you also want \term{mod\_http\_bind} to serve the URIs \term{/http-bind/},
     use this option: \term{\{request\_handlers, [\{["a", "b"], mod\_foo\}, \{["http-bind"], mod\_http\_bind\}]\}}
+  \titem{\{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 \xepref{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.
   \titem{\{shaper, <access rule>\}} \ind{options!shaper}This option defines a
     shaper for the port (see section~\ref{shapers}). The default value
     is \term{none}.