]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
First of a series of updates to documentation files
authorpeterd <peterd@isc.org>
Thu, 12 Nov 2020 12:08:17 +0000 (12:08 +0000)
committerTomek Mrugalski <tomek@isc.org>
Fri, 20 Nov 2020 11:04:41 +0000 (12:04 +0100)
doc/sphinx/arm/admin.rst
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst
doc/sphinx/arm/install.rst
doc/sphinx/arm/quickstart.rst

index 9e40c101206d5bf4a82eadb39dd2d5074ede8242..be0578243570a841563586c42eef986d47c978ec 100644 (file)
@@ -12,7 +12,7 @@ Databases and Database Version Numbers
 Kea may be configured to use a database as storage for leases or as a
 source of servers' configurations and host reservations (i.e. static
 assignments of addresses, prefixes, options, etc.). Kea
-updates introduce changes to the database schemas to faciliate new
+updates introduce changes to the database schemas to facilitate new
 features and correct discovered issues with the existing schemas.
 
 A given version of Kea expects a particular structure in the backend and
@@ -289,7 +289,7 @@ to create them now:
 Do not do this if the tables were created in Step 4. ``kea-admin``
 implements rudimentary checks; it will refuse to initialize a database
 that contains any existing tables. To start from scratch,
-all must be removed data manually. (This process is a manual operation
+all data must be removed manually. (This process is a manual operation
 on purpose, to avoid possibly irretrievable mistakes by ``kea-admin``.)
 
 .. _mysql-upgrade:
index 455fe469516d3efb1ef6be057e77cdbbcb5b840a..9a89d2d206122049693c43423bc542d758aa0a4f 100644 (file)
@@ -5465,7 +5465,7 @@ Even though it is technically possible to configure two (or more) subnets
 within the shared network to use different relay addresses, this will almost
 always lead to a different behavior than what the user would expect. In this
 case, the Kea server will initially select one of the subnets by matching
-the relay address in the client's packet with the subnet's conifguration.
+the relay address in the client's packet with the subnet's configuration.
 However, it MAY end up using the other subnet (even though it does not match
 the relay address) if the client already has a lease in this subnet, has a
 host reservation in this subnet or simply the initially selected subnet has no
index 388f308e61f13c494617aa59dda95448dc229b3f..69f143973132c6b426bc35bd46a1656b3176fcf9 100644 (file)
@@ -4925,7 +4925,7 @@ Even though it is technically possible to configure two (or more) subnets
 within the shared network to use different relay addresses, this will almost
 always lead to a different behavior than what the user would expect. In this
 case, the Kea server will initially select one of the subnets by matching
-the relay address in the client's packet with the subnet's conifguration.
+the relay address in the client's packet with the subnet's configuration.
 However, it MAY end up using the other subnet (even though it does not match
 the relay address) if the client already has a lease in this subnet, has a
 host reservation in this subnet or simply the initially selected subnet has no
index e7f216730cfba2525f05d20390f80bcdbf560181..acc55995fd04fed886c78e3597bfeac6da78e230 100644 (file)
@@ -228,7 +228,7 @@ options. Some commonly used options are:
    cryptographic functions. It is preferable to use OpenSSL (see below).
 
  - ``--with-openssl``
-   Replace Botan by the OpenSSL the cryptographic library. By default
+   Replace Botan by the OpenSSL cryptographic library. By default
    ``configure`` searches for a valid Botan installation. If one is not
    found, it searches for OpenSSL. Normally this is not necessary.
 
@@ -238,7 +238,7 @@ options. Some commonly used options are:
 
  - ``--with-site-packages``
    Only useful when ``kea-shell`` is enabled. It causes the kea-shell
-   python packages to be installed in specified directory. This is
+   python packages to be installed in the specified directory. This is
    mostly useful for Debian related distros. While most systems store
    python packages in ${prefix}/usr/lib/pythonX/site-packages, Debian
    introduced separate directory for packages installed from DEB. Such
@@ -250,9 +250,9 @@ options. Some commonly used options are:
    is to not build it.
 
  - ``--with-freeradius``
-   Build the optional ``RADIUS`` hook. This option specifies path to the
+   Build the optional ``RADIUS`` hook. This option specifies the path to the
    patched version of FreeRADIUS client. Available in subscriber only version.
-   This option requires subscription-only RADIUS hook.
+   This option requires the subscription-only RADIUS hook.
 
  - ``--with-freeradius-dictionary``
    Specify a non-standard location for a FreeRADIUS dictionary file. That
@@ -602,10 +602,10 @@ use regular UDP sockets (refer to ``dhcp-socket-type`` parameter in the
 
 .. note::
 
-   An alternative approach to running Kea with root privileges is to configure Kea to use
-   non-privileged ports (i.e. those greater than 1024) and redirect traffic. Note that this
-   only works for relayed traffic. Furthermore, we consider it experimental and untested in
-   production environments. Use it only after careful consideration.
+   An alternative approach to avoiding running Kea with root privileges assumes instructing Kea to
+   use non-privileged (greater than 1024) posts and redirecting traffic. This, however, will work
+   only for relayed traffic. This approach in general is considered experimental and not tested
+   enough for deployment in production environments. Use with caution!
 
 To use this approach, configure the server to listen on other non-privileged ports (e.g. 1547
 and 1548) by running the process with ``-p`` option in ``/etc/systemd/system/kea-dhcp4.service``:
index 0edc7f816fb8ec04357ce15ea7e67a69ae239d78..cf57ef967c50d4d57ae394d7bd8a324056406931 100644 (file)
@@ -57,7 +57,7 @@ to tweak specific compilation options, it is usually easier to install
 Kea using native packages.
 
 1. Go to `Kea on cloudsmith.io <https://cloudsmith.io/~isc/repos/>`__
-   and choose Kea version and enter repository.
+   and choose Kea version and enter the repository.
 
 2. Use ``Set Me Up`` and follow instructions to add repository
    on your system.