From 39b35cf54b141a9f1a0ddce591dca64d1f3f6fd7 Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 1 Apr 2008 12:00:34 +0000 Subject: [PATCH] * doc/guide.tex: Updated command line parameters, epmd section * doc/guide.html: Likewise SVN Revision: 1267 --- ChangeLog | 3 +++ doc/guide.html | 21 +++++++++++++-------- doc/guide.tex | 21 +++++++++++++-------- 3 files changed, 29 insertions(+), 16 deletions(-) diff --git a/ChangeLog b/ChangeLog index a2422ac07..5ff93d548 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2008-04-01 Badlop + * 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 b6e54c610..5119b47f0 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -2776,7 +2776,8 @@ all the environment variables and command line parameters.

The environment

ERL_CRASH_DUMP
Path to the file where crash reports will be dumped.
ERL_INETRC
- Indicates which IP name resolution to use. It is required if using -sname. + Indicates which IP name resolution to use. + If using -sname, specify either this option or -kernel inetrc filepath.
ERL_MAX_PORTS
Maximum number of simultaneously open Erlang ports.
ERL_MAX_ETS_TABLES
@@ -2791,7 +2792,10 @@ all the environment variables and command line parameters.

The environment The Erlang node will be fully identified. This is only useful if you plan to setup an ejabberd cluster with nodes in different networks.

-kernel inetrc "/etc/ejabberd/inetrc"
- Indicates which IP name resolution to use. It is required if using -sname. + Indicates which IP name resolution to use. + If using -sname, specify either this option or ERL_INETRC. +
-kernel inet_dist_listen_min 4200 inet_dist_listen_min 4210
+ Define the first and last ports that epmd (section 5.2) can listen to.
-detached
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: 5222Standard port for Jabber/XMPP client connections, plain or STARTTLS. 5223Standard port for Jabber client connections using the old SSL method. 5269Standard port for Jabber/XMPP server connections. -4369Port used by EPMD for communication between Erlang nodes. -port rangeUsed for connections between Erlang nodes. This range is configurable. +4369EPMD (section 5.2) listens for Erlang node name requests. +port rangeUsed for connections between Erlang nodes. This range is configurable (see section 5.2).

5.2  epmd

@@ -2928,8 +2932,8 @@ To communicate with ejabberd, the script ejabberdctl starts a and connects to the Erlang node that holds ejabberd. In order for this communication to work, 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.

If you build a cluster of several ejabberd instances, +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. Those ejabberd 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 ejabberd nodes you must open the port 4369 for the machines involved in the cluster. 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 ejabberdctl.cfg. +The Erlang command-line parameter used internally is, for example: 

erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375

5.3  Erlang Cookie

diff --git a/doc/guide.tex b/doc/guide.tex index d1f87a6f0..4a365a5e0 100644 --- 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} -- 2.40.0