Browse Source

updated README

tags/v1.0.0
Robin Thoni 7 years ago
parent
commit
3f9597b0d2
1 changed files with 15 additions and 3 deletions
  1. 15
    3
      README.md

+ 15
- 3
README.md View File

27
 Configuration
27
 Configuration
28
 -------------
28
 -------------
29
 
29
 
30
-Configuration file: `/etc/letsencrypt/certbot-pdns.json`:
30
+An example file is provided in `/usr/local/etc/letsencrypt/certbot-pdns.json`:
31
+```
32
+{
33
+  "api-key": "change_it",
34
+  "base-url": "http://127.0.0.1:34022/api/v1",
35
+  "axfr-time": 5
36
+}
37
+```
38
+
39
+Configuration file must be placed in `/etc/letsencrypt/certbot-pdns.json` or be specified with argument `certbot-pdns-config`.
40
+
41
+Configuration keys:
42
+
31
  - api-key: Your PowerDNS API Key as specified in property `api-key` in file `/etc/powerdns/pdns.conf`
43
  - api-key: Your PowerDNS API Key as specified in property `api-key` in file `/etc/powerdns/pdns.conf`
32
  - base-url: The base URL for PowerDNS API. Require `api=yes` and `api-readonly=no` in file `/etc/powerdns/pdns.conf`
44
  - base-url: The base URL for PowerDNS API. Require `api=yes` and `api-readonly=no` in file `/etc/powerdns/pdns.conf`
33
- - axfr-time: The time in seconds to wait for zone replication in slaves. Can be set to 0 if there is only one authoritative server for the zone.
45
+ - 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.
34
 
46
 
35
 Usage
47
 Usage
36
 -----
48
 -----
37
 
49
 
38
-Use certbot as usual but specify `--authenticator certbot-pdns:auth certonly`:
50
+Use certbot as usual but specify `--authenticator certbot-pdns:auth`:
39
 
51
 
40
 `certbot --agree-tos --text --renew-by-default --authenticator certbot-pdns:auth certonly -d example.com -d www.example.com`
52
 `certbot --agree-tos --text --renew-by-default --authenticator certbot-pdns:auth certonly -d example.com -d www.example.com`

Loading…
Cancel
Save