forked from TrueCloudLab/lego
61 lines
1.2 KiB
TOML
61 lines
1.2 KiB
TOML
|
Name = "HTTP request"
|
||
|
|
Description = ''''''
|
||
|
|
URL = "/dns/httpreq/"
|
||
|
|
Code = "httpreq"
|
||
|
|
|
||
|
|
Example = '''
|
||
|
|
HTTPREQ_ENDPOINT=http://my.server.com:9090 \
|
||
|
|
lego --dns httpreq --domains my.domain.com --email my@email.com run
|
||
|
|
'''
|
||
|
|
|
||
|
|
Additional = '''
|
||
|
|
## Description
|
||
|
|
|
||
|
|
The server must provide:
|
||
|
|
|
||
|
|
- `POST` `/present`
|
||
|
|
- `POST` `/cleanup`
|
||
|
|
|
||
|
|
The URL of the server must be define by `HTTPREQ_ENDPOINT`.
|
||
|
|
|
||
|
|
### Mode
|
||
|
|
|
||
|
|
There are 2 modes (`HTTPREQ_MODE`):
|
||
|
|
|
||
|
|
- default mode:
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"fqdn": "_acme-challenge.domain.",
|
||
|
|
"value": "LHDhK3oGRvkiefQnx7OOczTY5Tic_xZ6HcMOc_gmtoM"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
- `RAW`
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"domain": "domain",
|
||
|
|
"token": "token",
|
||
|
|
"keyAuth": "key"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Authentication
|
||
|
|
|
||
|
|
Basic authentication (optional) can be set with some environment variables:
|
||
|
|
|
||
|
|
- `HTTPREQ_USERNAME` and `HTTPREQ_PASSWORD`
|
||
|
|
- both values must be set, otherwise basic authentication is not defined.
|
||
|
|
|
||
|
|
'''
|
||
|
|
|
||
|
|
[Configuration]
|
||
|
|
[Configuration.Credentials]
|
||
|
|
HTTPREQ_MODE = "`RAW`, none"
|
||
|
|
HTTPREQ_ENDPOINT = "The URL of the server"
|
||
|
|
[Configuration.Additional]
|
||
|
|
HTTPREQ_USERNAME = "**TODO**"
|
||
|
|
HTTPREQ_PASSWORD = "**TODO**"
|
||
|
|
HTTPREQ_POLLING_INTERVAL = "Time between DNS propagation check"
|
||
|
|
HTTPREQ_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
|
||
|
|
HTTPREQ_HTTP_TIMEOUT = "API request timeout"
|