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 [email protected] --dns acme-dns --domains my.example.org run
31+
lego --email [email protected] --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 [email protected] --dns alidns --domains my.example.org run
31+
lego --email [email protected] --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 [email protected] --dns alidns --domains my.example.org run
37+
lego --email [email protected] --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 [email protected] --dns allinkl --domains my.example.org run
31+
lego --email [email protected] --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 [email protected] --dns arvancloud --domains my.example.org run
30+
lego --email [email protected] --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 [email protected] --dns auroradns --domains my.example.org run
31+
lego --email [email protected] --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 [email protected] --dns autodns --domains my.example.org run
31+
lego --email [email protected] --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 [email protected] --dns bindman --domains my.example.org run
30+
lego --email [email protected] --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 [email protected] --dns bluecat --domains my.example.org run
35+
lego --email [email protected] --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

0 commit comments

Comments
 (0)