Difference between revisions of "Network Time Protocol daemon"

From ArchWiki
Jump to: navigation, search
(Using without daemon)
(42 intermediate revisions by 23 users not shown)
Line 1: Line 1:
[[Category:Networking (English)]]
+
[[Category:Networking]]
[[Category:Daemons and system services]]
+
[[es:Network Time Protocol daemon]]
{{i18n|Network Time Protocol daemon}}
+
 
[[fr:ntp]]
 
[[fr:ntp]]
 
+
[[it:Network Time Protocol daemon]]
 +
[[ru:Network Time Protocol daemon]]
 +
[[zh-CN:Network Time Protocol daemon]]
 
This article describes how to set up and run NTPd (Network Time Protocol daemon), the most common method to synchronize the [[Time|software clock]] of a GNU/Linux system with internet time servers using the [[Wikipedia:Network Time Protocol|Network Time Protocol]]; if set up correctly, NTPd can make your computer act as a time server itself.
 
This article describes how to set up and run NTPd (Network Time Protocol daemon), the most common method to synchronize the [[Time|software clock]] of a GNU/Linux system with internet time servers using the [[Wikipedia:Network Time Protocol|Network Time Protocol]]; if set up correctly, NTPd can make your computer act as a time server itself.
  
Line 20: Line 21:
  
 
The following lines are just an example:
 
The following lines are just an example:
 
+
{{hc|/etc/ntp.conf|
server 0.pool.ntp.org iburst
+
server 0.pool.ntp.org iburst
server 1.pool.ntp.org iburst
+
server 1.pool.ntp.org iburst
server 2.pool.ntp.org iburst
+
server 2.pool.ntp.org iburst
server 3.pool.ntp.org iburst
+
server 3.pool.ntp.org iburst
 
+
}}
The ''iburst'' option is recommended, and sends a burst of packets if it cannot obtain a connection with the first attempt. The ''burst'' option always sends a burst of packets, even on the first attempt. The ''burst'' option should never be used without explicit permission and may result in blacklisting.
+
The {{ic|iburst}} option is recommended, and sends a burst of packets only if it cannot obtain a connection with the first attempt. The {{ic|burst}} option always does this, even on the first attempt, and should never be used without explicit permission and may result in blacklisting.
  
 
===Configuring your own NTP server===
 
===Configuring your own NTP server===
Line 44: Line 45:
 
  restrict default kod nomodify notrap nopeer noquery
 
  restrict default kod nomodify notrap nopeer noquery
  
{{Note|This still allows other people to query your time server. You need to add {{ic|noserve}} to stop serving time.}}
+
{{Note|This still allows other people to query your time server. You need to add {{ic|noserve}} to stop serving time. It will also block time synchronization since it blocks all packets except ntpq and ntpdc queries.}}
  
 
Full docs for the "restrict" option are in {{ic|man ntp_acc}}. See https://support.ntp.org/bin/view/Support/AccessRestrictions for detailed instructions.
 
Full docs for the "restrict" option are in {{ic|man ntp_acc}}. See https://support.ntp.org/bin/view/Support/AccessRestrictions for detailed instructions.
Line 84: Line 85:
 
===Other resources about NTP configuration===
 
===Other resources about NTP configuration===
 
In conclusion, never forget man pages: {{ic|man ntp.conf}} is likely to answer any doubts you could still have (see also the related man pages: {{ic|man <nowiki>{ntpd|ntp_auth|ntp_mon|ntp_acc|ntp_clock|ntp_misc}</nowiki>}}).
 
In conclusion, never forget man pages: {{ic|man ntp.conf}} is likely to answer any doubts you could still have (see also the related man pages: {{ic|man <nowiki>{ntpd|ntp_auth|ntp_mon|ntp_acc|ntp_clock|ntp_misc}</nowiki>}}).
 
{{Gentoo|NTP}}
 
  
 
==Using without daemon==
 
==Using without daemon==
 
 
To synchronize your system clock just once, without starting the NTP daemon, run:
 
To synchronize your system clock just once, without starting the NTP daemon, run:
  # ntpd -qg
+
  # ntpd -q
  
This has the same effect as the {{ic|ntpdate}} program, [http://support.ntp.org/bin/view/Dev/DeprecatingNtpdate which is now deprecated].
+
{{Note|This has the same effect as the [http://support.ntp.org/bin/view/Dev/DeprecatingNtpdate now deprecated] {{ic|ntpdate}}.}}
 
+
The {{ic|-g}} option allows shifting the clock further than the panic threshold (15 min by default) without a warning. Note that such offset is abnormal and might indicate either wrong timezone setting, clock chip failure, or simply a very long period of neglect. If in these cases you would rather not set the clock and print an error to syslog, remove {{ic|-g}}.
+
  
 
After updating the system clock, store the time to the hardware clock so that it is preserved when rebooting:
 
After updating the system clock, store the time to the hardware clock so that it is preserved when rebooting:
Line 100: Line 96:
  
 
===Synchronize once per boot===
 
===Synchronize once per boot===
 +
{{Warning|Using this method is discouraged on servers and in general on machines that run without rebooting for more than a few days.}}
  
To synchronize your system clock every time the system boots, add the following line to {{ic|/etc/rc.local}} (see [[Autostarting]] for alternative methods):
+
Write a ''oneshot'' [[systemd]] unit:
 
+
{{hc|/etc/systemd/system/ntp-once.service|2=
ntpd -qg &
+
[Unit]
 
+
Description=Network Time Service (once)
You should also ensure that the {{ic|hwclock}} daemon is added to the [[Daemon#Starting_on_Boot|DAEMONS array]], unless something other already takes care of updating the hardware clock, for example another operating system in dual boot. See also [[Time#hwclock daemon]].
+
After=network.target nss-lookup.target
 
+
In order for this method to work you have to make sure that, when {{ic|rc.local}} is executed, the network connection has already been initialized (for example you should not background essential network-related daemons in {{ic|/etc/rc.conf}})
+
 
+
If for some reason you do not want to run the {{ic|hwclock}} daemon, add the following line to {{ic|/etc/rc.local}} in place of {{ic|ntpd -qg &}}:
+
  
{ ntpd -qg; hwclock -w; } &
+
[Service]
 +
Type=oneshot
 +
ExecStart=/usr/bin/ntpd -g -u ntp:ntp ; /usr/bin/hwclock -w
  
This syntax causes both commands to run in the background, but ensures that they get executed in order (and not simultaneously). Note that running the {{ic|hwclock -w}} command at boot is not equivalent to executing the {{ic|hwclock}} daemon, which instead runs {{ic|hwclock --adjust}} at shutdown.
+
[Install]
 +
WantedBy=multi-user.target}}
  
{{Warning|
+
and enable it: {{bc|# systemctl enable ntp-once}}
*Using this method is discouraged on servers and in general on machines that need to run continuously for more than 2 or 3 days, as the system clock will be updated only once at boot time.
+
Note that a [[systemd]] unit of the type ''oneshot'' executes once only. Hence the {{ic|ntpd -q}} option should not be used in this case.
*Running {{ic|ntpd -qg}} as a ''cron'' event is to be avoided, unless you are aware of how your running applications would react to instantaneous system time changes.}}
+
  
 
==Running as a daemon==
 
==Running as a daemon==
===Starting ntpd===
 
ntpd sets 11 minute mode, which syncs the system clock to hardware every 11 minutes. The hwclock daemon measures hardware clock drift and syncs it, which conflicts with ntpd.
 
  
Stop the hwclock daemon (if it is running):
+
To start ntpd:
 +
{{bc|# systemctl start ntpd}}
  
{{bc|# rc.d stop hwclock}}
+
To enable ntpd at startup:
 +
{{bc|# systemctl enable ntpd}}
  
Start the ntpd daemon:
+
Or alternatively with the command:  
{{bc|# rc.d start ntpd}}
+
{{bc|# timedatectl set-ntp 1}}
  
Add ntpd to your DAEMONS array so it starts automatically on boot and make sure hwclock is disabled:
+
===Check whether the daemon is synchronizing correctly===
{{hc|/etc/rc.conf|2=DAEMONS=(... !hwclock '''ntpd''' ...)}}
+
Before you can use the ntpq command you'll need to use pacman and install the {{pkg|libedit}} package.  Then use ntpq to see the list of configured peers:
 +
{{bc|$ ntpq -np}}
 +
The delay, offset and jitter columns should be non-zero. The servers ntpd is synchronizing with are prefixed by an asterisk. It can take several minutes before ntpd selects a server to synchronize with; try checking after 17 minutes (1024 seconds).
  
 
===NetworkManager===
 
===NetworkManager===
 
{{Note|ntpd should still be running when the network is down if the hwclock daemon is disabled, so you should not use this.}}
 
{{Note|ntpd should still be running when the network is down if the hwclock daemon is disabled, so you should not use this.}}
''ntpd'' can be brought up/down along with a network connection through the use of [[NetworkManager#Network Services with NetworkManager Dispatcher|NetworkManager's dispatcher scripts]]. You can install the needed script from [community]:
+
''ntpd'' can be brought up/down along with a network connection through the use of [[NetworkManager#Network services with NetworkManager dispatcher|NetworkManager's dispatcher scripts]]. You will need to install {{Pkg|networkmanager-dispatcher-ntpd}} from the [[official repositories]].
 
+
{{bc|# pacman -S networkmanager-dispatcher-ntpd}}
+
  
 
===Running in a chroot===
 
===Running in a chroot===
{{Note|Before attempting this, complete the previous section on running as non-root, since chroots are relatively useless at securing processes running as root.}}
+
{{Note|ntpd should be run as non-root before attempting to jail it in a chroot (default in the vanilla Arch Linux package), since chroots are relatively useless at securing processes running as root.}}
  
 
Edit {{ic|/etc/conf.d/ntpd.conf}} and change
 
Edit {{ic|/etc/conf.d/ntpd.conf}} and change
 
 
  NTPD_ARGS="-g -u ntp:ntp"
 
  NTPD_ARGS="-g -u ntp:ntp"
  
 
to
 
to
 
 
  NTPD_ARGS="-g -i /var/lib/ntp -u ntp:ntp"
 
  NTPD_ARGS="-g -i /var/lib/ntp -u ntp:ntp"
  
 
Then, edit {{ic|/etc/ntp.conf}} to change the driftfile path such that it is relative to the chroot directory, rather than to the real system root. Change:
 
Then, edit {{ic|/etc/ntp.conf}} to change the driftfile path such that it is relative to the chroot directory, rather than to the real system root. Change:
 
 
  driftfile      /var/lib/ntp/ntp.drift
 
  driftfile      /var/lib/ntp/ntp.drift
  
 
to
 
to
 
 
  driftfile      /ntp.drift
 
  driftfile      /ntp.drift
  
 
Create a suitable chroot environment so that getaddrinfo() will work by creating pertinent directories and files (as root):
 
Create a suitable chroot environment so that getaddrinfo() will work by creating pertinent directories and files (as root):
 
+
# mkdir /var/lib/ntp/etc /var/lib/ntp/lib /var/lib/ntp/proc
{{bc|<nowiki># mkdir /var/lib/ntp/etc /var/lib/ntp/lib /var/lib/ntp/proc
+
# touch /var/lib/ntp/etc/resolv.conf /var/lib/ntp/etc/services
# touch /var/lib/ntp/etc/resolv.conf /var/lib/ntp/etc/services</nowiki>}}
+
  
 
and by bind-mounting the aformentioned files:
 
and by bind-mounting the aformentioned files:
Line 170: Line 160:
 
/etc/resolv.conf  /var/lib/ntp/etc/resolv.conf none bind 0 0
 
/etc/resolv.conf  /var/lib/ntp/etc/resolv.conf none bind 0 0
 
/etc/services   /var/lib/ntp/etc/services none bind 0 0
 
/etc/services   /var/lib/ntp/etc/services none bind 0 0
/lib           /var/lib/ntp/lib none bind 0 0
+
/lib   /var/lib/ntp/lib none bind 0 0
 
/proc   /var/lib/ntp/proc none bind 0 0
 
/proc   /var/lib/ntp/proc none bind 0 0
 
}}
 
}}
  
{{bc|# mount -a}}
+
# mount -a
  
 
Finally, restart the daemon again:
 
Finally, restart the daemon again:
 
+
# systemctl restart ntpd
{{bc|# rc.d restart ntpd}}
+
  
 
It is relatively difficult to be sure that your driftfile configuration is actually working without waiting a while, as ntpd does not read or write it very often. If you get it wrong, it will log an error; if you get it right, it will update the timestamp. If you do not see any errors about it after a full day of running, and the timestamp is updated, you should be confident of success.
 
It is relatively difficult to be sure that your driftfile configuration is actually working without waiting a while, as ntpd does not read or write it very often. If you get it wrong, it will log an error; if you get it right, it will update the timestamp. If you do not see any errors about it after a full day of running, and the timestamp is updated, you should be confident of success.
  
 
==Alternatives==
 
==Alternatives==
Available alternative to NTPd are [[Chrony]], a dial-up friendly and specifically designed for systems that are not online all the time, and [[OpenNTPD]], part of the OpenBSD project and currently not maintained for Linux.
+
An alternative to NTPd is [[Chrony]], a dial-up friendly and specifically designed for systems that are not online all the time.
  
 
==See also==
 
==See also==

Revision as of 03:48, 17 June 2013

This article describes how to set up and run NTPd (Network Time Protocol daemon), the most common method to synchronize the software clock of a GNU/Linux system with internet time servers using the Network Time Protocol; if set up correctly, NTPd can make your computer act as a time server itself.

Installation

Install ntp, available in the Official Repositories.

Configuration

Tip: The ntp package is installed with a default /etc/ntp.conf that should make NTPd work without requiring custom configuration.

Configuring connection to NTP servers

The first thing you define in your /etc/ntp.conf is the servers your machine will synchronize to.

NTP servers are classified in a hierarchical system with many levels called strata: the devices which are considered independent time sources are classified as stratum 0 sources; the servers directly connected to stratum 0 devices are classified as stratum 1 sources; servers connected to stratum 1 sources are then classified as stratum 2 sources and so on.

It has to be understood that a server's stratum cannot be taken as an indication of its accuracy or reliability. Typically, stratum 2 servers are used for general synchronization purposes: if you do not already know the servers you are going to connect to, you should use the pool.ntp.org servers (alternate link) and choose the server pool that is closest to your location.

The following lines are just an example:

/etc/ntp.conf
server 0.pool.ntp.org iburst
server 1.pool.ntp.org iburst
server 2.pool.ntp.org iburst
server 3.pool.ntp.org iburst

The iburst option is recommended, and sends a burst of packets only if it cannot obtain a connection with the first attempt. The burst option always does this, even on the first attempt, and should never be used without explicit permission and may result in blacklisting.

Configuring your own NTP server

If setting up an NTP server, you need to add local clock as a server, so that, in case it loses internet access, it will continue serving time to the network; add local clock as a stratum 10 server (using the fudge command) so that it will never be used unless internet access is lost:

server 127.127.1.0
fudge  127.127.1.0 stratum 10

Next, define the rules that will allow clients to connect to your service (localhost is considered a client too) using the restrict command; you should already have a line like this in your file:

restrict default nomodify nopeer noquery

This restricts everyone from modifying anything and prevents everyone from querying the status of your time server: nomodify prevents reconfiguring your ntpd (with ntpq or ntpdc), and noquery prevents dumping status data from your ntpd (also with ntpq or ntpdc).

You can also add other options:

restrict default kod nomodify notrap nopeer noquery
Note: This still allows other people to query your time server. You need to add noserve to stop serving time. It will also block time synchronization since it blocks all packets except ntpq and ntpdc queries.

Full docs for the "restrict" option are in man ntp_acc. See https://support.ntp.org/bin/view/Support/AccessRestrictions for detailed instructions.

Following this line, you need to tell ntpd what to allow through into your server; the following line is enough if you are not configuring an NTP server:

restrict 127.0.0.1

If you want to force DNS resolution to the IPv6 namespace, write -6 before the IP address or host name (-4 forces IPv4 instead), for example:

restrict -6 default kod nomodify notrap nopeer noquery
restrict -6 ::1    # ::1 is the IPv6 equivalent for 127.0.0.1

Lastly, specify the drift file (which keeps track of your clock's time deviation) and optionally the log file location:

driftfile /var/lib/ntp/ntp.drift
logfile /var/log/ntp.log

A very basic configuration file will look like this (all comments have been stripped out for clarity):

/etc/ntp.conf
server 0.pool.ntp.org iburst
server 1.pool.ntp.org iburst
server 2.pool.ntp.org iburst
server 3.pool.ntp.org iburst

restrict default kod nomodify notrap nopeer noquery
restrict -6 default kod nomodify notrap nopeer noquery

restrict 127.0.0.1
restrict -6 ::1  

driftfile /var/lib/ntp/ntp.drift
logfile /var/log/ntp.log
Note: Defining the log file is not mandatory, but it is always a good idea to have feedback for ntpd operations.

Other resources about NTP configuration

In conclusion, never forget man pages: man ntp.conf is likely to answer any doubts you could still have (see also the related man pages: man {ntpd|ntp_auth|ntp_mon|ntp_acc|ntp_clock|ntp_misc}).

Using without daemon

To synchronize your system clock just once, without starting the NTP daemon, run:

# ntpd -q
Note: This has the same effect as the now deprecated ntpdate.

After updating the system clock, store the time to the hardware clock so that it is preserved when rebooting:

# hwclock -w

Synchronize once per boot

Warning: Using this method is discouraged on servers and in general on machines that run without rebooting for more than a few days.

Write a oneshot systemd unit:

/etc/systemd/system/ntp-once.service
[Unit]
Description=Network Time Service (once)
After=network.target nss-lookup.target 

[Service]
Type=oneshot
ExecStart=/usr/bin/ntpd -g -u ntp:ntp ; /usr/bin/hwclock -w

[Install]
WantedBy=multi-user.target
and enable it:
# systemctl enable ntp-once

Note that a systemd unit of the type oneshot executes once only. Hence the ntpd -q option should not be used in this case.

Running as a daemon

To start ntpd:

# systemctl start ntpd

To enable ntpd at startup:

# systemctl enable ntpd

Or alternatively with the command:

# timedatectl set-ntp 1

Check whether the daemon is synchronizing correctly

Before you can use the ntpq command you'll need to use pacman and install the libedit package. Then use ntpq to see the list of configured peers:

$ ntpq -np

The delay, offset and jitter columns should be non-zero. The servers ntpd is synchronizing with are prefixed by an asterisk. It can take several minutes before ntpd selects a server to synchronize with; try checking after 17 minutes (1024 seconds).

NetworkManager

Note: ntpd should still be running when the network is down if the hwclock daemon is disabled, so you should not use this.

ntpd can be brought up/down along with a network connection through the use of NetworkManager's dispatcher scripts. You will need to install networkmanager-dispatcher-ntpd from the official repositories.

Running in a chroot

Note: ntpd should be run as non-root before attempting to jail it in a chroot (default in the vanilla Arch Linux package), since chroots are relatively useless at securing processes running as root.

Edit /etc/conf.d/ntpd.conf and change

NTPD_ARGS="-g -u ntp:ntp"

to

NTPD_ARGS="-g -i /var/lib/ntp -u ntp:ntp"

Then, edit /etc/ntp.conf to change the driftfile path such that it is relative to the chroot directory, rather than to the real system root. Change:

driftfile       /var/lib/ntp/ntp.drift

to

driftfile       /ntp.drift

Create a suitable chroot environment so that getaddrinfo() will work by creating pertinent directories and files (as root):

# mkdir /var/lib/ntp/etc /var/lib/ntp/lib /var/lib/ntp/proc
# touch /var/lib/ntp/etc/resolv.conf /var/lib/ntp/etc/services

and by bind-mounting the aformentioned files:

/etc/fstab
...
#ntpd chroot mounts
/etc/resolv.conf  /var/lib/ntp/etc/resolv.conf none bind 0 0
/etc/services	  /var/lib/ntp/etc/services none bind 0 0
/lib		  /var/lib/ntp/lib none bind 0 0
/proc		  /var/lib/ntp/proc none bind 0 0
# mount -a

Finally, restart the daemon again:

# systemctl restart ntpd

It is relatively difficult to be sure that your driftfile configuration is actually working without waiting a while, as ntpd does not read or write it very often. If you get it wrong, it will log an error; if you get it right, it will update the timestamp. If you do not see any errors about it after a full day of running, and the timestamp is updated, you should be confident of success.

Alternatives

An alternative to NTPd is Chrony, a dial-up friendly and specifically designed for systems that are not online all the time.

See also

  • Time (for more information on computer timekeeping)

External links