doc: add examples and fix some typos (#1309)

This commit is contained in:
Ludovic Fernandez 2020-11-27 20:40:44 +01:00 committed by GitHub
parent 6292f5878c
commit 1af9299a83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
139 changed files with 487 additions and 249 deletions

View file

@ -167,12 +167,12 @@ func displayDNSHelp(name string) error {
ew.writeln()
ew.writeln(`Credentials:`)
ew.writeln(` - "AURORA_ENDPOINT": API endpoint URL`)
ew.writeln(` - "AURORA_KEY": User API key`)
ew.writeln(` - "AURORA_USER_ID": User ID`)
ew.writeln()
ew.writeln(`Additional Configuration:`)
ew.writeln(` - "AURORA_ENDPOINT": API endpoint URL`)
ew.writeln(` - "AURORA_POLLING_INTERVAL": Time between DNS propagation check`)
ew.writeln(` - "AURORA_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
ew.writeln(` - "AURORA_TTL": The TTL of the TXT record used for the DNS challenge`)
@ -412,7 +412,7 @@ func displayDNSHelp(name string) error {
// generated from: providers/dns/constellix/constellix.toml
ew.writeln(`Configuration for Constellix.`)
ew.writeln(`Code: 'constellix'`)
ew.writeln(`Since: 'v0.3.4'`)
ew.writeln(`Since: 'v3.4.0'`)
ew.writeln()
ew.writeln(`Credentials:`)
@ -725,10 +725,10 @@ func displayDNSHelp(name string) error {
ew.writeln(`Credentials:`)
ew.writeln(` - "EXOSCALE_API_KEY": API key`)
ew.writeln(` - "EXOSCALE_API_SECRET": API secret`)
ew.writeln(` - "EXOSCALE_ENDPOINT": API endpoint URL`)
ew.writeln()
ew.writeln(`Additional Configuration:`)
ew.writeln(` - "EXOSCALE_ENDPOINT": API endpoint URL`)
ew.writeln(` - "EXOSCALE_HTTP_TIMEOUT": API request timeout`)
ew.writeln(` - "EXOSCALE_POLLING_INTERVAL": Time between DNS propagation check`)
ew.writeln(` - "EXOSCALE_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
@ -1000,7 +1000,7 @@ func displayDNSHelp(name string) error {
ew.writeln(` - "JOKER_API_KEY": API key (only with DMAPI mode)`)
ew.writeln(` - "JOKER_API_MODE": 'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI)`)
ew.writeln(` - "JOKER_PASSWORD": Joker.com password`)
ew.writeln(` - "JOKER_USERNAME": Joker.com username (email address)`)
ew.writeln(` - "JOKER_USERNAME": Joker.com username`)
ew.writeln()
ew.writeln(`Additional Configuration:`)
@ -1229,7 +1229,7 @@ func displayDNSHelp(name string) error {
// generated from: providers/dns/netlify/netlify.toml
ew.writeln(`Configuration for Netlify.`)
ew.writeln(`Code: 'netlify'`)
ew.writeln(`Since: 'v0.3.7'`)
ew.writeln(`Since: 'v3.7.0'`)
ew.writeln()
ew.writeln(`Credentials:`)
@ -1748,7 +1748,7 @@ func displayDNSHelp(name string) error {
// generated from: providers/dns/zonomi/zonomi.toml
ew.writeln(`Configuration for Zonomi.`)
ew.writeln(`Code: 'zonomi'`)
ew.writeln(`Since: 'v0.3.5'`)
ew.writeln(`Since: 'v3.5.0'`)
ew.writeln()
ew.writeln(`Credentials:`)

View file

@ -18,9 +18,13 @@ Configuration for [Joohoi's ACME-DNS](https://github.com/joohoi/acme-dns).
- Code: `acme-dns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Joohoi's ACME-DNS provider:
```bash
ACME_DNS_API_BASE=http://10.0.0.8:4443 \
ACME_DNS_STORAGE_PATH=/root/.lego-acme-dns-accounts.json \
lego --email myemail@example.com --dns acme-dns --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [Alibaba Cloud DNS](https://www.alibabacloud.com/product/dns).
- Code: `alidns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Alibaba Cloud DNS provider:
```bash
ALICLOUD_ACCESS_KEY=abcdefghijklmnopqrstuvwx \
ALICLOUD_SECRET_KEY=xxxxxxx \
lego --email myemail@example.com --dns alidns --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the ArvanCloud provider:
```bash
ARVANCLOUD_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
lego --dns arvancloud --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns arvancloud --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [Aurora DNS](https://www.pcextreme.com/aurora/dns).
- Code: `auroradns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Aurora DNS provider:
```bash
AURORA_USER_ID=xxxxx \
AURORA_KEY=yyyyyy \
lego --email myemail@example.com --dns auroradns --domains my.example.org run
```
@ -29,7 +33,6 @@ _Please contribute by adding a CLI example._
| Environment Variable Name | Description |
|-----------------------|-------------|
| `AURORA_ENDPOINT` | API endpoint URL |
| `AURORA_KEY` | User API key |
| `AURORA_USER_ID` | User ID |
@ -41,6 +44,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `AURORA_ENDPOINT` | API endpoint URL |
| `AURORA_POLLING_INTERVAL` | Time between DNS propagation check |
| `AURORA_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `AURORA_TTL` | The TTL of the TXT record used for the DNS challenge |

View file

@ -23,7 +23,7 @@ Here is an example bash command using the Autodns provider:
```bash
AUTODNS_API_USER=username \
AUTODNS_API_PASSWORD=supersecretpassword \
lego --dns autodns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns autodns --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Bindman provider:
```bash
BINDMAN_MANAGER_ADDRESS=<your bindman manager address> \
lego --dns bindman --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns bindman --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Checkdomain provider:
```bash
CHECKDOMAIN_TOKEN=yoursecrettoken \
lego --dns checkdomain --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns checkdomain --domains my.example.org run
```

View file

@ -24,7 +24,7 @@ Here is an example bash command using the CloudDNS provider:
CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \
CLOUDDNS_EMAIL=foo@bar.com \
CLOUDDNS_PASSWORD=b9841238feb177a84330f \
lego --dns clouddns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns clouddns --domains my.example.org run
```

View file

@ -23,12 +23,12 @@ Here is an example bash command using the Cloudflare provider:
```bash
CLOUDFLARE_EMAIL=foo@bar.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns cloudflare --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns cloudflare --domains my.example.org run
# or
CLOUDFLARE_DNS_API_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns cloudflare --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns cloudflare --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [ClouDNS](https://www.cloudns.net).
- Code: `cloudns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the ClouDNS provider:
```bash
CLOUDNS_AUTH_ID=xxxx \
CLOUDNS_AUTH_PASSWORD=yyyy \
lego --email myemail@example.com --dns cloudns --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [CloudXNS](https://www.cloudxns.net/).
- Code: `cloudxns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the CloudXNS provider:
```bash
CLOUDXNS_API_KEY=xxxx \
CLOUDXNS_SECRET_KEY=yyyy \
lego --email myemail@example.com --dns cloudxns --domains my.example.org run
```

View file

@ -18,9 +18,14 @@ Configuration for [ConoHa](https://www.conoha.jp/).
- Code: `conoha`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the ConoHa provider:
```bash
CONOHA_TENANT_ID=487727e3921d44e3bfe7ebb337bf085e \
CONOHA_API_USERNAME=xxxx \
CONOHA_API_PASSWORD=yyyy \
lego --email myemail@example.com --dns conoha --domains my.example.org run
```

View file

@ -9,7 +9,7 @@ slug: constellix
<!-- providers/dns/constellix/constellix.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.4
Since: v3.4.0
Configuration for [Constellix](https://constellix.com).
@ -23,7 +23,7 @@ Here is an example bash command using the Constellix provider:
```bash
CONSTELLIX_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
CONSTELLIX_SECRET_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
lego --dns constellix --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns constellix --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the deSEC.io provider:
```bash
DESEC_TOKEN=x-xxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --dns desec --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns desec --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Digital Ocean](https://www.digitalocean.com/docs/networking/d
- Code: `digitalocean`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Digital Ocean provider:
```bash
DO_AUTH_TOKEN=xxxxxx \
lego --email myemail@example.com --dns digitalocean --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the DNSimple provider:
```bash
DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns dnsimple --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns dnsimple --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
- Code: `dnsmadeeasy`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the DNS Made Easy provider:
```bash
DNSMADEEASY_API_KEY=xxxxxx \
DNSMADEEASY_API_SECRET=yyyyy \
lego --email myemail@example.com --dns dnsmadeeasy --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [DNSPod](http://www.dnspod.com/).
- Code: `dnspod`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the DNSPod provider:
```bash
DNSPOD_API_KEY=xxxxxx \
lego --email myemail@example.com --dns dnspod --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Domain Offensive (do.de)](https://www.do.de/).
- Code: `dode`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Domain Offensive (do.de) provider:
```bash
DODE_TOKEN=xxxxxx \
lego --email myemail@example.com --dns dode --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the DreamHost provider:
```bash
DREAMHOST_API_KEY="YOURAPIKEY" \
lego --domains "foo.example.com" --dns dreamhost --email some@email.com run
lego --email myemail@example.com --dns dreamhost --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Duck DNS](https://www.duckdns.org/).
- Code: `duckdns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Duck DNS provider:
```bash
DUCKDNS_TOKEN=xxxxxx \
lego --email myemail@example.com --dns duckdns --domains my.example.org run
```

View file

@ -18,9 +18,14 @@ Configuration for [Dyn](https://dyn.com/).
- Code: `dyn`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Dyn provider:
```bash
DYN_CUSTOMER_NAME=xxxxxx \
DYN_USER_NAME=yyyyy \
DYN_PASSWORD=zzzz \
lego --email myemail@example.com --dns dyn --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Dynu provider:
```bash
DYNU_API_KEY=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns dynu --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns dynu --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the EasyDNS provider:
```bash
EASYDNS_TOKEN=<your token> \
EASYDNS_KEY=<your key> \
lego --dns easydns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns easydns --domains my.example.org run
```

View file

@ -26,7 +26,7 @@ AKAMAI_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG= \
AKAMAI_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \
lego --domains="example.zone" --email="testuser@mail.me" --dns="edgedns" -a run
lego --email myemail@example.com --dns edgedns --domains my.example.org run
```

View file

@ -21,7 +21,7 @@ Here is an example bash command using the External program provider:
```bash
EXEC_PATH=/the/path/to/myscript.sh \
lego --dns exec --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns exec --domains my.example.org run
```
@ -51,19 +51,19 @@ The file name of the external program is specified in the environment variable `
When it is run by lego, three command-line parameters are passed to it:
The action ("present" or "cleanup"), the fully-qualified domain name and the value for the record.
For example, requesting a certificate for the domain 'foo.example.com' can be achieved by calling lego as follows:
For example, requesting a certificate for the domain 'my.example.org' can be achieved by calling lego as follows:
```bash
EXEC_PATH=./update-dns.sh \
lego --dns exec \
--domains foo.example.com \
--email invalid@example.com run
lego --email myemail@example.com \
--dns exec \
--domains my.example.org run
```
It will then call the program './update-dns.sh' with like this:
```bash
./update-dns.sh "present" "_acme-challenge.foo.example.com." "MsijOYZxqyjGnFGwhjrhfg-Xgbl5r68WPda0J9EgqqI"
./update-dns.sh "present" "_acme-challenge.my.example.org." "MsijOYZxqyjGnFGwhjrhfg-Xgbl5r68WPda0J9EgqqI"
```
The program then needs to make sure the record is inserted.
@ -77,15 +77,15 @@ If you want to use the raw domain, token, and keyAuth values with your program,
```bash
EXEC_MODE=RAW \
EXEC_PATH=./update-dns.sh \
lego --dns exec \
--domains foo.example.com \
--email invalid@example.com run
lego --email myemail@example.com \
--dns exec \
--domains my.example.org run
```
It will then call the program `./update-dns.sh` like this:
```bash
./update-dns.sh "present" "foo.example.com." "--" "some-token" "KxAy-J3NwUmg9ZQuM-gP_Mq1nStaYSaP9tYQs5_-YsE.ksT-qywTd8058G-SHHWA3RAN72Pr0yWtPYmmY5UBpQ8"
./update-dns.sh "present" "my.example.org." "--" "some-token" "KxAy-J3NwUmg9ZQuM-gP_Mq1nStaYSaP9tYQs5_-YsE.ksT-qywTd8058G-SHHWA3RAN72Pr0yWtPYmmY5UBpQ8"
```
## Commands

View file

@ -18,9 +18,13 @@ Configuration for [Exoscale](https://www.exoscale.com/).
- Code: `exoscale`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Exoscale provider:
```bash
EXOSCALE_API_KEY=abcdefghijklmnopqrstuvwx \
EXOSCALE_API_SECRET=xxxxxxx \
lego --email myemail@example.com --dns exoscale --domains my.example.org run
```
@ -31,7 +35,6 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `EXOSCALE_API_KEY` | API key |
| `EXOSCALE_API_SECRET` | API secret |
| `EXOSCALE_ENDPOINT` | API endpoint URL |
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).
@ -41,6 +44,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `EXOSCALE_ENDPOINT` | API endpoint URL |
| `EXOSCALE_HTTP_TIMEOUT` | API request timeout |
| `EXOSCALE_POLLING_INTERVAL` | Time between DNS propagation check |
| `EXOSCALE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |

View file

@ -18,9 +18,12 @@ Configuration for [Gandi](https://www.gandi.net).
- Code: `gandi`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Gandi provider:
```bash
GANDI_API_KEY=abcdefghijklmnopqrstuvwx \
lego --email myemail@example.com --dns gandi --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Gandi Live DNS (v5)](https://www.gandi.net).
- Code: `gandiv5`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Gandi Live DNS (v5) provider:
```bash
GANDIV5_API_KEY=abcdefghijklmnopqrstuvwx \
lego --email myemail@example.com --dns gandiv5 --domains my.example.org run
```
@ -52,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
## More information
- [API documentation](http://doc.livedns.gandi.net)
- [API documentation](https://api.gandi.net/docs/livedns/)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandiv5/gandiv5.toml -->

View file

@ -18,9 +18,13 @@ Configuration for [Glesys](https://glesys.com/).
- Code: `glesys`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Glesys provider:
```bash
GLESYS_API_USER=xxxxx \
GLESYS_API_KEY=yyyyy \
lego --email myemail@example.com --dns glesys --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the Go Daddy provider:
```bash
GODADDY_API_KEY=xxxxxxxx \
GODADDY_API_SECRET=yyyyyyyy \
lego --dns godaddy --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns godaddy --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Hetzner provider:
```bash
HETZNER_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
lego --dns hetzner --domains my.domain.com --email my@email.com run
lego -email myemail@example.com --dns hetzner --domains my.example.org -run
```

View file

@ -18,9 +18,13 @@ Configuration for [Hosting.de](https://www.hosting.de/).
- Code: `hostingde`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Hosting.de provider:
```bash
HOSTINGDE_API_KEY=xxxxxxxx \
HOSTINGDE_ZONE_NAME=yyyyy \
lego -email myemail@example.com --dns hostingde --domains my.example.org -run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the HTTP request provider:
```bash
HTTPREQ_ENDPOINT=http://my.server.com:9090 \
lego --dns httpreq --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns httpreq --domains my.example.org run
```

View file

@ -21,7 +21,7 @@ Configuration for [HyperOne](https://www.hyperone.com).
Here is an example bash command using the HyperOne provider:
```bash
lego --dns hyperone --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns hyperone --domains my.example.org run
```

View file

@ -18,9 +18,14 @@ Configuration for [Internet Initiative Japan](https://www.iij.ad.jp/en/).
- Code: `iij`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Internet Initiative Japan provider:
```bash
IIJ_API_ACCESS_KEY=xxxxxxxx \
IIJ_API_SECRET_KEY=yyyyyy \
IIJ_DO_SERVICE_CODE=zzzzzz \
lego -email myemail@example.com --dns iij --domains my.example.org -run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Infomaniak provider:
```bash
INFOMANIAK_ACCESS_TOKEN=1234567898765432 \
lego --dns infomaniak --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns infomaniak --domains my.example.org run
```

View file

@ -23,13 +23,13 @@ Here is an example bash command using the INWX provider:
```bash
INWX_USERNAME=xxxxxxxxxx \
INWX_PASSWORD=yyyyyyyyyy \
lego --dns inwx --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns inwx --domains my.example.org run
# 2FA
INWX_USERNAME=xxxxxxxxxx \
INWX_PASSWORD=yyyyyyyyyy \
INWX_SHARED_SECRET=zzzzzzzzzz \
lego --dns inwx --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns inwx --domains my.example.org run
```

View file

@ -25,17 +25,17 @@ Here is an example bash command using the Joker provider:
JOKER_API_MODE=SVC \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --dns joker --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns joker --domains my.example.org run
# DMAPI
JOKER_API_MODE=DMAPI \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --dns joker --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns joker --domains my.example.org run
## or
JOKER_API_MODE=DMAPI \
JOKER_API_KEY=<your API key> \
lego --dns joker --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns joker --domains my.example.org run
```
@ -48,7 +48,7 @@ lego --dns joker --domains my.domain.com --email my@email.com run
| `JOKER_API_KEY` | API key (only with DMAPI mode) |
| `JOKER_API_MODE` | 'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI) |
| `JOKER_PASSWORD` | Joker.com password |
| `JOKER_USERNAME` | Joker.com username (email address) |
| `JOKER_USERNAME` | Joker.com 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).

View file

@ -18,9 +18,12 @@ Configuration for [Linode (v4)](https://www.linode.com/).
- Code: `linode`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Linode (v4) provider:
```bash
LINODE_TOKEN=xxxxx \
lego --email myemail@example.com --dns linode --domains my.example.org run
```

View file

@ -22,9 +22,9 @@ Here is an example bash command using the Liquid Web provider:
```bash
LIQUID_WEB_USERNAME=someuser \
LIQUID_WEB_PASSWORD="somepass" \
LIQUID_WEB_PASSWORD=somepass \
LIQUID_ZONE=tacoman.com.net \
lego --dns liquidweb --email someaccount@email.com --domains "foo.email.com" run
lego --email myemail@example.com --dns liquidweb --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the LuaDNS provider:
```bash
LUADNS_API_USERNAME=youremail \
LUADNS_API_TOKEN=xxxxxxxx \
lego --dns luadns --email me@example.com --domains test.example.com run
lego --email myemail@example.com --dns luadns --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [MyDNS.jp](https://www.mydns.jp).
- Code: `mydnsjp`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the MyDNS.jp provider:
```bash
MYDNSJP_MASTER_ID=xxxxx \
MYDNSJP_PASSWORD=xxxxx \
lego --email myemail@example.com --dns mydnsjp --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the MythicBeasts provider:
```bash
MYTHICBEASTS_USER_NAME=myuser \
MYTHICBEASTS_PASSWORD=mypass \
lego --dns mythicbeasts --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns mythicbeasts --domains my.example.org run
```

View file

@ -26,7 +26,7 @@ Here is an example bash command using the Namecheap provider:
```bash
NAMECHEAP_API_USER=user \
NAMECHEAP_API_KEY=key \
lego --dns namecheap --email someaccount@email.com --domains "foo.email.com" run
lego --email myemail@example.com --dns namecheap --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the Name.com provider:
```bash
NAMECOM_USERNAME=foo.bar \
NAMECOM_API_TOKEN=a379a6f6eeafb9a55e378c118034e2751e682fab \
lego --dns="namedotcom" --domains="my.domain.com" --email="my@email.com" run
lego --email myemail@example.com --dns namedotcom --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Namesilo provider:
```bash
NAMESILO_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns namesilo --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns namesilo --domains my.example.org run
```

View file

@ -18,9 +18,14 @@ Configuration for [Netcup](https://www.netcup.eu/).
- Code: `netcup`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Netcup provider:
```bash
NETCUP_CUSTOMER_NUMBER=xxxx \
NETCUP_API_KEY=yyyy \
NETCUP_API_PASSWORD=zzzz \
lego --email myemail@example.com --dns netcup --domains my.example.org run
```

View file

@ -9,7 +9,7 @@ slug: netlify
<!-- providers/dns/netlify/netlify.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.7
Since: v3.7.0
Configuration for [Netlify](https://www.netlify.com).
@ -22,7 +22,7 @@ Here is an example bash command using the Netlify provider:
```bash
NETLIFY_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --dns netlify --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns netlify --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [NIFCloud](https://www.nifcloud.com/).
- Code: `nifcloud`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the NIFCloud provider:
```bash
NIFCLOUD_ACCESS_KEY_ID=xxxx \
NIFCLOUD_SECRET_ACCESS_KEY=yyyy \
lego --email myemail@example.com --dns nifcloud --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [NS1](https://ns1.com).
- Code: `ns1`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the NS1 provider:
```bash
NS1_API_KEY=xxxx \
lego --email myemail@example.com --dns ns1 --domains my.example.org run
```

View file

@ -28,7 +28,7 @@ OCI_USER_OCID="ocid1.user.oc1..secret" \
OCI_PUBKEY_FINGERPRINT="00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00" \
OCI_REGION="us-phoenix-1" \
OCI_COMPARTMENT_OCID="ocid1.tenancy.oc1..secret" \
lego --dns oraclecloud --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns oraclecloud --domains my.example.org run
```

View file

@ -25,7 +25,7 @@ OVH_APPLICATION_KEY=1234567898765432 \
OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
OVH_CONSUMER_KEY=256vfsd347245sdfg \
OVH_ENDPOINT=ovh-eu \
lego --dns autodns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns autodns --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [PowerDNS](https://www.powerdns.com/).
- Code: `pdns`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the PowerDNS provider:
```bash
PDNS_API_URL=http://pdns-server:80/ \
PDNS_API_KEY=xxxx \
lego --email myemail@example.com --dns pdns --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [Rackspace](https://www.rackspace.com/).
- Code: `rackspace`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Rackspace provider:
```bash
RACKSPACE_USER=xxxx \
RACKSPACE_API_KEY=yyyy \
lego --email myemail@example.com --dns rackspace --domains my.example.org run
```

View file

@ -22,8 +22,8 @@ Here is an example bash command using the reg.ru provider:
```bash
REGRU_USERNAME=xxxxxx \
REGRU_PASSWORD=yyyyyyy \
lego --dns regru --domains my.domain.com --email my@email.com run
REGRU_PASSWORD=yyyyyy \
lego --email myemail@example.com --dns regru --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the RimuHosting provider:
```bash
RIMUHOSTING_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --dns rimuhosting --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns rimuhosting --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [Sakura Cloud](https://cloud.sakura.ad.jp/).
- Code: `sakuracloud`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Sakura Cloud provider:
```bash
SAKURACLOUD_ACCESS_TOKEN=xxxxx \
SAKURACLOUD_ACCESS_TOKEN_SECRET=yyyyy \
lego --email myemail@example.com --dns sakuracloud --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Scaleway provider:
```bash
SCALEWAY_API_TOKEN=xxxxxxx-xxxxx-xxxx-xxx-xxxxxx \
lego --dns scaleway --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns scaleway --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Selectel](https://kb.selectel.com/).
- Code: `selectel`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Selectel provider:
```bash
SELECTEL_API_TOKEN=xxxxx \
lego --email myemail@example.com --dns selectel --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the Servercow provider:
```bash
SERVERCOW_USERNAME=xxxxxxxx \
SERVERCOW_PASSWORD=xxxxxxxx \
lego --dns servercow --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns servercow --domains my.example.org run
```

View file

@ -18,9 +18,14 @@ Configuration for [Stackpath](https://www.stackpath.com/).
- Code: `stackpath`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Stackpath provider:
```bash
STACKPATH_CLIENT_ID=xxxxx \
STACKPATH_CLIENT_SECRET=yyyyy \
STACKPATH_STACK_ID=zzzzz \
lego --email myemail@example.com --dns stackpath --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the TransIP provider:
```bash
TRANSIP_ACCOUNT_NAME = "Account name" \
TRANSIP_PRIVATE_KEY_PATH = "transip.key" \
lego --dns transip --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns transip --domains my.example.org run
```

View file

@ -23,7 +23,7 @@ Here is an example bash command using the Versio.[nl|eu|uk] provider:
```bash
VERSIO_USERNAME=<your login> \
VERSIO_PASSWORD=<your password> \
lego --dns versio --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns versio --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Vscale](https://vscale.io/).
- Code: `vscale`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Vscale provider:
```bash
VSCALE_API_TOKEN=xxxxx \
lego --email myemail@example.com --dns vscale --domains my.example.org run
```

View file

@ -18,9 +18,12 @@ Configuration for [Vultr](https://www.vultr.com/).
- Code: `vultr`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Vultr provider:
```bash
VULTR_API_KEY=xxxxx \
lego --email myemail@example.com --dns vultr --domains my.example.org run
```

View file

@ -22,7 +22,7 @@ Here is an example bash command using the Yandex provider:
```bash
YANDEX_PDD_TOKEN=<your PDD Token> \
lego --dns yandex --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns yandex --domains my.example.org run
```

View file

@ -18,9 +18,13 @@ Configuration for [Zone.ee](https://www.zone.ee/).
- Code: `zoneee`
{{% notice note %}}
_Please contribute by adding a CLI example._
{{% /notice %}}
Here is an example bash command using the Zone.ee provider:
```bash
ZONEEE_API_USER=xxxxx \
ZONEEE_API_KEY=yyyyy \
lego --email myemail@example.com --dns zoneee --domains my.example.org run
```

View file

@ -9,7 +9,7 @@ slug: zonomi
<!-- providers/dns/zonomi/zonomi.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.5
Since: v3.5.0
Configuration for [Zonomi](https://zonomi.com).
@ -22,7 +22,7 @@ Here is an example bash command using the Zonomi provider:
```bash
ZONOMI_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --dns zonomi --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns zonomi --domains my.example.org run
```

View file

@ -4,7 +4,11 @@ URL = "https://github.com/joohoi/acme-dns"
Code = "acme-dns"
Since = "v1.1.0"
Example = ''''''
Example = '''
ACME_DNS_API_BASE=http://10.0.0.8:4443 \
ACME_DNS_STORAGE_PATH=/root/.lego-acme-dns-accounts.json \
lego --email myemail@example.com --dns acme-dns --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,11 @@ URL = "https://www.alibabacloud.com/product/dns"
Code = "alidns"
Since = "v1.1.0"
Example = ''''''
Example = '''
ALICLOUD_ACCESS_KEY=abcdefghijklmnopqrstuvwx \
ALICLOUD_SECRET_KEY=xxxxxxx \
lego --email myemail@example.com --dns alidns --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -6,7 +6,7 @@ Since = "v3.8.0"
Example = '''
ARVANCLOUD_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
lego --dns arvancloud --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns arvancloud --domains my.example.org run
'''
[Configuration]

View file

@ -4,14 +4,18 @@ URL = "https://www.pcextreme.com/aurora/dns"
Code = "auroradns"
Since = "v0.4.0"
Example = ''''''
Example = '''
AURORA_USER_ID=xxxxx \
AURORA_KEY=yyyyyy \
lego --email myemail@example.com --dns auroradns --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]
AURORA_USER_ID = "User ID"
AURORA_KEY = "User API key"
AURORA_ENDPOINT = "API endpoint URL"
[Configuration.Additional]
AURORA_ENDPOINT = "API endpoint URL"
AURORA_POLLING_INTERVAL = "Time between DNS propagation check"
AURORA_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
AURORA_TTL = "The TTL of the TXT record used for the DNS challenge"

View file

@ -7,7 +7,7 @@ Since = "v3.2.0"
Example = '''
AUTODNS_API_USER=username \
AUTODNS_API_PASSWORD=supersecretpassword \
lego --dns autodns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns autodns --domains my.example.org run
'''
[Configuration]

View file

@ -6,7 +6,7 @@ Since = "v2.6.0"
Example = '''
BINDMAN_MANAGER_ADDRESS=<your bindman manager address> \
lego --dns bindman --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns bindman --domains my.example.org run
'''
[Configuration]

View file

@ -6,7 +6,7 @@ Since = "v3.3.0"
Example = '''
CHECKDOMAIN_TOKEN=yoursecrettoken \
lego --dns checkdomain --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns checkdomain --domains my.example.org run
'''
[Configuration]

View file

@ -8,7 +8,7 @@ Example = '''
CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \
CLOUDDNS_EMAIL=foo@bar.com \
CLOUDDNS_PASSWORD=b9841238feb177a84330f \
lego --dns clouddns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns clouddns --domains my.example.org run
'''
[Configuration]

View file

@ -7,12 +7,12 @@ Since = "v0.3.0"
Example = '''
CLOUDFLARE_EMAIL=foo@bar.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns cloudflare --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns cloudflare --domains my.example.org run
# or
CLOUDFLARE_DNS_API_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns cloudflare --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns cloudflare --domains my.example.org run
'''
Additional = '''

View file

@ -4,7 +4,11 @@ URL = "https://www.cloudns.net"
Code = "cloudns"
Since = "v2.3.0"
Example = ''''''
Example = '''
CLOUDNS_AUTH_ID=xxxx \
CLOUDNS_AUTH_PASSWORD=yyyy \
lego --email myemail@example.com --dns cloudns --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,11 @@ URL = "https://www.cloudxns.net/"
Code = "cloudxns"
Since = "v0.5.0"
Example = ''''''
Example = '''
CLOUDXNS_API_KEY=xxxx \
CLOUDXNS_SECRET_KEY=yyyy \
lego --email myemail@example.com --dns cloudxns --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,12 @@ URL = "https://www.conoha.jp/"
Code = "conoha"
Since = "v1.2.0"
Example = ''''''
Example = '''
CONOHA_TENANT_ID=487727e3921d44e3bfe7ebb337bf085e \
CONOHA_API_USERNAME=xxxx \
CONOHA_API_PASSWORD=yyyy \
lego --email myemail@example.com --dns conoha --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -2,12 +2,12 @@ Name = "Constellix"
Description = ''''''
URL = "https://constellix.com"
Code = "constellix"
Since = "v0.3.4"
Since = "v3.4.0"
Example = '''
CONSTELLIX_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
CONSTELLIX_SECRET_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
lego --dns constellix --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns constellix --domains my.example.org run
'''
[Configuration]

View file

@ -6,7 +6,7 @@ Since = "v3.7.0"
Example = '''
DESEC_TOKEN=x-xxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --dns desec --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns desec --domains my.example.org run
'''
[Configuration]

View file

@ -4,7 +4,10 @@ URL = "https://www.digitalocean.com/docs/networking/dns/"
Code = "digitalocean"
Since = "v0.3.0"
Example = ''''''
Example = '''
DO_AUTH_TOKEN=xxxxxx \
lego --email myemail@example.com --dns digitalocean --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -6,7 +6,7 @@ Since = "v0.3.0"
Example = '''
DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns dnsimple --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns dnsimple --domains my.example.org run
'''
Additional = '''

View file

@ -4,7 +4,11 @@ URL = "https://dnsmadeeasy.com/"
Code = "dnsmadeeasy"
Since = "v0.4.0"
Example = ''''''
Example = '''
DNSMADEEASY_API_KEY=xxxxxx \
DNSMADEEASY_API_SECRET=yyyyy \
lego --email myemail@example.com --dns dnsmadeeasy --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,10 @@ URL = "http://www.dnspod.com/"
Code = "dnspod"
Since = "v0.4.0"
Example = ''''''
Example = '''
DNSPOD_API_KEY=xxxxxx \
lego --email myemail@example.com --dns dnspod --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,10 @@ URL = "https://www.do.de/"
Code = "dode"
Since = "v2.4.0"
Example = ''''''
Example = '''
DODE_TOKEN=xxxxxx \
lego --email myemail@example.com --dns dode --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -6,7 +6,7 @@ Since = "v1.1.0"
Example = '''
DREAMHOST_API_KEY="YOURAPIKEY" \
lego --domains "foo.example.com" --dns dreamhost --email some@email.com run
lego --email myemail@example.com --dns dreamhost --domains my.example.org run
'''
[Configuration]

View file

@ -4,7 +4,10 @@ URL = "https://www.duckdns.org/"
Code = "duckdns"
Since = "v0.5.0"
Example = ''''''
Example = '''
DUCKDNS_TOKEN=xxxxxx \
lego --email myemail@example.com --dns duckdns --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,12 @@ URL = "https://dyn.com/"
Code = "dyn"
Since = "v0.3.0"
Example = ''''''
Example = '''
DYN_CUSTOMER_NAME=xxxxxx \
DYN_USER_NAME=yyyyy \
DYN_PASSWORD=zzzz \
lego --email myemail@example.com --dns dyn --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -6,7 +6,7 @@ Since = "v3.5.0"
Example = '''
DYNU_API_KEY=1234567890abcdefghijklmnopqrstuvwxyz \
lego --dns dynu --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns dynu --domains my.example.org run
'''
[Configuration]

View file

@ -7,7 +7,7 @@ Since = "v2.6.0"
Example = '''
EASYDNS_TOKEN=<your token> \
EASYDNS_KEY=<your key> \
lego --dns easydns --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns easydns --domains my.example.org run
'''
Additional = '''

View file

@ -12,7 +12,7 @@ AKAMAI_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG= \
AKAMAI_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \
lego --domains="example.zone" --email="testuser@mail.me" --dns="edgedns" -a run
lego --email myemail@example.com --dns edgedns --domains my.example.org run
'''
[Configuration]

View file

@ -6,7 +6,7 @@ Since = "v0.5.0"
Example = '''
EXEC_PATH=/the/path/to/myscript.sh \
lego --dns exec --domains my.domain.com --email my@email.com run
lego --email myemail@example.com --dns exec --domains my.example.org run
'''
Additional = '''
@ -34,19 +34,19 @@ The file name of the external program is specified in the environment variable `
When it is run by lego, three command-line parameters are passed to it:
The action ("present" or "cleanup"), the fully-qualified domain name and the value for the record.
For example, requesting a certificate for the domain 'foo.example.com' can be achieved by calling lego as follows:
For example, requesting a certificate for the domain 'my.example.org' can be achieved by calling lego as follows:
```bash
EXEC_PATH=./update-dns.sh \
lego --dns exec \
--domains foo.example.com \
--email invalid@example.com run
lego --email myemail@example.com \
--dns exec \
--domains my.example.org run
```
It will then call the program './update-dns.sh' with like this:
```bash
./update-dns.sh "present" "_acme-challenge.foo.example.com." "MsijOYZxqyjGnFGwhjrhfg-Xgbl5r68WPda0J9EgqqI"
./update-dns.sh "present" "_acme-challenge.my.example.org." "MsijOYZxqyjGnFGwhjrhfg-Xgbl5r68WPda0J9EgqqI"
```
The program then needs to make sure the record is inserted.
@ -60,15 +60,15 @@ If you want to use the raw domain, token, and keyAuth values with your program,
```bash
EXEC_MODE=RAW \
EXEC_PATH=./update-dns.sh \
lego --dns exec \
--domains foo.example.com \
--email invalid@example.com run
lego --email myemail@example.com \
--dns exec \
--domains my.example.org run
```
It will then call the program `./update-dns.sh` like this:
```bash
./update-dns.sh "present" "foo.example.com." "--" "some-token" "KxAy-J3NwUmg9ZQuM-gP_Mq1nStaYSaP9tYQs5_-YsE.ksT-qywTd8058G-SHHWA3RAN72Pr0yWtPYmmY5UBpQ8"
./update-dns.sh "present" "my.example.org." "--" "some-token" "KxAy-J3NwUmg9ZQuM-gP_Mq1nStaYSaP9tYQs5_-YsE.ksT-qywTd8058G-SHHWA3RAN72Pr0yWtPYmmY5UBpQ8"
```
## Commands

View file

@ -4,14 +4,18 @@ URL = "https://www.exoscale.com/"
Code = "exoscale"
Since = "v0.4.0"
Example = ''''''
Example = '''
EXOSCALE_API_KEY=abcdefghijklmnopqrstuvwx \
EXOSCALE_API_SECRET=xxxxxxx \
lego --email myemail@example.com --dns exoscale --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]
EXOSCALE_API_KEY = "API key"
EXOSCALE_API_SECRET = "API secret"
EXOSCALE_ENDPOINT = "API endpoint URL"
[Configuration.Additional]
EXOSCALE_ENDPOINT = "API endpoint URL"
EXOSCALE_POLLING_INTERVAL = "Time between DNS propagation check"
EXOSCALE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
EXOSCALE_TTL = "The TTL of the TXT record used for the DNS challenge"

View file

@ -4,7 +4,10 @@ URL = "https://www.gandi.net"
Code = "gandi"
Since = "v0.3.0"
Example = ''''''
Example = '''
GANDI_API_KEY=abcdefghijklmnopqrstuvwx \
lego --email myemail@example.com --dns gandi --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

View file

@ -4,7 +4,10 @@ URL = "https://www.gandi.net"
Code = "gandiv5"
Since = "v0.5.0"
Example = ''''''
Example = '''
GANDIV5_API_KEY=abcdefghijklmnopqrstuvwx \
lego --email myemail@example.com --dns gandiv5 --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]
@ -16,4 +19,4 @@ Example = ''''''
GANDIV5_HTTP_TIMEOUT = "API request timeout"
[Links]
API = "http://doc.livedns.gandi.net"
API = "https://api.gandi.net/docs/livedns/"

View file

@ -4,7 +4,11 @@ URL = "https://glesys.com/"
Code = "glesys"
Since = "v0.5.0"
Example = ''''''
Example = '''
GLESYS_API_USER=xxxxx \
GLESYS_API_KEY=yyyyy \
lego --email myemail@example.com --dns glesys --domains my.example.org run
'''
[Configuration]
[Configuration.Credentials]

Some files were not shown because too many files have changed in this diff Show more