diff options
Diffstat (limited to 'doc/knot.info')
| -rw-r--r-- | doc/knot.info | 320 |
1 files changed, 156 insertions, 164 deletions
diff --git a/doc/knot.info b/doc/knot.info index c2ad015..23137d0 100644 --- a/doc/knot.info +++ b/doc/knot.info @@ -1,6 +1,6 @@ -This is knot.info, produced by makeinfo version 4.13 from knot.texi. +This is ./knot.info, produced by makeinfo version 4.8 from ./knot.texi. -This manual is for Knot DNS (version 1.3.0-rc4, 9 July 2013), which is +This manual is for Knot DNS (version 1.3.0-rc5, 29 July 2013), which is a high-performance authoritative-only DNS server. Copyright (C) 2012 CZ.NIC, z.s.p.o. @@ -30,7 +30,7 @@ File: knot.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) Knot DNS ******** -This manual is for Knot DNS (version 1.3.0-rc4, 9 July 2013). +This manual is for Knot DNS (version 1.3.0-rc5, 29 July 2013). * Menu: @@ -502,7 +502,7 @@ For example: $ ./configure --enable-debug=server,packet --enable-debuglevel=brief $ ./configure --enable-debug=server,packet --enable-debuglevel=verbose -For more detailed information, see *note Debug messages::. +For more detailed information, see *Note Debug messages::. In most simple case you can just run configure without any options. @@ -732,14 +732,14 @@ can be used as a base for your Knot DNS setup. Now let's go step by step through this minimal configuration file: 1. In `system' statement we have configured `storage' directory where - Knot DNS will store slave zones and journal files. (See *note - system:: and *note storage::) + Knot DNS will store slave zones and journal files. (See *Note + system:: and *Note storage::) 2. The `interfaces' statement defines interfaces where Knot DNS will listen for incoming connections. We have defined two interfaces: one IPv4 called `my_interface' explicitly listening on port 53 and second IPv6 called `second_int' also listening on port 53, which - is the default port for the DNS. See *note interfaces::. + is the default port for the DNS. See *Note interfaces::. 3. The `log' statement defines the log facilities for Knot DNS. In this example we told Knot DNS to send its log messages with the @@ -747,7 +747,7 @@ Now let's go step by step through this minimal configuration file: you omit this sections, all severities will printed to either `stdout' or `stderr', and the severities from the `warning' and more serious to syslog. You can find all possible combinations in - the *note log::. + the *Note log::. 4. The `zones' statement is probably the most important one, because it defines the zones that Knot DNS will serve. In its most simple @@ -766,7 +766,7 @@ the zone master. If `update-in' is set and zone has a master, any accepted DNS UPDATE will be forwarded to master. Also note that you need to explicitly allow incoming NOTIFY, otherwise the daemon would reject them. Also, you can specify paths, relative to the storage -directory. See *note zones:: and *note storage::. If the zone file +directory. See *Note zones:: and *Note storage::. If the zone file doesn't exist and `xfr-in' is set, it will be bootstrapped over AXFR. remotes { @@ -788,7 +788,7 @@ configure a TSIG key and assign it to a remote. Supported algorithms for TSIG key are: `hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512' -Key secret is written in a base64 encoded format. See *note keys::. +Key secret is written in a base64 encoded format. See *Note keys::. keys { key0 hmac-md5 "Wg=="; # keyname algorithm secret @@ -929,7 +929,7 @@ File: knot.info, Node: Enabling zone semantic checks, Next: Creating IXFR diff ================================= You can turn on more detailed semantic checks of zone file in this -`zones' statement (*note zones::). Refer to *note zones List of zone +`zones' statement (*note zones::). Refer to *Note zones List of zone semantic checks:: to see which checks are enabled by default and which are optional. @@ -941,9 +941,9 @@ File: knot.info, Node: Creating IXFR differences from zone file changes, Next: If Knot is being run as a master server, experimental feature `ixfr-from-differences' can be enabled to create IXFR differences from -changes made to the master zone file. See *note Controlling running +changes made to the master zone file. See *Note Controlling running daemon:: for more information. For more about `zones' statement see -*note zones::. +*Note zones::. File: knot.info, Node: Using Response Rate Limiting, Prev: Creating IXFR differences from zone file changes, Up: Knot DNS Configuration @@ -959,21 +959,20 @@ could then exploit DNS server responding to every query, potentially flooding the victim with a large unsolicited DNS responses. As of Knot DNS version 1.2.0, RRL is compiled in, but disabled by -default. You can enable it with the *note rate-limit:: option in the -*note system:: section. Setting to a value greater than `0' means that +default. You can enable it with the *Note rate-limit:: option in the +*Note system:: section. Setting to a value greater than `0' means that every flow is allowed N responses per second, (i.e. `rate-limit 50;' means `50' responses per second). It is also possible to configure SLIP interval, which causes every Nth blocked response to be slipped as a truncated response. Not that some error responses cannot be truncated -and are slipped as-is. For more information, refer to *note +and are slipped as-is. For more information, refer to *Note rate-limit-slip::. It is advisable to not set slip interval to a value -larger than 2, to allow legitimate clients get at least some level of -service. +larger than 1. Example configuration: system { rate-limit 200; # Each flow is allowed to 200 resp. per second - rate-limit-slip 2; # Every other response is slipped (default) + rate-limit-slip 1; # Every response is slipped (default) } @@ -1026,8 +1025,6 @@ server daemon. If you want to control the daemon directly, use -v, --verbose Verbose mode - additional runtime information. -V, --version Print knot server version. - -w, --wait Wait for the server to finish stop - operations. -i, --interactive Interactive mode (do not daemonize). -h, --help Print help and usage. @@ -1091,7 +1088,7 @@ foreground mode, PID file will be created in `rundir' directory. $ knotd -d -c slave.conf # start the daemon $ knotc -c slave.conf stop # stop the daemon -When the server is running, you can control the daemon, see *note +When the server is running, you can control the daemon, see *Note Controlling running daemon::. @@ -1131,7 +1128,7 @@ restarting the server. This can be done with the `knotc reload' action. $ knotc -c master.conf reload # reconfigure and load updated zones If you want _IXFR-out_ differences created from changes you make to a -zone file, enable *note ixfr-from-differences:: in `zones' statement, +zone file, enable *Note ixfr-from-differences:: in `zones' statement, then reload your server as seen above. If _SOA_'s _serial_ is not changed no differences will be created. Please note that this feature is in _experimental_ stage and should be used with care. If you @@ -1662,7 +1659,7 @@ 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't be truncated (f.e. SERVFAIL). -Default value: `2' +Default value: `1' File: knot.info, Node: system Example, Prev: system Statement Definition and Usage, Up: system @@ -1671,8 +1668,8 @@ A.1.3 system Example -------------------- system { - identity "Knot DNS 1.3.0-rc4"; - version "1.3.0-rc4"; + identity "Knot DNS 1.3.0-rc5"; + version "1.3.0-rc5"; nsid "amaterasu"; storage "/var/lib/knot"; rundir "/var/run/knot"; @@ -1974,10 +1971,10 @@ A.5 `groups' Statement ====================== The `groups' statement is used to create groups of remote machines -defined in *note remotes:: statement. The group can substitute multiple +defined in *Note remotes:: statement. The group can substitute multiple machines specification anywhere in the configuration where the list of -remotes is allowed to be used (namely `allow' in *note control:: -section and ACLs in *note zones:: section). +remotes is allowed to be used (namely `allow' in *Note control:: +section and ACLs in *Note zones:: section). The remotes definitions must exist prior to using them in group definitions. One remote can be a member of multiple groups. @@ -2025,7 +2022,7 @@ A.5.2.2 `remote_id' ................... `remote_id' contains a symbolic name for a remote server as specified in -*note remotes:: section. +*Note remotes:: section. File: knot.info, Node: groups Examples, Prev: groups Statement Definition and Grammar, Up: groups @@ -2094,7 +2091,7 @@ A.6.2 Statement Definition and Grammar -------------------------------------- Control interface `listen-on' either defines a UNIX socket or an -IPv4/IPv6 `interface' definition as in *note interfaces::. Default +IPv4/IPv6 `interface' definition as in *Note interfaces::. Default port for IPv4/v6 control interface is `5533', however UNIX socket is preferred. UNIX socket address is relative to `rundir' if not specified as an absolute path. Without any configuration, the socket @@ -2266,7 +2263,7 @@ A.7.2.8 semantic-checks ....................... `semantic-checks' statement turns on optional semantic checks for this -particular zone. See *note zones List of zone semantic checks:: for +particular zone. See *Note zones List of zone semantic checks:: for more information. Possible values are `on' and `off'. Most checks are disabled by @@ -2281,7 +2278,7 @@ A.7.2.9 ixfr-from-differences EXPERIMENTAL: option `ixfr-from-differences' is only relevant if you are running Knot DNS as a master for this zone. By turning the feature on you tell Knot to create differences from changes you made to a zone -file upon server reload. See *note Controlling running daemon:: for +file upon server reload. See *Note Controlling running daemon:: for more information. Possible values are `on' and `off'. Disabled by default. @@ -2323,7 +2320,7 @@ A.7.2.13 zonefile-sync `zonefile-sync' is only relevant in a slave server scenario and only after receiving IXFR. It is a time in seconds after which current zone -in memory will be synced to its file on a disk (as set in *note +in memory will be synced to its file on a disk (as set in *Note file::). Knot DNS will serve the latest zone even after restart, but zone file on a disk will only be synced after `zonefile-sync' time has expired. Possible values are 1 to INT_MAX, optionally suffixed by unit @@ -2593,135 +2590,130 @@ A.9.2 Examples Tag Table: -Node: Top1039 -Node: Introduction4047 -Node: What is Knot DNS4345 -Node: Knot DNS features4863 -Node: Scope of this document5884 -Node: Knot DNS Resource Requirements6146 -Node: Hardware requirements6444 -Node: CPU requirements7084 -Node: Memory requirements7469 -Node: Supported operating system8185 -Node: Knot DNS Installation8653 -Node: Required build environment8960 -Node: Required libraries9584 -Node: Userspace RCU10389 -Node: Installation from the sources11341 -Node: Configuring and generating Makefiles11926 -Node: Compilation13584 -Node: Installation14160 -Node: Installation from packages14667 -Node: Installing Knot DNS packages on Debian15191 -Node: Installing Knot DNS packages on Ubuntu16169 -Node: Adding official PPA repository for Knot DNS17083 -Node: Installing Knot DNS packages on Fedora17711 -Node: Installing Knot DNS from ports on FreeBSD19110 -Node: Knot DNS Configuration19457 -Node: Minimal configuration20028 -Node: Slave configuration22041 -Node: Master configuration24037 -Node: Configuring multiple interfaces25083 -Node: Using DNS UPDATE25568 -Node: Remote control interface27135 -Node: Enabling zone semantic checks28227 -Node: Creating IXFR differences from zone file changes28694 -Node: Using Response Rate Limiting29267 -Node: Running Knot DNS30768 -Node: Running a slave server34499 -Node: Running a master server35795 -Node: Controlling running daemon36776 -Node: Troubleshooting37947 -Node: Submitting a bugreport38355 -Node: Generating backtrace39525 -Node: Debug messages40527 -Node: Enabling debug messages in server41197 -Node: Debug messages Example42757 -Node: Statement Index42956 -Node: Knot DNS Configuration Reference46779 -Node: system47145 -Node: system Syntax47506 -Node: system Statement Definition and Usage48385 -Node: identity48818 -Node: version49228 -Node: hostname49662 -Node: nsid50100 -Node: storage50420 -Node: rundir50777 -Node: pidfile51118 -Node: workers51417 -Node: user51802 -Node: max-conn-idle52236 -Node: max-conn-hs52553 -Node: max-conn-reply52914 -Node: transfers53145 -Node: rate-limit53430 -Node: rate-limit-size54172 -Node: rate-limit-slip54843 -Node: system Example55427 -Node: keys55792 -Node: keys Syntax56099 -Node: keys Statement Definition and Usage56328 -Node: key_id56534 -Node: Example57496 -Node: interfaces57730 -Node: interfaces Syntax58065 -Node: interfaces Statement Definition and Usage58403 -Node: interface_id58645 -Node: interfaces Examples59009 -Node: remotes59488 -Node: remotes Syntax60087 -Node: remotes Statement Definition and Grammar60526 -Node: remote_id60796 -Node: address60996 -Node: port61215 -Node: key61469 -Node: via61684 -Node: remotes Examples61914 -Node: groups62440 -Node: groups Syntax63130 -Node: groups Statement Definition and Grammar63348 -Node: group_id63606 -Node: groups_remote_id63813 -Node: groups Examples64060 -Node: control64466 -Node: control Syntax65003 -Node: control Statement Definition and Grammar65371 -Node: control Examples65954 -Node: zones66436 -Node: zones Syntax66780 -Node: zones Statement Definition and Grammar67740 -Node: zone_id68172 -Node: file68560 -Node: xfr-in68904 -Node: xfr-out69243 -Node: notify-in69588 -Node: notify-out69836 -Node: update-in70091 -Node: semantic-checks70434 -Node: ixfr-from-differences70853 -Node: disable-any71410 -Node: notify-timeout71797 -Node: notify-retries72142 -Node: zonefile-sync72461 -Node: ixfr-fslimit73171 -Node: zones Example73577 -Node: zones List of zone semantic checks74399 -Node: log76199 -Node: log Syntax76422 -Node: log Statement Definition and Grammar76746 -Node: log_name77456 -Node: category77785 -Node: severity78252 -Node: log_file78994 -Node: log Example79249 -Node: include79632 -Node: include Syntax80101 -Node: include Examples80239 +Node: Top1043 +Node: Introduction4052 +Node: What is Knot DNS4350 +Node: Knot DNS features4868 +Node: Scope of this document5889 +Node: Knot DNS Resource Requirements6151 +Node: Hardware requirements6449 +Node: CPU requirements7089 +Node: Memory requirements7474 +Node: Supported operating system8190 +Node: Knot DNS Installation8658 +Node: Required build environment8965 +Node: Required libraries9589 +Node: Userspace RCU10394 +Node: Installation from the sources11346 +Node: Configuring and generating Makefiles11931 +Node: Compilation13589 +Node: Installation14165 +Node: Installation from packages14672 +Node: Installing Knot DNS packages on Debian15196 +Node: Installing Knot DNS packages on Ubuntu16174 +Node: Adding official PPA repository for Knot DNS17088 +Node: Installing Knot DNS packages on Fedora17716 +Node: Installing Knot DNS from ports on FreeBSD19115 +Node: Knot DNS Configuration19462 +Node: Minimal configuration20033 +Node: Slave configuration22046 +Node: Master configuration24042 +Node: Configuring multiple interfaces25088 +Node: Using DNS UPDATE25573 +Node: Remote control interface27140 +Node: Enabling zone semantic checks28232 +Node: Creating IXFR differences from zone file changes28699 +Node: Using Response Rate Limiting29272 +Node: Running Knot DNS30703 +Node: Running a slave server34321 +Node: Running a master server35617 +Node: Controlling running daemon36598 +Node: Troubleshooting37769 +Node: Submitting a bugreport38177 +Node: Generating backtrace39347 +Node: Debug messages40349 +Node: Enabling debug messages in server41019 +Node: Debug messages Example42579 +Node: Statement Index42778 +Node: Knot DNS Configuration Reference46601 +Node: system46967 +Node: system Syntax47328 +Node: system Statement Definition and Usage48207 +Node: identity48640 +Node: version49050 +Node: hostname49484 +Node: nsid49922 +Node: storage50242 +Node: rundir50599 +Node: pidfile50940 +Node: workers51239 +Node: user51624 +Node: max-conn-idle52058 +Node: max-conn-hs52375 +Node: max-conn-reply52736 +Node: transfers52967 +Node: rate-limit53252 +Node: rate-limit-size53994 +Node: rate-limit-slip54665 +Node: system Example55249 +Node: keys55614 +Node: keys Syntax55921 +Node: keys Statement Definition and Usage56150 +Node: key_id56356 +Node: Example57318 +Node: interfaces57552 +Node: interfaces Syntax57887 +Node: interfaces Statement Definition and Usage58225 +Node: interface_id58467 +Node: interfaces Examples58831 +Node: remotes59310 +Node: remotes Syntax59909 +Node: remotes Statement Definition and Grammar60348 +Node: remote_id60618 +Node: address60818 +Node: port61037 +Node: key61291 +Node: via61506 +Node: remotes Examples61736 +Node: groups62262 +Node: groups Syntax62952 +Node: groups Statement Definition and Grammar63170 +Node: group_id63428 +Node: groups_remote_id63635 +Node: groups Examples63882 +Node: control64288 +Node: control Syntax64825 +Node: control Statement Definition and Grammar65193 +Node: control Examples65776 +Node: zones66258 +Node: zones Syntax66602 +Node: zones Statement Definition and Grammar67562 +Node: zone_id67994 +Node: file68382 +Node: xfr-in68726 +Node: xfr-out69065 +Node: notify-in69410 +Node: notify-out69658 +Node: update-in69913 +Node: semantic-checks70256 +Node: ixfr-from-differences70675 +Node: disable-any71232 +Node: notify-timeout71619 +Node: notify-retries71964 +Node: zonefile-sync72283 +Node: ixfr-fslimit72993 +Node: zones Example73399 +Node: zones List of zone semantic checks74221 +Node: log76021 +Node: log Syntax76244 +Node: log Statement Definition and Grammar76568 +Node: log_name77278 +Node: category77607 +Node: severity78074 +Node: log_file78816 +Node: log Example79071 +Node: include79454 +Node: include Syntax79923 +Node: include Examples80061 End Tag Table - - -Local Variables: -coding: utf-8 -End: |