diff options
Diffstat (limited to 'doc/running.texi')
| -rw-r--r-- | doc/running.texi | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/doc/running.texi b/doc/running.texi index aa5b93c..cfa8810 100644 --- a/doc/running.texi +++ b/doc/running.texi @@ -25,7 +25,7 @@ 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. @example -$ knotc -c knot.conf reload|restart +$ knotc -c knot.conf reload @end example The tool @code{knotc} is designed as a front-end for user, making it easier @@ -37,7 +37,8 @@ Usage: knotc [parameters] <action> [action_args] 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'). @@ -47,15 +48,13 @@ Parameters: -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. @@ -63,24 +62,34 @@ Actions: 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). @end example -Also, the server needs to create several files in order to run properly. -Zones and related data are stored in the directory described by @code{storage} (@pxref{storage}). +Also, the server needs to create several files in order to run properly. These +files are stored in the folowing directories. + +@code{storage} (@pxref{storage}): + @itemize @bullet @item +@emph{Zone files} - default directory for storing zone files. This can be overriden +using absolute zone file location. + +@item @emph{Journal files} - each zone has a journal file to store differences for IXFR and -dynamic updates. Journal for zone @code{example.com} will be -placed in @file{STORAGE/example.com.diff.db}. +dynamic updates. Journal for zone @code{example.com} will be placed in @file{example.com.diff.db}. +@end itemize +@code{rundir} (@pxref{rundir}): + +@itemize @bullet @item -@emph{PID file} - is created automatically in @code{rundir} (@pxref{rundir}) when -the server is run in background. +@emph{PID file} - is created automatically when the server is run in background. @item -@emph{Control sockets} - as a default, UNIX sockets are created in @code{rundir} (@pxref{rundir}), -but can be overriden. +@emph{Control sockets} - as a default, UNIX sockets are created here, +but this can be overriden. @end itemize @node Running a slave server @@ -152,13 +161,6 @@ If @emph{SOA}'s @emph{serial} is not changed no differences will be created. Ple that this feature is in @emph{experimental} stage and should be used with care. If you encounter a bug using this feature, please send it to Knot developers (@pxref{Submitting a bugreport}). -You can also choose to tear-down the server fully and restart with the @code{knotc restart} action. -Note that some actions like start, stop and restart cannot be done remotely. -@example -$ knotc -c master.conf status # check if running -$ knotc -c master.conf restart # fully restart -@end example - If you want to force refresh the slave zones, you can do this with the @code{knotc refresh} action. @example $ knotc -c slave.conf refresh |