From 75a5dea054bc6e48085adb48ddfc94b5cf0830e9 Mon Sep 17 00:00:00 2001 From: Holger Weiss Date: Mon, 4 Dec 2023 21:19:20 +0100 Subject: [PATCH] overview.edoc: Clarify ERL_DIST_PORT defaults For the binary release specifically, ERL_DIST_PORT is set to some port number by default (as the Erlang/OTP version included with the release is known to support this feature). Document this default value. --- doc/overview.edoc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/overview.edoc b/doc/overview.edoc index 0533afb12..e55f1ae12 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -654,14 +654,16 @@ The eturnal server recognizes the following environment variables. === ERL_DIST_PORT === The environment variable `ERL_DIST_PORT' specifies the TCP port number used by -the `eturnalctl' command for communicating with eturnal. By default, a random -port is chosen. If this variable is specified, the Erlang Port Mapper Daemon -(EPMD) service is not spawned during eturnal startup, and the {@section -ERL_EPMD_ADDRESS} and {@section ERL_EPMD_PORT} variables are ignored. -`ERL_DIST_PORT' must be set to the same port number during eturnal startup and -when calling `eturnalctl'. Therefore, it's usually most convenient to specify -the `dist_port' variable at the top of the `eturnalctl' script itself. This -feature requires at least Erlang/OTP 23.1 and Rebar3 3.18.0. +the `eturnalctl' command for communicating with eturnal. If this variable is +specified, the Erlang Port Mapper Daemon (EPMD) service is not spawned +during eturnal startup, and the {@section ERL_EPMD_ADDRESS} and {@section +ERL_EPMD_PORT} variables are ignored. `ERL_DIST_PORT' must be set to the same +port number during eturnal startup and when calling `eturnalctl'. Therefore, +it's usually most convenient to specify the `dist_port' variable at the top of +the `eturnalctl' script itself. For the binary release, the default value is +`3470'. Otherwise (or if `ERL_DIST_PORT' is set to an empty value), a random +port number is chosen. This feature requires at least Erlang/OTP 23.1 and +Rebar3 3.18.0. === ERL_EPMD_ADDRESS ===