Skip to content

Commit

Permalink
Add recommended port numbers in ntp.toml man page
Browse files Browse the repository at this point in the history
  • Loading branch information
rnijveld authored and davidv1992 committed Sep 20, 2023
1 parent 75c182e commit 2802681
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
17 changes: 9 additions & 8 deletions docs/man/ntp.toml.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,10 @@ time.
`listen` = *socketaddr*
: Address of a UDP socket on which the server should listen for incoming NTP
requests. Specified as an interface IP address, a colon and a port number.
Both IPv4 and IPv6 are supported. For example to listen on localhost port
123 in IPv4 you can use `127.0.0.1:123`. You can listen on all available
network interfaces at once using `0.0.0.0:123` for IPv4 or `[::]:123` for
IPv6.
The standard port number for NTP is UDP port 123. Both IPv4 and IPv6 are
supported. For example to listen on localhost port 123 in IPv4 you can use
`127.0.0.1:123`. You can listen on all available network interfaces at once
using `0.0.0.0:123` for IPv4 or `[::]:123` for IPv6.

`rate-limiting-cache-size` = *size* (**0**)
: Number of elements in the rate limiting cache. At most *size* elements are
Expand Down Expand Up @@ -216,10 +216,11 @@ untampered with.
`listen` = *socket*
: Address of a TCP socket on which the server should listen for incoming NTS
key exchange requests. Specified as an interface IP address, a colon and a
port number. Both IPv4 and IPv6 are supported. For example to listen on
localhost port 123 in IPv4 you can use `127.0.0.1:123`. You can listen on
all available network interfaces at once using `0.0.0.0:123` for IPv4 or
`[::]:123` for IPv6.
port number. The standard port number for an NTS key exchange server is TCP
port 4460. Both IPv4 and IPv6 are supported. For example to listen on
localhost port 4460 in IPv4 you can use `127.0.0.1:4460`. You can listen on
all available network interfaces at once using `0.0.0.0:4460` for IPv4 or
`[::]:4460` for IPv6.

`certificate-chain-path` = *path*
: Path to a certificate chain for the public certificate that the server
Expand Down
9 changes: 6 additions & 3 deletions docs/precompiled/man/ntp.toml.5
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ Servers always serve the system clock time.
Address of a UDP socket on which the server should listen for incoming
NTP requests.
Specified as an interface IP address, a colon and a port number.
The standard port number for NTP is UDP port 123.
Both IPv4 and IPv6 are supported.
For example to listen on localhost port 123 in IPv4 you can use
\f[V]127.0.0.1:123\f[R].
Expand Down Expand Up @@ -274,11 +275,13 @@ validate that the traffic was untampered with.
Address of a TCP socket on which the server should listen for incoming
NTS key exchange requests.
Specified as an interface IP address, a colon and a port number.
The standard port number for an NTS key exchange server is TCP port
4460.
Both IPv4 and IPv6 are supported.
For example to listen on localhost port 123 in IPv4 you can use
\f[V]127.0.0.1:123\f[R].
For example to listen on localhost port 4460 in IPv4 you can use
\f[V]127.0.0.1:4460\f[R].
You can listen on all available network interfaces at once using
\f[V]0.0.0.0:123\f[R] for IPv4 or \f[V][::]:123\f[R] for IPv6.
\f[V]0.0.0.0:4460\f[R] for IPv4 or \f[V][::]:4460\f[R] for IPv6.
.TP
\f[V]certificate-chain-path\f[R] = \f[I]path\f[R]
Path to a certificate chain for the public certificate that the server
Expand Down

0 comments on commit 2802681

Please sign in to comment.