summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWlodzimierz Wencel <wlodek@isc.org>2023-06-26 17:22:45 +0200
committerWlodzimierz Wencel <wlodek@isc.org>2023-06-26 17:22:45 +0200
commit02d0ef5f3160c466545486047f2af48c086d516d (patch)
tree5b9f0bb25b06e9c88d39cca952d492073dc98b53 /doc
parent[#2866] Changes after review (diff)
downloadkea-02d0ef5f3160c466545486047f2af48c086d516d.tar.xz
kea-02d0ef5f3160c466545486047f2af48c086d516d.zip
[#1452] Document installing FreeRADIUS from packages
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/hooks-radius.rst43
-rw-r--r--doc/sphinx/arm/install.rst4
2 files changed, 43 insertions, 4 deletions
diff --git a/doc/sphinx/arm/hooks-radius.rst b/doc/sphinx/arm/hooks-radius.rst
index 9e8377c6ab..b82d14327a 100644
--- a/doc/sphinx/arm/hooks-radius.rst
+++ b/doc/sphinx/arm/hooks-radius.rst
@@ -47,6 +47,45 @@ specific pool. Furthermore, the same mechanism can be used to control
what kind of options the client gets if there are DHCP options
specified for a particular class.
+.. _hooks-radius-pkg-install:
+
+Installation from packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ISC offers a FreeRADIUS client library using packages (rpm, deb) that contain
+the necessary code for the radius hook. Instructions how to setup Kea repository
+hosted by `Cloudsmith <https://cloudsmith.io/~isc/repos/>`_ can be found
+`on KB <https://kb.isc.org/docs/isc-kea-packages>`_
+
+The packages provided by ISC are based on the official freeradius packages
+and always have a version that includes ``1.1.7-isc``. Ones that contains compiled
+libraries need to run Kea are e.g. ``libfreeradius-client_1.1.7-isc20200318122047_amd64.deb``,
+and those which contains development (``-dev`` in deb and ``-devel`` in rpm)
+header files e.g. ``libfreeradius-client-dev_1.1.7-isc20200318122047_amd64.deb``.
+
+When listed (deb):
+
+.. code-block:: console
+
+ $ dpkg -l | grep libfreeradius
+ ii libfreeradius-client 1.1.7-isc20200318122047 amd64 Enhanced RADIUS client library
+ ii libfreeradius-client-dev 1.1.7-isc20200318122047 amd64 Enhanced RADIUS client library development files
+
+When listed (rpm):
+
+.. code-block:: console
+
+ $ dnf list installed | grep freeradius
+ freeradius-client.x86_64 1.1.7-isc20200318134606.el8 @isc-kea-2-2-prv
+ freeradius-client-devel.x86_64 1.1.7-isc20200318134606.el8 @isc-kea-2-2-prv
+
+If official freeradius packages will be installed Kea will return error
+on startup, typically displaying:
+
+.. code-block:: console
+
+ HOOKS_OPEN_ERROR failed to open hook library /usr/lib64/kea/hooks/libdhcp_radius.so: /usr/lib64/kea/hooks/libdhcp_radius.so: undefined symbol: rc_acct_async
+
.. _hooks-radius-install:
Compilation and Installation of the RADIUS Hook
@@ -58,7 +97,7 @@ on CentOS 7.0. Other systems may differ slightly.
.. note::
ISC provides Kea software and hooks in convenient-to-use
- native Alpine, deb, and RPM packages. This includes the RADIUS hook and the required patched version
+ native DEB, and RPM packages. This includes the RADIUS hook and the required patched version
of the FreeRADIUS client library. The software compilation for RADIUS is complicated; unless
there are specific reasons to compile it, administrators should seriously consider using
native packages.
@@ -326,7 +365,7 @@ takes many parameters. For example, this configuration could be used:
"library": "/usr/local/lib/kea/hooks/libdhcp_host_cache.so"
},
{
- "library": "/usr/local/lib/kea/hooks/libdhc_radius.so",
+ "library": "/usr/local/lib/kea/hooks/libdhcp_radius.so",
"parameters": {
# Specify where FreeRADIUS dictionary could be located
diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst
index 9639813022..63e41e6303 100644
--- a/doc/sphinx/arm/install.rst
+++ b/doc/sphinx/arm/install.rst
@@ -15,8 +15,8 @@ and installed using the system available in a specific distribution (such
as dpkg or rpm). The Kea repository can also be added to the system,
making it easier to install updates. For details, please
go to https://cloudsmith.io/~isc/repos, choose the repository of
-interest, and then click the ``Set Me Up`` button for detailed
-instructions.
+interest, and then click the ``Set Me Up`` button. For detailed
+instructions or refer to ISC `KB article <https://kb.isc.org/docs/isc-kea-packages>`_.
Installation From Cloudsmith Packages
-------------------------------------