Put in remaining pages and wiki contents.
[ikiwiki.git] / docs / handbook / handbook-network-ntp.mdwn
1 \r
2 \r
3 ## 19.12 NTP \r
4 \r
5 ***Contributed by Tom Hukins. ***\r
6 \r
7 ### 19.12.1 Overview \r
8 \r
9 Over time, a computer's clock is prone to drift. As time passes, the computer's clock becomes less accurate. NTP (Network Time Protocol) is one way to ensure your clock is right.\r
10 \r
11 Many Internet services rely on, or greatly benefit from, computers' clocks being accurate. For example, a Web server may receive requests to send a file if it has modified since a certain time. Services such as [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#cron&section8) run commands at a given time. If the clock is inaccurate, these commands may not run when expected.\r
12 \r
13 DragonFly ships with the [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpd&section8) NTP server which can be used to query other NTP servers to set the clock on your machine or provide time services to others.\r
14 \r
15 ### 19.12.2 Choosing Appropriate NTP Servers \r
16 \r
17 In order to synchronize your clock, you will need to find one or more NTP servers to use. Your network administrator or ISP may have set up an NTP server for this purpose--check their documentation to see if this is the case. There is a [list of publicly accessible NTP servers](http://www.eecis.udel.edu/~mills/ntp/servers.html) which you can use to find an NTP server near to you. Make sure you are aware of the policy for any servers you choose, and ask for permission if required.\r
18 \r
19 Choosing several unconnected NTP servers is a good idea in case one of the servers you are using becomes unreachable or its clock is unreliable. [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpd&section8) uses the responses it receives from other servers intelligently--it will favor unreliable servers less than reliable ones.\r
20 \r
21 ### 19.12.3 Configuring Your Machine \r
22 \r
23 #### Basic Configuration \r
24 \r
25 If you only wish to synchronize your clock when the machine boots up, you can use [ntpdate(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpdate&section8). This may be appropriate for some desktop machines which are frequently rebooted and only require infrequent synchronization, but most machines should run [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ntpd&section=8).\r
26 \r
27 Using [ntpdate(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpdate&section8) at boot time is also a good idea for machines that run [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ntpd&section=8). The [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ntpd&section=8) program changes the clock gradually, whereas [ntpdate(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ntpdate&section=8) sets the clock, no matter how great the difference between a machine's current clock setting and the correct time.\r
28 \r
29 To enable [ntpdate(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpdate&section8) at boot time, add `ntpdate_enable="YES"` to `/etc/rc.conf`. You will also need to specify all servers you wish to synchronize with and any flags to be passed to [ntpdate(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ntpdate&section=8) in `ntpdate_flags`.\r
30 \r
31 #### General Configuration \r
32 \r
33 NTP is configured by the `/etc/ntp.conf` file in the format described in [ntp.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntp.conf&section5). Here is a simple example:\r
34 \r
35     \r
36     server ntplocal.example.com prefer\r
37     server timeserver.example.org\r
38     server ntp2a.example.net\r
39     \r
40     driftfile /var/db/ntp.drift\r
41 \r
42 \r
43 The `server` option specifies which servers are to be used, with one server listed on each line. If a server is specified with the `prefer` argument, as with `ntplocal.example.com`, that server is preferred over other servers. A response from a preferred server will be discarded if it differs significantly from other servers' responses, otherwise it will be used without any consideration to other responses. The `prefer` argument is normally used for NTP servers that are known to be highly accurate, such as those with special time monitoring hardware.\r
44 \r
45 The `driftfile` option specifies which file is used to store the system clock's frequency offset. The [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpd&section8) program uses this to automatically compensate for the clock's natural drift, allowing it to maintain a reasonably correct setting even if it is cut off from all external time sources for a period of time.\r
46 \r
47 The `driftfile` option specifies which file is used to store information about previous responses from the NTP servers you are using. This file contains internal information for NTP. It should not be modified by any other process.\r
48 \r
49 #### Controlling Access to Your Server \r
50 \r
51 By default, your NTP server will be accessible to all hosts on the Internet. The `restrict` option in `/etc/ntp.conf` allows you to control which machines can access your server.\r
52 \r
53 If you want to deny all machines from accessing your NTP server, add the following line to `/etc/ntp.conf`:\r
54 \r
55     \r
56     restrict default ignore\r
57 \r
58 \r
59 If you only want to allow machines within your own network to synchronize their clocks with your server, but ensure they are not allowed to configure the server or used as peers to synchronize against, add\r
60 \r
61     \r
62     restrict mask notrust nomodify notrap\r
63 \r
64 \r
65 instead, where `` is an IP address on your network and `` is your network's netmask.\r
66 \r
67 `/etc/ntp.conf` can contain multiple `restrict` options. For more details, see the `Access Control Support` subsection of [ntp.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntp.conf&section5).\r
68 \r
69 ### 19.12.4 Running the NTP Server \r
70 \r
71 To ensure the NTP server is started at boot time, add the line `xntpd_enable#"YES"` to `/etc/rc.conf`. If you wish to pass additional flags to [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?commandntpd&section=8), edit the `xntpd_flags` parameter in `/etc/rc.conf`.\r
72 \r
73 To start the server without rebooting your machine, run `ntpd` being sure to specify any additional parameters from `xntpd_flags` in `/etc/rc.conf`. For example:\r
74 \r
75     \r
76     # ntpd -p /var/run/ntpd.pid\r
77 \r
78 \r
79 ### 19.12.5 Using ntpd with a Temporary Internet Connection \r
80 \r
81 The [ntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ntpd&section8) program does not need a permanent connection to the Internet to function properly. However, if you have a temporary connection that is configured to dial out on demand, it is a good idea to prevent NTP traffic from triggering a dial out or keeping the connection alive. If you are using user PPP, you can use `filter` directives in `/etc/ppp/ppp.conf`. For example:\r
82 \r
83     \r
84      set filter dial 0 deny udp src eq 123\r
85      # Prevent NTP traffic from initiating dial out\r
86      set filter dial 1 permit 0 0\r
87      set filter alive 0 deny udp src eq 123\r
88      # Prevent incoming NTP traffic from keeping the connection open\r
89      set filter alive 1 deny udp dst eq 123\r
90      # Prevent outgoing NTP traffic from keeping the connection open\r
91      set filter alive 2 permit 0/0 0/0\r
92 \r
93 \r
94 For more details see the `PACKET FILTERING` section in [ppp(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ppp&section8) and the examples in `/usr/share/examples/ppp/`.\r
95 \r
96  **Note:** Some Internet access providers block low-numbered ports, preventing NTP from functioning since replies never reach your machine.\r
97 \r
98 ### 19.12.6 Further Information \r
99 \r
100 Documentation for the NTP server can be found in `/usr/share/doc/ntp/` in HTML format.\r
101 \r
102 \r
103 \r
104 CategoryHandbook\r
105 CategoryHandbook-advancednetworking\r