From 6654f934ded5c8df72b1fdeeb9cc34fb1885fa79 Mon Sep 17 00:00:00 2001
From: Peter Schiffer <3899107+pschiffe@users.noreply.github.com>
Date: Fri, 25 Mar 2022 17:21:02 +0100
Subject: [PATCH] Document PDNS_ADMIN_SALT env var in readme

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 8245c80..cbfc310 100644
--- a/README.md
+++ b/README.md
@@ -137,6 +137,14 @@ PDNS_VERSION=""
 
 If this container is linked with pdns-mysql from this repo with alias `pdns`, it will be configured automatically and none of the env vars from above are needed to be specified.
 
+### PowerDNS Admin API keys and SALT
+
+In order to be able to generate an API Key, you will need to specify the SALT via `PDNS_ADMIN_SALT` env var. This is a secret value, which can be generated via command:
+```
+python3 -c 'import bcrypt; print(bcrypt.gensalt().decode("utf-8"));'
+```
+Example value looks like `$2b$12$xxxxxxxxxxxxxxxxxxxxxx` - remember that when using docker-compose, literal `$` must be specified as `$$`.
+
 ### Persistent data
 
 There is a directory with user uploads which should be persistent: `/opt/powerdns-admin/upload`