Skip to content

Commit

Permalink
overview.edoc: Clarify ERL_DIST_PORT defaults
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
weiss committed Dec 4, 2023
1 parent a4681fc commit 75a5dea
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions doc/overview.edoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <em>not</em> 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. <em>This
feature requires at least Erlang/OTP 23.1 and Rebar3 3.18.0.</em>
the `eturnalctl' command for communicating with eturnal. If this variable is
specified, the Erlang Port Mapper Daemon (EPMD) service is <em>not</em> 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. <em>This feature requires at least Erlang/OTP 23.1 and
Rebar3 3.18.0.</em>

=== ERL_EPMD_ADDRESS ===

Expand Down

0 comments on commit 75a5dea

Please sign in to comment.