]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
rec: Document that the webserver password and API key can be hashed
authorRemi Gacogne <remi.gacogne@powerdns.com>
Wed, 31 Mar 2021 07:07:16 +0000 (09:07 +0200)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Thu, 16 Sep 2021 12:12:27 +0000 (14:12 +0200)
pdns/recursordist/docs/http-api/index.rst
pdns/recursordist/docs/settings.rst

index e13b2ec21fe24a50e49127fe6376294b784a3dba..b7e3efad46d07de1c2e38d4f37c621aeae5ba746 100644 (file)
@@ -28,7 +28,7 @@ The following webserver related configuration items are available:
 
 * :ref:`setting-webserver`: If set to anything but 'no', a webserver is launched.
 * :ref:`setting-webserver-address`: Address to bind the webserver to. Defaults to 127.0.0.1, which implies that only the local computer is able to connect to the nameserver! To allow remote hosts to connect, change to 0.0.0.0 or the physical IP address of your nameserver.
-* :ref:`setting-webserver-password`: If set, viewers will have to enter this plaintext password in order to gain access to the statistics.
+* :ref:`setting-webserver-password`: If set, viewers will have to enter this password in order to gain access to the statistics.
 * :ref:`setting-webserver-port`: Port to bind the webserver to.
 * :ref:`setting-webserver-allow-from`: Netmasks that are allowed to connect to the webserver
 
index 75c7a15122a40bb5c646c8537430da202e64dd4b..8fb965af7376b158d1498be19e31166a1bb946f2 100644 (file)
@@ -95,11 +95,13 @@ Directory where the REST API stores its configuration and zones.
 ``api-key``
 -----------
 .. versionadded:: 4.0.0
+.. versionchanged:: 4.6.0
+  This setting now accepts a hashed and salted version.
 
 -  String
 -  Default: unset
 
-Static pre-shared authentication key for access to the REST API.
+Static pre-shared authentication key for access to the REST API. Since 4.6.0 the key can be hashed and salted using ``rec_control hash-password APIKEY`` instead of being stored in the configuration in plaintext.
 
 .. _setting-api-readonly:
 
@@ -2153,10 +2155,13 @@ The value between the hooks is a UUID that is generated for each request. This c
 
 ``webserver-password``
 ----------------------
+.. versionchanged:: 4.6.0
+  This setting now accepts a hashed and salted version.
+
 -  String
 -  Default: unset
 
-Password required to access the webserver.
+Password required to access the webserver. Since 4.6.0 the password can be hashed and salted using ``rec_control hash-password PASS`` instead of being in plaintext.
 
 .. _setting-webserver-port: