auth: Document that the webserver password and API key can be hashed

diff --git a/docs/http-api/index.rst b/docs/http-api/index.rst
index 34c01e4c3936d629b7f1e627a78c04caae8efbae..60b449fff9243ad3287d16bb35eff979c8f1170a 100644 (file)
--- a/docs/http-api/index.rst
+++ b/docs/http-api/index.rst
@@ -16,7 +16,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, in addition to entering the configured API key on the index page.
+* :ref:`setting-webserver-password`: If set, viewers will have to enter this password in order to gain access to the statistics, in addition to entering the configured API key on the index page.
 * :ref:`setting-webserver-port`: Port to bind the webserver to.
 * :ref:`setting-webserver-allow-from`: Netmasks that are allowed to connect to the webserver
 * :ref:`setting-webserver-max-bodysize`: Maximum request/response body size in megabytes

diff --git a/docs/settings.rst b/docs/settings.rst
index 693ee3061c9c7bb63c6a55bdef4072c988f133b6..e6b568022f0030c6d7f74ad77914388512e0062e 100644 (file)
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -134,7 +134,10 @@ Enable/disable the :doc:`http-api/index`.
 
 -  String
 
-Static pre-shared authentication key for access to the REST API.
+.. versionchanged:: 4.6.0
+  This setting now accepts a hashed and salted version.
+
+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-autosecondary:
 
@@ -1825,10 +1828,12 @@ Maximum request/response body size in megabytes.
 
 ``webserver-password``
 ----------------------
+.. versionchanged:: 4.6.0
+  This setting now accepts a hashed and salted version.
 
 -  String
 
-The plaintext password required for accessing the webserver.
+Password required to access the webserver. Since 4.6.0 the password can be hashed and salted using ``pdnsutil hash-password PASS`` instead of being in plaintext.
 
 .. _setting-webserver-port: