From: Razvan Becheriu Date: Thu, 22 May 2025 09:34:42 +0000 (+0300) Subject: [#3831] fix arm env var name X-Git-Tag: Kea-2.7.9~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ca2be270c115a016a8792e31bc5d86c39d0d6028;p=thirdparty%2Fkea.git [#3831] fix arm env var name --- diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index d6ff2b3edd..31e66b9bc0 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -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``. diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index b2a89d0529..410716258d 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -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. diff --git a/doc/sphinx/arm/hooks-host-cache.rst b/doc/sphinx/arm/hooks-host-cache.rst index 8de9810c64..f887cf295f 100644 --- a/doc/sphinx/arm/hooks-host-cache.rst +++ b/doc/sphinx/arm/hooks-host-cache.rst @@ -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 diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst index 183a8a8e79..42f429f262 100644 --- a/doc/sphinx/arm/hooks-lease-cmds.rst +++ b/doc/sphinx/arm/hooks-lease-cmds.rst @@ -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``. diff --git a/doc/sphinx/arm/security.rst b/doc/sphinx/arm/security.rst index 63b6ce86f4..783724f1c5 100644 --- a/doc/sphinx/arm/security.rst +++ b/doc/sphinx/arm/security.rst @@ -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`` | ++-------------------------------------+---------------------------------------+-------------------------------+