knot.conf.5in 23.3 KB
Newer Older
1 2
.\" Man page generated from reStructuredText.
.
3
.TH "KNOT.CONF" "5" "@RELEASE_DATE@" "@VERSION@" "Knot DNS"
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
.SH NAME
knot.conf \- Knot DNS configuration file
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
35 36
Configuration files for Knot DNS use simplified YAML format. Simplified means
that not all of the features are supported.
37
.sp
38 39
For the description of configuration items, we have to declare a meaning of
the following symbols:
40 41
.INDENT 0.0
.IP \(bu 2
42
\fIINT\fP – Integer
43
.IP \(bu 2
44
\fISTR\fP – Textual string
45
.IP \(bu 2
46
\fIHEXSTR\fP – Hexadecimal string (with \fB0x\fP prefix)
47
.IP \(bu 2
48
\fIBOOL\fP – Boolean value (\fBon\fP/\fBoff\fP or \fBtrue\fP/\fBfalse\fP)
49
.IP \(bu 2
50
\fITIME\fP – Number of seconds, an integer with possible time multiplier suffix
51 52
(\fBs\fP ~ 1, \fBm\fP ~ 60, \fBh\fP ~ 3600 or \fBd\fP ~ 24 * 3600)
.IP \(bu 2
53
\fISIZE\fP – Number of bytes, an integer with possible size multiplier suffix
54 55
(\fBB\fP ~ 1, \fBK\fP ~ 1024, \fBM\fP ~ 1024^2 or \fBG\fP ~ 1024^3)
.IP \(bu 2
56
\fIBASE64\fP – Base64 encoded string
57
.IP \(bu 2
58
\fIADDR\fP – IPv4 or IPv6 address
59
.IP \(bu 2
60
\fIDNAME\fP – Domain name
61
.IP \(bu 2
62
\&... – Multi\-valued item, order of the values is preserved
63
.IP \(bu 2
64
[ ] – Optional value
65
.IP \(bu 2
66
| – Choice
67 68 69
.UNINDENT
.sp
There are 8 main sections (\fBserver\fP, \fBkey\fP, \fBacl\fP, \fBcontrol\fP,
70 71
\fBremote\fP, \fBtemplate\fP, \fBzone\fP and \fBlog\fP) and module sections with the
\fBmod\-\fP prefix. The most of the sections (excluding \fBserver\fP and
72 73 74 75
\fBcontrol\fP) are sequences of settings blocks. Each settings block
begins with a unique identifier, which can be used as a reference from other
sections (such identifier must be defined in advance).
.sp
76 77 78 79 80 81 82 83 84 85 86 87 88
A multi\-valued item can be specified either as a YAML sequence:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
address: [10.0.0.1, 10.0.0.2]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or as more single\-valued items each on an extra line:
89 90 91 92 93 94 95 96 97 98 99
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
address: 10.0.0.1
address: 10.0.0.2
.ft P
.fi
.UNINDENT
.UNINDENT
100 101
.sp
If an item value contains spaces or other special characters, it is necessary
102
to enclose such value within double quotes \fB"\fP \fB"\fP\&.
103 104
.SH COMMENTS
.sp
105
A comment begins with a \fB#\fP character and is ignored during processing.
106 107 108 109 110
Also each configuration section or sequence block allows to specify permanent
comment using \fBcomment\fP item which is stored in the server beside the
configuration.
.SH INCLUDES
.sp
111 112 113 114
Another configuration file or files, matching a pattern, can be included at
the top level in the current file. If the path is not absolute, then it
is considered to be relative to the current file. The pattern can be
an arbitrary string meeting POSIX \fIglob\fP requirements, e.g. dir/*.conf.
115
Matching files are processed in sorted order.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include: STR
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SERVER SECTION
.sp
General options related to the server.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
server:
    identity: [STR]
    version: [STR]
    nsid: [STR|HEXSTR]
    rundir: STR
    user: STR[:STR]
    pidfile: STR
141 142
    udp\-workers: INT
    tcp\-workers: INT
143
    background\-workers: INT
144
    async\-start: BOOL
145
    tcp\-handshake\-timeout: TIME
146
    tcp\-idle\-timeout: TIME
147
    tcp\-reply\-timeout: TIME
148 149 150 151
    max\-tcp\-clients: INT
    max\-udp\-payload: SIZE
    rate\-limit: INT
    rate\-limit\-slip: INT
152
    rate\-limit\-table\-size: INT
153 154 155 156 157 158 159
    listen: ADDR[@INT] ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS identity
.sp
160
An identity of the server returned in the response to the query for TXT
161 162 163
record \fBid.server.\fP or \fBhostname.bind.\fP in the CHAOS class (see RFC 4892).
Set empty value to disable.
.sp
164
\fIDefault:\fP FQDN hostname
165 166
.SS version
.sp
167
A version of the server software returned in the response to the query
168 169 170
for TXT record \fBversion.server.\fP or \fBversion.bind.\fP in the CHAOS
class (see RFC 4892). Set empty value to disable.
.sp
171
\fIDefault:\fP server version
172 173 174 175
.SS nsid
.sp
A DNS name server identifier (see RFC 5001). Set empty value to disable.
.sp
176
\fIDefault:\fP FQDN hostname
177 178 179 180
.SS rundir
.sp
A path for storing run\-time data (PID file, unix sockets, etc.).
.sp
181
\fIDefault:\fP \fB${localstatedir}/run/knot\fP (configured with \fB\-\-with\-rundir=path\fP)
182 183 184 185 186 187
.SS user
.sp
A system user with an optional system group (\fIuser\fP:\fIgroup\fP) under which the
server is run after starting and binding to interfaces. Linux capabilities
are employed if supported.
.sp
188
\fIDefault:\fP root:root
189 190 191 192
.SS pidfile
.sp
A PID file location.
.sp
193
\fIDefault:\fP \fI\%rundir\fP/knot.pid
194
.SS udp\-workers
195
.sp
196 197
A number of quering UDP workers (threads).
.sp
198
\fIDefault:\fP auto\-estimated optimal value based on the number of online CPUs
199 200 201
.SS tcp\-workers
.sp
A number of quering TCP workers (threads).
202
.sp
203
\fIDefault:\fP auto\-estimated optimal value based on the number of online CPUs
204 205 206 207 208
.SS background\-workers
.sp
A number of workers (threads) used to execute background operations (zone
loading, zone updates, etc.).
.sp
209
\fIDefault:\fP auto\-estimated optimal value based on the number of online CPUs
210
.SS async\-start
211 212 213 214
.sp
If enabled, server doesn\(aqt wait for the zones to be loaded and starts
responding immediately with SERVFAIL answers until the zone loads.
.sp
215
\fIDefault:\fP off
216
.SS tcp\-handshake\-timeout
217 218 219 220 221
.sp
Maximum time between newly accepted TCP connection and the first query.
This is useful to disconnect inactive connections faster than connections
that already made at least 1 meaningful query.
.sp
222
\fIDefault:\fP 5
223 224 225 226 227
.SS tcp\-idle\-timeout
.sp
Maximum idle time between requests on a TCP connection. This also limits
receiving of a single query, each query must be received in this time limit.
.sp
228
\fIDefault:\fP 20
229
.SS tcp\-reply\-timeout
230
.sp
231 232 233
Maximum time to wait for an outgoing connection or for a reply to an issued
request (SOA, NOTIFY, AXFR...). This limit also applies to knotc remote
operation over an internet socket.
234
.sp
235
\fIDefault:\fP 10
236 237 238 239 240
.SS max\-tcp\-clients
.sp
A maximum number of TCP clients connected in parallel, set this below the file
descriptor limit to avoid resource exhaustion.
.sp
241
\fIDefault:\fP 100
242 243
.SS rate\-limit
.sp
244 245
Rate limiting is based on the token bucket scheme. A rate basically
represents a number of tokens available each second. Each response is
246 247 248 249 250 251 252 253
processed and classified (based on several discriminators, e.g.
source netblock, qtype, name, rcode, etc.). Classified responses are
then hashed and assigned to a bucket containing number of available
tokens, timestamp and metadata. When available tokens are exhausted,
response is rejected or enters \fI\%SLIP\fP
(server responds with a truncated response). Number of available tokens
is recalculated each second.
.sp
254
\fIDefault:\fP 0 (disabled)
255
.SS rate\-limit\-table\-size
256
.sp
257 258 259 260
Size of the hashtable in a number of buckets. The larger the hashtable, the lesser
the probability of a hash collision, but at the expense of additional memory costs.
Each bucket is estimated roughly to 32 bytes. The size should be selected as
a reasonably large prime due to better hash function distribution properties.
261
Hash table is internally chained and works well up to a fill rate of 90 %, general
262 263
rule of thumb is to select a prime near 1.2 * maximum_qps.
.sp
264
\fIDefault:\fP 393241
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
.SS rate\-limit\-slip
.sp
As attacks using DNS/UDP are usually based on a forged source address,
an attacker could deny services to the victim netblock if all
responses would be completely blocked. The idea behind SLIP mechanism
is to send each Nth response as truncated, thus allowing client to
reconnect via TCP for at least some degree of service. It is worth
noting, that some responses can\(aqt be truncated (e.g. SERVFAIL).
.sp
It is advisable not to set the slip interval to a value larger than 2,
as too large slip value means more denial of service for legitimate
requestors, and introduces excessive timeouts during resolution.
On the other hand, slipping truncated answer gives the legitimate
requestors a chance to reconnect over TCP.
.sp
280
\fIDefault:\fP 1
281 282 283 284
.SS max\-udp\-payload
.sp
Maximum EDNS0 UDP payload size.
.sp
285
\fIDefault:\fP 4096
286 287 288 289 290 291 292
.SS listen
.sp
One or more IP addresses where the server listens for incoming queries.
Optional port specification (default is 53) can be appended to each address
using \fB@\fP separator. Use \fB0.0.0.0\fP for all configured IPv4 addresses or
\fB::\fP for all configured IPv6 addresses.
.sp
293
\fIDefault:\fP not set
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
.SH KEY SECTION
.sp
Shared TSIG keys used to authenticate communication with the server.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
key:
  \- id: DNAME
    algorithm: hmac\-md5 | hmac\-sha1 | hmac\-sha224 | hmac\-sha256 | hmac\-sha384 | hmac\-sha512
    secret: BASE64
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A key name identifier.
.SS algorithm
.sp
A key algorithm.
.sp
317
\fIDefault:\fP not set
318 319 320 321
.SS secret
.sp
Shared key secret.
.sp
322
\fIDefault:\fP not set
323 324
.SH ACL SECTION
.sp
325
Access control list rule definition.
326 327 328 329 330 331 332
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
acl:
  \- id: STR
333
    address: ADDR[/INT] | ADDR\-ADDR ...
334
    key: key_id ...
335
    action: transfer | notify | update | control ...
336
    deny: BOOL
337 338 339 340 341 342 343 344 345
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
An ACL rule identifier.
.SS address
.sp
346 347
An ordered list of IP addresses, network subnets, or network ranges. The query
must match one of them. Empty value means that address match is not required.
348
.sp
349
\fIDefault:\fP not set
350 351
.SS key
.sp
352 353
An ordered list of \fI\%reference\fPs to TSIG keys. The query must
match one of them. Empty value means that TSIG key is not required.
354
.sp
355
\fIDefault:\fP not set
356 357 358 359 360 361 362
.SS action
.sp
An ordered list of allowed actions.
.sp
Possible values:
.INDENT 0.0
.IP \(bu 2
363
\fBtransfer\fP – Allow zone transfer
364
.IP \(bu 2
365
\fBnotify\fP – Allow incoming notify
366
.IP \(bu 2
367
\fBupdate\fP – Allow zone updates
368
.IP \(bu 2
369
\fBcontrol\fP – Allow remote control
370 371
.UNINDENT
.sp
372
\fIDefault:\fP not set
373 374 375 376 377
.SS deny
.sp
Deny if \fI\%address\fP, \fI\%key\fP and
\fI\%action\fP match.
.sp
378
\fIDefault:\fP off
379 380 381 382
.SH CONTROL SECTION
.sp
Configuration of the server remote control.
.sp
383
\fICaution:\fP The control protocol is not encrypted and is susceptible to replay
384
attacks in a short timeframe until message digest expires. For that reason,
385 386 387 388 389 390 391 392
it is recommended to use default UNIX socket.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
control:
    listen: ADDR[@INT]
393
    acl: acl_id ...
394 395 396 397 398 399 400 401 402 403
.ft P
.fi
.UNINDENT
.UNINDENT
.SS listen
.sp
A UNIX socket path or IP address where the server listens for remote control
commands. Optional port specification (default is 5533) can be appended to the
address using \fB@\fP separator.
.sp
404
\fIDefault:\fP \fI\%rundir\fP/knot.sock
405 406 407 408 409
.SS acl
.sp
An ordered list of \fI\%references\fP to ACL rules allowing the remote
control.
.sp
410
\fICaution:\fP This option has no effect with UNIX socket.
411
.sp
412
\fIDefault:\fP not set
413 414 415 416 417 418 419 420 421 422
.SH REMOTE SECTION
.sp
Definition of remote servers for zone transfers or notifications.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
remote:
  \- id: STR
423 424
    address: ADDR[@INT] ...
    via: ADDR[@INT] ...
425 426 427 428 429 430 431 432 433 434
    key: key_id
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A remote identifier.
.SS address
.sp
435 436 437 438
An ordered list of destination IP addresses which are used for communication
with the remote server. The addresses are tried in sequence unless the
operation is successful. Optional destination port (default is 53)
can be appended to the address using \fB@\fP separator.
439
.sp
440
\fIDefault:\fP not set
441 442
.SS via
.sp
443 444 445
An ordered list of source IP addresses. The first address with the same family
as the destination address is used. Optional source port (default is random)
can be appended to the address using \fB@\fP separator.
446
.sp
447
\fIDefault:\fP not set
448 449 450 451 452
.SS key
.sp
A \fI\%reference\fP to the TSIG key which ise used to autenticate
the communication with the remote server.
.sp
453
\fIDefault:\fP not set
454 455
.SH TEMPLATE SECTION
.sp
456 457
A template is a shareable zone setting which can be used for configuration of
many zones in one place. A special default template (with the \fIdefault\fP identifier)
458
can be used for global querying configuration or as an implicit configuration
459
if a zone doesn\(aqt have another template specified.
460 461 462 463 464 465 466
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
template:
  \- id: STR
467
    global\-module: STR/STR ...
468 469 470 471 472 473 474 475
    # All zone options (excluding \(aqtemplate\(aq item)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A template identifier.
476 477 478 479 480 481 482
.SS global\-module
.sp
An ordered list of references to query modules in the form
\fImodule_name/module_id\fP\&. These modules apply to all queries.
.sp
\fICaution:\fP This option is available only for the \fIdefault\fP template.
.sp
483
\fIDefault:\fP not set
484 485 486 487 488 489 490 491 492 493 494 495
.SH ZONE SECTION
.sp
Definition of zones served by the server.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zone:
  \- domain: DNAME
    template: template_id
    file: STR
496 497
    storage: STR
    master: remote_id ...
498
    ddns\-master: remote_id
499 500 501 502 503 504
    notify: remote_id ...
    acl: acl_id ...
    semantic\-checks: BOOL
    disable\-any: BOOL
    zonefile\-sync: TIME
    ixfr\-from\-differences: BOOL
505 506
    max\-journal\-size: SIZE
    dnssec\-signing: BOOL
507
    kasp\-db: STR
508
    request\-edns\-option: INT:[HEXSTR]
509 510 511 512 513 514
    serial\-policy: increment | unixtime
    module: STR/STR ...
.ft P
.fi
.UNINDENT
.UNINDENT
515
.SS domain
516
.sp
517 518 519
A zone name identifier.
.SS template
.sp
520
A \fI\%reference\fP to a configuration template.
521
.sp
522
\fIDefault:\fP not set or \fIdefault\fP (if the template exists)
523 524 525 526 527 528
.SS file
.sp
A path to the zone file. Non absolute path is relative to
\fI\%storage\fP\&. It is also possible to use the following formatters:
.INDENT 0.0
.IP \(bu 2
529
\fB%s\fP – means the current zone name in the textual representation (beware
530 531 532
of special characters which are escaped or encoded in the \eDDD form where
DDD is corresponding decimal ASCII code). The zone name doesn\(aqt include the
terminating dot, except for the root zone.
533
.IP \(bu 2
534
\fB%%\fP – means the \fB%\fP character
535 536
.UNINDENT
.sp
537
\fIDefault:\fP \fI\%storage\fP/\fB%s\fP\&.zone
538 539 540 541
.SS storage
.sp
A data directory for storing zone files, journal files and timers database.
.sp
542
\fIDefault:\fP \fB${localstatedir}/lib/knot\fP (configured with \fB\-\-with\-storage=path\fP)
543 544 545 546
.SS master
.sp
An ordered list of \fI\%references\fP to zone master servers.
.sp
547
\fIDefault:\fP not set
548 549
.SS ddns\-master
.sp
550
A \fI\%reference\fP to zone primary master server.
551 552
If not specified, the first \fI\%master\fP server is used.
.sp
553
\fIDefault:\fP not set
554 555 556 557 558
.SS notify
.sp
An ordered list of \fI\%references\fP to remotes to which notify
message is sent if the zone changes.
.sp
559
\fIDefault:\fP not set
560 561 562 563 564
.SS acl
.sp
An ordered list of \fI\%references\fP to ACL rules which can allow
or disallow zone transfers, updates or incoming notifies.
.sp
565
\fIDefault:\fP not set
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
.SS semantic\-checks
.sp
If enabled, extra zone file semantic checks are turned on.
.sp
Several checks are enabled by default and cannot be turned off. An error in
mandatory checks causes zone not to be loaded. An error in extra checks is
logged only.
.sp
Mandatory checks:
.INDENT 0.0
.IP \(bu 2
An extra record together with CNAME record (except for RRSIG and DS)
.IP \(bu 2
CNAME link chain length greater than 10 (including infinite cycles)
.IP \(bu 2
DNAME and CNAME records under the same owner (RFC 2672)
.IP \(bu 2
CNAME and DNAME wildcards pointing to themselves
.IP \(bu 2
SOA record missing in the zone (RFC 1034)
.IP \(bu 2
DNAME records having records under it (DNAME children) (RFC 2672)
.UNINDENT
.sp
Extra checks:
.INDENT 0.0
.IP \(bu 2
Missing NS record at the zone apex
.IP \(bu 2
Missing glue A or AAAA records
.IP \(bu 2
Broken or non\-cyclic NSEC(3) chain
.IP \(bu 2
Wrong NSEC(3) type bitmap
.IP \(bu 2
Multiple NSEC records at the same node
.IP \(bu 2
Missing NSEC records at authoritative nodes
.IP \(bu 2
605
Extra record types under the same name as NSEC3 record (this is RFC\-valid, but
606 607 608 609 610 611 612 613 614 615 616 617
Knot will not serve such a zone correctly)
.IP \(bu 2
NSEC3\-unsecured delegation that is not part of Opt\-out span
.IP \(bu 2
Wrong original TTL value in NSEC3 records
.IP \(bu 2
Wrong RDATA TTL value in RRSIG record
.IP \(bu 2
Signer name in RRSIG RR not the same as in DNSKEY
.IP \(bu 2
Signed RRSIG
.IP \(bu 2
618
Not all RRs in the node are signed
619 620 621 622
.IP \(bu 2
Wrong key flags or wrong key in RRSIG record (not the same as ZSK)
.UNINDENT
.sp
623
\fIDefault:\fP off
624 625
.SS disable\-any
.sp
626
If enabled, all authoritative ANY queries sent over UDP will be answered
627 628 629
with an empty response and with the TC bit set. Use this option to minimize
the risk of DNS reflection attack.
.sp
630
\fIDefault:\fP off
631 632
.SS zonefile\-sync
.sp
633
The time after which the current zone in memory will be synced with a zone file
634
on the disk (see \fI\%file\fP). The server will serve the latest
635
zone even after a restart using zone journal, but the zone file on the disk will
636
only be synced after \fBzonefile\-sync\fP time has expired (or after manual zone
637
flush). This is applicable when the zone is updated via IXFR, DDNS or automatic
638
DNSSEC signing. In order to disable automatic zonefile synchronization, \-1 value
639
can be used (manual zone flush is still possible).
640 641
.sp
\fICaution:\fP If you are serving large zones with frequent updates where
642
the immediate sync with a zone file is not desirable, increase the value.
643
.sp
644
\fIDefault:\fP 0 (immediate)
645 646 647
.SS ixfr\-from\-differences
.sp
If enabled, the server creates zone differences from changes you made to the
648
zone file upon server reload. This option is relevant only if the server
649 650
is a master server for the zone.
.sp
651 652 653
\fICaution:\fP This option has no effect with enabled
\fI\%dnssec\-signing\fP\&.
.sp
654
\fIDefault:\fP off
655
.SS max\-journal\-size
656
.sp
657
Maximum size of the zone journal file.
658
.sp
659
\fIDefault:\fP 2^64
660
.SS dnssec\-signing
661 662 663
.sp
If enabled, automatic DNSSEC signing for the zone is turned on.
.sp
664 665
\fICaution:\fP Cannot be enabled on a slave zone.
.sp
666
\fIDefault:\fP off
667
.SS kasp\-db
668
.sp
669 670
A KASP database path. Non absolute path is relative to
\fI\%storage\fP\&.
671
.sp
672
\fIDefault:\fP \fI\%storage\fP/keys
673 674 675 676 677
.SS request\-edns\-option
.sp
An arbitrary EDNS0 option which is included into a server request (AXFR, IXFR,
SOA, or NOTIFY). The value is in the option_code:option_data format.
.sp
678
\fIDefault:\fP not set
679 680 681 682 683 684 685 686 687
.SS serial\-policy
.sp
Specifies how the zone serial is updated after a dynamic update or
automatic DNSSEC signing. If the serial is changed by the dynamic update,
no change is made.
.sp
Possible values:
.INDENT 0.0
.IP \(bu 2
688
\fBincrement\fP – The serial is incremented according to serial number arithmetic
689
.IP \(bu 2
690
\fBunixtime\fP – The serial is set to the current unix time
691 692 693 694 695 696 697
.UNINDENT
.sp
\fICaution:\fP If your serial was in other than unix time format, be careful
with the transition to unix time.  It may happen that the new serial will
be \(aqlower\(aq than the old one. If this is the case, the transition should be
done by hand (see RFC 1982).
.sp
698
\fIDefault:\fP increment
699 700 701
.SS module
.sp
An ordered list of references to query modules in the form
702
\fImodule_name/module_id\fP\&. These modules apply only to the current zone queries.
703
.sp
704
\fIDefault:\fP not set
705 706 707 708 709 710
.SH LOGGING SECTION
.sp
Server can be configured to log to the standard output, standard error
output, syslog (or systemd journal if systemd is enabled) or into an arbitrary
file.
.sp
711
There are 6 logging severity levels:
712 713
.INDENT 0.0
.IP \(bu 2
714
\fBcritical\fP – Non\-recoverable error resulting in server shutdown
715
.IP \(bu 2
716
\fBerror\fP – Recoverable error, action should be taken
717
.IP \(bu 2
718
\fBwarning\fP – Warning that might require user action
719
.IP \(bu 2
720
\fBnotice\fP – Server notice or hint
721
.IP \(bu 2
722
\fBinfo\fP – Informational message
723
.IP \(bu 2
724
\fBdebug\fP – Debug messages (must be turned on at compile time)
725 726
.UNINDENT
.sp
727
In the case of missing log section, \fBwarning\fP or more serious messages
728 729 730 731 732 733 734 735
will be logged to both standard error output and syslog. The \fBinfo\fP and
\fBnotice\fP messages will be logged to standard output.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
log:
736
  \- target: stdout | stderr | syslog | STR
737 738 739 740 741 742 743
    server: critical | error | warning | notice | info | debug
    zone: critical | error | warning | notice | info | debug
    any: critical | error | warning | notice | info | debug
.ft P
.fi
.UNINDENT
.UNINDENT
744
.SS target
745 746 747 748 749 750
.sp
A logging output.
.sp
Possible values:
.INDENT 0.0
.IP \(bu 2
751
\fBstdout\fP – Standard output
752
.IP \(bu 2
753
\fBstderr\fP – Standard error output
754
.IP \(bu 2
755
\fBsyslog\fP – Syslog
756
.IP \(bu 2
757
\fIfile_name\fP – File
758 759 760 761 762 763
.UNINDENT
.SS server
.sp
Minimum severity level for messages related to general operation of the server
that are logged.
.sp
764
\fIDefault:\fP not set
765 766 767 768
.SS zone
.sp
Minimum severity level for messages related to zones that are logged.
.sp
769
\fIDefault:\fP not set
770 771 772 773
.SS any
.sp
Minimum severity level for all message types that are logged.
.sp
774
\fIDefault:\fP not set
775 776
.SH MODULE DNSTAP
.sp
777
The module dnstap allows query and response logging.
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
.sp
For all queries logging, use this module in the \fIdefault\fP template. For
zone\-specific logging, use this module in the proper zone configuration.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mod\-dnstap:
  \- id: STR
    sink: STR
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A module identifier.
.SS sink
.sp
798
A sink path, which can be either a file or a UNIX socket when prefixed with
799 800
\fBunix:\fP\&.
.sp
801
\fIRequired\fP
802 803
.SH MODULE SYNTH-RECORD
.sp
804
This module is able to synthesize either forward or reverse records for the
805 806 807 808 809 810 811 812 813 814
given prefix and subnet.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mod\-synth\-record:
  \- id: STR
    type: forward | reverse
    prefix: STR
815
    origin: DNAME
816
    ttl: INT
817
    network: ADDR[/INT] | ADDR\-ADDR
818 819 820 821 822 823 824 825 826 827 828 829 830 831
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A module identifier.
.SS type
.sp
The type of generated records.
.sp
Possible values:
.INDENT 0.0
.IP \(bu 2
832
\fBforward\fP – Forward records
833
.IP \(bu 2
834
\fBreverse\fP – Reverse records
835 836
.UNINDENT
.sp
837
\fIRequired\fP
838 839 840 841
.SS prefix
.sp
A record owner prefix.
.sp
842
\fICaution:\fP \fIprefix\fP doesn’t allow dots, address parts in the synthetic names are
843 844
separated with a dash.
.sp
845
\fIDefault:\fP empty
846
.SS origin
847
.sp
848
A zone origin (only valid for the \fI\%reverse type\fP).
849
.sp
850
\fIRequired\fP
851 852 853 854
.SS ttl
.sp
Time to live of the generated records.
.sp
855
\fIDefault:\fP 3600
856
.SS network
857
.sp
858
An IP address, a network subnet, or a network range the query must match.
859
.sp
860
\fIRequired\fP
861 862
.SH MODULE DNSPROXY
.sp
863
The module catches all unsatisfied queries and forwards them to the indicated
864 865 866 867 868 869 870 871
server for resolution.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mod\-dnsproxy:
  \- id: STR
872 873
    remote: remote_id
    catch\-nxdomain: BOOL
874 875 876 877 878 879 880 881 882
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A module identifier.
.SS remote
.sp
883 884
A \fI\%reference\fP to a remote server where the queries are
forwarded to.
885
.sp
886
\fIRequired\fP
887 888 889 890 891
.SS catch\-nxdomain
.sp
If enabled, all unsatisfied queries (also applies to local zone lookups)
are forwarded.
.sp
892
\fIDefault:\fP off
893 894 895
.SH MODULE ROSEDB
.sp
The module provides a mean to override responses for certain queries before
896
the available zones are searched for the record.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mod\-rosedb:
  \- id: STR
    dbdir: STR
.ft P
.fi
.UNINDENT
.UNINDENT
.SS id
.sp
A module identifier.
.SS dbdir
.sp
A path to the directory where the database is stored.
.sp
916
\fIRequired\fP
917 918 919
.SH AUTHOR
CZ.NIC Labs <http://www.knot-dns.cz>
.SH COPYRIGHT
920
Copyright 2010–2015, CZ.NIC, z.s.p.o.
921 922
.\" Generated by docutils manpage writer.
.