forked from TrueCloudLab/lego
doc: remove TODO. (#878)
This commit is contained in:
parent
b186acb858
commit
437d6a0408
9 changed files with 34 additions and 34 deletions
|
@ -650,8 +650,8 @@ func displayDNSHelp(name string) {
|
||||||
fmt.Fprintln(w)
|
fmt.Fprintln(w)
|
||||||
|
|
||||||
fmt.Fprintln(w, `Credentials:`)
|
fmt.Fprintln(w, `Credentials:`)
|
||||||
fmt.Fprintln(w, ` - "GODADDY_API_KEY": **TODO**`)
|
fmt.Fprintln(w, ` - "GODADDY_API_KEY": API key`)
|
||||||
fmt.Fprintln(w, ` - "GODADDY_API_SECRET": **TODO**`)
|
fmt.Fprintln(w, ` - "GODADDY_API_SECRET": API secret`)
|
||||||
fmt.Fprintln(w)
|
fmt.Fprintln(w)
|
||||||
|
|
||||||
fmt.Fprintln(w, `Additional Configuration:`)
|
fmt.Fprintln(w, `Additional Configuration:`)
|
||||||
|
@ -672,8 +672,8 @@ func displayDNSHelp(name string) {
|
||||||
fmt.Fprintln(w)
|
fmt.Fprintln(w)
|
||||||
|
|
||||||
fmt.Fprintln(w, `Credentials:`)
|
fmt.Fprintln(w, `Credentials:`)
|
||||||
fmt.Fprintln(w, ` - "HOSTINGDE_API_KEY": **TODO**`)
|
fmt.Fprintln(w, ` - "HOSTINGDE_API_KEY": API key`)
|
||||||
fmt.Fprintln(w, ` - "HOSTINGDE_ZONE_NAME": **TODO**`)
|
fmt.Fprintln(w, ` - "HOSTINGDE_ZONE_NAME": Zone name in ACE format`)
|
||||||
fmt.Fprintln(w)
|
fmt.Fprintln(w)
|
||||||
|
|
||||||
fmt.Fprintln(w, `Additional Configuration:`)
|
fmt.Fprintln(w, `Additional Configuration:`)
|
||||||
|
@ -699,10 +699,10 @@ func displayDNSHelp(name string) {
|
||||||
|
|
||||||
fmt.Fprintln(w, `Additional Configuration:`)
|
fmt.Fprintln(w, `Additional Configuration:`)
|
||||||
fmt.Fprintln(w, ` - "HTTPREQ_HTTP_TIMEOUT": API request timeout`)
|
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_POLLING_INTERVAL": Time between DNS propagation check`)
|
||||||
fmt.Fprintln(w, ` - "HTTPREQ_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
|
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)
|
||||||
fmt.Fprintln(w, `More information: https://go-acme.github.io/lego/dns/httpreq`)
|
fmt.Fprintln(w, `More information: https://go-acme.github.io/lego/dns/httpreq`)
|
||||||
|
|
|
@ -30,18 +30,18 @@ lego --dns exec --domains my.domain.com --email my@email.com run
|
||||||
|
|
||||||
## Base Configuration
|
## Base Configuration
|
||||||
|
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|-----------------------|-------------|
|
|---------------------------|---------------------------------------|
|
||||||
| `EXEC_MODE` | `RAW`, none |
|
| `EXEC_MODE` | `RAW`, none |
|
||||||
| `EXEC_PATH` | TODO |
|
| `EXEC_PATH` | The path of the the external program. |
|
||||||
|
|
||||||
|
|
||||||
## Additional Configuration
|
## Additional Configuration
|
||||||
|
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|--------------------------------|-------------|
|
|----------------------------|-------------------------------------------|
|
||||||
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check |
|
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check. |
|
||||||
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
|
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation. |
|
||||||
|
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
|
@ -29,8 +29,8 @@ _Please contribute by adding a CLI example._
|
||||||
|
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|-----------------------|-------------|
|
|-----------------------|-------------|
|
||||||
| `GODADDY_API_KEY` | **TODO** |
|
| `GODADDY_API_KEY` | API key |
|
||||||
| `GODADDY_API_SECRET` | **TODO** |
|
| `GODADDY_API_SECRET` | API secret |
|
||||||
|
|
||||||
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
|
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).
|
More information [here](/lego/dns/#configuration-and-credentials).
|
||||||
|
|
|
@ -29,8 +29,8 @@ _Please contribute by adding a CLI example._
|
||||||
|
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|-----------------------|-------------|
|
|-----------------------|-------------|
|
||||||
| `HOSTINGDE_API_KEY` | **TODO** |
|
| `HOSTINGDE_API_KEY` | API key |
|
||||||
| `HOSTINGDE_ZONE_NAME` | **TODO** |
|
| `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.
|
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).
|
More information [here](/lego/dns/#configuration-and-credentials).
|
||||||
|
|
|
@ -44,10 +44,10 @@ More information [here](/lego/dns/#configuration-and-credentials).
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|--------------------------------|-------------|
|
|--------------------------------|-------------|
|
||||||
| `HTTPREQ_HTTP_TIMEOUT` | API request timeout |
|
| `HTTPREQ_HTTP_TIMEOUT` | API request timeout |
|
||||||
| `HTTPREQ_PASSWORD` | **TODO** |
|
| `HTTPREQ_PASSWORD` | Basic authentication password |
|
||||||
| `HTTPREQ_POLLING_INTERVAL` | Time between DNS propagation check |
|
| `HTTPREQ_POLLING_INTERVAL` | Time between DNS propagation check |
|
||||||
| `HTTPREQ_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
|
| `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.
|
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).
|
More information [here](/lego/dns/#configuration-and-credentials).
|
||||||
|
|
|
@ -13,18 +13,18 @@ Additional = '''
|
||||||
|
|
||||||
## Base Configuration
|
## Base Configuration
|
||||||
|
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|-----------------------|-------------|
|
|---------------------------|---------------------------------------|
|
||||||
| `EXEC_MODE` | `RAW`, none |
|
| `EXEC_MODE` | `RAW`, none |
|
||||||
| `EXEC_PATH` | TODO |
|
| `EXEC_PATH` | The path of the the external program. |
|
||||||
|
|
||||||
|
|
||||||
## Additional Configuration
|
## Additional Configuration
|
||||||
|
|
||||||
| Environment Variable Name | Description |
|
| Environment Variable Name | Description |
|
||||||
|--------------------------------|-------------|
|
|----------------------------|-------------------------------------------|
|
||||||
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check |
|
| `EXEC_POLLING_INTERVAL` | Time between DNS propagation check. |
|
||||||
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
|
| `EXEC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation. |
|
||||||
|
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
|
@ -6,8 +6,8 @@ Since = "v0.5.0"
|
||||||
|
|
||||||
[Configuration]
|
[Configuration]
|
||||||
[Configuration.Credentials]
|
[Configuration.Credentials]
|
||||||
GODADDY_API_KEY = "**TODO**"
|
GODADDY_API_KEY = "API key"
|
||||||
GODADDY_API_SECRET = "**TODO**"
|
GODADDY_API_SECRET = "API secret"
|
||||||
[Configuration.Additional]
|
[Configuration.Additional]
|
||||||
GODADDY_POLLING_INTERVAL = "Time between DNS propagation check"
|
GODADDY_POLLING_INTERVAL = "Time between DNS propagation check"
|
||||||
GODADDY_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
GODADDY_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
||||||
|
|
|
@ -6,8 +6,8 @@ Since = "v1.1.0"
|
||||||
|
|
||||||
[Configuration]
|
[Configuration]
|
||||||
[Configuration.Credentials]
|
[Configuration.Credentials]
|
||||||
HOSTINGDE_API_KEY = "**TODO**"
|
HOSTINGDE_API_KEY = "API key"
|
||||||
HOSTINGDE_ZONE_NAME = "**TODO**"
|
HOSTINGDE_ZONE_NAME = "Zone name in ACE format"
|
||||||
[Configuration.Additional]
|
[Configuration.Additional]
|
||||||
HOSTINGDE_POLLING_INTERVAL = "Time between DNS propagation check"
|
HOSTINGDE_POLLING_INTERVAL = "Time between DNS propagation check"
|
||||||
HOSTINGDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
HOSTINGDE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
||||||
|
|
|
@ -54,8 +54,8 @@ Basic authentication (optional) can be set with some environment variables:
|
||||||
HTTPREQ_MODE = "`RAW`, none"
|
HTTPREQ_MODE = "`RAW`, none"
|
||||||
HTTPREQ_ENDPOINT = "The URL of the server"
|
HTTPREQ_ENDPOINT = "The URL of the server"
|
||||||
[Configuration.Additional]
|
[Configuration.Additional]
|
||||||
HTTPREQ_USERNAME = "**TODO**"
|
HTTPREQ_USERNAME = "Basic authentication username"
|
||||||
HTTPREQ_PASSWORD = "**TODO**"
|
HTTPREQ_PASSWORD = "Basic authentication password"
|
||||||
HTTPREQ_POLLING_INTERVAL = "Time between DNS propagation check"
|
HTTPREQ_POLLING_INTERVAL = "Time between DNS propagation check"
|
||||||
HTTPREQ_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
HTTPREQ_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
||||||
HTTPREQ_HTTP_TIMEOUT = "API request timeout"
|
HTTPREQ_HTTP_TIMEOUT = "API request timeout"
|
||||||
|
|
Loading…
Reference in a new issue