From b3e630761e6f32430f028c82cde4556cf9a1832b Mon Sep 17 00:00:00 2001 From: UnrealShadow Date: Fri, 6 Sep 2024 18:18:25 +0800 Subject: [PATCH] docs: fix typos in some DNS descriptors (#2264) Co-authored-by: Fernandez Ludovic --- cmd/zz_gen_cmd_dnshelp.go | 12 ++++++++++++ docs/content/dns/zz_gen_dnshomede.md | 11 +++++++++++ docs/content/dns/zz_gen_hurricane.md | 11 +++++++++++ providers/dns/dnshomede/dnshomede.toml | 2 +- providers/dns/hurricane/hurricane.toml | 2 +- 5 files changed, 36 insertions(+), 2 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index d77bc03c..a807f88c 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -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`) @@ -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`) diff --git a/docs/content/dns/zz_gen_dnshomede.md b/docs/content/dns/zz_gen_dnshomede.md index 85027cdf..46697744 100644 --- a/docs/content/dns/zz_gen_dnshomede.md +++ b/docs/content/dns/zz_gen_dnshomede.md @@ -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" %}}). diff --git a/docs/content/dns/zz_gen_hurricane.md b/docs/content/dns/zz_gen_hurricane.md index c19462ec..a5cf2b01 100644 --- a/docs/content/dns/zz_gen_hurricane.md +++ b/docs/content/dns/zz_gen_hurricane.md @@ -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. diff --git a/providers/dns/dnshomede/dnshomede.toml b/providers/dns/dnshomede/dnshomede.toml index 0598f38f..0af466bf 100644 --- a/providers/dns/dnshomede/dnshomede.toml +++ b/providers/dns/dnshomede/dnshomede.toml @@ -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" diff --git a/providers/dns/hurricane/hurricane.toml b/providers/dns/hurricane/hurricane.toml index a8d36c43..ce96a396 100644 --- a/providers/dns/hurricane/hurricane.toml +++ b/providers/dns/hurricane/hurricane.toml @@ -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"