Skip to content

Commit 589fbea

Browse files
davidv1992rnijveld
authored andcommitted
Added documentation on using ntpd-rs in the pool.
1 parent e81db82 commit 589fbea

File tree

4 files changed

+40
-0
lines changed

4 files changed

+40
-0
lines changed

docs/guide/nts-pool.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Participating in the NTS pool
2+
3+
Network Time Security (NTS) is an extension to the NTP protocol aimed at
4+
securing the communication between NTP clients and servers. An experimental
5+
pool for servers supporting NTS has recently been set up at
6+
<https://experimental.ntspooltest.org/>
7+
8+
NTPD-rs versions newer than 1.7.0-alpha.20251003 support being added to this
9+
pool. This guide will assume you are running a version more recent than this,
10+
and have already setup an NTS server using the instructions in [our NTS guide](./nts.md).
11+
12+
## Adding your server
13+
14+
To add an NTS server to the pool, on the pool website add the domain name of
15+
the server on the `Time sources` page after logging in. The pool will give you
16+
an authentication key the pool will use to authenticate itself to your NTS
17+
server. This key will need to be added to the ntpd-rs configuration to allow
18+
the pool to handle NTS key exchange connections for your server.
19+
20+
To add this key, modify the ntpd-rs configuration at `/etc/ntpd-rs/ntp.toml`,
21+
adding to the `[[nts-ke-server]]` section the following:
22+
```toml
23+
accepted-pool-authentication-tokens = ["<YOUR TOKEN HERE>"]
24+
```
25+
26+
After restarting your server, it will start accepting requests from the pool,
27+
and you will start to see your score on the pool website increase. When this
28+
happens, your server is succesfully configured for use in the pool.

docs/man/ntp.toml.5.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,11 @@ not tampered with.
319319
NTPv5 packets, you can set this value to `[4, 5]`. NTPv5 support is
320320
currently in beta and can still change in a backwards incompatible way.
321321

322+
`accepted-pool-authentication-tokens` = *list of keys* (**[]**)
323+
: Tokens pools can use to authenticate pool-specific requests to this NTS
324+
server. Note that pool support is currently in beta and can still change in
325+
a backwards incompatible way.
326+
322327
## `[synchronization]`
323328
This section of the configuration focusses on how the time information from the
324329
time sources is gathered and applied to the system clock.

docs/precompiled/man/ntp.toml.5

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,12 @@ To also allow negotiating NTS for draft NTPv5 packets, you can set this
404404
value to \f[V][4, 5]\f[R].
405405
NTPv5 support is currently in beta and can still change in a backwards
406406
incompatible way.
407+
.TP
408+
\f[V]accepted-pool-authentication-tokens\f[R] = \f[I]list of keys\f[R] (\f[B][]\f[R])
409+
Tokens pools can use to authenticate pool-specific requests to this NTS
410+
server.
411+
Note that pool support is currently in beta and can still change in a
412+
backwards incompatible way.
407413
.SS \f[V][synchronization]\f[R]
408414
.PP
409415
This section of the configuration focusses on how the time information

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ nav:
3636
- guide/gps-pps.md
3737
- guide/exporting-metrics.md
3838
- guide/nts.md
39+
- guide/nts-pool.md
3940
- guide/ntpv5.md
4041
- guide/migrating-chrony.md
4142
- guide/migrating-ntpd.md

0 commit comments

Comments
 (0)