Skip to content

Commit 815c61a

Browse files
authored
docs: use homogenous examples (#2328)
1 parent f2f5550 commit 815c61a

File tree

273 files changed

+327
-342
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

273 files changed

+327
-342
lines changed

docs/content/dns/zz_gen_acme-dns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Joohoi's ACME-DNS provider:
2828
```bash
2929
ACME_DNS_API_BASE=http://10.0.0.8:4443 \
3030
ACME_DNS_STORAGE_PATH=/root/.lego-acme-dns-accounts.json \
31-
lego --email you@example.com --dns acme-dns --domains my.example.org run
31+
lego --email you@example.com --dns "acme-dns" -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_alidns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Here is an example bash command using the Alibaba Cloud DNS provider:
2828
```bash
2929
# Setup using instance RAM role
3030
ALICLOUD_RAM_ROLE=lego \
31-
lego --email you@example.com --dns alidns --domains my.example.org run
31+
lego --email you@example.com --dns alidns -d '*.example.com' -d example.com run
3232

3333
# Or, using credentials
3434
ALICLOUD_ACCESS_KEY=abcdefghijklmnopqrstuvwx \
3535
ALICLOUD_SECRET_KEY=your-secret-key \
3636
ALICLOUD_SECURITY_TOKEN=your-sts-token \
37-
lego --email you@example.com --dns alidns --domains my.example.org run
37+
lego --email you@example.com --dns alidns - -d '*.example.com' -d example.com run
3838
```
3939

4040

docs/content/dns/zz_gen_allinkl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the all-inkl provider:
2828
```bash
2929
ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
3030
ALL_INKL_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \
31-
lego --email you@example.com --dns allinkl --domains my.example.org run
31+
lego --email you@example.com --dns allinkl -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_arvancloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the ArvanCloud provider:
2727

2828
```bash
2929
ARVANCLOUD_API_KEY="Apikey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
30-
lego --email you@example.com --dns arvancloud --domains my.example.org run
30+
lego --email you@example.com --dns arvancloud -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_auroradns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Aurora DNS provider:
2828
```bash
2929
AURORA_API_KEY=xxxxx \
3030
AURORA_SECRET=yyyyyy \
31-
lego --email you@example.com --dns auroradns --domains my.example.org run
31+
lego --email you@example.com --dns auroradns -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_autodns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Autodns provider:
2828
```bash
2929
AUTODNS_API_USER=username \
3030
AUTODNS_API_PASSWORD=supersecretpassword \
31-
lego --email you@example.com --dns autodns --domains my.example.org run
31+
lego --email you@example.com --dns autodns -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_azuredns.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,32 @@ Here is an example bash command using the Azure DNS provider:
3131
AZURE_CLIENT_ID=<your service principal client ID> \
3232
AZURE_TENANT_ID=<your service principal tenant ID> \
3333
AZURE_CLIENT_SECRET=<your service principal client secret> \
34-
lego --domains example.com --email your_example@email.com --dns azuredns run
34+
lego --email you@example.com --dns azuredns -d '*.example.com' -d example.com run
3535

3636
### Using client certificate
3737

3838
AZURE_CLIENT_ID=<your service principal client ID> \
3939
AZURE_TENANT_ID=<your service principal tenant ID> \
4040
AZURE_CLIENT_CERTIFICATE_PATH=<your service principal certificate path> \
41-
lego --domains example.com --email your_example@email.com --dns azuredns run
41+
lego --email you@example.com --dns azuredns -d '*.example.com' -d example.com run
4242

4343
### Using Azure CLI
4444

4545
az login \
46-
lego --domains example.com --email your_example@email.com --dns azuredns run
46+
lego --email you@example.com --dns azuredns -d '*.example.com' -d example.com run
4747

4848
### Using Managed Identity (Azure VM)
4949

5050
AZURE_TENANT_ID=<your service principal tenant ID> \
5151
AZURE_RESOURCE_GROUP=<your target zone resource group name> \
52-
lego --domains example.com --email your_example@email.com --dns azuredns run
52+
lego --email you@example.com --dns azuredns -d '*.example.com' -d example.com run
5353

5454
### Using Managed Identity (Azure Arc)
5555

5656
AZURE_TENANT_ID=<your service principal tenant ID> \
5757
IMDS_ENDPOINT=http://localhost:40342 \
5858
IDENTITY_ENDPOINT=http://localhost:40342/metadata/identity/oauth2/token \
59-
lego --domains example.com --email your_example@email.com --dns azuredns run
59+
lego --email you@example.com --dns azuredns -d '*.example.com' -d example.com run
6060

6161
```
6262

docs/content/dns/zz_gen_bindman.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Bindman provider:
2727

2828
```bash
2929
BINDMAN_MANAGER_ADDRESS=<your bindman manager address> \
30-
lego --email you@example.com --dns bindman --domains my.example.org run
30+
lego --email you@example.com --dns bindman -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_bluecat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ BLUECAT_USER_NAME=myusername \
3232
BLUECAT_CONFIG_NAME=myconfig \
3333
BLUECAT_SERVER_URL=https://bam.example.com \
3434
BLUECAT_TTL=30 \
35-
lego --email you@example.com --dns bluecat --domains my.example.org run
35+
lego --email you@example.com --dns bluecat -d '*.example.com' -d example.com run
3636
```
3737

3838

docs/content/dns/zz_gen_brandit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Here is an example bash command using the Brandit (deprecated) provider:
3131
```bash
3232
BRANDIT_API_KEY=xxxxxxxxxxxxxxxxxxxxx \
3333
BRANDIT_API_USERNAME=yyyyyyyyyyyyyyyyyyyy \
34-
lego --email myemail@example.com --dns brandit --domains my.example.org run
34+
lego --email you@example.com --dns brandit -d '*.example.com' -d example.com run
3535
```
3636

3737

docs/content/dns/zz_gen_bunny.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Bunny provider:
2727

2828
```bash
2929
BUNNY_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
30-
lego --email you@example.com --dns bunny --domains my.example.org run
30+
lego --email you@example.com --dns bunny -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_checkdomain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Checkdomain provider:
2727

2828
```bash
2929
CHECKDOMAIN_TOKEN=yoursecrettoken \
30-
lego --email you@example.com --dns checkdomain --domains my.example.org run
30+
lego --email you@example.com --dns checkdomain -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_civo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Civo provider:
2727

2828
```bash
2929
CIVO_TOKEN=xxxxxx \
30-
lego --email you@example.com --dns civo --domains my.example.org run
30+
lego --email you@example.com --dns civo -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_clouddns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Here is an example bash command using the CloudDNS provider:
2929
CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \
3030
CLOUDDNS_EMAIL=you@example.com \
3131
CLOUDDNS_PASSWORD=b9841238feb177a84330f \
32-
lego --email you@example.com --dns clouddns --domains my.example.org run
32+
lego --email you@example.com --dns clouddns -d '*.example.com' -d example.com run
3333
```
3434

3535

docs/content/dns/zz_gen_cloudflare.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Here is an example bash command using the Cloudflare provider:
2828
```bash
2929
CLOUDFLARE_EMAIL=you@example.com \
3030
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
31-
lego --email you@example.com --dns cloudflare --domains my.example.org run
31+
lego --email you@example.com --dns cloudflare -d '*.example.com' -d example.com run
3232

3333
# or
3434

3535
CLOUDFLARE_DNS_API_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
36-
lego --email you@example.com --dns cloudflare --domains my.example.org run
36+
lego --email you@example.com --dns cloudflare -d '*.example.com' -d example.com run
3737
```
3838

3939

docs/content/dns/zz_gen_cloudns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the ClouDNS provider:
2828
```bash
2929
CLOUDNS_AUTH_ID=xxxx \
3030
CLOUDNS_AUTH_PASSWORD=yyyy \
31-
lego --email you@example.com --dns cloudns --domains my.example.org run
31+
lego --email you@example.com --dns cloudns -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_cloudru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Here is an example bash command using the Cloud.ru provider:
2929
CLOUDRU_SERVICE_INSTANCE_ID=ppp \
3030
CLOUDRU_KEY_ID=xxx \
3131
CLOUDRU_SECRET=yyy \
32-
lego --email you@example.com --dns cloudru --domains my.example.org run
32+
lego --email you@example.com --dns cloudru -d '*.example.com' -d example.com run
3333
```
3434

3535

docs/content/dns/zz_gen_cloudxns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the CloudXNS (Deprecated) provider:
2828
```bash
2929
CLOUDXNS_API_KEY=xxxx \
3030
CLOUDXNS_SECRET_KEY=yyyy \
31-
lego --email you@example.com --dns cloudxns --domains my.example.org run
31+
lego --email you@example.com --dns cloudxns -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_conoha.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Here is an example bash command using the ConoHa provider:
2929
CONOHA_TENANT_ID=487727e3921d44e3bfe7ebb337bf085e \
3030
CONOHA_API_USERNAME=xxxx \
3131
CONOHA_API_PASSWORD=yyyy \
32-
lego --email you@example.com --dns conoha --domains my.example.org run
32+
lego --email you@example.com --dns conoha -d '*.example.com' -d example.com run
3333
```
3434

3535

docs/content/dns/zz_gen_constellix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Constellix provider:
2828
```bash
2929
CONSTELLIX_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
3030
CONSTELLIX_SECRET_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
31-
lego --email you@example.com --dns constellix --domains my.example.org run
31+
lego --email you@example.com --dns constellix -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_corenetworks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Core-Networks provider:
2828
```bash
2929
CORENETWORKS_LOGIN="xxxx" \
3030
CORENETWORKS_PASSWORD="yyyy" \
31-
lego --email myemail@example.com --dns corenetworks --domains my.example.org run
31+
lego --email you@example.com --dns corenetworks -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_cpanel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ Here is an example bash command using the CPanel/WHM provider:
3131
CPANEL_USERNAME = "yyyy"
3232
CPANEL_TOKEN = "xxxx"
3333
CPANEL_BASE_URL = "https://example.com:2083" \
34-
lego --email you@example.com --dns cpanel --domains my.example.org run
34+
lego --email you@example.com --dns cpanel -d '*.example.com' -d example.com run
3535

3636
## WHM
3737

3838
CPANEL_MODE = whm
3939
CPANEL_USERNAME = "yyyy"
4040
CPANEL_TOKEN = "xxxx"
4141
CPANEL_BASE_URL = "https://example.com:2087" \
42-
lego --email you@example.com --dns cpanel --domains my.example.org run
42+
lego --email you@example.com --dns cpanel -d '*.example.com' -d example.com run
4343
```
4444

4545

docs/content/dns/zz_gen_derak.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Derak Cloud provider:
2727

2828
```bash
2929
DERAK_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
30-
lego --email myemail@example.com --dns derak --domains my.example.org run
30+
lego --email you@example.com --dns derak -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_desec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the deSEC.io provider:
2727

2828
```bash
2929
DESEC_TOKEN=x-xxxxxxxxxxxxxxxxxxxxxxxxxx \
30-
lego --email you@example.com --dns desec --domains my.example.org run
30+
lego --email you@example.com --dns desec -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_designate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Designate DNSaaS for Openstack provide
2828
```bash
2929
# With a `clouds.yaml`
3030
OS_CLOUD=my_openstack \
31-
lego --email you@example.com --dns designate --domains my.example.org run
31+
lego --email you@example.com --dns designate -d '*.example.com' -d example.com run
3232

3333
# or
3434

@@ -37,7 +37,7 @@ OS_REGION_NAME=RegionOne \
3737
OS_PROJECT_ID=23d4522a987d4ab529f722a007c27846
3838
OS_USERNAME=myuser \
3939
OS_PASSWORD=passw0rd \
40-
lego --email you@example.com --dns designate --domains my.example.org run
40+
lego --email you@example.com --dns designate -d '*.example.com' -d example.com run
4141

4242
# or
4343

@@ -46,7 +46,7 @@ OS_REGION_NAME=RegionOne \
4646
OS_AUTH_TYPE=v3applicationcredential \
4747
OS_APPLICATION_CREDENTIAL_ID=imn74uq0or7dyzz20dwo1ytls4me8dry \
4848
OS_APPLICATION_CREDENTIAL_SECRET=68FuSPSdQqkFQYH5X1OoriEIJOwyLtQ8QSqXZOc9XxFK1A9tzZT6He2PfPw0OMja \
49-
lego --email you@example.com --dns designate --domains my.example.org run
49+
lego --email you@example.com --dns designate -d '*.example.com' -d example.com run
5050
```
5151

5252

docs/content/dns/zz_gen_digitalocean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Digital Ocean provider:
2727

2828
```bash
2929
DO_AUTH_TOKEN=xxxxxx \
30-
lego --email you@example.com --dns digitalocean --domains my.example.org run
30+
lego --email you@example.com --dns digitalocean -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_directadmin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Here is an example bash command using the DirectAdmin provider:
2929
DIRECTADMIN_API_URL="http://example.com:2222" \
3030
DIRECTADMIN_USERNAME=xxxx \
3131
DIRECTADMIN_PASSWORD=yyy \
32-
lego --email you@example.com --dns directadmin --domains my.example.org run
32+
lego --email you@example.com --dns directadmin -d '*.example.com' -d example.com run
3333
```
3434

3535

docs/content/dns/zz_gen_dnshomede.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Configuration for [dnsHome.de](https://www.dnshome.de).
2626
Here is an example bash command using the dnsHome.de provider:
2727

2828
```bash
29-
DNSHOMEDE_CREDENTIALS=sub.example.org:password \
30-
lego --email you@example.com --dns dnshomede --domains example.org --domains '*.example.org' run
29+
DNSHOMEDE_CREDENTIALS=example.org:password \
30+
lego --email you@example.com --dns dnshomede -d '*.example.com' -d example.com run
3131

3232
DNSHOMEDE_CREDENTIALS=my.example.org:password1,demo.example.org:password2 \
33-
lego --email you@example.com --dns dnshomede --domains my.example.org --domains demo.example.org
33+
lego --email you@example.com --dns dnshomede -d my.example.org -d demo.example.org
3434
```
3535

3636

docs/content/dns/zz_gen_dnsimple.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the DNSimple provider:
2727

2828
```bash
2929
DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
30-
lego --email you@example.com --dns dnsimple --domains my.example.org run
30+
lego --email you@example.com --dns dnsimple -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_dnsmadeeasy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the DNS Made Easy provider:
2828
```bash
2929
DNSMADEEASY_API_KEY=xxxxxx \
3030
DNSMADEEASY_API_SECRET=yyyyy \
31-
lego --email you@example.com --dns dnsmadeeasy --domains my.example.org run
31+
lego --email you@example.com --dns dnsmadeeasy -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_dnspod.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the DNSPod (deprecated) provider:
2727

2828
```bash
2929
DNSPOD_API_KEY=xxxxxx \
30-
lego --email you@example.com --dns dnspod --domains my.example.org run
30+
lego --email you@example.com --dns dnspod -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_dode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Domain Offensive (do.de) provider:
2727

2828
```bash
2929
DODE_TOKEN=xxxxxx \
30-
lego --email you@example.com --dns dode --domains my.example.org run
30+
lego --email you@example.com --dns dode -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_domeneshop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here is an example bash command using the Domeneshop provider:
2828
```bash
2929
DOMENESHOP_API_TOKEN=<token> \
3030
DOMENESHOP_API_SECRET=<secret> \
31-
lego --email example@example.com --dns domeneshop --domains example.com run
31+
lego --email example@example.com --dns domeneshop -d '*.example.com' -d example.com run
3232
```
3333

3434

docs/content/dns/zz_gen_dreamhost.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the DreamHost provider:
2727

2828
```bash
2929
DREAMHOST_API_KEY="YOURAPIKEY" \
30-
lego --email you@example.com --dns dreamhost --domains my.example.org run
30+
lego --email you@example.com --dns dreamhost -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_duckdns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is an example bash command using the Duck DNS provider:
2727

2828
```bash
2929
DUCKDNS_TOKEN=xxxxxx \
30-
lego --email you@example.com --dns duckdns --domains my.example.org run
30+
lego --email you@example.com --dns duckdns -d '*.example.com' -d example.com run
3131
```
3232

3333

docs/content/dns/zz_gen_dyn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Here is an example bash command using the Dyn provider:
2929
DYN_CUSTOMER_NAME=xxxxxx \
3030
DYN_USER_NAME=yyyyy \
3131
DYN_PASSWORD=zzzz \
32-
lego --email you@example.com --dns dyn --domains my.example.org run
32+
lego --email you@example.com --dns dyn -d '*.example.com' -d example.com run
3333
```
3434

3535

0 commit comments

Comments
 (0)