From 6b721c4d3a9ce0d81a9ea0bb113e2450f23b7f99 Mon Sep 17 00:00:00 2001 From: Thomas Markwalder Date: Fri, 16 May 2025 09:39:55 -0400 Subject: [PATCH] [#3831] Update ARM modified: ../../sphinx/arm/ddns.rst modified: ../../sphinx/arm/dhcp4-srv.rst modified: ../../sphinx/arm/dhcp6-srv.rst --- doc/sphinx/arm/ddns.rst | 11 +++++++++++ doc/sphinx/arm/dhcp4-srv.rst | 10 ++++++++++ doc/sphinx/arm/dhcp6-srv.rst | 10 ++++++++++ 3 files changed, 31 insertions(+) diff --git a/doc/sphinx/arm/ddns.rst b/doc/sphinx/arm/ddns.rst index 89217fd750..129082c296 100644 --- a/doc/sphinx/arm/ddns.rst +++ b/doc/sphinx/arm/ddns.rst @@ -324,6 +324,17 @@ values are 107 on Linux and 103 on FreeBSD. Kea supports only one ``unix`` control socket in the "control-sockets" list. +.. note:: + + As of Kea 2.7.9, control sockets may reside in the directory + determined during compilation as ``"[kea-install-dir]/var/run/kea"``. This + path may be overridden at startup by setting the environment variable + ``KEA_CONTROL_SOCKET_DIR`` to the desired path. If a path other than + this value is used in ``socket-name``, Kea will emit an error and refuse to + start or, if already running, log an unrecoverable error. For ease of use in + simply omit the path component from ``socket-name``. + + Communication over the control channel is conducted using JSON structures. See the `Control Channel section in the Kea Developer's Guide `__ diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index aa7f2a62a1..fcb071dab7 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -7836,6 +7836,16 @@ values are 107 on Linux and 103 on FreeBSD. Kea supports only one ``unix`` control socket in the "control-sockets" list. +.. note:: + + As of Kea 2.7.9, control sockets may reside in the directory + determined during compilation as ``"[kea-install-dir]/var/run/kea"``. This + path may be overridden at startup by setting the environment variable + ``KEA_CONTROL_SOCKET_DIR`` to the desired path. If a path other than + this value is used in ``socket-name``, Kea will emit an error and refuse to + start or, if already running, log an unrecoverable error. For ease of use in + simply omit the path component from ``socket-name``. + Communication over the control channel is conducted using JSON structures. See the `Control Channel section in the Kea Developer's Guide diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index b5a5aa8fe4..188cd97bfa 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -7742,6 +7742,16 @@ values are 107 on Linux and 103 on FreeBSD. Kea supports only one ``unix`` control socket in the "control-sockets" list. +.. note:: + + As of Kea 2.7.9, control sockets may reside in the directory + determined during compilation as ``"[kea-install-dir]/var/run/kea"``. This + path may be overridden at startup by setting the environment variable + ``KEA_CONTROL_SOCKET_DIR`` to the desired path. If a path other than + this value is used in ``socket-name``, Kea will emit an error and refuse to + start or, if already running, log an unrecoverable error. For ease of use in + simply omit the path component from ``socket-name``. + Communication over the control channel is conducted using JSON structures. See the `Control Channel section in the Kea Developer's Guide