diff options
Diffstat (limited to 'doc/knot.info')
| -rw-r--r-- | doc/knot.info | 354 |
1 files changed, 186 insertions, 168 deletions
diff --git a/doc/knot.info b/doc/knot.info index bed79fe..c2ad015 100644 --- a/doc/knot.info +++ b/doc/knot.info @@ -1,7 +1,6 @@ -This is ../../doc/knot.info, produced by makeinfo version 4.13 from -../../doc/knot.texi. +This is knot.info, produced by makeinfo version 4.13 from knot.texi. -This manual is for Knot DNS (version 1.3.0-rc3, 26 June 2013), which is +This manual is for Knot DNS (version 1.3.0-rc4, 9 July 2013), which is a high-performance authoritative-only DNS server. Copyright (C) 2012 CZ.NIC, z.s.p.o. @@ -31,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-rc3, 26 June 2013). +This manual is for Knot DNS (version 1.3.0-rc4, 9 July 2013). * Menu: @@ -147,6 +146,7 @@ Statement Definition and Usage * nsid:: * storage:: * rundir:: +* pidfile:: * workers:: * user:: * max-conn-idle:: @@ -732,9 +732,8 @@ 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 compiled zone files, PID file and for slave - zone also their 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: @@ -1005,7 +1004,7 @@ the same way. Use knotc tool for convenience when working with the server daemon. As of Knot DNS 1.3.0, the zones are not compiled anymore. That makes working with the server much more user friendly. - $ knotc -c knot.conf reload|restart + $ knotc -c knot.conf reload The tool `knotc' is designed as a front-end for user, making it easier to do everything from server startup to state checking of a running @@ -1016,7 +1015,8 @@ server daemon. If you want to control the daemon directly, use Parameters: -c [file], --config=[file] Select configuration file. - -s [server] Remote UNIX socket/IP address (default ${rundir}/knot.sock). + -s [server] Remote UNIX socket/IP address + (default ${rundir}/knot.sock). -p [port] Remote server port (only for IP). -y [[hmac:]name:key] Use key_id specified on the command line. -k [file] Use key file (as in config section 'keys'). @@ -1026,15 +1026,13 @@ 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 start/stop + -w, --wait Wait for the server to finish stop operations. -i, --interactive Interactive mode (do not daemonize). -h, --help Print help and usage. Actions: - start Start server (if not running). stop Stop server. - restart Restart server. reload Reload configuration and changed zones. refresh [zone] Refresh slave zone (all if not specified). flush Flush journal and update zone files. @@ -1042,20 +1040,28 @@ server daemon. If you want to control the daemon directly, use zonestatus Show status of configured zones. checkconf Check current server configuration. checkzone [zone] Check zone (all if not specified). - memstats [zone] Estimate memory consumption for zone (all if not specified). + memstats [zone] Estimate memory consumption for zone + (all if not specified). + +Also, the server needs to create several files in order to run +properly. These files are stored in the folowing directories. + +`storage' (*note storage::): + + * _Zone files_ - default directory for storing zone files. This can + be overriden using absolute zone file location. -Also, the server needs to create several files in order to run properly. -Zones and related data are stored in the directory described by -`storage' (*note storage::). * _Journal files_ - each zone has a journal file to store differences for IXFR and dynamic updates. Journal for zone - `example.com' will be placed in `STORAGE/example.com.diff.db'. + `example.com' will be placed in `example.com.diff.db'. + +`rundir' (*note rundir::): - * _PID file_ - is created automatically in `rundir' (*note rundir::) - when the server is run in background. + * _PID file_ - is created automatically when the server is run in + background. - * _Control sockets_ - as a default, UNIX sockets are created in - `rundir' (*note rundir::), but can be overriden. + * _Control sockets_ - as a default, UNIX sockets are created here, + but this can be overriden. File: knot.info, Node: Running a slave server, Next: Running a master server, Up: Running Knot DNS @@ -1132,12 +1138,6 @@ is in _experimental_ stage and should be used with care. If you encounter a bug using this feature, please send it to Knot developers (*note Submitting a bugreport::). -You can also choose to tear-down the server fully and restart with the -`knotc restart' action. Note that some actions like start, stop and -restart cannot be done remotely. - $ knotc -c master.conf status # check if running - $ knotc -c master.conf restart # fully restart - If you want to force refresh the slave zones, you can do this with the `knotc refresh' action. $ knotc -c slave.conf refresh @@ -1332,6 +1332,7 @@ Statement Index * notify-retries: notify-retries. (line 6) * notify-timeout: notify-timeout. (line 6) * nsid: nsid. (line 6) +* pidfile: pidfile. (line 6) * port: port. (line 6) * rate-limit: rate-limit. (line 6) * rate-limit-size: rate-limit-size. (line 6) @@ -1403,6 +1404,7 @@ A.1.1 `system' Syntax [ `nsid' ( `"'string`"' | hex_string )`;' ] [ `storage' `"'string`";' ] [ `rundir' `"'string`";' ] + [ `pidfile' `"'string`";' ] [ `workers' integer`;' ] [ `user' string[`.'string]`;' ] [ `max-conn-idle' ( integer | integer(`s' | `m' | `h' | `d')`;' ) ] @@ -1428,6 +1430,7 @@ A.1.2 Statement Definition and Usage * nsid:: * storage:: * rundir:: +* pidfile:: * workers:: * user:: * max-conn-idle:: @@ -1507,16 +1510,16 @@ File: knot.info, Node: storage, Next: rundir, Prev: nsid, Up: system Stateme A.1.2.5 storage ............... -The working directory of Knot DNS, it is used to store compiled zone -files and other persistent data. Default: `${sharedstatedir}/knot', -configured with `--with-storage=path' +The working directory of Knot DNS, it is used to store zone files and +journal files. Default: `${localstatedir}/lib/knot', configured with +`--with-storage=path' system { storage "/var/lib/knot"; } -File: knot.info, Node: rundir, Next: workers, Prev: storage, Up: system Statement Definition and Usage +File: knot.info, Node: rundir, Next: pidfile, Prev: storage, Up: system Statement Definition and Usage A.1.2.6 rundir .............. @@ -1530,9 +1533,23 @@ Default: `${localstatedir}/run/knot', configured with } -File: knot.info, Node: workers, Next: user, Prev: rundir, Up: system Statement Definition and Usage +File: knot.info, Node: pidfile, Next: workers, Prev: rundir, Up: system Statement Definition and Usage + +A.1.2.7 pidfile +............... + +Specifies a custom PID file location. + +Default value: `knot.pid' in `rundir' directory. + + system { + pidfile "/var/run/knot/knot_dmz.pid"; + } + + +File: knot.info, Node: workers, Next: user, Prev: pidfile, Up: system Statement Definition and Usage -A.1.2.7 workers +A.1.2.8 workers ............... Number of workers (threads) per server interface. This option is used @@ -1548,7 +1565,7 @@ online CPUs) File: knot.info, Node: user, Next: max-conn-idle, Prev: workers, Up: system Statement Definition and Usage -A.1.2.8 user +A.1.2.9 user ............ System `user' or `user'.`group' under which the Knot DNS is run after @@ -1565,8 +1582,8 @@ Default value: `root.root' File: knot.info, Node: max-conn-idle, Next: max-conn-hs, Prev: user, Up: system Statement Definition and Usage -A.1.2.9 max-conn-idle -..................... +A.1.2.10 max-conn-idle +...................... Maximum idle time between requests on a TCP connection. This also limits receiving of a single query, each query must be received in this @@ -1575,7 +1592,7 @@ time limit. File: knot.info, Node: max-conn-hs, Next: max-conn-reply, Prev: max-conn-idle, Up: system Statement Definition and Usage -A.1.2.10 max-conn-hs +A.1.2.11 max-conn-hs .................... Maximum time between newly accepted TCP connection and first query. @@ -1585,7 +1602,7 @@ connection that already made at least 1 meaningful query. File: knot.info, Node: max-conn-reply, Next: transfers, Prev: max-conn-hs, Up: system Statement Definition and Usage -A.1.2.11 max-conn-reply +A.1.2.12 max-conn-reply ....................... Maximum time to wait for a reply to an issued SOA query. @@ -1593,7 +1610,7 @@ Maximum time to wait for a reply to an issued SOA query. File: knot.info, Node: transfers, Next: rate-limit, Prev: max-conn-reply, Up: system Statement Definition and Usage -A.1.2.12 transfers +A.1.2.13 transfers .................. Maximum parallel transfers, including pending SOA queries. Lowest @@ -1602,7 +1619,7 @@ possible number is the number of CPUs. Default is 10. File: knot.info, Node: rate-limit, Next: rate-limit-size, Prev: transfers, Up: system Statement Definition and Usage -A.1.2.13 rate-limit +A.1.2.14 rate-limit ................... Rate limiting is based on a token bucket scheme, rate basically @@ -1619,7 +1636,7 @@ Default value: `0 (disabled)' File: knot.info, Node: rate-limit-size, Next: rate-limit-slip, Prev: rate-limit, Up: system Statement Definition and Usage -A.1.2.14 rate-limit-size +A.1.2.15 rate-limit-size ........................ Option controls the size of a hashtable of buckets. The larger the @@ -1635,7 +1652,7 @@ Default value: `393241' File: knot.info, Node: rate-limit-slip, Prev: rate-limit-size, Up: system Statement Definition and Usage -A.1.2.15 rate-limit-slip +A.1.2.16 rate-limit-slip ........................ As attacks using DNS/UDP are usually based on a forged source address, @@ -1654,8 +1671,8 @@ A.1.3 system Example -------------------- system { - identity "Knot DNS 1.3.0-rc3"; - version "1.3.0-rc3"; + identity "Knot DNS 1.3.0-rc4"; + version "1.3.0-rc4"; nsid "amaterasu"; storage "/var/lib/knot"; rundir "/var/run/knot"; @@ -2576,130 +2593,131 @@ A.9.2 Examples Tag Table: -Node: Top1060 -Node: Introduction4057 -Node: What is Knot DNS4355 -Node: Knot DNS features4873 -Node: Scope of this document5894 -Node: Knot DNS Resource Requirements6156 -Node: Hardware requirements6454 -Node: CPU requirements7094 -Node: Memory requirements7479 -Node: Supported operating system8195 -Node: Knot DNS Installation8663 -Node: Required build environment8970 -Node: Required libraries9594 -Node: Userspace RCU10399 -Node: Installation from the sources11351 -Node: Configuring and generating Makefiles11936 -Node: Compilation13594 -Node: Installation14170 -Node: Installation from packages14677 -Node: Installing Knot DNS packages on Debian15201 -Node: Installing Knot DNS packages on Ubuntu16179 -Node: Adding official PPA repository for Knot DNS17093 -Node: Installing Knot DNS packages on Fedora17721 -Node: Installing Knot DNS from ports on FreeBSD19120 -Node: Knot DNS Configuration19467 -Node: Minimal configuration20038 -Node: Slave configuration22099 -Node: Master configuration24095 -Node: Configuring multiple interfaces25141 -Node: Using DNS UPDATE25626 -Node: Remote control interface27193 -Node: Enabling zone semantic checks28285 -Node: Creating IXFR differences from zone file changes28752 -Node: Using Response Rate Limiting29325 -Node: Running Knot DNS30826 -Node: Running a slave server34527 -Node: Running a master server35823 -Node: Controlling running daemon36804 -Node: Troubleshooting38255 -Node: Submitting a bugreport38663 -Node: Generating backtrace39833 -Node: Debug messages40835 -Node: Enabling debug messages in server41505 -Node: Debug messages Example43065 -Node: Statement Index43264 -Node: Knot DNS Configuration Reference47014 -Node: system47380 -Node: system Syntax47741 -Node: system Statement Definition and Usage48585 -Node: identity49006 -Node: version49416 -Node: hostname49850 -Node: nsid50288 -Node: storage50608 -Node: rundir50979 -Node: workers51320 -Node: user51704 -Node: max-conn-idle52138 -Node: max-conn-hs52453 -Node: max-conn-reply52814 -Node: transfers53045 -Node: rate-limit53330 -Node: rate-limit-size54072 -Node: rate-limit-slip54743 -Node: system Example55327 -Node: keys55692 -Node: keys Syntax55999 -Node: keys Statement Definition and Usage56228 -Node: key_id56434 -Node: Example57396 -Node: interfaces57630 -Node: interfaces Syntax57965 -Node: interfaces Statement Definition and Usage58303 -Node: interface_id58545 -Node: interfaces Examples58909 -Node: remotes59388 -Node: remotes Syntax59987 -Node: remotes Statement Definition and Grammar60426 -Node: remote_id60696 -Node: address60896 -Node: port61115 -Node: key61369 -Node: via61584 -Node: remotes Examples61814 -Node: groups62340 -Node: groups Syntax63030 -Node: groups Statement Definition and Grammar63248 -Node: group_id63506 -Node: groups_remote_id63713 -Node: groups Examples63960 -Node: control64366 -Node: control Syntax64903 -Node: control Statement Definition and Grammar65271 -Node: control Examples65854 -Node: zones66336 -Node: zones Syntax66680 -Node: zones Statement Definition and Grammar67640 -Node: zone_id68072 -Node: file68460 -Node: xfr-in68804 -Node: xfr-out69143 -Node: notify-in69488 -Node: notify-out69736 -Node: update-in69991 -Node: semantic-checks70334 -Node: ixfr-from-differences70753 -Node: disable-any71310 -Node: notify-timeout71697 -Node: notify-retries72042 -Node: zonefile-sync72361 -Node: ixfr-fslimit73071 -Node: zones Example73477 -Node: zones List of zone semantic checks74299 -Node: log76099 -Node: log Syntax76322 -Node: log Statement Definition and Grammar76646 -Node: log_name77356 -Node: category77685 -Node: severity78152 -Node: log_file78894 -Node: log Example79149 -Node: include79532 -Node: include Syntax80001 -Node: include Examples80139 +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 End Tag Table |