]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
dnsdist: Clarify that Lua directives are still usable in the console 15158/head
authorRemi Gacogne <remi.gacogne@powerdns.com>
Fri, 7 Mar 2025 13:39:25 +0000 (14:39 +0100)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Fri, 7 Mar 2025 13:39:25 +0000 (14:39 +0100)
pdns/dnsdistdist/dnsdist-rust-lib/dnsdist-settings-documentation-generator.py
pdns/dnsdistdist/docs/reference/config.rst
pdns/dnsdistdist/docs/reference/yaml-settings.rst

index c6c220375d64e9f865f4723b70b6cbf7173194b0..6af7d12687e8d796bbfbfbd33877705c65aedef2 100644 (file)
@@ -139,6 +139,7 @@ Since 2.0.0, :program:`dnsdist` supports the YAML configuration format in additi
 If the configuration file passed to :program:`dnsdist` via the ``-C`` command-line switch ends in ``.yml``, it is assumed to be in the new YAML format, and an attempt to load a Lua configuration file with the same name but the ``.lua`` will be done before loading the YAML configuration. If the names ends in ``.lua``, there will also be an attempt to find a file with the same name but ending in ``.yml``. Otherwise the existing Lua configuration format is assumed.
 
 By default, when a YAML configuration file is used, any Lua configuration file used along the YAML configuration should only contain functions, and ideally even those should be defined either inline in the YAML file or in separate files included from the YAML configuration, for clarity. It is however possible to change this behaviour using the :func:`enableLuaConfiguration` directive to enable Lua configuration directives, but it is strongly advised not to use this directive unless absolutely necessary, and to prefer doing all the configuration in either Lua or YAML but to not mix them.
+Note that Lua directives that can be used at runtime are always available via the :doc:`../guides/console`, regardless of whether they are enabled during configuration.
 
 A YAML configuration file contains several sections, that are described below.
 
index 4855fd87bbbaa9fb9893e682f1cac731fce9754d..5594fd61a1b2c72ed4c7dc0aea6a3d4356604312 100644 (file)
@@ -52,6 +52,7 @@ Global configuration
 
   Enable using Lua configuration directives along with a YAML configuration file. By default, when a YAML configuration file is used, any Lua configuration file used along the YAML configuration should only contain functions, and ideally even those should be defined either inline in the YAML file or in separate files included from the YAML configuration, for clarity.
   It is strongly advised not to use this directive unless absolutely necessary, and to prefer doing all the configuration in either Lua or YAML but to not mix them.
+  Note that Lua directives that can be used at runtime are always available via the :doc:`../guides/console`, regardless of whether they are enabled during configuration.
 
 .. function:: includeDirectory(path)
 
index f02d2d29f940429ca2f49ec228e5a5ebe202ce00..db3cdd900ecff5732ba140a8dff5005bbc20ec83 100644 (file)
@@ -12,6 +12,7 @@ Since 2.0.0, :program:`dnsdist` supports the YAML configuration format in additi
 If the configuration file passed to :program:`dnsdist` via the ``-C`` command-line switch ends in ``.yml``, it is assumed to be in the new YAML format, and an attempt to load a Lua configuration file with the same name but the ``.lua`` will be done before loading the YAML configuration. If the names ends in ``.lua``, there will also be an attempt to find a file with the same name but ending in ``.yml``. Otherwise the existing Lua configuration format is assumed.
 
 By default, when a YAML configuration file is used, any Lua configuration file used along the YAML configuration should only contain functions, and ideally even those should be defined either inline in the YAML file or in separate files included from the YAML configuration, for clarity. It is however possible to change this behaviour using the :func:`enableLuaConfiguration` directive to enable Lua configuration directives, but it is strongly advised not to use this directive unless absolutely necessary, and to prefer doing all the configuration in either Lua or YAML but to not mix them.
+Note that Lua directives that can be used at runtime are always available via the :doc:`../guides/console`, regardless of whether they are enabled during configuration.
 
 A YAML configuration file contains several sections, that are described below.