Skip to content

Commit b3e6307

Browse files
hyunrealshadowldez
andauthored
docs: fix typos in some DNS descriptors (#2264)
Co-authored-by: Fernandez Ludovic <[email protected]>
1 parent dc429c2 commit b3e6307

File tree

5 files changed

+36
-2
lines changed

5 files changed

+36
-2
lines changed

cmd/zz_gen_cmd_dnshelp.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -771,6 +771,12 @@ func displayDNSHelp(w io.Writer, name string) error {
771771
ew.writeln(` - "DNSHOMEDE_CREDENTIALS": Comma-separated list of domain:password credential pairs`)
772772
ew.writeln()
773773

774+
ew.writeln(`Additional Configuration:`)
775+
ew.writeln(` - "DNSHOMEDE_HTTP_TIMEOUT": API request timeout`)
776+
ew.writeln(` - "DNSHOMEDE_POLLING_INTERVAL": Time between DNS propagation checks`)
777+
ew.writeln(` - "DNSHOMEDE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)`)
778+
ew.writeln(` - "DNSHOMEDE_SEQUENCE_INTERVAL": Time between sequential requests`)
779+
774780
ew.writeln()
775781
ew.writeln(`More information: https://go-acme.github.io/lego/dns/dnshomede`)
776782

@@ -1368,6 +1374,12 @@ func displayDNSHelp(w io.Writer, name string) error {
13681374
ew.writeln(` - "HURRICANE_TOKENS": TXT record names and tokens`)
13691375
ew.writeln()
13701376

1377+
ew.writeln(`Additional Configuration:`)
1378+
ew.writeln(` - "HURRICANE_HTTP_TIMEOUT": API request timeout`)
1379+
ew.writeln(` - "HURRICANE_POLLING_INTERVAL": Time between DNS propagation checks`)
1380+
ew.writeln(` - "HURRICANE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)`)
1381+
ew.writeln(` - "HURRICANE_SEQUENCE_INTERVAL": Time between sequential requests`)
1382+
13711383
ew.writeln()
13721384
ew.writeln(`More information: https://go-acme.github.io/lego/dns/hurricane`)
13731385

docs/content/dns/zz_gen_dnshomede.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,17 @@ The environment variable names can be suffixed by `_FILE` to reference a file in
4646
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
4747

4848

49+
## Additional Configuration
50+
51+
| Environment Variable Name | Description |
52+
|--------------------------------|-------------|
53+
| `DNSHOMEDE_HTTP_TIMEOUT` | API request timeout |
54+
| `DNSHOMEDE_POLLING_INTERVAL` | Time between DNS propagation checks |
55+
| `DNSHOMEDE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation; defaults to 300s (5 minutes) |
56+
| `DNSHOMEDE_SEQUENCE_INTERVAL` | Time between sequential requests |
57+
58+
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
59+
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
4960

5061

5162

docs/content/dns/zz_gen_hurricane.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,17 @@ The environment variable names can be suffixed by `_FILE` to reference a file in
4646
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
4747

4848

49+
## Additional Configuration
50+
51+
| Environment Variable Name | Description |
52+
|--------------------------------|-------------|
53+
| `HURRICANE_HTTP_TIMEOUT` | API request timeout |
54+
| `HURRICANE_POLLING_INTERVAL` | Time between DNS propagation checks |
55+
| `HURRICANE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation; defaults to 300s (5 minutes) |
56+
| `HURRICANE_SEQUENCE_INTERVAL` | Time between sequential requests |
57+
58+
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
59+
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
4960

5061
Before using lego to request a certificate for a given domain or wildcard (such as `my.example.org` or `*.my.example.org`),
5162
create a TXT record named `_acme-challenge.my.example.org`, and enable dynamic updates on it.

providers/dns/dnshomede/dnshomede.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ lego --email [email protected] --dns dnshomede --domains my.example.org --domains
1515
[Configuration]
1616
[Configuration.Credentials]
1717
DNSHOMEDE_CREDENTIALS = "Comma-separated list of domain:password credential pairs"
18-
[Configuration.Addtional]
18+
[Configuration.Additional]
1919
DNSHOMEDE_POLLING_INTERVAL = "Time between DNS propagation checks"
2020
DNSHOMEDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)"
2121
DNSHOMEDE_SEQUENCE_INTERVAL = "Time between sequential requests"

providers/dns/hurricane/hurricane.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ HURRICANE_TOKENS=example.org:token
3838
[Configuration]
3939
[Configuration.Credentials]
4040
HURRICANE_TOKENS = "TXT record names and tokens"
41-
[Configuration.Addtional]
41+
[Configuration.Additional]
4242
HURRICANE_POLLING_INTERVAL = "Time between DNS propagation checks"
4343
HURRICANE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)"
4444
HURRICANE_SEQUENCE_INTERVAL = "Time between sequential requests"

0 commit comments

Comments
 (0)