doc: adds information about _FILE suffix. (#829)

This commit is contained in:
Ludovic Fernandez 2019-03-18 17:42:54 +01:00 committed by GitHub
parent 0c87df143e
commit 3684cc738d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
55 changed files with 354 additions and 4 deletions

View file

@ -5,14 +5,51 @@ draft: false
weight: 3
---
Credentials for DNS providers must be passed through environment variables.
## Configuration and Credentials
Credentials and DNS configuration for DNS providers must be passed through environment variables.
### Environment Variables: Value
The environment variables can reference a value.
Here is an example bash command using the CloudFlare DNS provider:
```bash
CLOUDFLARE_EMAIL=foo@bar.com \
$ CLOUDFLARE_EMAIL=foo@bar.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns cloudflare --domains www.example.com --email me@bar.com run
```
### Environment Variables: File
The environment variables can reference a path to file.
In this case the name of environment variable must be suffixed by `_FILE`.
{{% notice note %}}
The file must contain only the value.
{{% /notice %}}
Here is an example bash command using the CloudFlare DNS provider:
```bash
$ cat /the/path/to/my/key
b9841238feb177a84330febba8a83208921177bffe733
$ cat /the/path/to/my/email
foo@bar.com
$ CLOUDFLARE_EMAIL_FILE=/the/path/to/my/email \
CLOUDFLARE_API_KEY=/the/path/to/my/key \
lego --dns cloudflare --domains www.example.com --email me@bar.com run
```
## Experimental Features
To resolve CNAME when creating dns-01 challenge:
set `LEGO_EXPERIMENTAL_CNAME_SUPPORT` to `true`.
## DNS Providers
{{%children style="h2" description="true" %}}

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `ACME_DNS_API_BASE` | The ACME-DNS API address |
| `ACME_DNS_STORAGE_PATH` | The ACME-DNS JSON account data file. A per-domain account will be registered/persisted to this file and used for TXT updates. |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `ALICLOUD_ACCESS_KEY` | Access key ID |
| `ALICLOUD_SECRET_KEY` | Access Key secret |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `ALICLOUD_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `ALICLOUD_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `AURORA_KEY` | User API key |
| `AURORA_USER_ID` | User ID |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `AURORA_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `AURORA_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -35,6 +35,9 @@ _Please contribute by adding a CLI example._
| `AZURE_TENANT_ID` | Tenant ID |
| `instance metadata service` | If the credentials are **not** set via the environment, then it will attempt to get a bearer token via the [instance metadata service](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service). |
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).
## Additional Configuration
@ -45,6 +48,9 @@ _Please contribute by adding a CLI example._
| `AZURE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `AZURE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -34,6 +34,9 @@ _Please contribute by adding a CLI example._
| `BLUECAT_SERVER_URL` | The server URL, should have scheme, hostname, and port (if required) of the authoritative Bluecat BAM serve |
| `BLUECAT_USER_NAME` | API 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).
## Additional Configuration
@ -44,6 +47,9 @@ _Please contribute by adding a CLI example._
| `BLUECAT_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `BLUECAT_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -35,6 +35,9 @@ lego --dns cloudflare --domains my.domain.com --email my@email.com run
| `CLOUDFLARE_API_KEY` | API key |
| `CLOUDFLARE_EMAIL` | Account email |
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).
## Additional Configuration
@ -45,6 +48,9 @@ lego --dns cloudflare --domains my.domain.com --email my@email.com run
| `CLOUDFLARE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `CLOUDFLARE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `CLOUDNS_AUTH_ID` | The API user ID |
| `CLOUDNS_AUTH_PASSWORD` | The password for API user ID |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `CLOUDNS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `CLOUDNS_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `CLOUDXNS_API_KEY` | The API key |
| `CLOUDXNS_SECRET_KEY` | THe API secret key |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `CLOUDXNS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `CLOUDXNS_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `CONOHA_API_USERNAME` | The API username |
| `CONOHA_TENANT_ID` | Tenant ID |
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).
## Additional Configuration
@ -43,6 +46,9 @@ _Please contribute by adding a CLI example._
| `CONOHA_REGION` | The region |
| `CONOHA_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -34,6 +34,9 @@ _Please contribute by adding a CLI example._
| `OS_TENANT_NAME` | Tenant name |
| `OS_USERNAME` | 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).
## Additional Configuration
@ -43,6 +46,9 @@ _Please contribute by adding a CLI example._
| `DESIGNATE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `DESIGNATE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `DO_AUTH_TOKEN` | Authentication token |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `DO_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `DO_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `DNSIMPLE_BASE_URL` | API endpoint URL |
| `DNSIMPLE_OAUTH_TOKEN` | OAuth token |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `DNSIMPLE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `DNSIMPLE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `DNSMADEEASY_API_KEY` | The API key |
| `DNSMADEEASY_API_SECRET` | The API Secret key |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `DNSMADEEASY_SANDBOX` | Activate the sandbox (boolean) |
| `DNSMADEEASY_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `DNSPOD_API_KEY` | The user token |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `DNSPOD_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `DNSPOD_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `DREAMHOST_API_KEY` | The API key |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `DREAMHOST_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `DREAMHOST_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `DUCKDNS_TOKEN` | Account token |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `DUCKDNS_SEQUENCE_INTERVAL` | Interval between iteration |
| `DUCKDNS_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `DYN_PASSWORD` | Paswword |
| `DYN_USER_NAME` | User name |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `DYN_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `DYN_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `EXOSCALE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `EXOSCALE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -33,6 +33,9 @@ _Please contribute by adding a CLI example._
| `AKAMAI_CLIENT_TOKEN` | Client token |
| `AKAMAI_HOST` | API host |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `AKAMAI_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `AKAMAI_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `GANDI_API_KEY` | API key |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `GANDI_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `GANDI_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `GANDIV5_API_KEY` | API key |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `GANDIV5_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `GANDIV5_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -33,6 +33,9 @@ _Please contribute by adding a CLI example._
| `GCE_SERVICE_ACCOUNT` | Account |
| `GCE_SERVICE_ACCOUNT_FILE` | Account file path |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `GCE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `GCE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `GLESYS_API_KEY` | API key |
| `GLESYS_API_USER` | API user |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `GLESYS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `GLESYS_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `GODADDY_API_KEY` | **TODO** |
| `GODADDY_API_SECRET` | **TODO** |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `GODADDY_SEQUENCE_INTERVAL` | Interval between iteration |
| `GODADDY_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `HOSTINGDE_API_KEY` | **TODO** |
| `HOSTINGDE_ZONE_NAME` | **TODO** |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `HOSTINGDE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `HOSTINGDE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -34,6 +34,9 @@ lego --dns httpreq --domains my.domain.com --email my@email.com run
| `HTTPREQ_ENDPOINT` | The URL of the server |
| `HTTPREQ_MODE` | `RAW`, none |
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).
## Additional Configuration
@ -45,6 +48,9 @@ lego --dns httpreq --domains my.domain.com --email my@email.com run
| `HTTPREQ_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `HTTPREQ_USERNAME` | **TODO** |
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).
## Description
The server must provide:

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `IIJ_API_SECRET_KEY` | API secret key |
| `IIJ_DO_SERVICE_CODE` | DO service code |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `IIJ_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `IIJ_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `INWX_PASSWORD` | Password |
| `INWX_USERNAME` | 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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `INWX_SANDBOX` | Activate the sandbox (boolean) |
| `INWX_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `AWS_SECRET_ACCESS_KEY` | Secret access key |
| `DNS_ZONE` | DNS zone |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `LIGHTSAIL_POLLING_INTERVAL` | Time between DNS propagation check |
| `LIGHTSAIL_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `LINODE_API_KEY` | API key |
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).
## Additional Configuration
@ -39,6 +42,9 @@ _Please contribute by adding a CLI example._
| `LINODE_POLLING_INTERVAL` | Time between DNS propagation check |
| `LINODE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `LINODE_TOKEN` | API token |
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).
## Additional Configuration
@ -39,6 +42,9 @@ _Please contribute by adding a CLI example._
| `LINODE_POLLING_INTERVAL` | Time between DNS propagation check |
| `LINODE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `MYDNSJP_MASTER_ID` | Master ID |
| `MYDNSJP_PASSWORD` | Password |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `MYDNSJP_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `MYDNSJP_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `NAMECHEAP_API_KEY` | API key |
| `NAMECHEAP_API_USER` | API user |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `NAMECHEAP_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NAMECHEAP_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `NAMECOM_API_TOKEN` | API token |
| `NAMECOM_USERNAME` | 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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `NAMECOM_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NAMECOM_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `NETCUP_API_PASSWORD` | API password |
| `NETCUP_CUSTOMER_NUMBER` | Customer number |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `NETCUP_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NETCUP_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `NIFCLOUD_ACCESS_KEY_ID` | Access key |
| `NIFCLOUD_SECRET_ACCESS_KEY` | Secret access key |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `NIFCLOUD_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NIFCLOUD_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `NS1_API_KEY` | API key |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `NS1_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `NS1_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -45,6 +45,9 @@ lego --dns oraclecloud --domains my.domain.com --email my@email.com run
| `OCI_TENANCY_OCID` | Tenanct OCID |
| `OCI_USER_OCID` | User OCID |
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).
## Additional Configuration
@ -54,6 +57,9 @@ lego --dns oraclecloud --domains my.domain.com --email my@email.com run
| `OCI_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `OCI_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -34,6 +34,9 @@ _Please contribute by adding a CLI example._
| `OTC_PROJECT_NAME` | Project name |
| `OTC_USER_NAME` | User name |
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).
## Additional Configuration
@ -44,6 +47,9 @@ _Please contribute by adding a CLI example._
| `OTC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `OTC_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -33,6 +33,9 @@ _Please contribute by adding a CLI example._
| `OVH_CONSUMER_KEY` | Consumer key |
| `OVH_ENDPOINT` | Endpoint URL (ovh-eu or ovh-ca) |
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).
## Additional Configuration
@ -43,6 +46,9 @@ _Please contribute by adding a CLI example._
| `OVH_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `OVH_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `PDNS_API_KEY` | API key |
| `PDNS_API_URL` | API 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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `PDNS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `PDNS_TTL` | The TTL of the TXT record used for the DNS challenge |
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).
## Information
Tested and confirmed to work with PowerDNS authoritative server 3.4.8 and 4.0.1. Refer to [PowerDNS documentation](https://doc.powerdns.com/md/httpapi/README/) instructions on how to enable the built-in API interface.

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `RACKSPACE_API_KEY` | API key |
| `RACKSPACE_USER` | API user |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `RACKSPACE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `RACKSPACE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -33,6 +33,9 @@ _Please contribute by adding a CLI example._
| `RFC2136_TSIG_KEY` | Name of the secret key as defined in DNS server configuration. To disable TSIG authentication, leave the `RFC2136_TSIG*` variables unset. |
| `RFC2136_TSIG_SECRET` | Secret key payload. To disable TSIG authentication, leave the` RFC2136_TSIG*` variables unset. |
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).
## Additional Configuration
@ -44,6 +47,9 @@ _Please contribute by adding a CLI example._
| `RFC2136_SEQUENCE_INTERVAL` | Interval between iteration |
| `RFC2136_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -33,6 +33,9 @@ _Please contribute by adding a CLI example._
| `AWS_REGION` | |
| `AWS_SECRET_ACCESS_KEY` | |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `AWS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `AWS_TTL` | The TTL of the TXT record used for the DNS challenge |
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).
## Description
AWS Credentials are automatically detected in the following locations and prioritized in the following order:

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `SAKURACLOUD_ACCESS_TOKEN` | Access token |
| `SAKURACLOUD_ACCESS_TOKEN_SECRET` | Access token secret |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `SAKURACLOUD_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `SAKURACLOUD_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `SELECTEL_API_TOKEN` | API token |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `SELECTEL_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `SELECTEL_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `STACKPATH_CLIENT_SECRET` | Client secret |
| `STACKPATH_STACK_ID` | Stack ID |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `STACKPATH_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `STACKPATH_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `TRANSIP_ACCOUNT_NAME` | Account name |
| `TRANSIP_PRIVATE_KEY_PATH` | Private key path |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `TRANSIP_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `TRANSIP_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -32,6 +32,9 @@ _Please contribute by adding a CLI example._
| `SECRET_VEGADNS_SECRET` | API secret |
| `VEGADNS_URL` | 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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `VEGADNS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `VEGADNS_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `VSCALE_API_TOKEN` | API token |
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).
## Additional Configuration
@ -41,6 +44,9 @@ _Please contribute by adding a CLI example._
| `VSCALE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `VSCALE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -30,6 +30,9 @@ _Please contribute by adding a CLI example._
|-----------------------|-------------|
| `VULTR_API_KEY` | API key |
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).
## Additional Configuration
@ -40,6 +43,9 @@ _Please contribute by adding a CLI example._
| `VULTR_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `VULTR_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -31,6 +31,9 @@ _Please contribute by adding a CLI example._
| `ZONEEE_API_KEY` | API key |
| `ZONEEE_API_USER` | API user |
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).
## Additional Configuration
@ -42,6 +45,9 @@ _Please contribute by adding a CLI example._
| `ZONEEE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `ZONEEE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).

View file

@ -22,7 +22,7 @@ COMMANDS:
run Register an account, then create and install a certificate
revoke Revoke a certificate
renew Renew a certificate
dnshelp Shows additional help for the --dns global option
dnshelp Shows additional help for the '--dns' global option
list Display certificates and accounts information.
help, h Shows a list of commands or help for one command
@ -35,7 +35,7 @@ GLOBAL OPTIONS:
--eab Use External Account Binding for account registration. Requires --kid and --hmac.
--kid value Key identifier from External CA. Used for External Account Binding.
--hmac value MAC key from External CA. Should be in Base64 URL Encoding without padding format. Used for External Account Binding.
--key-type value, -k value Key type to use for private keys. Supported: rsa2048, rsa4096, rsa8192, ec256, ec384. (default: "rsa2048")
--key-type value, -k value Key type to use for private keys. Supported: rsa2048, rsa4096, rsa8192, ec256, ec384. (default: "ec384")
--filename value (deprecated) Filename of the generated certificate.
--path value Directory to use for storing the data. (default: "./.lego")
--http Use the HTTP challenge to solve challenges. Can be mixed with other types of challenges.

View file

@ -40,6 +40,8 @@ _Please contribute by adding a CLI example._
| `{{$k}}` | {{$v}} |
{{- end}}
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).
{{- end}}
{{if .Configuration.Additional }}
@ -51,6 +53,8 @@ _Please contribute by adding a CLI example._
| `{{$k}}` | {{$v}} |
{{- end}}
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).
{{- end}}
{{- end}}