Commit 2641692c authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

[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.
parent 84fce430
......@@ -25,9 +25,9 @@
<title>JSON configuration backend</title>
<para>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.</para>
(either directly or using a script, e.g. <filename>keactrl</filename>).
The JSON backend uses certain signals to influence Kea. The
configuration file is specified upon startup using -c parameter.</para>
<section id="json-format">
<title>JSON syntax</title>
......@@ -41,12 +41,12 @@
<para>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.</para>
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.</para>
<para>For example, a very simple configuration for both DHCPv4 and DHCPv6
could look like this:
......
......@@ -161,7 +161,10 @@ use it for 4000 seconds. (Note that integer numbers are specified as is,
without any quotes around them.) <command>renew-timer</command> and
<command>rebind-timer</command> are values that
define T1 and T2 timers that govern when the client will begin renewal and
rebind procedures.</para>
rebind procedures. Note that <command>renew-timer</command> and
<command>rebind-timer</command> are optional. If they are not specified the
client will select values for T1 and T2 timers according to the
<ulink url="http://tools.ietf.org/html/rfc2131">RFC 2131</ulink>.</para>
<para>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
......
......@@ -392,8 +392,8 @@ Debian and Ubuntu:
<para>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.</para>
currently supports two values: BUNDY and JSON. JSON is the default.
</para>
<variablelist>
......@@ -401,7 +401,7 @@ Debian and Ubuntu:
<term>BUNDY</term>
<listitem>
<simpara>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.
......
......@@ -57,11 +57,11 @@
<listitem>
<simpara>
Kea supports two crypto libraries: Botan and OpenSSL. Only one of them
is required during compilation. Kea uses the Botan crypto library for
C++ (<ulink url="http://botan.randombit.net/"/>), version 1.8 or
later. As an alternative to Botan, Kea can use the OpenSSL crypto
library (<ulink url="http://www.openssl.org/"/>). It requires a version
with SHA-2 support.
is required to be installed during compilation. Kea uses the Botan
crypto library for C++ (<ulink url="http://botan.randombit.net/"/>),
version 1.8 or later. As an alternative to Botan, Kea can use the
OpenSSL crypto library (<ulink url="http://www.openssl.org/"/>).
It requires a version with SHA-2 support.
</simpara>
</listitem>
......
......@@ -43,8 +43,8 @@ keactrl &lt;command&gt; [-c keactrl-config-file] [-s server[,server,..]]
The optional <command>-s server[,server ...]</command> 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. (<command>--server</command> is a synonym for
<command>-s</command>.) If multiple servers are specified, they
configuration file (<command>--server</command> is a synonym for
<command>-s</command>). If multiple servers are specified, they
should be separated by commas with no intervening spaces.
</para>
</section>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment