From: Marcin Siodelski Date: Tue, 12 Aug 2014 17:03:01 +0000 (+0200) Subject: [3429] A couple of additional fixes to the User Guide. X-Git-Tag: trac3482_base~41^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2641692cb62cdcf002860c5c4f443240016cfee3;p=thirdparty%2Fkea.git [3429] A couple of additional fixes to the User Guide. Various fixes are applied as a result of reading the whole document up to the section about the DHCPv4 server configuration. --- diff --git a/doc/guide/config.xml b/doc/guide/config.xml index 296e95e7ef..a2217f796a 100644 --- a/doc/guide/config.xml +++ b/doc/guide/config.xml @@ -25,9 +25,9 @@ JSON configuration backend JSON is the default configuration backend. It assumes that the servers are started from the command line - (either directly or using a script). The JSON backend uses - certain signals to influence Kea. The configuration file is - specified upon startup using -c parameter. + (either directly or using a script, e.g. keactrl). + The JSON backend uses certain signals to influence Kea. The + configuration file is specified upon startup using -c parameter.
JSON syntax @@ -41,12 +41,12 @@ The configuration file consists of a single object (often colloquially called a map) started with a curly bracket. It comprises the "Dhcp4", "Dhcp6", "DhcpDdns" and/or "Logging" objects. It is possible to define additional - elements, but they will be ignored. (That principle was chosen to ease - configuration management.) For example, it is possible to define Dhcp4, - Dhcp6 and Logging elements in a single configuration file that can be used to - start both the DHCPv4 and DHCPv6 components. When starting, the DHCPv4 component - will use Dhcp4 object to configure itself and the Logging object to configure logging - parameters; it will ignore the Dhcp6 object. + elements, but they will be ignored. For example, it is possible to define + Dhcp4, Dhcp6 and Logging elements in a single configuration file that can + be used to start both the DHCPv4 and DHCPv6 components. When starting, + the DHCPv4 component will use Dhcp4 object to configure itself and the + Logging object to configure logging parameters; it will ignore the Dhcp6 + object. For example, a very simple configuration for both DHCPv4 and DHCPv6 could look like this: diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index ada2cebfee..ec0126e57f 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -161,7 +161,10 @@ use it for 4000 seconds. (Note that integer numbers are specified as is, without any quotes around them.) renew-timer and rebind-timer are values that define T1 and T2 timers that govern when the client will begin renewal and -rebind procedures. +rebind procedures. Note that renew-timer and +rebind-timer are optional. If they are not specified the +client will select values for T1 and T2 timers according to the +RFC 2131. The next couple lines define the lease database, the place where the server stores its lease information. This particular example tells the server to use diff --git a/doc/guide/install.xml b/doc/guide/install.xml index 7cd5d5553a..fb7159f9e9 100644 --- a/doc/guide/install.xml +++ b/doc/guide/install.xml @@ -392,8 +392,8 @@ Debian and Ubuntu: Kea 0.9 introduces configuration backends that are switchable during compilation phase. The backend is chosen using the --with-kea-config switch when running the configure script. It - currently supports two values: BIND10 and JSON. This is currently - only supported by DHCPv6 component. JSON is the default. + currently supports two values: BUNDY and JSON. JSON is the default. + @@ -401,7 +401,7 @@ Debian and Ubuntu: BUNDY BUNDY means - that Kea6 is linked with the Bundy configuration backend that + that Kea is linked with the Bundy configuration backend that connects to the Bundy framework and in general works exactly the same as Kea 0.8 and earlier BIND10 versions. The benefits of that backend are uniform integration with the Bundy @@ -435,7 +435,7 @@ Debian and Ubuntu: a way that makes it possible to choose which database product should be used to store the lease information. At present, Kea supports three database backends: MySQL, PostgreSQL and Memfile. To limit external dependencies, both MySQL and PostgreSQL - support are disabled by default and only Memfile (which is implemented in pure C++) + support are disabled by default and only Memfile is available. Support for the optional external database backend must be explicitly included when Kea is built. This section covers the building of Kea with MySQL and/or PostgreSQL and the creation of the lease database. diff --git a/doc/guide/intro.xml b/doc/guide/intro.xml index 71b654bb04..cfde8b6ba6 100644 --- a/doc/guide/intro.xml +++ b/doc/guide/intro.xml @@ -57,11 +57,11 @@ Kea supports two crypto libraries: Botan and OpenSSL. Only one of them - is required during compilation. Kea uses the Botan crypto library for - C++ (), version 1.8 or - later. As an alternative to Botan, Kea can use the OpenSSL crypto - library (). It requires a version - with SHA-2 support. + is required to be installed during compilation. Kea uses the Botan + crypto library for C++ (), + version 1.8 or later. As an alternative to Botan, Kea can use the + OpenSSL crypto library (). + It requires a version with SHA-2 support. diff --git a/doc/guide/keactrl.xml b/doc/guide/keactrl.xml index 3befae5805..3249f4ad25 100644 --- a/doc/guide/keactrl.xml +++ b/doc/guide/keactrl.xml @@ -43,8 +43,8 @@ keactrl <command> [-c keactrl-config-file] [-s server[,server,..]] The optional -s server[,server ...] switch selects the servers to which the command is issued. If absent, the command is sent to all servers enabled in the keactrl - configuration file. (--server is a synonym for - -s.) If multiple servers are specified, they + configuration file (--server is a synonym for + -s). If multiple servers are specified, they should be separated by commas with no intervening spaces.