* doc/guide.tex: Updated command line parameters, epmd section

* doc/guide.html: Likewise

SVN Revision: 1267

diff --git a/ChangeLog b/ChangeLog
index a2422ac07ae5206e04b2637c3ad950746ea954c4..5ff93d548f50f309becf98bea6ee5108cb166c2a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2008-04-01  Badlop  <badlop@process-one.net>
 
+       * doc/guide.tex: Updated command line parameters, epmd section
+       * doc/guide.html: Likewise
+
        * doc/api/Makefile: Report the correct ejabberd version. When
        cleaning, remove also erlang.png
 

diff --git a/doc/guide.html b/doc/guide.html
index b6e54c610870e91c9a0ddbdf6cef64827c59e3bf..5119b47f063e657b5793fc38edced101517b885f 100644 (file)
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -2776,7 +2776,8 @@ all the environment variables and command line parameters.</P><P>The environment
 </DD><DT CLASS="dt-description"><B><TT>ERL_CRASH_DUMP</TT></B></DT><DD CLASS="dd-description"> 
        Path to the file where crash reports will be dumped.
 </DD><DT CLASS="dt-description"><B><TT>ERL_INETRC</TT></B></DT><DD CLASS="dd-description"> 
-       Indicates which IP name resolution to use. It is required if using <TT>-sname</TT>.
+       Indicates which IP name resolution to use.
+       If using <TT>-sname</TT>, specify either this option or <TT>-kernel inetrc filepath</TT>.
 </DD><DT CLASS="dt-description"><B><TT>ERL_MAX_PORTS</TT></B></DT><DD CLASS="dd-description"> 
        Maximum number of simultaneously open Erlang ports.
 </DD><DT CLASS="dt-description"><B><TT>ERL_MAX_ETS_TABLES</TT></B></DT><DD CLASS="dd-description"> 
@@ -2791,7 +2792,10 @@ all the environment variables and command line parameters.</P><P>The environment
        The Erlang node will be fully identified.
 This is only useful if you plan to setup an <TT>ejabberd</TT> cluster with nodes in different networks.
 </DD><DT CLASS="dt-description"><B><TT>-kernel inetrc "/etc/ejabberd/inetrc"</TT></B></DT><DD CLASS="dd-description"> 
-       Indicates which IP name resolution to use. It is required if using <TT>-sname</TT>.
+       Indicates which IP name resolution to use. 
+       If using <TT>-sname</TT>, specify either this option or <TT>ERL_INETRC</TT>.
+</DD><DT CLASS="dt-description"><B><TT>-kernel inet_dist_listen_min 4200 inet_dist_listen_min 4210</TT></B></DT><DD CLASS="dd-description"> 
+       Define the first and last ports that <TT>epmd</TT> (section <A HREF="#epmd">5.2</A>) can listen to.
 </DD><DT CLASS="dt-description"><B><TT>-detached</TT></B></DT><DD CLASS="dd-description"> 
 Starts the Erlang system detached from the system console. 
        Useful for running daemons and backgrounds processes. 
@@ -2912,8 +2916,8 @@ you must follow these instructions:
 <TR><TD ALIGN=left NOWRAP>5222</TD><TD ALIGN=left NOWRAP>Standard port for Jabber/XMPP client connections, plain or STARTTLS.</TD></TR>
 <TR><TD ALIGN=left NOWRAP>5223</TD><TD ALIGN=left NOWRAP>Standard port for Jabber client connections using the old SSL method.</TD></TR>
 <TR><TD ALIGN=left NOWRAP>5269</TD><TD ALIGN=left NOWRAP>Standard port for Jabber/XMPP server connections.</TD></TR>
-<TR><TD ALIGN=left NOWRAP>4369</TD><TD ALIGN=left NOWRAP>Port used by EPMD for communication between Erlang nodes.</TD></TR>
-<TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable.</TD></TR>
+<TR><TD ALIGN=left NOWRAP>4369</TD><TD ALIGN=left NOWRAP>EPMD (section <A HREF="#epmd">5.2</A>) listens for Erlang node name requests.</TD></TR>
+<TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable (see section <A HREF="#epmd">5.2</A>).</TD></TR>
 </TABLE>
 <DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><!--TOC section epmd -->
 <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc66">5.2</A>&#XA0;&#XA0;epmd </H2><!--SEC END --><P>
@@ -2928,8 +2932,8 @@ To communicate with <TT>ejabberd</TT>, the script <TT>ejabberdctl</TT> starts a
 and connects to the Erlang node that holds <TT>ejabberd</TT>.
 In order for this communication to work,
 <TT>epmd</TT> must be running and listening for name requests in the port 4369.
-You should block the port 4369 in the firewall,
-so only the programs in your machine can access it.</P><P>If you build a cluster of several <TT>ejabberd</TT> instances,
+You should block the port 4369 in the firewall in such a way that
+only the programs in your machine can access it.</P><P>If you build a cluster of several <TT>ejabberd</TT> instances,
 each <TT>ejabberd</TT> instance is called an <TT>ejabberd</TT> node.
 Those <TT>ejabberd</TT> nodes use a special Erlang communication method to
 build the cluster, and EPMD is again needed listening in the port 4369.
@@ -2937,8 +2941,9 @@ So, if you plan to build a cluster of <TT>ejabberd</TT> nodes
 you must open the port 4369 for the machines involved in the cluster.
 Remember to block the port so Internet doesn&#X2019;t have access to it.</P><P>Once an Erlang node solved the node name of another Erlang node using EPMD and port 4369,
 the nodes communicate directly.
-The ports used in this case are random. 
-You can limit the range of ports when starting Erlang with a command-line parameter, for example:
+The ports used in this case by default are random, 
+but can be configured in the file <TT>ejabberdctl.cfg</TT>.
+The Erlang command-line parameter used internally is, for example:
 </P><PRE CLASS="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
 </PRE><!--TOC section Erlang Cookie-->
 <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc67">5.3</A>&#XA0;&#XA0;Erlang Cookie</H2><!--SEC END --><P>

diff --git a/doc/guide.tex b/doc/guide.tex
index d1f87a6f0c9cfbcccb14c46010d08846ada70b8f..4a365a5e0dbe8d6bf1ee8c166a9d17de2638a39d 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3466,7 +3466,8 @@ The environment variables:
   \titem{ERL\_CRASH\_DUMP} 
        Path to the file where crash reports will be dumped.
   \titem{ERL\_INETRC} 
-       Indicates which IP name resolution to use. It is required if using \term{-sname}.
+       Indicates which IP name resolution to use.
+       If using \term{-sname}, specify either this option or \term{-kernel inetrc filepath}.
   \titem{ERL\_MAX\_PORTS} 
        Maximum number of simultaneously open Erlang ports.
   \titem{ERL\_MAX\_ETS\_TABLES} 
@@ -3483,7 +3484,10 @@ The command line parameters:
        The Erlang node will be fully identified.
     This is only useful if you plan to setup an \ejabberd{} cluster with nodes in different networks.
   \titem{-kernel inetrc "/etc/ejabberd/inetrc"} 
-       Indicates which IP name resolution to use. It is required if using \term{-sname}.
+       Indicates which IP name resolution to use. 
+       If using \term{-sname}, specify either this option or \term{ERL\_INETRC}.
+  \titem{-kernel inet\_dist\_listen\_min 4200 inet\_dist\_listen\_min 4210} 
+       Define the first and last ports that \term{epmd} (section \ref{epmd}) can listen to.
   \titem{-detached} 
         Starts the Erlang system detached from the system console. 
        Useful for running daemons and backgrounds processes. 
@@ -3635,8 +3639,8 @@ You need to take the following TCP ports in mind when configuring your firewall:
     \hline \hline 5222& Standard port for Jabber/XMPP client connections, plain or STARTTLS.\\
     \hline 5223& Standard port for Jabber client connections using the old SSL method.\\
     \hline 5269& Standard port for Jabber/XMPP server connections.\\
-    \hline 4369& Port used by EPMD for communication between Erlang nodes.\\
-    \hline port range& Used for connections between Erlang nodes. This range is configurable.\\
+    \hline 4369& EPMD (section \ref{epmd}) listens for Erlang node name requests.\\
+    \hline port range& Used for connections between Erlang nodes. This range is configurable (see section \ref{epmd}).\\
     \hline
   \end{tabular}
 \end{table}
@@ -3657,8 +3661,8 @@ To communicate with \ejabberd{}, the script \term{ejabberdctl} starts a new Erla
 and connects to the Erlang node that holds \ejabberd{}.
 In order for this communication to work,
 \term{epmd} must be running and listening for name requests in the port 4369.
-You should block the port 4369 in the firewall,
-so only the programs in your machine can access it.
+You should block the port 4369 in the firewall in such a way that
+only the programs in your machine can access it.
 
 If you build a cluster of several \ejabberd{} instances,
 each \ejabberd{} instance is called an \ejabberd{} node.
@@ -3670,8 +3674,9 @@ Remember to block the port so Internet doesn't have access to it.
 
 Once an Erlang node solved the node name of another Erlang node using EPMD and port 4369,
 the nodes communicate directly.
-The ports used in this case are random. 
-You can limit the range of ports when starting Erlang with a command-line parameter, for example:
+The ports used in this case by default are random, 
+but can be configured in the file \term{ejabberdctl.cfg}.
+The Erlang command-line parameter used internally is, for example:
 \begin{verbatim}
 erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
 \end{verbatim}