From: Remi Gacogne <remi.gacogne@powerdns.com>
Date: Wed, 31 Mar 2021 07:06:18 +0000 (+0200)
Subject: dnsdist: Document that the API key can now be hashed as well
X-Git-Tag: dnsdist-1.7.0-alpha1~12^2~32
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d965efd57a7767c68611e8929d41a3b9af166e19;p=thirdparty%2Fpdns.git

dnsdist: Document that the API key can now be hashed as well
---

diff --git a/pdns/dnsdistdist/docs/reference/config.rst b/pdns/dnsdistdist/docs/reference/config.rst
index 97e21d5f79..815d93d2ed 100644
--- a/pdns/dnsdistdist/docs/reference/config.rst
+++ b/pdns/dnsdistdist/docs/reference/config.rst
@@ -334,7 +334,7 @@ Webserver configuration
     ``statsRequireAuthentication``, ``maxConcurrentConnections`` optional parameters added.
 
   .. versionchanged:: 1.7.0
-    The optional ``password`` parameter now accepts hashed passwords.
+    The optional ``password`` and ``apiKey`` parameters now accept hashed passwords.
 
   Setup webserver configuration. See :func:`webserver`.
 
@@ -342,8 +342,8 @@ Webserver configuration
 
   Options:
 
-  * ``password=newPassword``: string - Set the password used to access the internal webserver. Since 1.7.0 the password needs to be hashed and salted via the :func:`hashPassword` command
-  * ``apiKey=newKey``: string - Changes the API Key (set to an empty string do disable it)
+  * ``password=newPassword``: string - Set the password used to access the internal webserver. Since 1.7.0 the password should be hashed and salted via the :func:`hashPassword` command.
+  * ``apiKey=newKey``: string - Changes the API Key (set to an empty string do disable it). Since 1.7.0 the key should be hashed and salted via the :func:`hashPassword` command.
   * ``custom_headers={[str]=str,...}``: map of string - Allows setting custom headers and removing the defaults.
   * ``acl=newACL``: string - List of IP addresses, as a string, that are allowed to open a connection to the web server. Defaults to "127.0.0.1, ::1".
   * ``statsRequireAuthentication``: bool - Whether access to the statistics (/metrics and /jsonstat endpoints) require a valid password or API key. Defaults to true.