1 .\" Hey, Emacs! This is an -*- nroff -*- source file.
2 .TH CHIARK\-NAMED\-CONF 8 "30th December 2001" "Greenend" "chiark utilities"
4 chiark\-named\-conf \- check and generate nameserver configuration
7 .B chiark\-named\-conf [\fIoptions\fP] \-n|\-y|\-f
9 .B chiark\-named\-conf [\fIoptions\fP] \fIzone ...\fP
12 .B chiark\-named\-conf
13 is a tool for managing nameserver configurations and checking for
14 suspected DNS problems. Its main functions are to check that
15 delegations are appropriate and working, and to generate a
18 from its own input file.
23 .BR -n ", " -y ", or " -f
24 is supplied then chiark-named-conf will read its main configuration
25 file for the list of relevant zones. It will then check the
26 configuration and delegation for each zone
27 and/or generate and install a new configuration file for
31 Generate and install new nameserver config, as well as checking
32 configuration, for all listed zones.
35 Check configuration, for all listed zones, but
36 do not generate new nameserver config.
39 Generate and install new nameserver config, without doing any
40 configuration cross-checking. (Syntax errors in our input
41 configuration will still abort this operation.)
43 Alternatively, one or more zone names may be supplied as arguments, in
44 which case their delegations will be checked, and compared with the
45 data for that zone in the main configuration (if any). In this case
46 no new configuration file for the nameserver will be made.
48 .SS ADDITIONAL OPTIONS
50 \fB\-C\fP|\-\-config \fIconfig\-file\fP
54 .BR /etc/bind/chiark-conf-gen.zones .
57 Do not print any information about zone(s) which do not have warnings.
60 Print additional information about each zone.
63 Enables debugging. Useful for debugging chiark\-named\-conf, but
64 probably not useful for debugging your DNS configuration.
67 .B /etc/bind/chiark-conf-gen.zones
68 (or other file specified with the
70 option) contains a sequence of directives, one per line. Blank lines
71 are permitted. Leading and trailing whitespace on each line is
72 ignored. Comments are lines starting with
74 .SS GENERAL DIRECTIVES
75 These directives specify general configuration details. They should
76 appear before directives specifying zones, as each will affect only
77 later zone directives.
79 \fBself\-ns\fP \fIfqdn ...\fP
80 Specifies the list of names that this server may be known by in NS
81 records. There is no default.
83 \fBself\-soa\fP \fIfqdn ...\fP
84 Specifies the list of names that this server may be known by in
85 the ORIGIN field of SOA records. There is no default.
87 \fBself\fP \fIfqdn ...\fP
89 .BR self\-ns " and " self-\soa
90 with the same set of names.
92 \fBslave\-dir\fP \fIdirectory\fP [[\fIprefix\fP] \fIsuffix\fP]
93 Specifies the directory in which slave (secondary and stealth)
94 zonefiles should be placed. The default
97 .BR /var/cache/bind/chiark-slave .
99 .IR suffix " and " prefix
100 are empty; they also will be reset to these defaults by a
102 directive which does not specify them.
104 \fBdefault\-dir\fP \fIdirectory\fP
107 be the default directory (which affects the interpretation of
108 relative filenames). The default is the directory containing
109 the main configuration file, ie
115 \fBoutput\fP \fIformat\fP \fIfilename\fP [\fIformat\fP \fIfilename ...\fP]
118 will be overwritten when
120 are used; its new contents will be configuration
121 directives for the zones which follow for the
122 nameserver in question. Currently the only
126 which indicates new-style BIND 8. If no zones follow, then each
127 file will still be overwritten, by an effectively empty file.
128 Default: if there is no
130 directive in the configuration then the default is to use
131 .BR bind8 " " chiark-conf-gen.bind8 ;
132 otherwise it is an error for there to be any zones in the
133 configuration before the first
137 These directives specify one or more zones.
139 \fBprimary\fP \fIzone\fP \fIfilename\fP
140 Specifies that this server is supposed to be the primary nameserver
143 and that the zone data is to be found in
146 \fBprimary-dir\fP \fIdirectory\fP [[\fIprefix\fP] \fIsuffix\fP]
149 for files whose names match the glob pattern
150 .IR suffix * prefix .
151 Each such file is taken to represent a zone file for which this server
152 is supposed to be the primary. * is the name of the zone. The
161 \fBsecondary\fP \fIzone\fP \fIorigin\-addr\fP
162 Specifies that this server is supposed to be a published secondary for
163 the zone in question.
165 \fBstealth\fP \fIzone\fP \fIserver\-addr ...\fP
166 Specifies that this server is supposed to be an unpublished secondary
167 (aka stealth secondary) for the zone in question.
170 \fBinclude\fP \fIfile\fP
173 as if it were included here.
176 Ends processing of this file; any data beyond this point is ignored.
178 chiark\-named\-conf makes the following checks:
180 Delegations: Each delegation from a server for the superzone should
181 contain the same set of nameservers. None of the delegations should
182 lack glue. The glue addresses should be the same in each delegation,
183 and agree with the local default nameserver.
185 Delegated servers: Each server mentioned in the delegation should have
186 the same SOA record (and obviously, should be authoritative).
188 All published nameservers - including delegated servers and servers
189 named in the zone's nameserver set: All nameservers for the zone
190 should supply the same list of nameservers for the zone, and none of
191 this authority information should be glueless. All the glue should
192 always give the same addresses.
194 Origin server's data: The set of nameservers in the origin server's
195 version of the zone should be a superset of those in the delegations.
197 Our zone configuration: For
199 zones, the SOA origin should be one of the names specified with
200 .BR self\-soa " (or " self ). For
202 zones, the address should be that of the SOA origin. For
204 zones, the address should be that of the SOA origin or one of the
205 published nameservers.
208 .B /etc/bind/chiark-conf-gen.zones
209 Default input configuration file. (Override with
213 Default directory. (Override with
214 .BR -C " or " default\-dir .)
216 .IB dir /chiark-conf-gen.bind8
219 .B /var/cache/bind/chiark-slave
220 Default location for slave zones.
222 .B chiark\-named\-conf
223 and this manpage were written by Ian Jackson <ian@chiark.greenend.org.uk>.