Browse Source

Added modifications to README

tags/v1.2.0
fabian 6 years ago
parent
commit
3ed344e83d
1 changed files with 7 additions and 1 deletions
  1. 7
    1
      README.md

+ 7
- 1
README.md View File

@@ -37,7 +37,9 @@ An example file is provided in `/usr/local/etc/letsencrypt/certbot-pdns.json`:
37 37
 {
38 38
   "api-key": "change_it",
39 39
   "base-url": "http://127.0.0.1:34022/api/v1",
40
-  "axfr-time": 5
40
+  "axfr-time": 5,
41
+  "http-auth": ["user", "secret_pass"],
42
+  "verify-cert": "False"
41 43
 }
42 44
 ```
43 45
 
@@ -49,6 +51,10 @@ Configuration keys:
49 51
  - base-url: The base URL for PowerDNS API. Require `api=yes` and `api-readonly=no` in file `/etc/powerdns/pdns.conf`
50 52
  - axfr-time: The time in seconds to wait for AXFR in slaves. Can be set to 0 if there is only one authoritative server for the zone.
51 53
 
54
+The following two keys are optional and added in case a (nginx) reverse proxy is used to secure access to the api:
55
+ - http-auth (optional): A list of two strings containing the Username and Password for a http-basic-authentication
56
+ - verify-cert (optional): defines whether the SSL-certificate provided by the reverse proxy shall be verified. Possible options are True/False or a string containing the path to a local certificate which can be used to verify the one provided by the proxy.
57
+
52 58
 Usage
53 59
 -----
54 60
 

Loading…
Cancel
Save