faraphel/chrony
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: replace foobar naming in examples

Browse source
This commit is contained in:
Miroslav Lichvar 2023-11-22 10:29:01 +01:00
parent 5e5adbea0c
commit ed6b0b55c7
4 changed files with 73 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
doc/chrony.conf.adoc
View file

@ -427,7 +427,7 @@ error. *chronyd* then enters its normal operating mode.
An example of the use of the directive is: An example of the use of the directive is:
+ +
---- ----
initstepslew 30 foo.example.net bar.example.net baz.example.net initstepslew 30 ntp1.example.net ntp2.example.net ntp3.example.net
---- ----
+ +
where 3 NTP servers are used to make the measurement. The _30_ indicates that where 3 NTP servers are used to make the measurement. The _30_ indicates that
@ -865,10 +865,10 @@ they change (e.g. after a renewal).
An example is: An example is:
+ +
---- ----
ntstrustedcerts /etc/pki/nts/foo.crt ntstrustedcerts /etc/pki/nts/ca1.example.net.crt
ntstrustedcerts 1 /etc/pki/nts/bar.crt ntstrustedcerts 1 /etc/pki/nts/ca2.example.net.crt
ntstrustedcerts 1 /etc/pki/nts/baz.crt ntstrustedcerts 1 /etc/pki/nts/ca3.example.net.crt
ntstrustedcerts 2 /etc/pki/nts/qux.crt ntstrustedcerts 2 /etc/pki/nts/ntp2.example.net.crt
---- ----
[[nosystemcert]]*nosystemcert*:: [[nosystemcert]]*nosystemcert*::
@ -965,9 +965,9 @@ before 4.0.
As an example, the following configuration using the default *mix* mode: As an example, the following configuration using the default *mix* mode:
+ +
---- ----
server foo.example.net nts server ntp1.example.net nts
server bar.example.net nts server ntp2.example.net nts
server baz.example.net server ntp3.example.net
refclock SOCK /var/run/chrony.ttyS0.sock refclock SOCK /var/run/chrony.ttyS0.sock
---- ----
+ +
@ -975,9 +975,9 @@ is equivalent to the following configuration using the *ignore* mode:
+ +
---- ----
authselectmode ignore authselectmode ignore
server foo.example.net nts require trust server ntp1.example.net nts require trust
server bar.example.net nts require trust server ntp2.example.net nts require trust
server baz.example.net server ntp3.example.net
refclock /var/run/chrony.ttyS0.sock require trust refclock /var/run/chrony.ttyS0.sock require trust
---- ----
@ -2759,7 +2759,7 @@ the PTP transparent clocks.
An example of client configuration is: An example of client configuration is:
+ +
---- ----
server foo.example.net minpoll 0 maxpoll 0 xleave port 319 extfield F324 server ntp1.example.net minpoll 0 maxpoll 0 xleave port 319 extfield F324
hwtimestamp * rxfilter ptp hwtimestamp * rxfilter ptp
ptpport 319 ptpport 319
---- ----
@ -2820,13 +2820,13 @@ the following methods:
facilities. facilities.
* Use public servers from the https://www.pool.ntp.org/[pool.ntp.org] project. * Use public servers from the https://www.pool.ntp.org/[pool.ntp.org] project.
Assuming that your NTP servers are called _foo.example.net_, _bar.example.net_ Assuming that your NTP servers are called _ntp1.example.net_, _ntp2.example.net_
and _baz.example.net_, your _chrony.conf_ file could contain as a minimum: and _ntp3.example.net_, your _chrony.conf_ file could contain as a minimum:
---- ----
server foo.example.net server ntp1.example.net
server bar.example.net server ntp2.example.net
server baz.example.net server ntp3.example.net
---- ----
However, you will probably want to include some of the other directives. The However, you will probably want to include some of the other directives. The
@ -2837,9 +2837,9 @@ synchronisation. The smallest useful configuration file would look something
like: like:
---- ----
server foo.example.net iburst server ntp1.example.net iburst
server bar.example.net iburst server ntp2.example.net iburst
server baz.example.net iburst server ntp3.example.net iburst
driftfile @CHRONYVARDIR@/drift driftfile @CHRONYVARDIR@/drift
makestep 1.0 3 makestep 1.0 3
rtcsync rtcsync
@ -2863,9 +2863,9 @@ option will enable a secure synchronisation to the servers. The configuration
file could look like: file could look like:
---- ----
server foo.example.net iburst nts server ntp1.example.net iburst nts
server bar.example.net iburst nts server ntp2.example.net iburst nts
server baz.example.net iburst nts server ntp3.example.net iburst nts
driftfile @CHRONYVARDIR@/drift driftfile @CHRONYVARDIR@/drift
makestep 1.0 3 makestep 1.0 3
rtcsync rtcsync
@ -2879,14 +2879,14 @@ additional configuration to tell *chronyd* when the connection goes up and
down. This saves the program from continuously trying to poll the servers when down. This saves the program from continuously trying to poll the servers when
they are inaccessible. they are inaccessible.
Again, assuming that your NTP servers are called _foo.example.net_, Again, assuming that your NTP servers are called _ntp1.example.net_,
_bar.example.net_ and _baz.example.net_, your _chrony.conf_ file would now _ntp2.example.net_ and _ntp3.example.net_, your _chrony.conf_ file would now
contain: contain:
---- ----
server foo.example.net offline server ntp1.example.net offline
server bar.example.net offline server ntp2.example.net offline
server baz.example.net offline server ntp3.example.net offline
driftfile @CHRONYVARDIR@/drift driftfile @CHRONYVARDIR@/drift
makestep 1.0 3 makestep 1.0 3
rtcsync rtcsync
@ -3070,9 +3070,9 @@ configuration files are shown.
For the _chrony.conf_ file, the following can be used as an example. For the _chrony.conf_ file, the following can be used as an example.
---- ----
server foo.example.net maxdelay 0.4 offline server ntp1.example.net maxdelay 0.4 offline
server bar.example.net maxdelay 0.4 offline server ntp2.example.net maxdelay 0.4 offline
server baz.example.net maxdelay 0.4 offline server ntp3.example.net maxdelay 0.4 offline
logdir /var/log/chrony logdir /var/log/chrony
log statistics measurements tracking log statistics measurements tracking
driftfile @CHRONYVARDIR@/drift driftfile @CHRONYVARDIR@/drift
@ -3131,10 +3131,10 @@ configuration).
The configuration file could look like: The configuration file could look like:
---- ----
server foo.example.net iburst server ntp1.example.net iburst
server bar.example.net iburst server ntp2.example.net iburst
server baz.example.net iburst server ntp3.example.net iburst
server qux.example.net iburst server ntp4.example.net iburst
makestep 1.0 3 makestep 1.0 3
rtcsync rtcsync
allow allow

38
doc/chronyc.adoc
View file

@ -144,7 +144,7 @@ The *tracking* command displays parameters about the system's clock
performance. An example of the output is shown below. performance. An example of the output is shown below.
+ +
---- ----
Reference ID : CB00710F (foo.example.net) Reference ID : CB00710F (ntp1.example.net)
Stratum : 3 Stratum : 3
Ref time (UTC) : Fri Jan 27 09:49:17 2017 Ref time (UTC) : Fri Jan 27 09:49:17 2017
System time : 0.000006523 seconds slow of NTP time System time : 0.000006523 seconds slow of NTP time
@ -178,7 +178,7 @@ with an IPv4 address.
*Stratum*::: *Stratum*:::
The stratum indicates how many hops away from a computer with an attached The stratum indicates how many hops away from a computer with an attached
reference clock we are. Such a computer is a stratum-1 computer, so the reference clock we are. Such a computer is a stratum-1 computer, so the
computer in the example is two hops away (i.e. _foo.example.net_ is a computer in the example is two hops away (i.e. _ntp1.example.net_ is a
stratum-2 and is synchronised from a stratum-1). stratum-2 and is synchronised from a stratum-1).
*Ref time*::: *Ref time*:::
This is the time (UTC) at which the last measurement from the reference This is the time (UTC) at which the last measurement from the reference
@ -321,8 +321,8 @@ extra caption lines are shown as a reminder of the meanings of the columns.
MS Name/IP address Stratum Poll Reach LastRx Last sample MS Name/IP address Stratum Poll Reach LastRx Last sample
=============================================================================== ===============================================================================
#* GPS0 0 4 377 11 -479ns[ -621ns] +/- 134ns #* GPS0 0 4 377 11 -479ns[ -621ns] +/- 134ns
^? foo.example.net 2 6 377 23 -923us[ -924us] +/- 43ms ^? ntp1.example.net 2 6 377 23 -923us[ -924us] +/- 43ms
^+ bar.example.net 1 6 377 21 -2629us[-2619us] +/- 86ms ^+ ntp2.example.net 1 6 377 21 -2629us[-2619us] +/- 86ms
---- ----
+ +
The columns are as follows: The columns are as follows:
@ -400,7 +400,7 @@ An example report is:
---- ----
Name/IP Address NP NR Span Frequency Freq Skew Offset Std Dev Name/IP Address NP NR Span Frequency Freq Skew Offset Std Dev
=============================================================================== ===============================================================================
foo.example.net 11 5 46m -0.001 0.045 1us 25us ntp1.example.net 11 5 46m -0.001 0.045 1us 25us
---- ----
+ +
The columns are as follows: The columns are as follows:
@ -444,9 +444,9 @@ An example of the output is shown below.
---- ----
S Name/IP Address Auth COpts EOpts Last Score Interval Leap S Name/IP Address Auth COpts EOpts Last Score Interval Leap
======================================================================= =======================================================================
D foo.example.net Y ----- --TR- 4 1.0 -61ms +62ms N D ntp1.example.net Y ----- --TR- 4 1.0 -61ms +62ms N
* bar.example.net N ----- ----- 0 1.0 -6846us +7305us N * ntp2.example.net N ----- ----- 0 1.0 -6846us +7305us N
+ baz.example.net N ----- ----- 10 1.0 -7381us +7355us N + ntp3.example.net N ----- ----- 10 1.0 -7381us +7355us N
---- ----
+ +
The columns are as follows: The columns are as follows:
@ -592,9 +592,9 @@ shown below.
---- ----
Name/IP address Mode KeyID Type KLen Last Atmp NAK Cook CLen Name/IP address Mode KeyID Type KLen Last Atmp NAK Cook CLen
========================================================================= =========================================================================
foo.example.net NTS 1 15 256 135m 0 0 8 100 ntp1.example.net NTS 1 15 256 135m 0 0 8 100
bar.example.net SK 30 13 128 - 0 0 0 0 ntp2.example.net SK 30 13 128 - 0 0 0 0
baz.example.net - 0 0 0 - 0 0 0 0 ntp3.example.net - 0 0 0 - 0 0 0 0
---- ----
+ +
The columns are as follows: The columns are as follows:
@ -758,7 +758,7 @@ parameters and options is identical to that for the
An example of using this command is shown below. An example of using this command is shown below.
+ +
---- ----
add peer foo.example.net minpoll 6 maxpoll 10 key 25 add peer ntp1.example.net minpoll 6 maxpoll 10 key 25
---- ----
[[add_pool]]*add pool* _name_ [_option_]...:: [[add_pool]]*add pool* _name_ [_option_]...::
@ -772,7 +772,7 @@ directive in the configuration file.
An example of using this command is shown below: An example of using this command is shown below:
+ +
---- ----
add pool foo.example.net maxsources 3 iburst add pool ntp1.example.net maxsources 3 iburst
---- ----
[[add_server]]*add server* _name_ [_option_]...:: [[add_server]]*add server* _name_ [_option_]...::
@ -786,7 +786,7 @@ directive in the configuration file.
An example of using this command is shown below: An example of using this command is shown below:
+ +
---- ----
add server foo.example.net minpoll 6 maxpoll 10 key 25 add server ntp1.example.net minpoll 6 maxpoll 10 key 25
---- ----
[[delete]]*delete* _address_:: [[delete]]*delete* _address_::
@ -862,7 +862,7 @@ IPv6 addresses have first 48 bits equal to _2001:db8:789a_.
Example of the three-argument form of the command is: Example of the three-argument form of the command is:
+ +
---- ----
burst 2/10 foo.example.net burst 2/10 ntp1.example.net
---- ----
[[maxdelay]]*maxdelay* _address_ _delay_:: [[maxdelay]]*maxdelay* _address_ _delay_::
@ -928,7 +928,7 @@ uses an IP address or a hostname. These forms are illustrated below.
offline offline
offline 255.255.255.0/1.2.3.0 offline 255.255.255.0/1.2.3.0
offline 2001:db8:789a::/48 offline 2001:db8:789a::/48
offline foo.example.net offline ntp1.example.net
---- ----
+ +
The second form means that the *offline* command is to be applied to any source The second form means that the *offline* command is to be applied to any source
@ -1094,7 +1094,7 @@ particular host.
Examples of use, showing a named host and a numeric IP address, are as follows: Examples of use, showing a named host and a numeric IP address, are as follows:
+ +
---- ----
accheck foo.example.net accheck ntp1.example.net
accheck 1.2.3.4 accheck 1.2.3.4
accheck 2001:db8::1 accheck 2001:db8::1
---- ----
@ -1121,7 +1121,7 @@ An example of the output is:
Hostname NTP Drop Int IntL Last Cmd Drop Int Last Hostname NTP Drop Int IntL Last Cmd Drop Int Last
=============================================================================== ===============================================================================
localhost 2 0 2 - 133 15 0 -1 7 localhost 2 0 2 - 133 15 0 -1 7
foo.example.net 12 0 6 - 23 0 0 - - ntp1.example.net 12 0 6 - 23 0 0 - -
---- ----
+ +
Each row shows the data for a single host. Only hosts that have passed the host Each row shows the data for a single host. Only hosts that have passed the host
@ -1321,7 +1321,7 @@ used to check whether monitoring access is permitted from a named host.
Examples of use are as follows: Examples of use are as follows:
+ +
---- ----
cmdaccheck foo.example.net cmdaccheck ntp1.example.net
cmdaccheck 1.2.3.4 cmdaccheck 1.2.3.4
cmdaccheck 2001:db8::1 cmdaccheck 2001:db8::1
---- ----

26
doc/faq.adoc
View file

@ -265,11 +265,11 @@ An example of a client configuration limiting the impact of the attacks could
be be
---- ----
server foo.example.net iburst nts maxdelay 0.1 server ntp1.example.net iburst nts maxdelay 0.1
server bar.example.net iburst nts maxdelay 0.2 server ntp2.example.net iburst nts maxdelay 0.2
server baz.example.net iburst nts maxdelay 0.05 server ntp3.example.net iburst nts maxdelay 0.05
server qux.example.net iburst nts maxdelay 0.1 server ntp4.example.net iburst nts maxdelay 0.1
server quux.example.net iburst nts maxdelay 0.1 server ntp5.example.net iburst nts maxdelay 0.1
minsources 3 minsources 3
maxchange 100 0 0 maxchange 100 0 0
makestep 0.001 1 makestep 0.001 1
@ -318,7 +318,7 @@ An example of the directive for an NTP server on the Internet that you are
allowed to poll frequently could be allowed to poll frequently could be
---- ----
server foo.example.net minpoll 4 maxpoll 6 polltarget 16 server ntp.example.net minpoll 4 maxpoll 6 polltarget 16
---- ----
An example using shorter polling intervals with a server located in the same An example using shorter polling intervals with a server located in the same
@ -725,9 +725,9 @@ this:
---- ----
MS Name/IP address Stratum Poll Reach LastRx Last sample MS Name/IP address Stratum Poll Reach LastRx Last sample
=============================================================================== ===============================================================================
^* foo.example.net 2 6 377 34 +484us[ -157us] +/- 30ms ^* ntp1.example.net 2 6 377 34 +484us[ -157us] +/- 30ms
^- bar.example.net 2 6 377 34 +33ms[ +32ms] +/- 47ms ^- ntp2.example.net 2 6 377 34 +33ms[ +32ms] +/- 47ms
^+ baz.example.net 3 6 377 35 -1397us[-2033us] +/- 60ms ^+ ntp3.example.net 3 6 377 35 -1397us[-2033us] +/- 60ms
---- ----
=== Are NTP servers specified with the `offline` option? === Are NTP servers specified with the `offline` option?
@ -797,9 +797,9 @@ successful:
# chronyc -N authdata # chronyc -N authdata
Name/IP address Mode KeyID Type KLen Last Atmp NAK Cook CLen Name/IP address Mode KeyID Type KLen Last Atmp NAK Cook CLen
========================================================================= =========================================================================
foo.example.net NTS 1 15 256 33m 0 0 8 100 ntp1.example.net NTS 1 15 256 33m 0 0 8 100
bar.example.net NTS 1 15 256 33m 0 0 8 100 ntp2.example.net NTS 1 15 256 33m 0 0 8 100
baz.example.net NTS 1 15 256 33m 0 0 8 100 ntp3.example.net NTS 1 15 256 33m 0 0 8 100
---- ----
The KeyID, Type, and KLen columns should have non-zero values. If they are The KeyID, Type, and KLen columns should have non-zero values. If they are
@ -923,7 +923,7 @@ Name/IP Address NP NR Span Frequency Freq Skew Offset Std Dev
============================================================================== ==============================================================================
PPS0 0 0 0 +0.000 2000.000 +0ns 4000ms PPS0 0 0 0 +0.000 2000.000 +0ns 4000ms
NMEA 58 30 231 -96.494 38.406 +504ms 6080us NMEA 58 30 231 -96.494 38.406 +504ms 6080us
foo.example.net 7 3 200 -2.991 16.141 -107us 492us ntp1.example.net 7 3 200 -2.991 16.141 -107us 492us
---- ----
the offset of the NMEA source would need to be increased by about 0.504 the offset of the NMEA source would need to be increased by about 0.504

12
examples/chrony.conf.example3
View file

@ -27,9 +27,9 @@
# you can access at http://support.ntp.org/bin/view/Servers/WebHome or # you can access at http://support.ntp.org/bin/view/Servers/WebHome or
# you can use servers from the pool.ntp.org project. # you can use servers from the pool.ntp.org project.
! server foo.example.net iburst ! server ntp1.example.net iburst
! server bar.example.net iburst ! server ntp2.example.net iburst
! server baz.example.net iburst ! server ntp3.example.net iburst
! pool pool.ntp.org iburst ! pool pool.ntp.org iburst
@ -99,8 +99,8 @@ ntsdumpdir /var/lib/chrony
# and edit the following lines to specify the locations of the certificate and # and edit the following lines to specify the locations of the certificate and
# key. # key.
! ntsservercert /etc/.../foo.example.net.crt ! ntsservercert /etc/.../nts-server.crt
! ntsserverkey /etc/.../foo.example.net.key ! ntsserverkey /etc/.../nts-server.key
# chronyd can save the measurement history for the servers to files when # chronyd can save the measurement history for the servers to files when
# it exits. This is useful in 2 situations: # it exits. This is useful in 2 situations:
@ -238,7 +238,7 @@ ntsdumpdir /var/lib/chrony
# several people, you need to set up a mailing list or sendmail alias # several people, you need to set up a mailing list or sendmail alias
# for them and use the address of that.) # for them and use the address of that.)
! mailonchange wibble@foo.example.net 0.5 ! mailonchange wibble@example.net 0.5
####################################################################### #######################################################################
### COMMAND ACCESS ### COMMAND ACCESS