Skip to content

docs: use homogenous examples #2328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_acme-dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ 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 you@example.com --dns acme-dns --domains my.example.org run
lego --email you@example.com --dns "acme-dns" -d '*.example.com' -d example.com run
```


Expand Down
4 changes: 2 additions & 2 deletions docs/content/dns/zz_gen_alidns.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Here is an example bash command using the Alibaba Cloud DNS provider:
```bash
# Setup using instance RAM role
ALICLOUD_RAM_ROLE=lego \
lego --email you@example.com --dns alidns --domains my.example.org run
lego --email you@example.com --dns alidns -d '*.example.com' -d example.com run

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_allinkl.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the all-inkl provider:
```bash
ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
ALL_INKL_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \
lego --email you@example.com --dns allinkl --domains my.example.org run
lego --email you@example.com --dns allinkl -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_arvancloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the ArvanCloud provider:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_auroradns.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the Aurora DNS provider:
```bash
AURORA_API_KEY=xxxxx \
AURORA_SECRET=yyyyyy \
lego --email you@example.com --dns auroradns --domains my.example.org run
lego --email you@example.com --dns auroradns -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_autodns.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the Autodns provider:
```bash
AUTODNS_API_USER=username \
AUTODNS_API_PASSWORD=supersecretpassword \
lego --email you@example.com --dns autodns --domains my.example.org run
lego --email you@example.com --dns autodns -d '*.example.com' -d example.com run
```


Expand Down
10 changes: 5 additions & 5 deletions docs/content/dns/zz_gen_azuredns.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,32 +31,32 @@ Here is an example bash command using the Azure DNS provider:
AZURE_CLIENT_ID=<your service principal client ID> \
AZURE_TENANT_ID=<your service principal tenant ID> \
AZURE_CLIENT_SECRET=<your service principal client secret> \
lego --domains example.com --email your_example@email.com --dns azuredns run
lego --email you@example.com --dns azuredns -d '*.example.com' -d example.com run

### Using client certificate

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

### Using Azure CLI

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

### Using Managed Identity (Azure VM)

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

### Using Managed Identity (Azure Arc)

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

```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_bindman.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Bindman provider:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_bluecat.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ BLUECAT_USER_NAME=myusername \
BLUECAT_CONFIG_NAME=myconfig \
BLUECAT_SERVER_URL=https://bam.example.com \
BLUECAT_TTL=30 \
lego --email you@example.com --dns bluecat --domains my.example.org run
lego --email you@example.com --dns bluecat -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_brandit.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Here is an example bash command using the Brandit (deprecated) provider:
```bash
BRANDIT_API_KEY=xxxxxxxxxxxxxxxxxxxxx \
BRANDIT_API_USERNAME=yyyyyyyyyyyyyyyyyyyy \
lego --email myemail@example.com --dns brandit --domains my.example.org run
lego --email you@example.com --dns brandit -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_bunny.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Bunny provider:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_checkdomain.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Checkdomain provider:

```bash
CHECKDOMAIN_TOKEN=yoursecrettoken \
lego --email you@example.com --dns checkdomain --domains my.example.org run
lego --email you@example.com --dns checkdomain -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_civo.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Civo provider:

```bash
CIVO_TOKEN=xxxxxx \
lego --email you@example.com --dns civo --domains my.example.org run
lego --email you@example.com --dns civo -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_clouddns.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is an example bash command using the CloudDNS provider:
CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \
CLOUDDNS_EMAIL=you@example.com \
CLOUDDNS_PASSWORD=b9841238feb177a84330f \
lego --email you@example.com --dns clouddns --domains my.example.org run
lego --email you@example.com --dns clouddns -d '*.example.com' -d example.com run
```


Expand Down
4 changes: 2 additions & 2 deletions docs/content/dns/zz_gen_cloudflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Here is an example bash command using the Cloudflare provider:
```bash
CLOUDFLARE_EMAIL=you@example.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --email you@example.com --dns cloudflare --domains my.example.org run
lego --email you@example.com --dns cloudflare -d '*.example.com' -d example.com run

# or

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_cloudns.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the ClouDNS provider:
```bash
CLOUDNS_AUTH_ID=xxxx \
CLOUDNS_AUTH_PASSWORD=yyyy \
lego --email you@example.com --dns cloudns --domains my.example.org run
lego --email you@example.com --dns cloudns -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_cloudru.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is an example bash command using the Cloud.ru provider:
CLOUDRU_SERVICE_INSTANCE_ID=ppp \
CLOUDRU_KEY_ID=xxx \
CLOUDRU_SECRET=yyy \
lego --email you@example.com --dns cloudru --domains my.example.org run
lego --email you@example.com --dns cloudru -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_cloudxns.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the CloudXNS (Deprecated) provider:
```bash
CLOUDXNS_API_KEY=xxxx \
CLOUDXNS_SECRET_KEY=yyyy \
lego --email you@example.com --dns cloudxns --domains my.example.org run
lego --email you@example.com --dns cloudxns -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_conoha.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is an example bash command using the ConoHa provider:
CONOHA_TENANT_ID=487727e3921d44e3bfe7ebb337bf085e \
CONOHA_API_USERNAME=xxxx \
CONOHA_API_PASSWORD=yyyy \
lego --email you@example.com --dns conoha --domains my.example.org run
lego --email you@example.com --dns conoha -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_constellix.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,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 --email you@example.com --dns constellix --domains my.example.org run
lego --email you@example.com --dns constellix -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_corenetworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the Core-Networks provider:
```bash
CORENETWORKS_LOGIN="xxxx" \
CORENETWORKS_PASSWORD="yyyy" \
lego --email myemail@example.com --dns corenetworks --domains my.example.org run
lego --email you@example.com --dns corenetworks -d '*.example.com' -d example.com run
```


Expand Down
4 changes: 2 additions & 2 deletions docs/content/dns/zz_gen_cpanel.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ Here is an example bash command using the CPanel/WHM provider:
CPANEL_USERNAME = "yyyy"
CPANEL_TOKEN = "xxxx"
CPANEL_BASE_URL = "https://example.com:2083" \
lego --email you@example.com --dns cpanel --domains my.example.org run
lego --email you@example.com --dns cpanel -d '*.example.com' -d example.com run

## WHM

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_derak.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Derak Cloud provider:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_desec.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the deSEC.io provider:

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


Expand Down
6 changes: 3 additions & 3 deletions docs/content/dns/zz_gen_designate.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the Designate DNSaaS for Openstack provide
```bash
# With a `clouds.yaml`
OS_CLOUD=my_openstack \
lego --email you@example.com --dns designate --domains my.example.org run
lego --email you@example.com --dns designate -d '*.example.com' -d example.com run

# or

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

# or

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_digitalocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Digital Ocean provider:

```bash
DO_AUTH_TOKEN=xxxxxx \
lego --email you@example.com --dns digitalocean --domains my.example.org run
lego --email you@example.com --dns digitalocean -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_directadmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is an example bash command using the DirectAdmin provider:
DIRECTADMIN_API_URL="http://example.com:2222" \
DIRECTADMIN_USERNAME=xxxx \
DIRECTADMIN_PASSWORD=yyy \
lego --email you@example.com --dns directadmin --domains my.example.org run
lego --email you@example.com --dns directadmin -d '*.example.com' -d example.com run
```


Expand Down
6 changes: 3 additions & 3 deletions docs/content/dns/zz_gen_dnshomede.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Configuration for [dnsHome.de](https://www.dnshome.de).
Here is an example bash command using the dnsHome.de provider:

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

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_dnsimple.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the DNSimple provider:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_dnsmadeeasy.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the DNS Made Easy provider:
```bash
DNSMADEEASY_API_KEY=xxxxxx \
DNSMADEEASY_API_SECRET=yyyyy \
lego --email you@example.com --dns dnsmadeeasy --domains my.example.org run
lego --email you@example.com --dns dnsmadeeasy -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_dnspod.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the DNSPod (deprecated) provider:

```bash
DNSPOD_API_KEY=xxxxxx \
lego --email you@example.com --dns dnspod --domains my.example.org run
lego --email you@example.com --dns dnspod -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_dode.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Domain Offensive (do.de) provider:

```bash
DODE_TOKEN=xxxxxx \
lego --email you@example.com --dns dode --domains my.example.org run
lego --email you@example.com --dns dode -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_domeneshop.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Here is an example bash command using the Domeneshop provider:
```bash
DOMENESHOP_API_TOKEN=<token> \
DOMENESHOP_API_SECRET=<secret> \
lego --email example@example.com --dns domeneshop --domains example.com run
lego --email example@example.com --dns domeneshop -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_dreamhost.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the DreamHost provider:

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


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_duckdns.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is an example bash command using the Duck DNS provider:

```bash
DUCKDNS_TOKEN=xxxxxx \
lego --email you@example.com --dns duckdns --domains my.example.org run
lego --email you@example.com --dns duckdns -d '*.example.com' -d example.com run
```


Expand Down
2 changes: 1 addition & 1 deletion docs/content/dns/zz_gen_dyn.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here is an example bash command using the Dyn provider:
DYN_CUSTOMER_NAME=xxxxxx \
DYN_USER_NAME=yyyyy \
DYN_PASSWORD=zzzz \
lego --email you@example.com --dns dyn --domains my.example.org run
lego --email you@example.com --dns dyn -d '*.example.com' -d example.com run
```


Expand Down
Loading