]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3831] fix arm env var name
authorRazvan Becheriu <razvan@isc.org>
Thu, 22 May 2025 09:34:42 +0000 (12:34 +0300)
committerRazvan Becheriu <razvan@isc.org>
Thu, 22 May 2025 10:00:58 +0000 (13:00 +0300)
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst
doc/sphinx/arm/hooks-host-cache.rst
doc/sphinx/arm/hooks-lease-cmds.rst
doc/sphinx/arm/security.rst

index d6ff2b3edd71fe574673919edc1c77f40c5a2fd6..31e66b9bc04f0e72db384989d5177971ce5b1943 100644 (file)
@@ -372,7 +372,7 @@ that can be used to configure the memfile backend.
     As of Kea 2.7.9, lease files may only be loaded from the data directory
     determined during compilation: ``"[kea-install-dir]/var/lib/kea"``. This
     path may be overridden at startup by setting the environment variable
-    ``KEA_DHCP_DATA_DIRECTORY`` to the desired path.  If a path other than
+    ``KEA_DHCP_DATA_DIR`` to the desired path.  If a path other than
     this value is used in ``name``, Kea will emit an error and refuse to start
     or, if already running, log an unrecoverable error.  For ease of use in
     specifying a custom file name simply omit the path component from ``name``.
index b2a89d0529d981870db32d5c619e4a9648ac8359..410716258d6c2fedc2e4e6bffdae64e98091e32d 100644 (file)
@@ -328,7 +328,7 @@ that can be used to configure the memfile backend.
     As of Kea 2.7.9, lease files may only be loaded from the data directory
     determined during compilation: ``"[kea-install-dir]/var/lib/kea"``. This
     path may be overridden at startup by setting the environment variable
-    ``KEA_DHCP_DATA_DIRECTORY`` to the desired path.  If a path other than
+    ``KEA_DHCP_DATA_DIR`` to the desired path.  If a path other than
     this value is used in ``name``, Kea will emit an error and refuse to start
     or, if already running, log an unrecoverable error.  For ease of use in
     specifying a custom file name simply omit the path component from ``name``.
@@ -6456,7 +6456,7 @@ memory lease file into its data directory. By default this directory is
     files may only be loaded from the directory determined at
     compilation: ``"[kea-install-dir]/var/lib/kea"``. This path may be
     overridden at startup by setting the environment variable
-    ``KEA_DHCP_DATA_DIRECTORY`` to the desired path.  If a path other than
+    ``KEA_DHCP_DATA_DIR`` to the desired path.  If a path other than
     this value is used in ``data-directory``, Kea will emit an error and
     refuse to start or, if already running, log an unrecoverable error.
 
index 8de9810c64057890f37aa9a810f08f9eb3faebe0..f887cf295fba9a2232c841383191471955e891d9 100644 (file)
@@ -149,7 +149,7 @@ processed by any other tool that is able to understand JSON format.
     As of Kea 2.7.9, the cache file may only be written to the data directory
     determined during compilation: ``"[kea-install-dir]/var/lib/kea"``. This
     path may be overridden at startup by setting the environment variable
-    ``KEA_DHCP_DATA_DIRECTORY`` to the desired path. For ease of use in
+    ``KEA_DHCP_DATA_DIR`` to the desired path. For ease of use in
     specifying a custom file name simply omit the path portion from ``filename``.
 
 .. isccmd:: cache-load
index 183a8a8e798531e2259e840a36661fd8a0ee7101..42f429f262a68f94654c16288c89e1d44bdd33c5 100644 (file)
@@ -1098,7 +1098,7 @@ to the previous filename: for example, ``.bak14326``.
     As of Kea 2.7.9, the lease file may only be written to the data directory
     determined during compilation: ``"[kea-install-dir]/var/lib/kea"``. This
     path may be overridden at startup by setting the environment variable
-    ``KEA_DHCP_DATA_DIRECTORY`` to the desired path.  If a path other than
+    ``KEA_DHCP_DATA_DIR`` to the desired path.  If a path other than
     this value is used in ``filename``, Kea will emit an error and refuse to start
     or, if already running, log an unrecoverable error.  For ease of use in
     specifying a custom file name simply omit the path portion from ``filename``.
index 63b6ce86f4ae3c2fea125fa1c814e5eb857a5608..783724f1c53af3e8de0a9de4ab8e4379a419d88e 100644 (file)
@@ -293,7 +293,7 @@ Potential Kea security issues can be minimized by running only those processes r
     (DHCPv4 and DHCPv6) and duid file (DHCPv6 only) may only be loaded from
     the directory determined at compilation: ``"[kea-install-dir]/var/lib/kea"``.
     This path may be overridden at startup by setting the environment variable
-    ``KEA_DHCP_DATA_DIRECTORY`` to the desired path.  If a path other than
+    ``KEA_DHCP_DATA_DIR`` to the desired path.  If a path other than
     this value is used in ``name`` or ``data-directory``, Kea will emit an error and
     refuse to start or, if already running, log an unrecoverable error.
     This restriction applies to writing lease file using ``lease4-write`` and
@@ -409,21 +409,21 @@ Summary of Path Restrictions
 Path restrictions mentioned through this section can be summarized according to
 the following table:
 
-+-------------------------------------+---------------------------------------+----------------------------------+
-| Restricted Element                  | Default Value                         | Environment Variable Override    |
-+=====================================+=======================================+==================================+
-| Config Files (``config-write``)     | Same Directory as Initial Config File | N/A                              |
-+-------------------------------------+---------------------------------------+----------------------------------+
-| Host Cache Files (``cache-write``)  | ``var/lib/kea``                       | ``KEA_DHCP_DATA_DIRECTORY``      |
-+-------------------------------------+---------------------------------------+----------------------------------+
-| Lease Files                         | ``var/lib/kea``                       | ``KEA_DHCP_DATA_DIRECTORY``      |
-+-------------------------------------+---------------------------------------+----------------------------------+
-| Log Files                           | ``var/log/kea``                       | ``KEA_LOG_FILE_DIR``             |
-+-------------------------------------+---------------------------------------+----------------------------------+
-| Forensic Log Files                  | ``var/log/kea``                       | ``KEA_LEGAL_LOG_DIR``            |
-+-------------------------------------+---------------------------------------+----------------------------------+
-| Unix Sockets                        | ``var/run/kea``                       | ``KEA_CONTROL_SOCKET_DIR``       |
-+-------------------------------------+---------------------------------------+----------------------------------+
++-------------------------------------+---------------------------------------+-------------------------------+
+| Restricted Element                  | Default Value                         | Environment Variable Override |
++=====================================+=======================================+===============================+
+| Config Files (``config-write``)     | Same Directory as Initial Config File | N/A                           |
++-------------------------------------+---------------------------------------+-------------------------------+
+| Host Cache Files (``cache-write``)  | ``var/lib/kea``                       | ``KEA_DHCP_DATA_DIR``         |
++-------------------------------------+---------------------------------------+-------------------------------+
+| Lease Files                         | ``var/lib/kea``                       | ``KEA_DHCP_DATA_DIR``         |
++-------------------------------------+---------------------------------------+-------------------------------+
+| Log Files                           | ``var/log/kea``                       | ``KEA_LOG_FILE_DIR``          |
++-------------------------------------+---------------------------------------+-------------------------------+
+| Forensic Log Files                  | ``var/log/kea``                       | ``KEA_LEGAL_LOG_DIR``         |
++-------------------------------------+---------------------------------------+-------------------------------+
+| Unix Sockets                        | ``var/run/kea``                       | ``KEA_CONTROL_SOCKET_DIR``    |
++-------------------------------------+---------------------------------------+-------------------------------+