docs: fix typos in some DNS descriptors (#2264)

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
This commit is contained in:
UnrealShadow 2024-09-06 18:18:25 +08:00 committed by GitHub
parent dc429c26a0
commit b3e630761e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 36 additions and 2 deletions

View file

@ -771,6 +771,12 @@ func displayDNSHelp(w io.Writer, name string) error {
ew.writeln(` - "DNSHOMEDE_CREDENTIALS": Comma-separated list of domain:password credential pairs`) ew.writeln(` - "DNSHOMEDE_CREDENTIALS": Comma-separated list of domain:password credential pairs`)
ew.writeln() ew.writeln()
ew.writeln(`Additional Configuration:`)
ew.writeln(` - "DNSHOMEDE_HTTP_TIMEOUT": API request timeout`)
ew.writeln(` - "DNSHOMEDE_POLLING_INTERVAL": Time between DNS propagation checks`)
ew.writeln(` - "DNSHOMEDE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)`)
ew.writeln(` - "DNSHOMEDE_SEQUENCE_INTERVAL": Time between sequential requests`)
ew.writeln() ew.writeln()
ew.writeln(`More information: https://go-acme.github.io/lego/dns/dnshomede`) ew.writeln(`More information: https://go-acme.github.io/lego/dns/dnshomede`)
@ -1368,6 +1374,12 @@ func displayDNSHelp(w io.Writer, name string) error {
ew.writeln(` - "HURRICANE_TOKENS": TXT record names and tokens`) ew.writeln(` - "HURRICANE_TOKENS": TXT record names and tokens`)
ew.writeln() ew.writeln()
ew.writeln(`Additional Configuration:`)
ew.writeln(` - "HURRICANE_HTTP_TIMEOUT": API request timeout`)
ew.writeln(` - "HURRICANE_POLLING_INTERVAL": Time between DNS propagation checks`)
ew.writeln(` - "HURRICANE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)`)
ew.writeln(` - "HURRICANE_SEQUENCE_INTERVAL": Time between sequential requests`)
ew.writeln() ew.writeln()
ew.writeln(`More information: https://go-acme.github.io/lego/dns/hurricane`) ew.writeln(`More information: https://go-acme.github.io/lego/dns/hurricane`)

View file

@ -46,6 +46,17 @@ The environment variable names can be suffixed by `_FILE` to reference a file in
More information [here]({{% ref "dns#configuration-and-credentials" %}}). More information [here]({{% ref "dns#configuration-and-credentials" %}}).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `DNSHOMEDE_HTTP_TIMEOUT` | API request timeout |
| `DNSHOMEDE_POLLING_INTERVAL` | Time between DNS propagation checks |
| `DNSHOMEDE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation; defaults to 300s (5 minutes) |
| `DNSHOMEDE_SEQUENCE_INTERVAL` | Time between sequential requests |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{% ref "dns#configuration-and-credentials" %}}).

View file

@ -46,6 +46,17 @@ The environment variable names can be suffixed by `_FILE` to reference a file in
More information [here]({{% ref "dns#configuration-and-credentials" %}}). More information [here]({{% ref "dns#configuration-and-credentials" %}}).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `HURRICANE_HTTP_TIMEOUT` | API request timeout |
| `HURRICANE_POLLING_INTERVAL` | Time between DNS propagation checks |
| `HURRICANE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation; defaults to 300s (5 minutes) |
| `HURRICANE_SEQUENCE_INTERVAL` | Time between sequential requests |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
Before using lego to request a certificate for a given domain or wildcard (such as `my.example.org` or `*.my.example.org`), Before using lego to request a certificate for a given domain or wildcard (such as `my.example.org` or `*.my.example.org`),
create a TXT record named `_acme-challenge.my.example.org`, and enable dynamic updates on it. create a TXT record named `_acme-challenge.my.example.org`, and enable dynamic updates on it.

View file

@ -15,7 +15,7 @@ lego --email you@example.com --dns dnshomede --domains my.example.org --domains
[Configuration] [Configuration]
[Configuration.Credentials] [Configuration.Credentials]
DNSHOMEDE_CREDENTIALS = "Comma-separated list of domain:password credential pairs" DNSHOMEDE_CREDENTIALS = "Comma-separated list of domain:password credential pairs"
[Configuration.Addtional] [Configuration.Additional]
DNSHOMEDE_POLLING_INTERVAL = "Time between DNS propagation checks" DNSHOMEDE_POLLING_INTERVAL = "Time between DNS propagation checks"
DNSHOMEDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)" DNSHOMEDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)"
DNSHOMEDE_SEQUENCE_INTERVAL = "Time between sequential requests" DNSHOMEDE_SEQUENCE_INTERVAL = "Time between sequential requests"

View file

@ -38,7 +38,7 @@ HURRICANE_TOKENS=example.org:token
[Configuration] [Configuration]
[Configuration.Credentials] [Configuration.Credentials]
HURRICANE_TOKENS = "TXT record names and tokens" HURRICANE_TOKENS = "TXT record names and tokens"
[Configuration.Addtional] [Configuration.Additional]
HURRICANE_POLLING_INTERVAL = "Time between DNS propagation checks" HURRICANE_POLLING_INTERVAL = "Time between DNS propagation checks"
HURRICANE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)" HURRICANE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation; defaults to 300s (5 minutes)"
HURRICANE_SEQUENCE_INTERVAL = "Time between sequential requests" HURRICANE_SEQUENCE_INTERVAL = "Time between sequential requests"