From 1af9299a835b0048f478b6089cfefe001ec752d3 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Fri, 27 Nov 2020 20:40:44 +0100 Subject: [PATCH] doc: add examples and fix some typos (#1309) --- cmd/zz_gen_cmd_dnshelp.go | 12 ++++++------ docs/content/dns/zz_gen_acme-dns.md | 10 +++++++--- docs/content/dns/zz_gen_alidns.md | 10 +++++++--- docs/content/dns/zz_gen_arvancloud.md | 2 +- docs/content/dns/zz_gen_auroradns.md | 12 ++++++++---- docs/content/dns/zz_gen_autodns.md | 2 +- docs/content/dns/zz_gen_bindman.md | 2 +- docs/content/dns/zz_gen_checkdomain.md | 2 +- docs/content/dns/zz_gen_clouddns.md | 2 +- docs/content/dns/zz_gen_cloudflare.md | 4 ++-- docs/content/dns/zz_gen_cloudns.md | 10 +++++++--- docs/content/dns/zz_gen_cloudxns.md | 10 +++++++--- docs/content/dns/zz_gen_conoha.md | 11 ++++++++--- docs/content/dns/zz_gen_constellix.md | 4 ++-- docs/content/dns/zz_gen_desec.md | 2 +- docs/content/dns/zz_gen_digitalocean.md | 9 ++++++--- docs/content/dns/zz_gen_dnsimple.md | 2 +- docs/content/dns/zz_gen_dnsmadeeasy.md | 10 +++++++--- docs/content/dns/zz_gen_dnspod.md | 9 ++++++--- docs/content/dns/zz_gen_dode.md | 9 ++++++--- docs/content/dns/zz_gen_dreamhost.md | 2 +- docs/content/dns/zz_gen_duckdns.md | 9 ++++++--- docs/content/dns/zz_gen_dyn.md | 11 ++++++++--- docs/content/dns/zz_gen_dynu.md | 2 +- docs/content/dns/zz_gen_easydns.md | 2 +- docs/content/dns/zz_gen_edgedns.md | 2 +- docs/content/dns/zz_gen_exec.md | 20 ++++++++++---------- docs/content/dns/zz_gen_exoscale.md | 12 ++++++++---- docs/content/dns/zz_gen_gandi.md | 9 ++++++--- docs/content/dns/zz_gen_gandiv5.md | 11 +++++++---- docs/content/dns/zz_gen_glesys.md | 10 +++++++--- docs/content/dns/zz_gen_godaddy.md | 2 +- docs/content/dns/zz_gen_hetzner.md | 2 +- docs/content/dns/zz_gen_hostingde.md | 10 +++++++--- docs/content/dns/zz_gen_httpreq.md | 2 +- docs/content/dns/zz_gen_hyperone.md | 2 +- docs/content/dns/zz_gen_iij.md | 11 ++++++++--- docs/content/dns/zz_gen_infomaniak.md | 2 +- docs/content/dns/zz_gen_inwx.md | 4 ++-- docs/content/dns/zz_gen_joker.md | 8 ++++---- docs/content/dns/zz_gen_linode.md | 9 ++++++--- docs/content/dns/zz_gen_liquidweb.md | 4 ++-- docs/content/dns/zz_gen_luadns.md | 2 +- docs/content/dns/zz_gen_mydnsjp.md | 10 +++++++--- docs/content/dns/zz_gen_mythicbeasts.md | 2 +- docs/content/dns/zz_gen_namecheap.md | 2 +- docs/content/dns/zz_gen_namedotcom.md | 2 +- docs/content/dns/zz_gen_namesilo.md | 2 +- docs/content/dns/zz_gen_netcup.md | 11 ++++++++--- docs/content/dns/zz_gen_netlify.md | 4 ++-- docs/content/dns/zz_gen_nifcloud.md | 10 +++++++--- docs/content/dns/zz_gen_ns1.md | 9 ++++++--- docs/content/dns/zz_gen_oraclecloud.md | 2 +- docs/content/dns/zz_gen_ovh.md | 2 +- docs/content/dns/zz_gen_pdns.md | 10 +++++++--- docs/content/dns/zz_gen_rackspace.md | 10 +++++++--- docs/content/dns/zz_gen_regru.md | 4 ++-- docs/content/dns/zz_gen_rimuhosting.md | 2 +- docs/content/dns/zz_gen_sakuracloud.md | 10 +++++++--- docs/content/dns/zz_gen_scaleway.md | 2 +- docs/content/dns/zz_gen_selectel.md | 9 ++++++--- docs/content/dns/zz_gen_servercow.md | 2 +- docs/content/dns/zz_gen_stackpath.md | 11 ++++++++--- docs/content/dns/zz_gen_transip.md | 2 +- docs/content/dns/zz_gen_versio.md | 2 +- docs/content/dns/zz_gen_vscale.md | 9 ++++++--- docs/content/dns/zz_gen_vultr.md | 9 ++++++--- docs/content/dns/zz_gen_yandex.md | 2 +- docs/content/dns/zz_gen_zoneee.md | 10 +++++++--- docs/content/dns/zz_gen_zonomi.md | 4 ++-- providers/dns/acmedns/acmedns.toml | 6 +++++- providers/dns/alidns/alidns.toml | 6 +++++- providers/dns/arvancloud/arvancloud.toml | 2 +- providers/dns/auroradns/auroradns.toml | 8 ++++++-- providers/dns/autodns/autodns.toml | 2 +- providers/dns/bindman/bindman.toml | 2 +- providers/dns/checkdomain/checkdomain.toml | 2 +- providers/dns/clouddns/clouddns.toml | 2 +- providers/dns/cloudflare/cloudflare.toml | 4 ++-- providers/dns/cloudns/cloudns.toml | 6 +++++- providers/dns/cloudxns/cloudxns.toml | 6 +++++- providers/dns/conoha/conoha.toml | 7 ++++++- providers/dns/constellix/constellix.toml | 4 ++-- providers/dns/desec/desec.toml | 2 +- providers/dns/digitalocean/digitalocean.toml | 5 ++++- providers/dns/dnsimple/dnsimple.toml | 2 +- providers/dns/dnsmadeeasy/dnsmadeeasy.toml | 6 +++++- providers/dns/dnspod/dnspod.toml | 5 ++++- providers/dns/dode/dode.toml | 5 ++++- providers/dns/dreamhost/dreamhost.toml | 2 +- providers/dns/duckdns/duckdns.toml | 5 ++++- providers/dns/dyn/dyn.toml | 7 ++++++- providers/dns/dynu/dynu.toml | 2 +- providers/dns/easydns/easydns.toml | 2 +- providers/dns/edgedns/edgedns.toml | 2 +- providers/dns/exec/exec.toml | 20 ++++++++++---------- providers/dns/exoscale/exoscale.toml | 8 ++++++-- providers/dns/gandi/gandi.toml | 5 ++++- providers/dns/gandiv5/gandiv5.toml | 7 +++++-- providers/dns/glesys/glesys.toml | 6 +++++- providers/dns/godaddy/godaddy.toml | 2 +- providers/dns/hetzner/hetzner.toml | 2 +- providers/dns/hostingde/hostingde.toml | 6 ++++++ providers/dns/httpreq/httpreq.toml | 2 +- providers/dns/hyperone/hyperone.toml | 2 +- providers/dns/iij/iij.toml | 7 ++++++- providers/dns/infomaniak/infomaniak.toml | 2 +- providers/dns/inwx/inwx.toml | 4 ++-- providers/dns/joker/joker.toml | 8 ++++---- providers/dns/linode/linode.toml | 5 ++++- providers/dns/liquidweb/liquidweb.toml | 4 ++-- providers/dns/luadns/luadns.toml | 2 +- providers/dns/mydnsjp/mydnsjp.toml | 6 +++++- providers/dns/mythicbeasts/mythicbeasts.toml | 2 +- providers/dns/namecheap/namecheap.toml | 2 +- providers/dns/namedotcom/namedotcom.toml | 2 +- providers/dns/namesilo/namesilo.toml | 2 +- providers/dns/netcup/netcup.toml | 7 ++++++- providers/dns/netlify/netlify.toml | 4 ++-- providers/dns/nifcloud/nifcloud.toml | 6 +++++- providers/dns/ns1/ns1.toml | 5 ++++- providers/dns/oraclecloud/oraclecloud.toml | 2 +- providers/dns/ovh/ovh.toml | 2 +- providers/dns/pdns/pdns.toml | 6 +++++- providers/dns/rackspace/rackspace.toml | 6 +++++- providers/dns/regru/regru.toml | 4 ++-- providers/dns/rimuhosting/rimuhosting.toml | 2 +- providers/dns/sakuracloud/sakuracloud.toml | 6 +++++- providers/dns/scaleway/scaleway.toml | 2 +- providers/dns/selectel/selectel.toml | 5 ++++- providers/dns/servercow/servercow.toml | 2 +- providers/dns/stackpath/stackpath.toml | 7 ++++++- providers/dns/transip/transip.toml | 2 +- providers/dns/versio/versio.toml | 2 +- providers/dns/vscale/vscale.toml | 5 ++++- providers/dns/vultr/vultr.toml | 5 ++++- providers/dns/yandex/yandex.toml | 2 +- providers/dns/zoneee/zoneee.toml | 6 +++++- providers/dns/zonomi/zonomi.toml | 4 ++-- 139 files changed, 487 insertions(+), 249 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 48a3721d0..383d7b4d3 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -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:`) diff --git a/docs/content/dns/zz_gen_acme-dns.md b/docs/content/dns/zz_gen_acme-dns.md index 58e349da1..c06277eb5 100644 --- a/docs/content/dns/zz_gen_acme-dns.md +++ b/docs/content/dns/zz_gen_acme-dns.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_alidns.md b/docs/content/dns/zz_gen_alidns.md index c4d4835b2..15f3628b4 100644 --- a/docs/content/dns/zz_gen_alidns.md +++ b/docs/content/dns/zz_gen_alidns.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_arvancloud.md b/docs/content/dns/zz_gen_arvancloud.md index 00a8fb39f..372f89e19 100644 --- a/docs/content/dns/zz_gen_arvancloud.md +++ b/docs/content/dns/zz_gen_arvancloud.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_auroradns.md b/docs/content/dns/zz_gen_auroradns.md index 0e9e6d485..e75fb55ff 100644 --- a/docs/content/dns/zz_gen_auroradns.md +++ b/docs/content/dns/zz_gen_auroradns.md @@ -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 | diff --git a/docs/content/dns/zz_gen_autodns.md b/docs/content/dns/zz_gen_autodns.md index de1b33fcd..0f2620b4e 100644 --- a/docs/content/dns/zz_gen_autodns.md +++ b/docs/content/dns/zz_gen_autodns.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_bindman.md b/docs/content/dns/zz_gen_bindman.md index bd4f55295..4b4910306 100644 --- a/docs/content/dns/zz_gen_bindman.md +++ b/docs/content/dns/zz_gen_bindman.md @@ -22,7 +22,7 @@ Here is an example bash command using the Bindman provider: ```bash 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 ``` diff --git a/docs/content/dns/zz_gen_checkdomain.md b/docs/content/dns/zz_gen_checkdomain.md index de63006ed..449a350e4 100644 --- a/docs/content/dns/zz_gen_checkdomain.md +++ b/docs/content/dns/zz_gen_checkdomain.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_clouddns.md b/docs/content/dns/zz_gen_clouddns.md index cd2d244b3..6374301ca 100644 --- a/docs/content/dns/zz_gen_clouddns.md +++ b/docs/content/dns/zz_gen_clouddns.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_cloudflare.md b/docs/content/dns/zz_gen_cloudflare.md index 1bd8f139f..66db361c6 100644 --- a/docs/content/dns/zz_gen_cloudflare.md +++ b/docs/content/dns/zz_gen_cloudflare.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_cloudns.md b/docs/content/dns/zz_gen_cloudns.md index f5823f318..e15280623 100644 --- a/docs/content/dns/zz_gen_cloudns.md +++ b/docs/content/dns/zz_gen_cloudns.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_cloudxns.md b/docs/content/dns/zz_gen_cloudxns.md index 0c7b0420d..a6a134fb3 100644 --- a/docs/content/dns/zz_gen_cloudxns.md +++ b/docs/content/dns/zz_gen_cloudxns.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_conoha.md b/docs/content/dns/zz_gen_conoha.md index c13def5d8..1358de2c1 100644 --- a/docs/content/dns/zz_gen_conoha.md +++ b/docs/content/dns/zz_gen_conoha.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_constellix.md b/docs/content/dns/zz_gen_constellix.md index f66cece4c..b90c3b74b 100644 --- a/docs/content/dns/zz_gen_constellix.md +++ b/docs/content/dns/zz_gen_constellix.md @@ -9,7 +9,7 @@ slug: constellix -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 ``` diff --git a/docs/content/dns/zz_gen_desec.md b/docs/content/dns/zz_gen_desec.md index 3a49e95d1..a9b862fc0 100644 --- a/docs/content/dns/zz_gen_desec.md +++ b/docs/content/dns/zz_gen_desec.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_digitalocean.md b/docs/content/dns/zz_gen_digitalocean.md index 72bd52529..ef8b1e14c 100644 --- a/docs/content/dns/zz_gen_digitalocean.md +++ b/docs/content/dns/zz_gen_digitalocean.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_dnsimple.md b/docs/content/dns/zz_gen_dnsimple.md index 1d60c4331..e0d096c2e 100644 --- a/docs/content/dns/zz_gen_dnsimple.md +++ b/docs/content/dns/zz_gen_dnsimple.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_dnsmadeeasy.md b/docs/content/dns/zz_gen_dnsmadeeasy.md index 475a9bc57..7ad6d4be8 100644 --- a/docs/content/dns/zz_gen_dnsmadeeasy.md +++ b/docs/content/dns/zz_gen_dnsmadeeasy.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_dnspod.md b/docs/content/dns/zz_gen_dnspod.md index af1968df1..2f346bc75 100644 --- a/docs/content/dns/zz_gen_dnspod.md +++ b/docs/content/dns/zz_gen_dnspod.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_dode.md b/docs/content/dns/zz_gen_dode.md index dcafe6dad..5196d3738 100644 --- a/docs/content/dns/zz_gen_dode.md +++ b/docs/content/dns/zz_gen_dode.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_dreamhost.md b/docs/content/dns/zz_gen_dreamhost.md index 3de108e88..c4dac42b7 100644 --- a/docs/content/dns/zz_gen_dreamhost.md +++ b/docs/content/dns/zz_gen_dreamhost.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_duckdns.md b/docs/content/dns/zz_gen_duckdns.md index b1c39ee0a..bdb1b1dcf 100644 --- a/docs/content/dns/zz_gen_duckdns.md +++ b/docs/content/dns/zz_gen_duckdns.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_dyn.md b/docs/content/dns/zz_gen_dyn.md index ff478a35f..ec0a66d9e 100644 --- a/docs/content/dns/zz_gen_dyn.md +++ b/docs/content/dns/zz_gen_dyn.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_dynu.md b/docs/content/dns/zz_gen_dynu.md index f707ebb96..31184c7bb 100644 --- a/docs/content/dns/zz_gen_dynu.md +++ b/docs/content/dns/zz_gen_dynu.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_easydns.md b/docs/content/dns/zz_gen_easydns.md index 22f963c20..449e4cf7b 100644 --- a/docs/content/dns/zz_gen_easydns.md +++ b/docs/content/dns/zz_gen_easydns.md @@ -23,7 +23,7 @@ Here is an example bash command using the EasyDNS provider: ```bash EASYDNS_TOKEN= \ EASYDNS_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 ``` diff --git a/docs/content/dns/zz_gen_edgedns.md b/docs/content/dns/zz_gen_edgedns.md index 67553c0ac..8631fbc9c 100644 --- a/docs/content/dns/zz_gen_edgedns.md +++ b/docs/content/dns/zz_gen_edgedns.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_exec.md b/docs/content/dns/zz_gen_exec.md index a8938645b..d2eb05d2b 100644 --- a/docs/content/dns/zz_gen_exec.md +++ b/docs/content/dns/zz_gen_exec.md @@ -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 diff --git a/docs/content/dns/zz_gen_exoscale.md b/docs/content/dns/zz_gen_exoscale.md index c1108ec89..430e288e5 100644 --- a/docs/content/dns/zz_gen_exoscale.md +++ b/docs/content/dns/zz_gen_exoscale.md @@ -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 | diff --git a/docs/content/dns/zz_gen_gandi.md b/docs/content/dns/zz_gen_gandi.md index 9ff3b68d0..fbbedf2ca 100644 --- a/docs/content/dns/zz_gen_gandi.md +++ b/docs/content/dns/zz_gen_gandi.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_gandiv5.md b/docs/content/dns/zz_gen_gandiv5.md index bf390d5ab..d9adf66e5 100644 --- a/docs/content/dns/zz_gen_gandiv5.md +++ b/docs/content/dns/zz_gen_gandiv5.md @@ -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/) diff --git a/docs/content/dns/zz_gen_glesys.md b/docs/content/dns/zz_gen_glesys.md index 0e34ff43a..afe5771c1 100644 --- a/docs/content/dns/zz_gen_glesys.md +++ b/docs/content/dns/zz_gen_glesys.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_godaddy.md b/docs/content/dns/zz_gen_godaddy.md index 84c23ce27..62000e3cc 100644 --- a/docs/content/dns/zz_gen_godaddy.md +++ b/docs/content/dns/zz_gen_godaddy.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_hetzner.md b/docs/content/dns/zz_gen_hetzner.md index 581f212fe..58699222a 100644 --- a/docs/content/dns/zz_gen_hetzner.md +++ b/docs/content/dns/zz_gen_hetzner.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_hostingde.md b/docs/content/dns/zz_gen_hostingde.md index a2596dd8a..3bf8f1170 100644 --- a/docs/content/dns/zz_gen_hostingde.md +++ b/docs/content/dns/zz_gen_hostingde.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_httpreq.md b/docs/content/dns/zz_gen_httpreq.md index 0896a4390..fee0825bb 100644 --- a/docs/content/dns/zz_gen_httpreq.md +++ b/docs/content/dns/zz_gen_httpreq.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_hyperone.md b/docs/content/dns/zz_gen_hyperone.md index 30dd79b9f..018ac46c1 100644 --- a/docs/content/dns/zz_gen_hyperone.md +++ b/docs/content/dns/zz_gen_hyperone.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_iij.md b/docs/content/dns/zz_gen_iij.md index 108656d1d..031b62763 100644 --- a/docs/content/dns/zz_gen_iij.md +++ b/docs/content/dns/zz_gen_iij.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_infomaniak.md b/docs/content/dns/zz_gen_infomaniak.md index a26425ed3..e62f0c3c4 100644 --- a/docs/content/dns/zz_gen_infomaniak.md +++ b/docs/content/dns/zz_gen_infomaniak.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_inwx.md b/docs/content/dns/zz_gen_inwx.md index 9adcdc054..cbee14811 100644 --- a/docs/content/dns/zz_gen_inwx.md +++ b/docs/content/dns/zz_gen_inwx.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_joker.md b/docs/content/dns/zz_gen_joker.md index 6582cea2b..93c71863f 100644 --- a/docs/content/dns/zz_gen_joker.md +++ b/docs/content/dns/zz_gen_joker.md @@ -25,17 +25,17 @@ Here is an example bash command using the Joker provider: JOKER_API_MODE=SVC \ JOKER_USERNAME= \ JOKER_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= \ JOKER_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= \ -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). diff --git a/docs/content/dns/zz_gen_linode.md b/docs/content/dns/zz_gen_linode.md index 3910def6b..b5dc4d8ca 100644 --- a/docs/content/dns/zz_gen_linode.md +++ b/docs/content/dns/zz_gen_linode.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_liquidweb.md b/docs/content/dns/zz_gen_liquidweb.md index 7312595a6..82e7c0797 100644 --- a/docs/content/dns/zz_gen_liquidweb.md +++ b/docs/content/dns/zz_gen_liquidweb.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_luadns.md b/docs/content/dns/zz_gen_luadns.md index aeba99ca7..f1e586d1b 100644 --- a/docs/content/dns/zz_gen_luadns.md +++ b/docs/content/dns/zz_gen_luadns.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_mydnsjp.md b/docs/content/dns/zz_gen_mydnsjp.md index 365cd2f5e..b5178b7af 100644 --- a/docs/content/dns/zz_gen_mydnsjp.md +++ b/docs/content/dns/zz_gen_mydnsjp.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_mythicbeasts.md b/docs/content/dns/zz_gen_mythicbeasts.md index f5cf2e1bb..a7cd43cf0 100644 --- a/docs/content/dns/zz_gen_mythicbeasts.md +++ b/docs/content/dns/zz_gen_mythicbeasts.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_namecheap.md b/docs/content/dns/zz_gen_namecheap.md index 92a25b957..8adaa0151 100644 --- a/docs/content/dns/zz_gen_namecheap.md +++ b/docs/content/dns/zz_gen_namecheap.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_namedotcom.md b/docs/content/dns/zz_gen_namedotcom.md index b4d2b4a51..c93ba558c 100644 --- a/docs/content/dns/zz_gen_namedotcom.md +++ b/docs/content/dns/zz_gen_namedotcom.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_namesilo.md b/docs/content/dns/zz_gen_namesilo.md index 32d95c2eb..f11e47322 100644 --- a/docs/content/dns/zz_gen_namesilo.md +++ b/docs/content/dns/zz_gen_namesilo.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_netcup.md b/docs/content/dns/zz_gen_netcup.md index bde8e38e5..5c520221d 100644 --- a/docs/content/dns/zz_gen_netcup.md +++ b/docs/content/dns/zz_gen_netcup.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_netlify.md b/docs/content/dns/zz_gen_netlify.md index 02a0ec730..23e1a7d6c 100644 --- a/docs/content/dns/zz_gen_netlify.md +++ b/docs/content/dns/zz_gen_netlify.md @@ -9,7 +9,7 @@ slug: netlify -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 ``` diff --git a/docs/content/dns/zz_gen_nifcloud.md b/docs/content/dns/zz_gen_nifcloud.md index d2ffeb281..f9ad32279 100644 --- a/docs/content/dns/zz_gen_nifcloud.md +++ b/docs/content/dns/zz_gen_nifcloud.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_ns1.md b/docs/content/dns/zz_gen_ns1.md index aecd2f09c..27678b0c9 100644 --- a/docs/content/dns/zz_gen_ns1.md +++ b/docs/content/dns/zz_gen_ns1.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_oraclecloud.md b/docs/content/dns/zz_gen_oraclecloud.md index 1561c7ba5..7d6631b4f 100644 --- a/docs/content/dns/zz_gen_oraclecloud.md +++ b/docs/content/dns/zz_gen_oraclecloud.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_ovh.md b/docs/content/dns/zz_gen_ovh.md index 8be15376c..bfeb355b5 100644 --- a/docs/content/dns/zz_gen_ovh.md +++ b/docs/content/dns/zz_gen_ovh.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_pdns.md b/docs/content/dns/zz_gen_pdns.md index 7e0be2a57..debe2a50c 100644 --- a/docs/content/dns/zz_gen_pdns.md +++ b/docs/content/dns/zz_gen_pdns.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_rackspace.md b/docs/content/dns/zz_gen_rackspace.md index dd0798ba3..91fbfa3f2 100644 --- a/docs/content/dns/zz_gen_rackspace.md +++ b/docs/content/dns/zz_gen_rackspace.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_regru.md b/docs/content/dns/zz_gen_regru.md index a4becf59b..8ce4e1d88 100644 --- a/docs/content/dns/zz_gen_regru.md +++ b/docs/content/dns/zz_gen_regru.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_rimuhosting.md b/docs/content/dns/zz_gen_rimuhosting.md index 2c6dd2f80..345c15f39 100644 --- a/docs/content/dns/zz_gen_rimuhosting.md +++ b/docs/content/dns/zz_gen_rimuhosting.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_sakuracloud.md b/docs/content/dns/zz_gen_sakuracloud.md index 51f8cf973..1024a3b16 100644 --- a/docs/content/dns/zz_gen_sakuracloud.md +++ b/docs/content/dns/zz_gen_sakuracloud.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_scaleway.md b/docs/content/dns/zz_gen_scaleway.md index 80da1f9a6..737bd5480 100644 --- a/docs/content/dns/zz_gen_scaleway.md +++ b/docs/content/dns/zz_gen_scaleway.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_selectel.md b/docs/content/dns/zz_gen_selectel.md index 7972ca48c..fdb8b6e81 100644 --- a/docs/content/dns/zz_gen_selectel.md +++ b/docs/content/dns/zz_gen_selectel.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_servercow.md b/docs/content/dns/zz_gen_servercow.md index 4502534d4..219b8b785 100644 --- a/docs/content/dns/zz_gen_servercow.md +++ b/docs/content/dns/zz_gen_servercow.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_stackpath.md b/docs/content/dns/zz_gen_stackpath.md index 920d897e9..d6b38fcb9 100644 --- a/docs/content/dns/zz_gen_stackpath.md +++ b/docs/content/dns/zz_gen_stackpath.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_transip.md b/docs/content/dns/zz_gen_transip.md index c34fccfdf..ac2c758e6 100644 --- a/docs/content/dns/zz_gen_transip.md +++ b/docs/content/dns/zz_gen_transip.md @@ -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 ``` diff --git a/docs/content/dns/zz_gen_versio.md b/docs/content/dns/zz_gen_versio.md index b3c7ca528..9ce707227 100644 --- a/docs/content/dns/zz_gen_versio.md +++ b/docs/content/dns/zz_gen_versio.md @@ -23,7 +23,7 @@ Here is an example bash command using the Versio.[nl|eu|uk] provider: ```bash VERSIO_USERNAME= \ VERSIO_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 ``` diff --git a/docs/content/dns/zz_gen_vscale.md b/docs/content/dns/zz_gen_vscale.md index 0e9ccd87e..26c694606 100644 --- a/docs/content/dns/zz_gen_vscale.md +++ b/docs/content/dns/zz_gen_vscale.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_vultr.md b/docs/content/dns/zz_gen_vultr.md index 7e43ee18c..f5dc14a2d 100644 --- a/docs/content/dns/zz_gen_vultr.md +++ b/docs/content/dns/zz_gen_vultr.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_yandex.md b/docs/content/dns/zz_gen_yandex.md index 24e1d732b..36cf2393e 100644 --- a/docs/content/dns/zz_gen_yandex.md +++ b/docs/content/dns/zz_gen_yandex.md @@ -22,7 +22,7 @@ Here is an example bash command using the Yandex provider: ```bash YANDEX_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 ``` diff --git a/docs/content/dns/zz_gen_zoneee.md b/docs/content/dns/zz_gen_zoneee.md index f14564586..845573b3f 100644 --- a/docs/content/dns/zz_gen_zoneee.md +++ b/docs/content/dns/zz_gen_zoneee.md @@ -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 +``` diff --git a/docs/content/dns/zz_gen_zonomi.md b/docs/content/dns/zz_gen_zonomi.md index 079c6da66..f9f54473d 100644 --- a/docs/content/dns/zz_gen_zonomi.md +++ b/docs/content/dns/zz_gen_zonomi.md @@ -9,7 +9,7 @@ slug: zonomi -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 ``` diff --git a/providers/dns/acmedns/acmedns.toml b/providers/dns/acmedns/acmedns.toml index 2fb4a0d81..ade29c2d0 100644 --- a/providers/dns/acmedns/acmedns.toml +++ b/providers/dns/acmedns/acmedns.toml @@ -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] diff --git a/providers/dns/alidns/alidns.toml b/providers/dns/alidns/alidns.toml index 4f613f91e..ca4b0185c 100644 --- a/providers/dns/alidns/alidns.toml +++ b/providers/dns/alidns/alidns.toml @@ -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] diff --git a/providers/dns/arvancloud/arvancloud.toml b/providers/dns/arvancloud/arvancloud.toml index 0557b6f49..382228983 100644 --- a/providers/dns/arvancloud/arvancloud.toml +++ b/providers/dns/arvancloud/arvancloud.toml @@ -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] diff --git a/providers/dns/auroradns/auroradns.toml b/providers/dns/auroradns/auroradns.toml index be2e946ac..172e13a13 100644 --- a/providers/dns/auroradns/auroradns.toml +++ b/providers/dns/auroradns/auroradns.toml @@ -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" diff --git a/providers/dns/autodns/autodns.toml b/providers/dns/autodns/autodns.toml index 7a05cedb9..82dbe76c6 100644 --- a/providers/dns/autodns/autodns.toml +++ b/providers/dns/autodns/autodns.toml @@ -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] diff --git a/providers/dns/bindman/bindman.toml b/providers/dns/bindman/bindman.toml index b9f44d3c9..c20937535 100644 --- a/providers/dns/bindman/bindman.toml +++ b/providers/dns/bindman/bindman.toml @@ -6,7 +6,7 @@ Since = "v2.6.0" Example = ''' 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] diff --git a/providers/dns/checkdomain/checkdomain.toml b/providers/dns/checkdomain/checkdomain.toml index ff2517514..b8de672fc 100644 --- a/providers/dns/checkdomain/checkdomain.toml +++ b/providers/dns/checkdomain/checkdomain.toml @@ -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] diff --git a/providers/dns/clouddns/clouddns.toml b/providers/dns/clouddns/clouddns.toml index bbc0d3546..654cb55bc 100644 --- a/providers/dns/clouddns/clouddns.toml +++ b/providers/dns/clouddns/clouddns.toml @@ -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] diff --git a/providers/dns/cloudflare/cloudflare.toml b/providers/dns/cloudflare/cloudflare.toml index f29341ba8..1c47d32c7 100644 --- a/providers/dns/cloudflare/cloudflare.toml +++ b/providers/dns/cloudflare/cloudflare.toml @@ -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 = ''' diff --git a/providers/dns/cloudns/cloudns.toml b/providers/dns/cloudns/cloudns.toml index 493fa196c..8d301efc2 100644 --- a/providers/dns/cloudns/cloudns.toml +++ b/providers/dns/cloudns/cloudns.toml @@ -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] diff --git a/providers/dns/cloudxns/cloudxns.toml b/providers/dns/cloudxns/cloudxns.toml index 1330d614e..0309757b5 100644 --- a/providers/dns/cloudxns/cloudxns.toml +++ b/providers/dns/cloudxns/cloudxns.toml @@ -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] diff --git a/providers/dns/conoha/conoha.toml b/providers/dns/conoha/conoha.toml index 730145192..42a7b2098 100644 --- a/providers/dns/conoha/conoha.toml +++ b/providers/dns/conoha/conoha.toml @@ -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] diff --git a/providers/dns/constellix/constellix.toml b/providers/dns/constellix/constellix.toml index 8ed2fdcab..67b72fb16 100644 --- a/providers/dns/constellix/constellix.toml +++ b/providers/dns/constellix/constellix.toml @@ -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] diff --git a/providers/dns/desec/desec.toml b/providers/dns/desec/desec.toml index cfb232351..51bbcf3be 100644 --- a/providers/dns/desec/desec.toml +++ b/providers/dns/desec/desec.toml @@ -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] diff --git a/providers/dns/digitalocean/digitalocean.toml b/providers/dns/digitalocean/digitalocean.toml index 7dbb123d3..6c77bca70 100644 --- a/providers/dns/digitalocean/digitalocean.toml +++ b/providers/dns/digitalocean/digitalocean.toml @@ -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] diff --git a/providers/dns/dnsimple/dnsimple.toml b/providers/dns/dnsimple/dnsimple.toml index 82a2f40e6..eadf38464 100644 --- a/providers/dns/dnsimple/dnsimple.toml +++ b/providers/dns/dnsimple/dnsimple.toml @@ -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 = ''' diff --git a/providers/dns/dnsmadeeasy/dnsmadeeasy.toml b/providers/dns/dnsmadeeasy/dnsmadeeasy.toml index a3e927049..24b98f0d4 100644 --- a/providers/dns/dnsmadeeasy/dnsmadeeasy.toml +++ b/providers/dns/dnsmadeeasy/dnsmadeeasy.toml @@ -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] diff --git a/providers/dns/dnspod/dnspod.toml b/providers/dns/dnspod/dnspod.toml index c11f22200..7edddc961 100644 --- a/providers/dns/dnspod/dnspod.toml +++ b/providers/dns/dnspod/dnspod.toml @@ -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] diff --git a/providers/dns/dode/dode.toml b/providers/dns/dode/dode.toml index 470b73062..16551dd20 100644 --- a/providers/dns/dode/dode.toml +++ b/providers/dns/dode/dode.toml @@ -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] diff --git a/providers/dns/dreamhost/dreamhost.toml b/providers/dns/dreamhost/dreamhost.toml index 2b79e6915..75299877d 100644 --- a/providers/dns/dreamhost/dreamhost.toml +++ b/providers/dns/dreamhost/dreamhost.toml @@ -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] diff --git a/providers/dns/duckdns/duckdns.toml b/providers/dns/duckdns/duckdns.toml index 6aebf8eee..7089460bf 100644 --- a/providers/dns/duckdns/duckdns.toml +++ b/providers/dns/duckdns/duckdns.toml @@ -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] diff --git a/providers/dns/dyn/dyn.toml b/providers/dns/dyn/dyn.toml index d351e8e14..942f648c4 100644 --- a/providers/dns/dyn/dyn.toml +++ b/providers/dns/dyn/dyn.toml @@ -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] diff --git a/providers/dns/dynu/dynu.toml b/providers/dns/dynu/dynu.toml index 34b02a373..f719323e2 100644 --- a/providers/dns/dynu/dynu.toml +++ b/providers/dns/dynu/dynu.toml @@ -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] diff --git a/providers/dns/easydns/easydns.toml b/providers/dns/easydns/easydns.toml index 01e866e66..8a1df8860 100644 --- a/providers/dns/easydns/easydns.toml +++ b/providers/dns/easydns/easydns.toml @@ -7,7 +7,7 @@ Since = "v2.6.0" Example = ''' EASYDNS_TOKEN= \ EASYDNS_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 = ''' diff --git a/providers/dns/edgedns/edgedns.toml b/providers/dns/edgedns/edgedns.toml index 97a0bc407..1d4f42ac3 100644 --- a/providers/dns/edgedns/edgedns.toml +++ b/providers/dns/edgedns/edgedns.toml @@ -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] diff --git a/providers/dns/exec/exec.toml b/providers/dns/exec/exec.toml index 615c55d90..e7a576f35 100644 --- a/providers/dns/exec/exec.toml +++ b/providers/dns/exec/exec.toml @@ -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 diff --git a/providers/dns/exoscale/exoscale.toml b/providers/dns/exoscale/exoscale.toml index 038944608..6761410ed 100644 --- a/providers/dns/exoscale/exoscale.toml +++ b/providers/dns/exoscale/exoscale.toml @@ -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" diff --git a/providers/dns/gandi/gandi.toml b/providers/dns/gandi/gandi.toml index ec866b823..7f974c19c 100644 --- a/providers/dns/gandi/gandi.toml +++ b/providers/dns/gandi/gandi.toml @@ -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] diff --git a/providers/dns/gandiv5/gandiv5.toml b/providers/dns/gandiv5/gandiv5.toml index bd2ffd924..0570f1033 100644 --- a/providers/dns/gandiv5/gandiv5.toml +++ b/providers/dns/gandiv5/gandiv5.toml @@ -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/" diff --git a/providers/dns/glesys/glesys.toml b/providers/dns/glesys/glesys.toml index c65c32f43..178929759 100644 --- a/providers/dns/glesys/glesys.toml +++ b/providers/dns/glesys/glesys.toml @@ -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] diff --git a/providers/dns/godaddy/godaddy.toml b/providers/dns/godaddy/godaddy.toml index 3e6f3ab43..670f0274d 100644 --- a/providers/dns/godaddy/godaddy.toml +++ b/providers/dns/godaddy/godaddy.toml @@ -7,7 +7,7 @@ Since = "v0.5.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/hetzner/hetzner.toml b/providers/dns/hetzner/hetzner.toml index 1ef3c80fc..417d98b33 100644 --- a/providers/dns/hetzner/hetzner.toml +++ b/providers/dns/hetzner/hetzner.toml @@ -6,7 +6,7 @@ Since = "v3.7.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/hostingde/hostingde.toml b/providers/dns/hostingde/hostingde.toml index f19c4941c..72654cfd5 100644 --- a/providers/dns/hostingde/hostingde.toml +++ b/providers/dns/hostingde/hostingde.toml @@ -4,6 +4,12 @@ URL = "https://www.hosting.de/" Code = "hostingde" Since = "v1.1.0" +Example = ''' +HOSTINGDE_API_KEY=xxxxxxxx \ +HOSTINGDE_ZONE_NAME=yyyyy \ +lego -email myemail@example.com --dns hostingde --domains my.example.org -run +''' + [Configuration] [Configuration.Credentials] HOSTINGDE_API_KEY = "API key" diff --git a/providers/dns/httpreq/httpreq.toml b/providers/dns/httpreq/httpreq.toml index 64750678e..36c8f0a8d 100644 --- a/providers/dns/httpreq/httpreq.toml +++ b/providers/dns/httpreq/httpreq.toml @@ -6,7 +6,7 @@ Since = "v2.0.0" Example = ''' 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 ''' Additional = ''' diff --git a/providers/dns/hyperone/hyperone.toml b/providers/dns/hyperone/hyperone.toml index a16f72616..d1a9e6929 100644 --- a/providers/dns/hyperone/hyperone.toml +++ b/providers/dns/hyperone/hyperone.toml @@ -4,7 +4,7 @@ URL = "https://www.hyperone.com" Code = "hyperone" Example = ''' -lego --dns hyperone --domains my.domain.com --email my@email.com run +lego --email myemail@example.com --dns hyperone --domains my.example.org run ''' Additional = ''' diff --git a/providers/dns/iij/iij.toml b/providers/dns/iij/iij.toml index 5232af0e1..9494be343 100644 --- a/providers/dns/iij/iij.toml +++ b/providers/dns/iij/iij.toml @@ -4,7 +4,12 @@ URL = "https://www.iij.ad.jp/en/" Code = "iij" Since = "v1.1.0" -Example = '''''' +Example = ''' +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 +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/infomaniak/infomaniak.toml b/providers/dns/infomaniak/infomaniak.toml index 01691f997..a5583eef3 100644 --- a/providers/dns/infomaniak/infomaniak.toml +++ b/providers/dns/infomaniak/infomaniak.toml @@ -6,7 +6,7 @@ Since = "v4.1.0" Example = ''' 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 ''' Additional = ''' diff --git a/providers/dns/inwx/inwx.toml b/providers/dns/inwx/inwx.toml index 95a9494a5..4a05cf3e5 100644 --- a/providers/dns/inwx/inwx.toml +++ b/providers/dns/inwx/inwx.toml @@ -7,13 +7,13 @@ Since = "v2.0.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/joker/joker.toml b/providers/dns/joker/joker.toml index a7137b5dc..d60c67546 100644 --- a/providers/dns/joker/joker.toml +++ b/providers/dns/joker/joker.toml @@ -9,23 +9,23 @@ Example = ''' JOKER_API_MODE=SVC \ JOKER_USERNAME= \ JOKER_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= \ JOKER_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= \ -lego --dns joker --domains my.domain.com --email my@email.com run +lego --email myemail@example.com --dns joker --domains my.example.org run ''' [Configuration] [Configuration.Credentials] JOKER_API_MODE = "'DMAPI' or 'SVC'. DMAPI is for resellers accounts. (Default: DMAPI)" - JOKER_USERNAME = "Joker.com username (email address)" + JOKER_USERNAME = "Joker.com username" JOKER_PASSWORD = "Joker.com password" JOKER_API_KEY = "API key (only with DMAPI mode)" [Configuration.Additional] diff --git a/providers/dns/linode/linode.toml b/providers/dns/linode/linode.toml index a124e989d..d373ceb7e 100644 --- a/providers/dns/linode/linode.toml +++ b/providers/dns/linode/linode.toml @@ -4,7 +4,10 @@ URL = "https://www.linode.com/" Code = "linode" Since = "v1.1.0" -Example = '''''' +Example = ''' +LINODE_TOKEN=xxxxx \ +lego --email myemail@example.com --dns linode --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/liquidweb/liquidweb.toml b/providers/dns/liquidweb/liquidweb.toml index 2b7dbcbb0..3aec0197e 100644 --- a/providers/dns/liquidweb/liquidweb.toml +++ b/providers/dns/liquidweb/liquidweb.toml @@ -6,9 +6,9 @@ Since = "v3.1.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/luadns/luadns.toml b/providers/dns/luadns/luadns.toml index 89ce16599..5049f6776 100644 --- a/providers/dns/luadns/luadns.toml +++ b/providers/dns/luadns/luadns.toml @@ -7,7 +7,7 @@ Since = "v3.7.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/mydnsjp/mydnsjp.toml b/providers/dns/mydnsjp/mydnsjp.toml index 37b6bb854..f55f98ccc 100644 --- a/providers/dns/mydnsjp/mydnsjp.toml +++ b/providers/dns/mydnsjp/mydnsjp.toml @@ -4,7 +4,11 @@ URL = "https://www.mydns.jp" Code = "mydnsjp" Since = "v1.2.0" -Example = '''''' +Example = ''' +MYDNSJP_MASTER_ID=xxxxx \ +MYDNSJP_PASSWORD=xxxxx \ +lego --email myemail@example.com --dns mydnsjp --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/mythicbeasts/mythicbeasts.toml b/providers/dns/mythicbeasts/mythicbeasts.toml index f977f3e50..100e7e43c 100644 --- a/providers/dns/mythicbeasts/mythicbeasts.toml +++ b/providers/dns/mythicbeasts/mythicbeasts.toml @@ -7,7 +7,7 @@ Since = "v0.3.7" Example = ''' 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 ''' Additional = ''' diff --git a/providers/dns/namecheap/namecheap.toml b/providers/dns/namecheap/namecheap.toml index 68df3cefe..8bf37fa3d 100644 --- a/providers/dns/namecheap/namecheap.toml +++ b/providers/dns/namecheap/namecheap.toml @@ -12,7 +12,7 @@ Configuration for [Namecheap](https://www.namecheap.com). Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/namedotcom/namedotcom.toml b/providers/dns/namedotcom/namedotcom.toml index a4be1236b..30c750aaa 100644 --- a/providers/dns/namedotcom/namedotcom.toml +++ b/providers/dns/namedotcom/namedotcom.toml @@ -7,7 +7,7 @@ Since = "v0.5.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/namesilo/namesilo.toml b/providers/dns/namesilo/namesilo.toml index 89a455c4f..15c9590db 100644 --- a/providers/dns/namesilo/namesilo.toml +++ b/providers/dns/namesilo/namesilo.toml @@ -6,7 +6,7 @@ Since = "v2.7.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/netcup/netcup.toml b/providers/dns/netcup/netcup.toml index 992e868a0..01770415b 100644 --- a/providers/dns/netcup/netcup.toml +++ b/providers/dns/netcup/netcup.toml @@ -4,7 +4,12 @@ URL = "https://www.netcup.eu/" Code = "netcup" Since = "v1.1.0" -Example = '''''' +Example = ''' +NETCUP_CUSTOMER_NUMBER=xxxx \ +NETCUP_API_KEY=yyyy \ +NETCUP_API_PASSWORD=zzzz \ +lego --email myemail@example.com --dns netcup --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/netlify/netlify.toml b/providers/dns/netlify/netlify.toml index 7d99807a6..39da538e8 100644 --- a/providers/dns/netlify/netlify.toml +++ b/providers/dns/netlify/netlify.toml @@ -2,11 +2,11 @@ Name = "Netlify" Description = '''''' URL = "https://www.netlify.com" Code = "netlify" -Since = "v0.3.7" +Since = "v3.7.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/nifcloud/nifcloud.toml b/providers/dns/nifcloud/nifcloud.toml index 9394cc8e6..fe0117fbc 100644 --- a/providers/dns/nifcloud/nifcloud.toml +++ b/providers/dns/nifcloud/nifcloud.toml @@ -4,7 +4,11 @@ URL = "https://www.nifcloud.com/" Code = "nifcloud" Since = "v1.1.0" -Example = '''''' +Example = ''' +NIFCLOUD_ACCESS_KEY_ID=xxxx \ +NIFCLOUD_SECRET_ACCESS_KEY=yyyy \ +lego --email myemail@example.com --dns nifcloud --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/ns1/ns1.toml b/providers/dns/ns1/ns1.toml index 94200cf34..4893bb25b 100644 --- a/providers/dns/ns1/ns1.toml +++ b/providers/dns/ns1/ns1.toml @@ -4,7 +4,10 @@ URL = "https://ns1.com" Code = "ns1" Since = "v0.4.0" -Example = '''''' +Example = ''' +NS1_API_KEY=xxxx \ +lego --email myemail@example.com --dns ns1 --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/oraclecloud/oraclecloud.toml b/providers/dns/oraclecloud/oraclecloud.toml index d9c519c17..1465faba7 100644 --- a/providers/dns/oraclecloud/oraclecloud.toml +++ b/providers/dns/oraclecloud/oraclecloud.toml @@ -12,7 +12,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 ''' [Configuration] diff --git a/providers/dns/ovh/ovh.toml b/providers/dns/ovh/ovh.toml index 3be1f47ae..deb8eafa5 100644 --- a/providers/dns/ovh/ovh.toml +++ b/providers/dns/ovh/ovh.toml @@ -9,7 +9,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 ''' Additional = ''' diff --git a/providers/dns/pdns/pdns.toml b/providers/dns/pdns/pdns.toml index 6c913754a..a9072b99a 100644 --- a/providers/dns/pdns/pdns.toml +++ b/providers/dns/pdns/pdns.toml @@ -4,7 +4,11 @@ URL = "https://www.powerdns.com/" Code = "pdns" Since = "v0.4.0" -Example = '''''' +Example = ''' +PDNS_API_URL=http://pdns-server:80/ \ +PDNS_API_KEY=xxxx \ +lego --email myemail@example.com --dns pdns --domains my.example.org run +''' Additional = ''' ## Information diff --git a/providers/dns/rackspace/rackspace.toml b/providers/dns/rackspace/rackspace.toml index 5688ddb92..a0110363c 100644 --- a/providers/dns/rackspace/rackspace.toml +++ b/providers/dns/rackspace/rackspace.toml @@ -4,7 +4,11 @@ URL = "https://www.rackspace.com/" Code = "rackspace" Since = "v0.4.0" -Example = '''''' +Example = ''' +RACKSPACE_USER=xxxx \ +RACKSPACE_API_KEY=yyyy \ +lego --email myemail@example.com --dns rackspace --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/regru/regru.toml b/providers/dns/regru/regru.toml index 462c6448b..a4511c04a 100644 --- a/providers/dns/regru/regru.toml +++ b/providers/dns/regru/regru.toml @@ -6,8 +6,8 @@ Since = "v3.5.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/rimuhosting/rimuhosting.toml b/providers/dns/rimuhosting/rimuhosting.toml index b91a5d3b9..b2bc3c2fb 100644 --- a/providers/dns/rimuhosting/rimuhosting.toml +++ b/providers/dns/rimuhosting/rimuhosting.toml @@ -6,7 +6,7 @@ Since = "v0.3.5" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/sakuracloud/sakuracloud.toml b/providers/dns/sakuracloud/sakuracloud.toml index 0dfcb944c..88e224a75 100644 --- a/providers/dns/sakuracloud/sakuracloud.toml +++ b/providers/dns/sakuracloud/sakuracloud.toml @@ -4,7 +4,11 @@ URL = "https://cloud.sakura.ad.jp/" Code = "sakuracloud" Since = "v1.1.0" -Example = '''''' +Example = ''' +SAKURACLOUD_ACCESS_TOKEN=xxxxx \ +SAKURACLOUD_ACCESS_TOKEN_SECRET=yyyyy \ +lego --email myemail@example.com --dns sakuracloud --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/scaleway/scaleway.toml b/providers/dns/scaleway/scaleway.toml index 8f8125089..845188917 100644 --- a/providers/dns/scaleway/scaleway.toml +++ b/providers/dns/scaleway/scaleway.toml @@ -6,7 +6,7 @@ Since = "v3.4.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/selectel/selectel.toml b/providers/dns/selectel/selectel.toml index 2d9ee4861..388ea301d 100644 --- a/providers/dns/selectel/selectel.toml +++ b/providers/dns/selectel/selectel.toml @@ -4,7 +4,10 @@ URL = "https://kb.selectel.com/" Code = "selectel" Since = "v1.2.0" -Example = '''''' +Example = ''' +SELECTEL_API_TOKEN=xxxxx \ +lego --email myemail@example.com --dns selectel --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/servercow/servercow.toml b/providers/dns/servercow/servercow.toml index 7a3bb5583..1f425996c 100644 --- a/providers/dns/servercow/servercow.toml +++ b/providers/dns/servercow/servercow.toml @@ -7,7 +7,7 @@ Since = "v3.4.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/stackpath/stackpath.toml b/providers/dns/stackpath/stackpath.toml index 1a492ebb8..0f0905884 100644 --- a/providers/dns/stackpath/stackpath.toml +++ b/providers/dns/stackpath/stackpath.toml @@ -4,7 +4,12 @@ URL = "https://www.stackpath.com/" Code = "stackpath" Since = "v1.1.0" -Example = '''''' +Example = ''' +STACKPATH_CLIENT_ID=xxxxx \ +STACKPATH_CLIENT_SECRET=yyyyy \ +STACKPATH_STACK_ID=zzzzz \ +lego --email myemail@example.com --dns stackpath --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/transip/transip.toml b/providers/dns/transip/transip.toml index 2bfc32401..7ce6bb8a8 100644 --- a/providers/dns/transip/transip.toml +++ b/providers/dns/transip/transip.toml @@ -7,7 +7,7 @@ Since = "v2.0.0" Example = ''' 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 ''' [Configuration] diff --git a/providers/dns/versio/versio.toml b/providers/dns/versio/versio.toml index 697a1ce35..fbe330fc4 100644 --- a/providers/dns/versio/versio.toml +++ b/providers/dns/versio/versio.toml @@ -7,7 +7,7 @@ Since = "v2.7.0" Example = ''' VERSIO_USERNAME= \ VERSIO_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 ''' Additional = ''' diff --git a/providers/dns/vscale/vscale.toml b/providers/dns/vscale/vscale.toml index 341eb22c8..b68a1dab8 100644 --- a/providers/dns/vscale/vscale.toml +++ b/providers/dns/vscale/vscale.toml @@ -4,7 +4,10 @@ URL = "https://vscale.io/" Code = "vscale" Since = "v2.0.0" -Example = '''''' +Example = ''' +VSCALE_API_TOKEN=xxxxx \ +lego --email myemail@example.com --dns vscale --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/vultr/vultr.toml b/providers/dns/vultr/vultr.toml index 8e59a0d5e..93e47324e 100644 --- a/providers/dns/vultr/vultr.toml +++ b/providers/dns/vultr/vultr.toml @@ -4,7 +4,10 @@ URL = "https://www.vultr.com/" Code = "vultr" Since = "v0.3.1" -Example = '''''' +Example = ''' +VULTR_API_KEY=xxxxx \ +lego --email myemail@example.com --dns vultr --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/yandex/yandex.toml b/providers/dns/yandex/yandex.toml index 4500fd292..92e4c7af8 100644 --- a/providers/dns/yandex/yandex.toml +++ b/providers/dns/yandex/yandex.toml @@ -6,7 +6,7 @@ Since = "v3.7.0" Example = ''' YANDEX_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 ''' [Configuration] diff --git a/providers/dns/zoneee/zoneee.toml b/providers/dns/zoneee/zoneee.toml index fbff725c4..b087b8b1a 100644 --- a/providers/dns/zoneee/zoneee.toml +++ b/providers/dns/zoneee/zoneee.toml @@ -4,7 +4,11 @@ URL = "https://www.zone.ee/" Code = "zoneee" Since = "v2.1.0" -Example = '''''' +Example = ''' +ZONEEE_API_USER=xxxxx \ +ZONEEE_API_KEY=yyyyy \ +lego --email myemail@example.com --dns zoneee --domains my.example.org run +''' [Configuration] [Configuration.Credentials] diff --git a/providers/dns/zonomi/zonomi.toml b/providers/dns/zonomi/zonomi.toml index 8d1793411..f26a3a638 100644 --- a/providers/dns/zonomi/zonomi.toml +++ b/providers/dns/zonomi/zonomi.toml @@ -2,11 +2,11 @@ Name = "Zonomi" Description = '''''' URL = "https://zonomi.com" Code = "zonomi" -Since = "v0.3.5" +Since = "v3.5.0" Example = ''' 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 ''' [Configuration]