Skip to content

Commit 24f4214

Browse files
kylejuliandevldez
andauthored
cloudflare: update documentation to specify the unit of time-based options (#2239)
Co-authored-by: Fernandez Ludovic <[email protected]>
1 parent fa7cf5c commit 24f4214

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

cmd/zz_gen_cmd_dnshelp.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -500,10 +500,10 @@ func displayDNSHelp(w io.Writer, name string) error {
500500
ew.writeln()
501501

502502
ew.writeln(`Additional Configuration:`)
503-
ew.writeln(` - "CLOUDFLARE_HTTP_TIMEOUT": API request timeout`)
504-
ew.writeln(` - "CLOUDFLARE_POLLING_INTERVAL": Time between DNS propagation check`)
505-
ew.writeln(` - "CLOUDFLARE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
506-
ew.writeln(` - "CLOUDFLARE_TTL": The TTL of the TXT record used for the DNS challenge`)
503+
ew.writeln(` - "CLOUDFLARE_HTTP_TIMEOUT": API request timeout (in seconds)`)
504+
ew.writeln(` - "CLOUDFLARE_POLLING_INTERVAL": Time between DNS propagation check (in seconds)`)
505+
ew.writeln(` - "CLOUDFLARE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation (in seconds)`)
506+
ew.writeln(` - "CLOUDFLARE_TTL": The TTL of the TXT record used for the DNS challenge (in seconds)`)
507507

508508
ew.writeln()
509509
ew.writeln(`More information: https://go-acme.github.io/lego/dns/cloudflare`)

docs/content/dns/zz_gen_cloudflare.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ More information [here]({{< ref "dns#configuration-and-credentials" >}}).
6060

6161
| Environment Variable Name | Description |
6262
|--------------------------------|-------------|
63-
| `CLOUDFLARE_HTTP_TIMEOUT` | API request timeout |
64-
| `CLOUDFLARE_POLLING_INTERVAL` | Time between DNS propagation check |
65-
| `CLOUDFLARE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
66-
| `CLOUDFLARE_TTL` | The TTL of the TXT record used for the DNS challenge |
63+
| `CLOUDFLARE_HTTP_TIMEOUT` | API request timeout (in seconds) |
64+
| `CLOUDFLARE_POLLING_INTERVAL` | Time between DNS propagation check (in seconds) |
65+
| `CLOUDFLARE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation (in seconds) |
66+
| `CLOUDFLARE_TTL` | The TTL of the TXT record used for the DNS challenge (in seconds) |
6767

6868
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
6969
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

providers/dns/cloudflare/cloudflare.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ It follows the principle of least privilege and limits the possible damage, shou
6868
CLOUDFLARE_DNS_API_TOKEN = "Alias to CF_DNS_API_TOKEN"
6969
CLOUDFLARE_ZONE_API_TOKEN = "Alias to CF_ZONE_API_TOKEN"
7070
[Configuration.Additional]
71-
CLOUDFLARE_POLLING_INTERVAL = "Time between DNS propagation check"
72-
CLOUDFLARE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
73-
CLOUDFLARE_TTL = "The TTL of the TXT record used for the DNS challenge"
74-
CLOUDFLARE_HTTP_TIMEOUT = "API request timeout"
71+
CLOUDFLARE_POLLING_INTERVAL = "Time between DNS propagation check (in seconds)"
72+
CLOUDFLARE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation (in seconds)"
73+
CLOUDFLARE_TTL = "The TTL of the TXT record used for the DNS challenge (in seconds)"
74+
CLOUDFLARE_HTTP_TIMEOUT = "API request timeout (in seconds)"
7575

7676
[Links]
7777
API = "https://api.cloudflare.com/"

0 commit comments

Comments
 (0)