potyarkin/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

doc: remove TODO. (#878)

Browse source
This commit is contained in:
Ludovic Fernandez 2019-05-06 19:37:51 +02:00 committed by GitHub
parent b186acb858
commit 437d6a0408
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 34 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
cmd/zz_gen_cmd_dnshelp.go
View file

@ -650,8 +650,8 @@ func displayDNSHelp(name string) {
fmt.Fprintln(w)
fmt.Fprintln(w, `Credentials:`)
fmt.Fprintln(w, ` - "GODADDY_API_KEY": **TODO**`)
fmt.Fprintln(w, ` - "GODADDY_API_SECRET": **TODO**`)
fmt.Fprintln(w, ` - "GODADDY_API_KEY": API key`)
fmt.Fprintln(w, ` - "GODADDY_API_SECRET": API secret`)
fmt.Fprintln(w)
fmt.Fprintln(w, `Additional Configuration:`)
@ -672,8 +672,8 @@ func displayDNSHelp(name string) {
fmt.Fprintln(w)
fmt.Fprintln(w, `Credentials:`)
fmt.Fprintln(w, ` - "HOSTINGDE_API_KEY": **TODO**`)
fmt.Fprintln(w, ` - "HOSTINGDE_ZONE_NAME": **TODO**`)
fmt.Fprintln(w, ` - "HOSTINGDE_API_KEY": API key`)
fmt.Fprintln(w, ` - "HOSTINGDE_ZONE_NAME": Zone name in ACE format`)
fmt.Fprintln(w)
fmt.Fprintln(w, `Additional Configuration:`)
@ -699,10 +699,10 @@ func displayDNSHelp(name string) {
fmt.Fprintln(w, `Additional Configuration:`)
fmt.Fprintln(w, ` - "HTTPREQ_HTTP_TIMEOUT": API request timeout`)
fmt.Fprintln(w, ` - "HTTPREQ_PASSWORD": **TODO**`)
fmt.Fprintln(w, ` - "HTTPREQ_PASSWORD": Basic authentication password`)
fmt.Fprintln(w, ` - "HTTPREQ_POLLING_INTERVAL": Time between DNS propagation check`)
fmt.Fprintln(w, ` - "HTTPREQ_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
fmt.Fprintln(w, ` - "HTTPREQ_USERNAME": **TODO**`)
fmt.Fprintln(w, ` - "HTTPREQ_USERNAME": Basic authentication username`)
fmt.Fprintln(w)
fmt.Fprintln(w, `More information: https://go-acme.github.io/lego/dns/httpreq`)

16
docs/content/dns/zz_gen_exec.md
View file

@ -30,18 +30,18 @@ lego --dns exec --domains my.domain.com --email my@email.com run
## Base Configuration
| Environment Variable Name | Description |
|-----------------------|-------------|
| `EXEC_MODE` | `RAW`, none |
| `EXEC_PATH` | TODO |
| Environment Variable Name | Description |
|---------------------------|---------------------------------------|
| `EXEC_MODE` | `RAW`, none |
| `EXEC_PATH` | The path of the the external program. |
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check |
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| Environment Variable Name | Description |
|----------------------------|-------------------------------------------|
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check. |
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation. |
## Description

4
docs/content/dns/zz_gen_godaddy.md
View file

@ -29,8 +29,8 @@ _Please contribute by adding a CLI example._
| Environment Variable Name | Description |
|-----------------------|-------------|
| `GODADDY_API_KEY` | **TODO** |
| `GODADDY_API_SECRET` | **TODO** |
| `GODADDY_API_KEY` | API key |
| `GODADDY_API_SECRET` | API secret |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

4
docs/content/dns/zz_gen_hostingde.md
View file

@ -29,8 +29,8 @@ _Please contribute by adding a CLI example._
| Environment Variable Name | Description |
|-----------------------|-------------|
| `HOSTINGDE_API_KEY` | **TODO** |
| `HOSTINGDE_ZONE_NAME` | **TODO** |
| `HOSTINGDE_API_KEY` | API key |
| `HOSTINGDE_ZONE_NAME` | Zone name in ACE format |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

4
docs/content/dns/zz_gen_httpreq.md
View file

@ -44,10 +44,10 @@ More information [here](/lego/dns/#configuration-and-credentials).
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `HTTPREQ_HTTP_TIMEOUT` | API request timeout |
| `HTTPREQ_PASSWORD` | **TODO** |
| `HTTPREQ_PASSWORD` | Basic authentication password |
| `HTTPREQ_POLLING_INTERVAL` | Time between DNS propagation check |
| `HTTPREQ_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `HTTPREQ_USERNAME` | **TODO** |
| `HTTPREQ_USERNAME` | Basic authentication username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

16
providers/dns/exec/exec.toml
View file

@ -13,18 +13,18 @@ Additional = '''
## Base Configuration
| Environment Variable Name | Description |
|-----------------------|-------------|
| `EXEC_MODE` | `RAW`, none |
| `EXEC_PATH` | TODO |
| Environment Variable Name | Description |
|---------------------------|---------------------------------------|
| `EXEC_MODE` | `RAW`, none |
| `EXEC_PATH` | The path of the the external program. |
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check |
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| Environment Variable Name | Description |
|----------------------------|-------------------------------------------|
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check. |
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation. |
## Description

4
providers/dns/godaddy/godaddy.toml
View file

@ -6,8 +6,8 @@ Since = "v0.5.0"
[Configuration]
[Configuration.Credentials]
GODADDY_API_KEY = "**TODO**"
GODADDY_API_SECRET = "**TODO**"
GODADDY_API_KEY = "API key"
GODADDY_API_SECRET = "API secret"
[Configuration.Additional]
GODADDY_POLLING_INTERVAL = "Time between DNS propagation check"
GODADDY_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"

4
providers/dns/hostingde/hostingde.toml
View file

@ -6,8 +6,8 @@ Since = "v1.1.0"
[Configuration]
[Configuration.Credentials]
HOSTINGDE_API_KEY = "**TODO**"
HOSTINGDE_ZONE_NAME = "**TODO**"
HOSTINGDE_API_KEY = "API key"
HOSTINGDE_ZONE_NAME = "Zone name in ACE format"
[Configuration.Additional]
HOSTINGDE_POLLING_INTERVAL = "Time between DNS propagation check"
HOSTINGDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"

4
providers/dns/httpreq/httpreq.toml
View file

@ -54,8 +54,8 @@ Basic authentication (optional) can be set with some environment variables:
HTTPREQ_MODE = "`RAW`, none"
HTTPREQ_ENDPOINT = "The URL of the server"
[Configuration.Additional]
HTTPREQ_USERNAME = "**TODO**"
HTTPREQ_PASSWORD = "**TODO**"
HTTPREQ_USERNAME = "Basic authentication username"
HTTPREQ_PASSWORD = "Basic authentication password"
HTTPREQ_POLLING_INTERVAL = "Time between DNS propagation check"
HTTPREQ_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
HTTPREQ_HTTP_TIMEOUT = "API request timeout"