From: Francis Dupont Date: Sat, 30 Aug 2025 22:53:52 +0000 (+0200) Subject: [#4042] Removed hook paths from doc X-Git-Tag: Kea-3.1.2~16 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=9efb9dd745dfdf16fbe8d85d17aa48612fcdbd4d;p=thirdparty%2Fkea.git [#4042] Removed hook paths from doc --- diff --git a/doc/devel/congestion-handling.dox b/doc/devel/congestion-handling.dox index 83079e8a46..1a963fd0cb 100644 --- a/doc/devel/congestion-handling.dox +++ b/doc/devel/congestion-handling.dox @@ -292,7 +292,7 @@ to look something like this: "hooks-libraries": [ { # Loading your hook library! - "library": "/somepath/lib/libyour_packet_queue.so" + "library": "libyour_packet_queue.so" } # any other hook libs @@ -430,7 +430,7 @@ Server configuration for kea-dhcp6: "hooks-libraries": [ { # Loading your hook library! - "library": "/somepath/lib/libyour_packet_queue.so" + "library": "libyour_packet_queue.so" } # any other hook libs diff --git a/doc/examples/agent/rbac.json b/doc/examples/agent/rbac.json index 575cfd90e5..9db38796b0 100644 --- a/doc/examples/agent/rbac.json +++ b/doc/examples/agent/rbac.json @@ -32,7 +32,7 @@ // Add hooks here. "hooks-libraries": [ { - "library": "/opt/lib/libdhcp_rbac.so", + "library": "libdhcp_rbac.so", "parameters": { // This section configures the RBAC hook library. // Mandatory parameters. diff --git a/doc/examples/agent/simple.json b/doc/examples/agent/simple.json index 62596c45ca..e96bc54f95 100644 --- a/doc/examples/agent/simple.json +++ b/doc/examples/agent/simple.json @@ -126,7 +126,7 @@ // Hook libraries list may contain more than one library. { // The only necessary parameter is the library filename. - "library": "/opt/local/control-agent-commands.so", + "library": "control-agent-commands.so", // Some libraries may support parameters. Make sure you // type this section carefully, as the CA does not validate diff --git a/doc/examples/ddns/all-keys-netconf.json b/doc/examples/ddns/all-keys-netconf.json index be481f6851..ae910fb84b 100644 --- a/doc/examples/ddns/all-keys-netconf.json +++ b/doc/examples/ddns/all-keys-netconf.json @@ -52,7 +52,7 @@ "hooks-libraries": [ { // Location of the hook library to be loaded. - "library": "/opt/local/ddns-server-commands.so", + "library": "ddns-server-commands.so", // Hook library-specific configuration parameters. "parameters": { } diff --git a/doc/examples/ddns/all-keys.json b/doc/examples/ddns/all-keys.json index 56d0a227ed..a2dd686e31 100644 --- a/doc/examples/ddns/all-keys.json +++ b/doc/examples/ddns/all-keys.json @@ -134,7 +134,7 @@ "hooks-libraries": [ { // Location of the hook library to be loaded. - "library": "/opt/local/ddns-server-commands.so", + "library": "ddns-server-commands.so", // Hook library-specific configuration parameters. "parameters": { } diff --git a/doc/examples/ddns/gss-tsig.json b/doc/examples/ddns/gss-tsig.json index 0af13519c3..0e3623ca0e 100644 --- a/doc/examples/ddns/gss-tsig.json +++ b/doc/examples/ddns/gss-tsig.json @@ -61,7 +61,7 @@ // The GSS-TSIG hook is loaded and its configuration is specified here. "hooks-libraries": [ { - "library": "/opt/lib/libddns_gss_tsig.so", + "library": "libddns_gss_tsig.so", "parameters": { // This section governs the GSS-TSIG integration. Each server // mentioned in forward-ddns and/or reverse-ddns needs to have diff --git a/doc/examples/ddns/sample1.json b/doc/examples/ddns/sample1.json index 3766700440..5ed91c09b3 100644 --- a/doc/examples/ddns/sample1.json +++ b/doc/examples/ddns/sample1.json @@ -42,7 +42,7 @@ // Hook libraries list may contain more than one library. { // The only necessary parameter is the library filename. - "library": "/opt/local/ddns-server-commands.so", + "library": "ddns-server-commands.so", // Some libraries may support parameters. Make sure you // type this section carefully, as the CA does not validate diff --git a/doc/examples/kea4/all-keys-netconf.json b/doc/examples/kea4/all-keys-netconf.json index e350af1bd2..a82ab13c96 100644 --- a/doc/examples/kea4/all-keys-netconf.json +++ b/doc/examples/kea4/all-keys-netconf.json @@ -459,18 +459,18 @@ "hooks-libraries": [ { // Location of the hook library to be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", // Hook library-specific configuration parameters. "parameters": { } }, { // The MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, { // The PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" } ], diff --git a/doc/examples/kea4/all-keys.json b/doc/examples/kea4/all-keys.json index 89465c33e1..82f633426d 100644 --- a/doc/examples/kea4/all-keys.json +++ b/doc/examples/kea4/all-keys.json @@ -459,18 +459,18 @@ "hooks-libraries": [ { // Location of the hook library to be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", // Hook library-specific configuration parameters. "parameters": { } }, { // The MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, { // The PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" } ], diff --git a/doc/examples/kea4/backends.json b/doc/examples/kea4/backends.json index 5d37ca1c56..a758548e0e 100644 --- a/doc/examples/kea4/backends.json +++ b/doc/examples/kea4/backends.json @@ -50,7 +50,7 @@ // Specify the lease backend hook library location. // { // // the MySQL lease backend hook library required for lease storage. -// "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" +// "library": "libdhcp_mysql.so" // }, // 3. PostgreSQL backend. Leases will be stored in PostgreSQL database. Make @@ -78,7 +78,7 @@ // Specify the lease backend hook library location. // { // // the PostgreSQL lease backend hook library required for lease storage. -// "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" +// "library": "libdhcp_pgsql.so" // }, // Addresses will be assigned with a lifetime of 4000 seconds. diff --git a/doc/examples/kea4/config-backend.json b/doc/examples/kea4/config-backend.json index 0bcfba91b9..5c04180101 100644 --- a/doc/examples/kea4/config-backend.json +++ b/doc/examples/kea4/config-backend.json @@ -63,19 +63,19 @@ // The libdhcp_mysql.so is required to use MySQL Configuration // Backend. { - "library": "/usr/local/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" } // If using PostgreSQL Configuration Backend, the "libdhcp_pgsql.so" is // required. // { - // "library": "/usr/local/lib/kea/hooks/libdhcp_pgsql.so" + // "library": "libdhcp_pgsql.so" // } // The libdhcp_cb_cmds.so is optional. It allows for managing the // configuration in the database. If this library is not loaded, // the configuration can be managed directly using available // tools that work directly with the MySQL database. // ,{ - // "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so" + // "library": "libdhcp_cb_cmds.so" // } ], diff --git a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json index 2a89216268..9dcdca5610 100644 --- a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json +++ b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json @@ -99,12 +99,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { // The HA hook library should be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. // Each server should have the same HA configuration, except for the diff --git a/doc/examples/kea4/ha-load-balancing-server2-mt.json b/doc/examples/kea4/ha-load-balancing-server2-mt.json index 32643d8278..0dc65370b9 100644 --- a/doc/examples/kea4/ha-load-balancing-server2-mt.json +++ b/doc/examples/kea4/ha-load-balancing-server2-mt.json @@ -98,12 +98,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { // The HA hook library should be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. // Each server should have the same HA configuration, except for the diff --git a/doc/examples/kea4/hooks-radius.json b/doc/examples/kea4/hooks-radius.json index 55704c21d9..01edfe00e7 100644 --- a/doc/examples/kea4/hooks-radius.json +++ b/doc/examples/kea4/hooks-radius.json @@ -125,7 +125,7 @@ "hooks-libraries": [ { // Load the flex-id hook library. - "library": "/usr/local/lib/kea/hooks/libdhcp_flex_id.so", + "library": "libdhcp_flex_id.so", "parameters": { // Take the ID from the AOP option. @@ -141,11 +141,11 @@ // Load the host cache hook library. It is needed by the RADIUS // library to keep the attributes from authorization to later user // for accounting. - "library": "/usr/local/lib/kea/hooks/libdhcp_host_cache.so" + "library": "libdhcp_host_cache.so" }, { // Load the RADIUS hook library. - "library": "/usr/local/lib/kea/hooks/libdhcp_radius.so", + "library": "libdhcp_radius.so", "parameters": { // If do not use RFC 4361 diff --git a/doc/examples/kea4/hooks.json b/doc/examples/kea4/hooks.json index 3bdf86ecdb..383b8c858c 100644 --- a/doc/examples/kea4/hooks.json +++ b/doc/examples/kea4/hooks.json @@ -35,10 +35,10 @@ "hooks-libraries": [ { - "library": "/opt/lib/security.so" + "library": "security.so" }, { - "library": "/opt/lib/charging.so", + "library": "charging.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-forensic6" diff --git a/doc/examples/kea4/mysql-reservations.json b/doc/examples/kea4/mysql-reservations.json index 26d9eee027..e3a9a24895 100644 --- a/doc/examples/kea4/mysql-reservations.json +++ b/doc/examples/kea4/mysql-reservations.json @@ -75,7 +75,7 @@ "hooks-libraries": [ { // the MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" } ], diff --git a/doc/examples/kea4/pgsql-reservations.json b/doc/examples/kea4/pgsql-reservations.json index 94b1904192..144a838295 100644 --- a/doc/examples/kea4/pgsql-reservations.json +++ b/doc/examples/kea4/pgsql-reservations.json @@ -73,7 +73,7 @@ "hooks-libraries": [ { // the PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" } ], diff --git a/doc/examples/kea6/all-keys-netconf.json b/doc/examples/kea6/all-keys-netconf.json index e070989d04..9d7e8f1602 100644 --- a/doc/examples/kea6/all-keys-netconf.json +++ b/doc/examples/kea6/all-keys-netconf.json @@ -401,18 +401,18 @@ "hooks-libraries": [ { // Location of the hook library to be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", // Hook library-specific configuration parameters. "parameters": { } }, { // The MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, { // The PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" } ], diff --git a/doc/examples/kea6/all-keys.json b/doc/examples/kea6/all-keys.json index 4b8d344650..edf1cea2f9 100644 --- a/doc/examples/kea6/all-keys.json +++ b/doc/examples/kea6/all-keys.json @@ -401,18 +401,18 @@ "hooks-libraries": [ { // Location of the hook library to be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", // Hook library-specific configuration parameters. "parameters": { } }, { // The MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, { // The PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" } ], diff --git a/doc/examples/kea6/backends.json b/doc/examples/kea6/backends.json index c30200f86e..54ba753a53 100644 --- a/doc/examples/kea6/backends.json +++ b/doc/examples/kea6/backends.json @@ -50,7 +50,7 @@ // Specify the lease backend hook library location. // { // // the MySQL lease backend hook library required for lease storage. -// "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" +// "library": "libdhcp_mysql.so" // }, // 3. PostgreSQL backend. Leases will be stored in PostgreSQL database. Make @@ -78,7 +78,7 @@ // Specify the lease backend hook library location. // { // // the PostgreSQL lease backend hook library required for lease storage. -// "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" +// "library": "libdhcp_pgsql.so" // }, // Addresses will be assigned with preferred and valid lifetimes diff --git a/doc/examples/kea6/config-backend.json b/doc/examples/kea6/config-backend.json index d0a1f8a97b..bf67dcb445 100644 --- a/doc/examples/kea6/config-backend.json +++ b/doc/examples/kea6/config-backend.json @@ -63,19 +63,19 @@ // The libdhcp_mysql.so is required to use MySQL Configuration // Backend. { - "library": "/usr/local/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" } // If using PostgreSQL Configuration Backend, the "libdhcp_pgsql.so" is // required. // { - // "library": "/usr/local/lib/kea/hooks/libdhcp_pgsql.so" + // "library": "libdhcp_pgsql.so" // } // The libdhcp_cb_cmds.so is optional. It allows for managing the // configuration in the database. If this library is not loaded, // the configuration can be managed directly using available // tools that work directly with the MySQL database. // ,{ - // "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so" + // "library": "libdhcp_cb_cmds.so" // } ], diff --git a/doc/examples/kea6/ha-hot-standby-server1-with-tls.json b/doc/examples/kea6/ha-hot-standby-server1-with-tls.json index 19d2b5e5b5..e2e92a4322 100644 --- a/doc/examples/kea6/ha-hot-standby-server1-with-tls.json +++ b/doc/examples/kea6/ha-hot-standby-server1-with-tls.json @@ -46,12 +46,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { // The HA hook library should be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. // Each server should have the same HA configuration, except for the diff --git a/doc/examples/kea6/ha-hot-standby-server2.json b/doc/examples/kea6/ha-hot-standby-server2.json index 4c1cf1fff4..38c7f1d1d7 100644 --- a/doc/examples/kea6/ha-hot-standby-server2.json +++ b/doc/examples/kea6/ha-hot-standby-server2.json @@ -45,12 +45,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/opt/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { // The HA hook library should be loaded. - "library": "/opt/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // High Availability configuration is specified for the HA hook library. // Each server should have the same HA configuration, except for the diff --git a/doc/examples/kea6/hooks.json b/doc/examples/kea6/hooks.json index b683c6edb5..be197c9ba9 100644 --- a/doc/examples/kea6/hooks.json +++ b/doc/examples/kea6/hooks.json @@ -43,10 +43,10 @@ "hooks-libraries": [ { - "library": "/opt/lib/security.so" + "library": "security.so" }, { - "library": "/opt/lib/charging.so", + "library": "charging.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-forensic6" diff --git a/doc/examples/kea6/mysql-reservations.json b/doc/examples/kea6/mysql-reservations.json index b83b9c003c..8ee9adde8d 100644 --- a/doc/examples/kea6/mysql-reservations.json +++ b/doc/examples/kea6/mysql-reservations.json @@ -63,7 +63,7 @@ "hooks-libraries": [ { // the MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" } ], diff --git a/doc/examples/kea6/pgsql-reservations.json b/doc/examples/kea6/pgsql-reservations.json index d2987caeeb..422118b484 100644 --- a/doc/examples/kea6/pgsql-reservations.json +++ b/doc/examples/kea6/pgsql-reservations.json @@ -60,7 +60,7 @@ "hooks-libraries": [ { // the PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" } ], diff --git a/doc/examples/netconf/simple-dhcp4.json b/doc/examples/netconf/simple-dhcp4.json index 6847e2a9f3..1e5665bfec 100644 --- a/doc/examples/netconf/simple-dhcp4.json +++ b/doc/examples/netconf/simple-dhcp4.json @@ -75,7 +75,7 @@ // // Hook libraries list may contain more than one library. // { // // The only necessary parameter is the library filename. - // "library": "/opt/local/netconf-commands.so", + // "library": "netconf-commands.so", // // Some libraries may support parameters. Make sure you // // type this section carefully, as the CA does not validate diff --git a/doc/examples/netconf/simple-dhcp6.json b/doc/examples/netconf/simple-dhcp6.json index 0b74926666..0592379b6e 100644 --- a/doc/examples/netconf/simple-dhcp6.json +++ b/doc/examples/netconf/simple-dhcp6.json @@ -76,7 +76,7 @@ // // Hook libraries list may contain more than one library. // { // // The only necessary parameter is the library filename. - // "library": "/opt/local/netconf-commands.so", + // "library": "netconf-commands.so", // // Some libraries may support parameters. Make sure you // // type this section carefully, as the CA does not validate diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf index add138055a..99b3f7d10f 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf @@ -93,12 +93,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_lease_cmds.so" + "library": "libdhcp_lease_cmds.so" }, { // The HA hook library should be loaded. - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the // "this-server-name" parameter. diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf index bce555f56c..8a3a654f0e 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf @@ -93,12 +93,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_lease_cmds.so" + "library": "libdhcp_lease_cmds.so" }, { // The HA hook library should be loaded. - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the // "this-server-name" parameter. diff --git a/doc/examples/template-power-user-home/kea-dhcp4-1.conf b/doc/examples/template-power-user-home/kea-dhcp4-1.conf index 810b182345..d3720b22f5 100644 --- a/doc/examples/template-power-user-home/kea-dhcp4-1.conf +++ b/doc/examples/template-power-user-home/kea-dhcp4-1.conf @@ -76,12 +76,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_lease_cmds.so" + "library": "libdhcp_lease_cmds.so" }, { // The HA hook library should be loaded. - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the // "this-server-name" parameter. diff --git a/doc/examples/template-power-user-home/kea-dhcp4-2.conf b/doc/examples/template-power-user-home/kea-dhcp4-2.conf index 9928e8a648..1c2c5a2186 100644 --- a/doc/examples/template-power-user-home/kea-dhcp4-2.conf +++ b/doc/examples/template-power-user-home/kea-dhcp4-2.conf @@ -76,12 +76,12 @@ // deliver lease updates to the server as well as synchronize the // lease database after failure. { - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_lease_cmds.so" + "library": "libdhcp_lease_cmds.so" }, { // The HA hook library should be loaded. - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { // Each server should have the same HA configuration, except for the // "this-server-name" parameter. diff --git a/doc/sphinx/arm/agent.rst b/doc/sphinx/arm/agent.rst index 6cf7b30330..c4fff8a788 100644 --- a/doc/sphinx/arm/agent.rst +++ b/doc/sphinx/arm/agent.rst @@ -95,7 +95,7 @@ The following example demonstrates the basic CA configuration. "hooks-libraries": [ { - "library": "/opt/local/custom_hooks_example.so", + "library": "custom_hooks_example.so", "parameters": { "param1": "foo" } diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index f4da752fce..28701b7c7c 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -686,7 +686,7 @@ Specify the lease backend hook library location: "Dhcp4": { "hooks-libraries": [ { // the MySQL lease backend hook library required for lease storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, ... ], ... } Since Kea.2.7.4, the libdhcp_pgsql.so hook library must be loaded in order to @@ -698,7 +698,7 @@ Specify the lease backend hook library location. "Dhcp4": { "hooks-libraries": [ { // the PostgreSQL lease backend hook library required for lease storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" }, ... ], ... } @@ -943,7 +943,7 @@ Specify the lease backend hook library location: "Dhcp4": { "hooks-libraries": [ { // the MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, ... ], ... } Since Kea.2.7.4, the libdhcp_pgsql.so hook library must be loaded in order to @@ -955,7 +955,7 @@ Specify the lease backend hook library location. "Dhcp4": { "hooks-libraries": [ { // the PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" }, ... ], ... } @@ -8624,10 +8624,10 @@ database: }, "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, { - "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so" + "library": "libdhcp_cb_cmds.so" } ] } @@ -8655,10 +8655,10 @@ The following snippet illustrates the use of a PostgreSQL database: }, "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" }, { - "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so" + "library": "libdhcp_cb_cmds.so" } ] } diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index 1430581864..8372a0445d 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -642,7 +642,7 @@ Specify the lease backend hook library location: "Dhcp6": { "hooks-libraries": [ { // the MySQL lease backend hook library required for lease storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, ... ], ... } Since Kea.2.7.4, the libdhcp_pgsql.so hook library must be loaded in order to @@ -654,7 +654,7 @@ Specify the lease backend hook library location. "Dhcp6": { "hooks-libraries": [ { // the PostgreSQL lease backend hook library required for lease storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" }, ... ], ... } @@ -899,7 +899,7 @@ Specify the lease backend hook library location: "Dhcp6": { "hooks-libraries": [ { // the MySQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, ... ], ... } Since Kea.2.7.4, the libdhcp_pgsql.so hook library must be loaded in order to @@ -911,7 +911,7 @@ Specify the lease backend hook library location. "Dhcp6": { "hooks-libraries": [ { // the PostgreSQL host backend hook library required for host storage. - "library": "/opt/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" }, ... ], ... } @@ -8467,10 +8467,10 @@ database: }, "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_mysql.so" + "library": "libdhcp_mysql.so" }, { - "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so" + "library": "libdhcp_cb_cmds.so" } ] } @@ -8498,10 +8498,10 @@ The following snippet illustrates the use of a PostgreSQL database: }, "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_pgsql.so" + "library": "libdhcp_pgsql.so" }, { - "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so" + "library": "libdhcp_cb_cmds.so" } ] } diff --git a/doc/sphinx/arm/ext-gss-tsig.rst b/doc/sphinx/arm/ext-gss-tsig.rst index 12a38e333e..163e3efda0 100644 --- a/doc/sphinx/arm/ext-gss-tsig.rst +++ b/doc/sphinx/arm/ext-gss-tsig.rst @@ -516,7 +516,7 @@ An excerpt from a D2 server configuration is provided below; more examples are a // The GSS-TSIG hook is loaded and its configuration is specified here. "hooks-libraries": [ { - "library": "/opt/lib/libddns_gss_tsig.so", + "library": "libddns_gss_tsig.so", "parameters": { // This section governs the GSS-TSIG integration. Each server // mentioned in forward-ddns and/or reverse-ddns needs to have diff --git a/doc/sphinx/arm/ext-netconf.rst b/doc/sphinx/arm/ext-netconf.rst index a1b5f29a69..37e66d26da 100644 --- a/doc/sphinx/arm/ext-netconf.rst +++ b/doc/sphinx/arm/ext-netconf.rst @@ -582,7 +582,7 @@ Kea sources. // The hook libraries list may contain more than one library. { // The only necessary parameter is the library filename. - "library": "/opt/local/custom_hooks_example.so", + "library": "custom_hooks_example.so", // Some libraries may support parameters. Make sure you // type this section carefully, as kea-netconf does not diff --git a/doc/sphinx/arm/ext-radius.rst b/doc/sphinx/arm/ext-radius.rst index 4bf8178def..1313b95fed 100644 --- a/doc/sphinx/arm/ext-radius.rst +++ b/doc/sphinx/arm/ext-radius.rst @@ -66,10 +66,10 @@ takes many parameters. For example, this configuration can be used: { // Note that the RADIUS access service requires host-cache for // proper operation, so this library is loaded as well. - "library": "/usr/local/lib/kea/hooks/libdhcp_host_cache.so" + "library": "libdhcp_host_cache.so" }, { - "library": "/usr/local/lib/kea/hooks/libdhcp_radius.so", + "library": "libdhcp_radius.so", "parameters": { // Specify where the dictionary is located. diff --git a/doc/sphinx/arm/hooks-bootp.rst b/doc/sphinx/arm/hooks-bootp.rst index ee4f595cbd..93bfcad3c1 100644 --- a/doc/sphinx/arm/hooks-bootp.rst +++ b/doc/sphinx/arm/hooks-bootp.rst @@ -32,7 +32,7 @@ it takes no parameters. "Dhcp4": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_bootp.so" }, + { "library": "libdhcp_bootp.so" }, ... ] } diff --git a/doc/sphinx/arm/hooks-ddns-tuning.rst b/doc/sphinx/arm/hooks-ddns-tuning.rst index af32a39a51..23e01e713a 100644 --- a/doc/sphinx/arm/hooks-ddns-tuning.rst +++ b/doc/sphinx/arm/hooks-ddns-tuning.rst @@ -23,7 +23,7 @@ server's configuration: { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_ddns_tuning.so", + "library": "libdhcp_ddns_tuning.so", "parameters": { ... } @@ -47,7 +47,7 @@ expression is shown below: { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_ddns_tuning.so", + "library": "libdhcp_ddns_tuning.so", "parameters": { "hostname-expr": "'host-'+hexstring(pkt4.mac,'-')", ... @@ -67,7 +67,7 @@ the ``hostname-expr`` one would use to reverse this rule: { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_ddns_tuning.so", + "library": "libdhcp_ddns_tuning.so", "parameters": { "hostname-expr" : "ifelse(option[12].exists, option[host-name].text, option[81].text)" } diff --git a/doc/sphinx/arm/hooks-flex-id.rst b/doc/sphinx/arm/hooks-flex-id.rst index dad534ce5f..222273f117 100644 --- a/doc/sphinx/arm/hooks-flex-id.rst +++ b/doc/sphinx/arm/hooks-flex-id.rst @@ -48,7 +48,7 @@ and ``ignore-iaid``: "Dhcp6": { "hooks-libraries": [ { - "library": "/path/libdhcp_flex_id.so", + "library": "libdhcp_flex_id.so", "parameters": { "identifier-expression": "expression", "replace-client-id": false, @@ -96,7 +96,7 @@ can be achieved by using the following configuration: # add "flex-id" to reservation identifiers "hooks-libraries": [ { - "library": "/path/libdhcp_flex_id.so", + "library": "libdhcp_flex_id.so", "parameters": { "identifier-expression": "substring(relay6[0].option[18].hex,0,8)" } @@ -145,7 +145,7 @@ for non-printable characters and do not require the use of the # add "flex-id" to reservation identifiers "hooks-libraries": [ { - "library": "/path/libdhcp_flex_id.so", + "library": "libdhcp_flex_id.so", "parameters": { "identifier-expression": "vendor[4491].option[1026].hex" } @@ -198,7 +198,7 @@ The following is a stub configuration that enables this behavior: "Dhcp4": { "hooks-libraries": [ { - "library": "/path/libdhcp_flex_id.so", + "library": "libdhcp_flex_id.so", "parameters": { "identifier-expression": "expression", "replace-client-id": true diff --git a/doc/sphinx/arm/hooks-flex-option.rst b/doc/sphinx/arm/hooks-flex-option.rst index 1943a0d656..06f3b7df49 100644 --- a/doc/sphinx/arm/hooks-flex-option.rst +++ b/doc/sphinx/arm/hooks-flex-option.rst @@ -52,7 +52,7 @@ expression. "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_flex_option.so", + "library": "libdhcp_flex_option.so", "parameters": { "options": [ { @@ -81,7 +81,7 @@ mask in the response: "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_flex_option.so", + "library": "libdhcp_flex_option.so", "parameters": { "options": [ { @@ -176,7 +176,7 @@ encapsulates the ``vendor-encapsulated-options`` space. "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_flex_option.so", + "library": "libdhcp_flex_option.so", "parameters": { "options": [ { diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst index e1ec8e5c64..070f1be8bc 100644 --- a/doc/sphinx/arm/hooks-ha.rst +++ b/doc/sphinx/arm/hooks-ha.rst @@ -244,10 +244,10 @@ Server 1: { "Dhcp4": { "hooks-libraries": [{ - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [{ "this-server-name": "server1", @@ -291,10 +291,10 @@ Server 2: { "Dhcp4": { "hooks-libraries": [{ - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [{ "this-server-name": "server2", @@ -671,10 +671,10 @@ only difference that ``this-server-name`` should be set to "server2" and "Dhcp4": { "hooks-libraries": [{ - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [{ "this-server-name": "server1", @@ -1011,10 +1011,10 @@ library configuration has been removed from this example. }], "hooks-libraries": [{ - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [{ }] @@ -1073,10 +1073,10 @@ The following is an example configuration of the primary server in a "Dhcp4": { "hooks-libraries": [{ - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [{ "this-server-name": "server1", @@ -1158,10 +1158,10 @@ The following is an example configuration file for the primary server in a { "Dhcp4": { "hooks-libraries": [{ - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [{ "this-server-name": "server1", @@ -1277,11 +1277,11 @@ default to ``true``: "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { "this-server-name": "server1", @@ -1370,11 +1370,11 @@ single page of leases from 60 seconds to 90 seconds: "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { "this-server-name": "server1", @@ -1449,11 +1449,11 @@ the HA state machine to pause in the ``waiting`` state after server startup. "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { "this-server-name": "server1", @@ -1504,11 +1504,11 @@ Consider the following configuration: "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { "this-server-name": "server1", @@ -1665,11 +1665,11 @@ as illustrated below: "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { } }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { "this-server-name": "server1", @@ -2446,11 +2446,11 @@ grouped into relationships as in the snippet below: }, "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": {} }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { @@ -2550,11 +2550,11 @@ branch ``server3``: }, "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": {} }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { diff --git a/doc/sphinx/arm/hooks-host-cache.rst b/doc/sphinx/arm/hooks-host-cache.rst index 3a3cc18be1..5a54137b14 100644 --- a/doc/sphinx/arm/hooks-host-cache.rst +++ b/doc/sphinx/arm/hooks-host-cache.rst @@ -41,7 +41,7 @@ any other hook library; for example, this configuration could be used: "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_host_cache.so", + "library": "libdhcp_host_cache.so", "parameters": { # Tells Kea to never cache more than 1000 hosts. diff --git a/doc/sphinx/arm/hooks-host-cmds.rst b/doc/sphinx/arm/hooks-host-cmds.rst index 1a2021c523..e790e6da14 100644 --- a/doc/sphinx/arm/hooks-host-cmds.rst +++ b/doc/sphinx/arm/hooks-host-cmds.rst @@ -83,7 +83,7 @@ servers. "Dhcp6": { "hooks-libraries": [ { - "library": "/path/libdhcp_host_cmds.so" + "library": "libdhcp_host_cmds.so" }, ... ] diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst index 4728c4c79b..ac4b2ca8cc 100644 --- a/doc/sphinx/arm/hooks-lease-cmds.rst +++ b/doc/sphinx/arm/hooks-lease-cmds.rst @@ -122,7 +122,7 @@ servers. "Dhcp6": { "hooks-libraries": [ { - "library": "/path/libdhcp_lease_cmds.so" + "library": "libdhcp_lease_cmds.so" }, ... ] @@ -1139,7 +1139,7 @@ lease: { "hooks-libraries": [{ - "library": "/path/libdhcp_lease_cmds.so", + "library": "libdhcp_lease_cmds.so", "parameters": { "binding-variables": [{ "name": "opt-222", diff --git a/doc/sphinx/arm/hooks-lease-query.rst b/doc/sphinx/arm/hooks-lease-query.rst index 590e93858b..a080ed3a89 100644 --- a/doc/sphinx/arm/hooks-lease-query.rst +++ b/doc/sphinx/arm/hooks-lease-query.rst @@ -142,7 +142,7 @@ addresses: { "hooks-libraries": [ { - "library": "lib/kea/hooks/libdhcp_lease_query.so", + "library": "libdhcp_lease_query.so", "parameters": { "requesters": [ "192.0.1.1", "10.0.0.2" ] } @@ -327,7 +327,7 @@ addresses: { "hooks-libraries": [ { - "library": "lib/kea/hooks/libdhcp_lease_query.so", + "library": "libdhcp_lease_query.so", "parameters": { "requesters": [ "2001:db8:1::1", "2001:db8:2::1" ], "prefix-lengths": [ 72 ] @@ -542,7 +542,7 @@ For instance, for DHCPv4: { "hooks-libraries": [ { - "library": "lib/kea/hooks/libdhcp_lease_query.so", + "library": "libdhcp_lease_query.so", "parameters": { "requesters": [ "192.0.2.1", "192.0.2.2" ], "advanced" : { @@ -571,7 +571,7 @@ or for DHCPv6: { "hooks-libraries": [ { - "library": "lib/kea/hooks/libdhcp_lease_query.so", + "library": "libdhcp_lease_query.so", "parameters": { "requesters": [ "2001:db8:1::1", "2001:db8:2::1" ], "advanced" : { diff --git a/doc/sphinx/arm/hooks-legal-log.rst b/doc/sphinx/arm/hooks-legal-log.rst index 99143fe434..af5574dc6c 100644 --- a/doc/sphinx/arm/hooks-legal-log.rst +++ b/doc/sphinx/arm/hooks-legal-log.rst @@ -96,7 +96,7 @@ by the ``--prefix`` meson setup option which defaults to "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-forensic4" @@ -114,7 +114,7 @@ For :iscman:`kea-dhcp6`, the configuration is: "Dhcp6": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-forensic6" @@ -200,7 +200,7 @@ Examples: "Dhcp6": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-forensic6", @@ -233,7 +233,7 @@ Examples: "Dhcp6": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-forensic6", @@ -252,7 +252,7 @@ Additional parameters for the database connection can be specified, e.g: "Dhcp6": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "name": "database-name", "password": "1234", @@ -490,7 +490,7 @@ Examples: "Dhcp4": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "name": "database-name", "password": "1234", @@ -815,7 +815,7 @@ Examples: "Dhcp6": { "hooks-libraries": [ { - "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", + "library": "libdhcp_legal_log.so", "parameters": { "name": "database-name", "password": "1234", diff --git a/doc/sphinx/arm/hooks-limits.rst b/doc/sphinx/arm/hooks-limits.rst index ca12a3c2cb..b1fe7e63d8 100644 --- a/doc/sphinx/arm/hooks-limits.rst +++ b/doc/sphinx/arm/hooks-limits.rst @@ -34,7 +34,7 @@ The library can be loaded by both :iscman:`kea-dhcp4` and :iscman:`kea-dhcp6` se "Dhcp6": { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_limits.so" + "library": "libdhcp_limits.so" } ] } diff --git a/doc/sphinx/arm/hooks-perfmon.rst b/doc/sphinx/arm/hooks-perfmon.rst index 2081198ca9..881a1329e7 100644 --- a/doc/sphinx/arm/hooks-perfmon.rst +++ b/doc/sphinx/arm/hooks-perfmon.rst @@ -24,7 +24,7 @@ the server's configuration: { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_perfmon.so", + "library": "libdhcp_perfmon.so", "parameters": { ... } @@ -408,7 +408,7 @@ A sample configuration is shown below: { "hooks-libraries": [ { - "library": "lib/kea/hooks/libdhcp_perfmon.so", + "library": "libdhcp_perfmon.so", "parameters": { "enable-monitoring": true, "interval-width-secs": 5, diff --git a/doc/sphinx/arm/hooks-ping-check.rst b/doc/sphinx/arm/hooks-ping-check.rst index 661a50a1a4..7f5f5d0fd5 100644 --- a/doc/sphinx/arm/hooks-ping-check.rst +++ b/doc/sphinx/arm/hooks-ping-check.rst @@ -26,7 +26,7 @@ by adding it to the ``hooks-libraries`` element of the server's configuration: { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_ping_check.so", + "library": "libdhcp_ping_check.so", "parameters": { ... } @@ -132,7 +132,7 @@ The following configuration excerpt illustrates a global-level configuration: { "hooks-libraries": [{ - "library": "lib/kea/hooks/libdhcp_ping_check.so", + "library": "libdhcp_ping_check.so", "parameters": { "enable-ping-check" : true, "min-ping-requests" : 1, diff --git a/doc/sphinx/arm/hooks-rbac.rst b/doc/sphinx/arm/hooks-rbac.rst index 88bad10c15..014463ca84 100644 --- a/doc/sphinx/arm/hooks-rbac.rst +++ b/doc/sphinx/arm/hooks-rbac.rst @@ -268,7 +268,7 @@ in the Kea source and is copied below. // Add hooks here. "hooks-libraries": [ { - "library": "/opt/lib/libdhcp_rbac.so", + "library": "libdhcp_rbac.so", "parameters": { // This section configures the RBAC hook library. // Mandatory parameters. diff --git a/doc/sphinx/arm/hooks-run-script.rst b/doc/sphinx/arm/hooks-run-script.rst index 31f8ad1574..3ef4728c72 100644 --- a/doc/sphinx/arm/hooks-run-script.rst +++ b/doc/sphinx/arm/hooks-run-script.rst @@ -22,7 +22,7 @@ packet-processing hook points. { "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_run_script.so", + "library": "libdhcp_run_script.so", "parameters": { "name": "/full_path_to/script_name.sh", "sync": false diff --git a/doc/sphinx/arm/hooks-stat-cmds.rst b/doc/sphinx/arm/hooks-stat-cmds.rst index fce8cfa8e0..f14f95f8f4 100644 --- a/doc/sphinx/arm/hooks-stat-cmds.rst +++ b/doc/sphinx/arm/hooks-stat-cmds.rst @@ -49,7 +49,7 @@ parameters: "Dhcp6": { "hooks-libraries": [ { - "library": "/path/libdhcp_stat_cmds.so" + "library": "libdhcp_stat_cmds.so" }, ... ] diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst index 0af1eb1184..b8c56ef01d 100644 --- a/doc/sphinx/arm/hooks.rst +++ b/doc/sphinx/arm/hooks.rst @@ -193,10 +193,10 @@ configuration would be: "Dhcp6": { "hooks-libraries": [ { - "library": "/opt/first_custom_hooks_example.so" + "library": "first_custom_hooks_example.so" }, { - "library": "/opt/local/second_custom_hooks_example.so", + "library": "second_custom_hooks_example.so", "parameters": { "mail": "spam@example.com", "floor": 13, @@ -227,7 +227,7 @@ directory determined during compilation and shown in the config report as "Hooks directory". This value may be overridden at startup by setting the environment variable ``KEA_HOOKS_PATH`` to the desired path. If a path other than this value is used in a ``library`` element Kea will emit an error and refuse -to load the library. For ease of use ``library`` elements may simply omit path +to load the library. For ease of use ``library`` elements should simply omit path components, specifying the file name only as shown below: .. code-block:: json @@ -245,23 +245,6 @@ components, specifying the file name only as shown below: } } -This snippet (on Debian 12) is equivalent to: - -.. code-block:: json - - { - "Dhcp6": { - "hooks-libraries": [ - { - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/first_custom_hooks_example.so" - }, - { - "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/second_custom_hooks_example.so" - } - ] - } - } - .. note:: The support for path components in ``library`` elements is deprecated as of 2.7.8, and will eventually be removed. @@ -393,7 +376,7 @@ The Limits hook uses user-context in classes and subnets to set parameters. For ], "hooks-libraries": [ { - "library": "/usr/local/lib/libdhcp_limits.so" + "library": "libdhcp_limits.so" } ], "subnet6": [ @@ -459,10 +442,10 @@ It lowers the number of concurrently parked packets to 128. "parked-packet-limit": 128 "hooks-libraries": [ { - "library": "/usr/lib/kea/hooks/libdhcp_lease_cmds.so" + "library": "libdhcp_lease_cmds.so" }, { - "library": "/usr/lib/kea/hooks/libdhcp_ha.so", + "library": "libdhcp_ha.so", "parameters": { "high-availability": [ { diff --git a/src/hooks/dhcp/bootp/bootp.dox b/src/hooks/dhcp/bootp/bootp.dox index 4ed0d3eb08..7b4b61b14d 100644 --- a/src/hooks/dhcp/bootp/bootp.dox +++ b/src/hooks/dhcp/bootp/bootp.dox @@ -38,7 +38,7 @@ configuration: @code "Dhcp4": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_bootp.so" }, + { "library": "libdhcp_bootp.so" }, ... ] } diff --git a/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox b/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox index 18e264840c..cfc1c2b9dd 100644 --- a/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox +++ b/src/hooks/dhcp/flex_id/libdhcp_flex_id.dox @@ -40,7 +40,7 @@ configuration: @code "Dhcp4": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_flex_id.so", + { "library": "libdhcp_flex_id.so", "parameters": { "identifier-expression": "relay4[2].hex", "replace-client-id": true @@ -56,7 +56,7 @@ To configure it for kea-dhcp6, the commands are simply as shown below: @code "Dhcp6": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_flex_id.so", + { "library": "libdhcp_flex_id.so", "parameters": { "identifier-expression": "relay6[0].option[37].hex", "replace-client-id": true, diff --git a/src/hooks/dhcp/flex_option/flex_option.dox b/src/hooks/dhcp/flex_option/flex_option.dox index 72b76a8c4c..0436b791a5 100644 --- a/src/hooks/dhcp/flex_option/flex_option.dox +++ b/src/hooks/dhcp/flex_option/flex_option.dox @@ -40,7 +40,7 @@ configuration: @code "Dhcp4": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_flex_option.so", + { "library": "libdhcp_flex_option.so", "parameters": { "options": [ { @@ -61,7 +61,7 @@ To configure it for kea-dhcp6, the commands are simply as shown below: @code "Dhcp6": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_flex_option.so", + { "library": "libdhcp_flex_option.so", "parameters": { "options": [ { diff --git a/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox b/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox index a0d2d3f22e..1bf1b54369 100644 --- a/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox +++ b/src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox @@ -355,7 +355,7 @@ configuration: @code "Dhcp4": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_legal_log.so", + { "library": "libdhcp_legal_log.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-legal4" } }, @@ -369,7 +369,7 @@ To configure it for kea-dhcp6, the commands are simply as shown below: @code "Dhcp6": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_legal_log.so", + { "library": "libdhcp_legal_log.so", "parameters": { "path": "/var/log/kea", "base-name": "kea-legal6" } }, diff --git a/src/hooks/dhcp/run_script/run_script.dox b/src/hooks/dhcp/run_script/run_script.dox index 6fbba7425f..4f3fec5dd5 100644 --- a/src/hooks/dhcp/run_script/run_script.dox +++ b/src/hooks/dhcp/run_script/run_script.dox @@ -38,7 +38,7 @@ the following Kea4 configuration: @code "Dhcp4": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_run_script.so", + { "library": "libdhcp_run_script.so", "parameters": { "name": "/full_path_to/script_name.sh", "sync": false @@ -55,7 +55,7 @@ the following Kea6 configuration: @code "Dhcp6": { "hooks-libraries": [ - { "library": "/usr/local/lib/libdhcp_run_script.so", + { "library": "libdhcp_run_script.so", "parameters": { "name": "/full_path_to/script_name.sh", "sync": false diff --git a/src/lib/hooks/hooks_user.dox b/src/lib/hooks/hooks_user.dox index 5d9d8fd9ee..f88ea3e597 100644 --- a/src/lib/hooks/hooks_user.dox +++ b/src/lib/hooks/hooks_user.dox @@ -918,7 +918,7 @@ DHCPv4 module, it must be listed in the "hooks-libraries" element of the : "hooks-libraries": [ { - "library": "/usr/local/lib/example.so" + "library": "example.so" } ] : @@ -1325,10 +1325,10 @@ as separate elements of the hooks-libraries configuration element, e.g., : "hooks-libraries": [ { - "library": "/usr/lib/library1.so" + "library": "library1.so" }, { - "library": "/opt/library2.so" + "library": "library2.so" } : ] @@ -1402,15 +1402,15 @@ logic. Consider the following example: @code "hooks-libraries": [ { - "library": "/opt/first.so" + "library": "first.so" }, { - "library": "/opt/second.so", + "library": "second.so", "parameters": { } }, { - "library": "/opt/third.so", + "library": "third.so", "parameters": { "mail": "spam@example.com", "floor": 13, diff --git a/src/lib/hooks/library_handle.h b/src/lib/hooks/library_handle.h index 4c38ee20f9..f541d3f9d2 100644 --- a/src/lib/hooks/library_handle.h +++ b/src/lib/hooks/library_handle.h @@ -140,11 +140,11 @@ public: /// /// "hooks-libraries": [ /// { - /// "library": "/opt/charging.so", + /// "library": "charging.so", /// "parameters": {} /// }, /// { - /// "library": "/opt/local/notification.so", + /// "library": "notification.so", /// "parameters": { /// "mail": "alarm@example.com", /// "floor": 42,