Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix typos in some DNS descriptors #2264

Merged
merged 2 commits into from
Sep 6, 2024
Merged

docs: fix typos in some DNS descriptors #2264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ce179f
docs: fix typos in dnshomede and hurricane
hyunrealshadow Sep 6, 2024
09c68a3
review: generate
ldez Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions cmd/zz_gen_cmd_dnshelp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()

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(`More information: https://go-acme.github.io/lego/dns/dnshomede`)

Expand Down Expand Up @@ -1368,6 +1374,12 @@ func displayDNSHelp(w io.Writer, name string) error {
ew.writeln(` - "HURRICANE_TOKENS": TXT record names and tokens`)
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(`More information: https://go-acme.github.io/lego/dns/hurricane`)

Expand Down
11 changes: 11 additions & 0 deletions docs/content/dns/zz_gen_dnshomede.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}).


## 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" %}}).



Expand Down
11 changes: 11 additions & 0 deletions docs/content/dns/zz_gen_hurricane.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}).


## 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`),
create a TXT record named `_acme-challenge.my.example.org`, and enable dynamic updates on it.
Expand Down
2 changes: 1 addition & 1 deletion providers/dns/dnshomede/dnshomede.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ lego --email you@example.com --dns dnshomede --domains my.example.org --domains
[Configuration]
[Configuration.Credentials]
DNSHOMEDE_CREDENTIALS = "Comma-separated list of domain:password credential pairs"
[Configuration.Addtional]
[Configuration.Additional]
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"
Expand Down
2 changes: 1 addition & 1 deletion providers/dns/hurricane/hurricane.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ HURRICANE_TOKENS=example.org:token
[Configuration]
[Configuration.Credentials]
HURRICANE_TOKENS = "TXT record names and tokens"
[Configuration.Addtional]
[Configuration.Additional]
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"
Expand Down