mbiryukova/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

docs: refactoring and cleanup (#1658)

Browse source
This commit is contained in:
Dominik Menke 2022-06-17 00:25:42 +02:00 committed by GitHub
parent 257dfa777e
commit 85f616f85b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
220 changed files with 1597 additions and 863 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/documentation.yml vendored
View file

@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
env:
GO_VERSION: 1.18
HUGO_VERSION: 0.54.0
HUGO_VERSION: 0.101.0
CGO_ENABLED: 0
steps:

1
docs/.gitignore vendored
View file

@ -1,2 +1,3 @@
themes/
public/
.hugo_build.lock

6
docs/config.toml
View file

@ -45,6 +45,7 @@ pygmentsUseClasses = true
# ordersectionsby = "weight"
# Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = "blue"
custom_css = ["css/theme-custom.css"]
disableLandingPageButton = true
[Languages]
@ -64,5 +65,10 @@ pygmentsUseClasses = true
url = "https://github.com/go-acme/lego/issues"
weight = 11
[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-comments'></i> Discussions"
url = "https://github.com/go-acme/lego/discussions"
weight = 12
[outputs]
home = [ "HTML", "RSS", "JSON"]

7
docs/content/_index.md
View file

@ -20,11 +20,12 @@ Let's Encrypt client and ACME library written in Go.
- DNS (dns-01)
- TLS (tls-alpn-01)
- SAN certificate support
- Comes with multiple optional [DNS providers](dns)
- [Custom challenge solvers](usage/library/writing-a-challenge-solver/)
- Comes with multiple optional [DNS providers]({{< ref "dns" >}})
- [Custom challenge solvers]({{< ref "usage/library/Writing-a-Challenge-Solver" >}})
- Certificate bundling
- OCSP helper function
lego introduced support for ACME v2 in [v1.0.0](https://github.com/go-acme/lego/releases/tag/v1.0.0).
lego introduced support for ACME v2 in [v1.0.0](https://github.com/go-acme/lego/releases/tag/v1.0.0).
If you still need to utilize ACME v1, you can do so by using the [v0.5.0](https://github.com/go-acme/lego/releases/tag/v0.5.0) version.

18
docs/content/dns/_index.md
View file

@ -15,10 +15,10 @@ 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_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns cloudflare --domains www.example.com --email me@bar.com run
```console
$ CLOUDFLARE_EMAIL=you@example.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --dns cloudflare --domains www.example.com --email you@example.com run
```
### Environment Variables: File
@ -33,16 +33,16 @@ The file must contain only the value.
Here is an example bash command using the CloudFlare DNS provider:
```bash
```console
$ cat /the/path/to/my/key
b9841238feb177a84330febba8a83208921177bffe733
$ cat /the/path/to/my/email
foo@bar.com
you@example.com
$ CLOUDFLARE_EMAIL_FILE=/the/path/to/my/email \
CLOUDFLARE_API_KEY_FILE=/the/path/to/my/key \
lego --dns cloudflare --domains www.example.com --email me@bar.com run
CLOUDFLARE_API_KEY_FILE=/the/path/to/my/key \
lego --dns cloudflare --domains www.example.com --email you@example.com run
```
## Experimental Features
@ -52,4 +52,4 @@ set `LEGO_EXPERIMENTAL_CNAME_SUPPORT` to `true`.
## DNS Providers
{{%children style="h2" description="true" %}}
{{% tableofdnsproviders %}}

77
docs/content/dns/manual.md
View file

@ -3,6 +3,10 @@ title: "Manual"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: manual
dnsprovider:
since: v0.3.0
code: manual
url:
---
Solving the DNS-01 challenge using CLI prompt.
@ -11,49 +15,58 @@ Solving the DNS-01 challenge using CLI prompt.
## Example
To start using the CLI prompt "provider", start lego with `--dns manual`:
```console
$ lego --email "you@example.com" --domains="example.com" --dns "manual" run
```
What follows are a few log print outs, interspersed with some prompts, asking for you to do perform some actions:
```txt
No key found for account you@example.com. Generating a P256 key.
Saved key to ./.lego/accounts/acme-v02.api.letsencrypt.org/you@example.com/keys/you@example.com.key
Please review the TOS at https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf
Do you accept the TOS? Y/n
```
[INFO] acme: Registering account for test@test.com
If you accept the linked Terms of Service, hit `Enter`.
```txt
[INFO] acme: Registering account for you@example.com
!!!! HEADS UP !!!!
Your account credentials have been saved in your Let's Encrypt
configuration directory at "~/.lego/accounts".
configuration directory at "./.lego/accounts".
You should make a secure backup of this folder now. This
configuration directory will also contain certificates and
private keys obtained from Let's Encrypt so making regular
backups of this folder is ideal.
[INFO] [test.com] acme: Obtaining bundled SAN certificate
[INFO] [test.com] AuthURL: https://acme-v02.api.letsencrypt.org/acme/authz/lornkZmVYjsh5wLHpxdQcZDPekGf_TYUM-MTJk3-yrA
[INFO] [test.com] acme: Could not find solver for: tls-alpn-01
[INFO] [test.com] acme: Could not find solver for: http-01
[INFO] [test.com] acme: use dns-01 solver
[INFO] [test.com] acme: Preparing to solve DNS-01
lego: Please create the following TXT record in your test.com. zone:
_acme-challenge.test.com. 120 IN TXT "VP-dby1RBuUOnDZg1n9sF-cwicLsognMzJb0Vx8ttAI"
[INFO] [example.com] acme: Obtaining bundled SAN certificate
[INFO] [example.com] AuthURL: https://acme-v02.api.letsencrypt.org/acme/authz-v3/2345678901
[INFO] [example.com] acme: Could not find solver for: tls-alpn-01
[INFO] [example.com] acme: Could not find solver for: http-01
[INFO] [example.com] acme: use dns-01 solver
[INFO] [example.com] acme: Preparing to solve DNS-01
lego: Please create the following TXT record in your example.com. zone:
_acme-challenge.example.com. 120 IN TXT "hX0dPkG6Gfs9hUvBAchQclkyyoEKbShbpvJ9mY5q2JQ"
lego: Press 'Enter' when you are done
```
Do you accept the TOS? Y/n
Do as instructed, and create the TXT records, and hit `Enter`.
[INFO] acme: Registering account for test@test.com
!!!! HEADS UP !!!!
```txt
[INFO] [example.com] acme: Trying to solve DNS-01
[INFO] [example.com] acme: Checking DNS record propagation using [192.168.8.1:53]
[INFO] Wait for propagation [timeout: 1m0s, interval: 2s]
[INFO] [example.com] acme: Waiting for DNS record propagation.
[INFO] [example.com] The server validated our request
[INFO] [example.com] acme: Cleaning DNS-01 challenge
lego: You can now remove this TXT record from your example.com. zone:
_acme-challenge.example.com. 120 IN TXT "hX0dPkG6Gfs9hUvBAchQclkyyoEKbShbpvJ9mY5q2JQ"
[INFO] [example.com] acme: Validations succeeded; requesting certificates
[INFO] [example.com] Server responded with a certificate.
```
Your account credentials have been saved in your Let's Encrypt
configuration directory at "~/.lego/accounts".
You should make a secure backup of this folder now. This
configuration directory will also contain certificates and
private keys obtained from Let's Encrypt so making regular
backups of this folder is ideal.
[INFO] [test.com] acme: Obtaining bundled SAN certificate
[INFO] [test.com] AuthURL: https://acme-v02.api.letsencrypt.org/acme/authz/lornkZmVYjsh5wLHpxdQcZDPekGf_TYUM-MTJk3-yrA
[INFO] [test.com] acme: Could not find solver for: tls-alpn-01
[INFO] [test.com] acme: Could not find solver for: http-01
[INFO] [test.com] acme: use dns-01 solver
[INFO] [test.com] acme: Preparing to solve DNS-01
lego: Please create the following TXT record in your test.com. zone:
_acme-challenge.test.com. 120 IN TXT "VP-dby1RBuUOnDZg1n9sF-cwicLsognMzJb0Vx8ttAI"
lego: Press 'Enter' when you are done
```
As mentioned, you can now remove the TXT record again.

11
docs/content/dns/zz_gen_acme-dns.md
View file

@ -3,13 +3,16 @@ title: "Joohoi's ACME-DNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: acme-dns
dnsprovider:
since: "v1.1.0"
code: "acme-dns"
url: "https://github.com/joohoi/acme-dns"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/acmedns/acmedns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Joohoi's ACME-DNS](https://github.com/joohoi/acme-dns).
@ -17,13 +20,15 @@ Configuration for [Joohoi's ACME-DNS](https://github.com/joohoi/acme-dns).
<!--more-->
- Code: `acme-dns`
- Since: v1.1.0
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
lego --email you@example.com --dns acme-dns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns acme-dns --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

15
docs/content/dns/zz_gen_alidns.md
View file

@ -3,13 +3,16 @@ title: "Alibaba Cloud DNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: alidns
dnsprovider:
since: "v1.1.0"
code: "alidns"
url: "https://www.alibabacloud.com/product/dns"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/alidns/alidns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Alibaba Cloud DNS](https://www.alibabacloud.com/product/dns).
@ -17,19 +20,21 @@ Configuration for [Alibaba Cloud DNS](https://www.alibabacloud.com/product/dns).
<!--more-->
- Code: `alidns`
- Since: v1.1.0
Here is an example bash command using the Alibaba Cloud DNS provider:
```bash
# Setup using instance RAM role
ALICLOUD_RAM_ROLE=lego \
lego --email myemail@example.com --dns alidns --domains my.example.org run
lego --email you@example.com --dns alidns --domains my.example.org run
# Or, using credentials
ALICLOUD_ACCESS_KEY=abcdefghijklmnopqrstuvwx \
ALICLOUD_SECRET_KEY=your-secret-key \
ALICLOUD_SECURITY_TOKEN=your-sts-token \
lego --email myemail@example.com --dns alidns --domains my.example.org run
lego --email you@example.com --dns alidns --domains my.example.org run
```
@ -45,7 +50,7 @@ lego --email myemail@example.com --dns alidns --domains my.example.org run
| `ALICLOUD_SECURITY_TOKEN` | STS Security Token (optional) |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -58,7 +63,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_allinkl.md
View file

@ -3,13 +3,16 @@ title: "all-inkl"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: allinkl
dnsprovider:
since: "v4.5.0"
code: "allinkl"
url: "https://all-inkl.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/allinkl/allinkl.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [all-inkl](https://all-inkl.com).
@ -17,13 +20,15 @@ Configuration for [all-inkl](https://all-inkl.com).
<!--more-->
- Code: `allinkl`
- Since: v4.5.0
Here is an example bash command using the all-inkl provider:
```bash
ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
ALL_INKL_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \
lego --email myemail@example.com --dns allinkl --domains my.example.org run
lego --email you@example.com --dns allinkl --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns allinkl --domains my.example.org run
| `ALL_INKL_PASSWORD` | KAS 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `ALL_INKL_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_arvancloud.md
View file

@ -3,13 +3,16 @@ title: "ArvanCloud"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: arvancloud
dnsprovider:
since: "v3.8.0"
code: "arvancloud"
url: "https://arvancloud.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/arvancloud/arvancloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.8.0
Configuration for [ArvanCloud](https://arvancloud.com).
@ -17,12 +20,14 @@ Configuration for [ArvanCloud](https://arvancloud.com).
<!--more-->
- Code: `arvancloud`
- Since: v3.8.0
Here is an example bash command using the ArvanCloud provider:
```bash
ARVANCLOUD_API_KEY="Apikey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
lego --email myemail@example.com --dns arvancloud --domains my.example.org run
lego --email you@example.com --dns arvancloud --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns arvancloud --domains my.example.org run
| `ARVANCLOUD_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `ARVANCLOUD_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_auroradns.md
View file

@ -3,13 +3,16 @@ title: "Aurora DNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: auroradns
dnsprovider:
since: "v0.4.0"
code: "auroradns"
url: "https://www.pcextreme.com/aurora/dns"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/auroradns/auroradns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Aurora DNS](https://www.pcextreme.com/aurora/dns).
@ -17,13 +20,15 @@ Configuration for [Aurora DNS](https://www.pcextreme.com/aurora/dns).
<!--more-->
- Code: `auroradns`
- Since: v0.4.0
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
lego --email you@example.com --dns auroradns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns auroradns --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_autodns.md
View file

@ -3,13 +3,16 @@ title: "Autodns"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: autodns
dnsprovider:
since: "v3.2.0"
code: "autodns"
url: "https://www.internetx.com/domains/autodns/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/autodns/autodns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.2.0
Configuration for [Autodns](https://www.internetx.com/domains/autodns/).
@ -17,13 +20,15 @@ Configuration for [Autodns](https://www.internetx.com/domains/autodns/).
<!--more-->
- Code: `autodns`
- Since: v3.2.0
Here is an example bash command using the Autodns provider:
```bash
AUTODNS_API_USER=username \
AUTODNS_API_PASSWORD=supersecretpassword \
lego --email myemail@example.com --dns autodns --domains my.example.org run
lego --email you@example.com --dns autodns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns autodns --domains my.example.org run
| `AUTODNS_API_USER` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `AUTODNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_azure.md
View file

@ -3,13 +3,16 @@ title: "Azure"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: azure
dnsprovider:
since: "v0.4.0"
code: "azure"
url: "https://azure.microsoft.com/services/dns/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/azure/azure.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Azure](https://azure.microsoft.com/services/dns/).
@ -17,6 +20,8 @@ Configuration for [Azure](https://azure.microsoft.com/services/dns/).
<!--more-->
- Code: `azure`
- Since: v0.4.0
{{% notice note %}}
_Please contribute by adding a CLI example._
@ -38,7 +43,7 @@ _Please contribute by adding a CLI example._
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -53,7 +58,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `AZURE_ZONE_NAME` | Zone name to use inside Azure DNS service to add the TXT record in |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_bindman.md
View file

@ -3,13 +3,16 @@ title: "Bindman"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: bindman
dnsprovider:
since: "v2.6.0"
code: "bindman"
url: "https://github.com/labbsr0x/bindman-dns-webhook"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/bindman/bindman.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.6.0
Configuration for [Bindman](https://github.com/labbsr0x/bindman-dns-webhook).
@ -17,12 +20,14 @@ Configuration for [Bindman](https://github.com/labbsr0x/bindman-dns-webhook).
<!--more-->
- Code: `bindman`
- Since: v2.6.0
Here is an example bash command using the Bindman provider:
```bash
BINDMAN_MANAGER_ADDRESS=<your bindman manager address> \
lego --email myemail@example.com --dns bindman --domains my.example.org run
lego --email you@example.com --dns bindman --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns bindman --domains my.example.org run
| `BINDMAN_MANAGER_ADDRESS` | The server URL, should have scheme, hostname, and port (if required) of the Bindman-DNS Manager server |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -47,7 +52,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `BINDMAN_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_bluecat.md
View file

@ -3,13 +3,16 @@ title: "Bluecat"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: bluecat
dnsprovider:
since: "v0.5.0"
code: "bluecat"
url: "https://www.bluecatnetworks.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/bluecat/bluecat.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Bluecat](https://www.bluecatnetworks.com).
@ -17,6 +20,8 @@ Configuration for [Bluecat](https://www.bluecatnetworks.com).
<!--more-->
- Code: `bluecat`
- Since: v0.5.0
Here is an example bash command using the Bluecat provider:
@ -27,7 +32,7 @@ BLUECAT_USER_NAME=myusername \
BLUECAT_CONFIG_NAME=myconfig \
BLUECAT_SERVER_URL=https://bam.example.com \
BLUECAT_TTL=30 \
lego --email myemail@example.com --dns bluecat --domains my.example.org run
lego --email you@example.com --dns bluecat --domains my.example.org run
```
@ -44,7 +49,7 @@ lego --email myemail@example.com --dns bluecat --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -57,7 +62,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_checkdomain.md
View file

@ -3,13 +3,16 @@ title: "Checkdomain"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: checkdomain
dnsprovider:
since: "v3.3.0"
code: "checkdomain"
url: "https://checkdomain.de/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/checkdomain/checkdomain.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.3.0
Configuration for [Checkdomain](https://checkdomain.de/).
@ -17,12 +20,14 @@ Configuration for [Checkdomain](https://checkdomain.de/).
<!--more-->
- Code: `checkdomain`
- Since: v3.3.0
Here is an example bash command using the Checkdomain provider:
```bash
CHECKDOMAIN_TOKEN=yoursecrettoken \
lego --email myemail@example.com --dns checkdomain --domains my.example.org run
lego --email you@example.com --dns checkdomain --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns checkdomain --domains my.example.org run
| `CHECKDOMAIN_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `CHECKDOMAIN_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

15
docs/content/dns/zz_gen_clouddns.md
View file

@ -3,13 +3,16 @@ title: "CloudDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: clouddns
dnsprovider:
since: "v3.6.0"
code: "clouddns"
url: "https://vshosting.eu/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/clouddns/clouddns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.6.0
Configuration for [CloudDNS](https://vshosting.eu/).
@ -17,14 +20,16 @@ Configuration for [CloudDNS](https://vshosting.eu/).
<!--more-->
- Code: `clouddns`
- Since: v3.6.0
Here is an example bash command using the CloudDNS provider:
```bash
CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \
CLOUDDNS_EMAIL=foo@bar.com \
CLOUDDNS_EMAIL=you@example.com \
CLOUDDNS_PASSWORD=b9841238feb177a84330f \
lego --email myemail@example.com --dns clouddns --domains my.example.org run
lego --email you@example.com --dns clouddns --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns clouddns --domains my.example.org run
| `CLOUDDNS_PASSWORD` | Account 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `CLOUDDNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

17
docs/content/dns/zz_gen_cloudflare.md
View file

@ -3,13 +3,16 @@ title: "Cloudflare"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: cloudflare
dnsprovider:
since: "v0.3.0"
code: "cloudflare"
url: "https://www.cloudflare.com/dns/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/cloudflare/cloudflare.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Cloudflare](https://www.cloudflare.com/dns/).
@ -17,18 +20,20 @@ Configuration for [Cloudflare](https://www.cloudflare.com/dns/).
<!--more-->
- Code: `cloudflare`
- Since: v0.3.0
Here is an example bash command using the Cloudflare provider:
```bash
CLOUDFLARE_EMAIL=foo@bar.com \
CLOUDFLARE_EMAIL=you@example.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --email myemail@example.com --dns cloudflare --domains my.example.org run
lego --email you@example.com --dns cloudflare --domains my.example.org run
# or
CLOUDFLARE_DNS_API_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --email myemail@example.com --dns cloudflare --domains my.example.org run
lego --email you@example.com --dns cloudflare --domains my.example.org run
```
@ -48,7 +53,7 @@ lego --email myemail@example.com --dns cloudflare --domains my.example.org run
| `CLOUDFLARE_ZONE_API_TOKEN` | Alias to CF_ZONE_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -61,7 +66,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_cloudns.md
View file

@ -3,13 +3,16 @@ title: "ClouDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: cloudns
dnsprovider:
since: "v2.3.0"
code: "cloudns"
url: "https://www.cloudns.net"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/cloudns/cloudns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.3.0
Configuration for [ClouDNS](https://www.cloudns.net).
@ -17,13 +20,15 @@ Configuration for [ClouDNS](https://www.cloudns.net).
<!--more-->
- Code: `cloudns`
- Since: v2.3.0
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
lego --email you@example.com --dns cloudns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns cloudns --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_cloudxns.md
View file

@ -3,13 +3,16 @@ title: "CloudXNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: cloudxns
dnsprovider:
since: "v0.5.0"
code: "cloudxns"
url: "https://www.cloudxns.net/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/cloudxns/cloudxns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [CloudXNS](https://www.cloudxns.net/).
@ -17,13 +20,15 @@ Configuration for [CloudXNS](https://www.cloudxns.net/).
<!--more-->
- Code: `cloudxns`
- Since: v0.5.0
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
lego --email you@example.com --dns cloudxns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns cloudxns --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_conoha.md
View file

@ -3,13 +3,16 @@ title: "ConoHa"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: conoha
dnsprovider:
since: "v1.2.0"
code: "conoha"
url: "https://www.conoha.jp/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/conoha/conoha.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.2.0
Configuration for [ConoHa](https://www.conoha.jp/).
@ -17,6 +20,8 @@ Configuration for [ConoHa](https://www.conoha.jp/).
<!--more-->
- Code: `conoha`
- Since: v1.2.0
Here is an example bash command using the ConoHa provider:
@ -24,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 myemail@example.com --dns conoha --domains my.example.org run
lego --email you@example.com --dns conoha --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns conoha --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -53,7 +58,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_constellix.md
View file

@ -3,13 +3,16 @@ title: "Constellix"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: constellix
dnsprovider:
since: "v3.4.0"
code: "constellix"
url: "https://constellix.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/constellix/constellix.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.4.0
Configuration for [Constellix](https://constellix.com).
@ -17,13 +20,15 @@ Configuration for [Constellix](https://constellix.com).
<!--more-->
- Code: `constellix`
- Since: v3.4.0
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 myemail@example.com --dns constellix --domains my.example.org run
lego --email you@example.com --dns constellix --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns constellix --domains my.example.org run
| `CONSTELLIX_SECRET_KEY` | User 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `CONSTELLIX_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_desec.md
View file

@ -3,13 +3,16 @@ title: "deSEC.io"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: desec
dnsprovider:
since: "v3.7.0"
code: "desec"
url: "https://desec.io"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/desec/desec.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [deSEC.io](https://desec.io).
@ -17,12 +20,14 @@ Configuration for [deSEC.io](https://desec.io).
<!--more-->
- Code: `desec`
- Since: v3.7.0
Here is an example bash command using the deSEC.io provider:
```bash
DESEC_TOKEN=x-xxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --email myemail@example.com --dns desec --domains my.example.org run
lego --email you@example.com --dns desec --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns desec --domains my.example.org run
| `DESEC_TOKEN` | Domain 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `DESEC_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

17
docs/content/dns/zz_gen_designate.md
View file

@ -3,13 +3,16 @@ title: "Designate DNSaaS for Openstack"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: designate
dnsprovider:
since: "v2.2.0"
code: "designate"
url: "https://docs.openstack.org/designate/latest/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/designate/designate.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.2.0
Configuration for [Designate DNSaaS for Openstack](https://docs.openstack.org/designate/latest/).
@ -17,13 +20,15 @@ Configuration for [Designate DNSaaS for Openstack](https://docs.openstack.org/de
<!--more-->
- Code: `designate`
- Since: v2.2.0
Here is an example bash command using the Designate DNSaaS for Openstack provider:
```bash
# With a `clouds.yaml`
OS_CLOUD=my_openstack \
lego --email myemail@example.com --dns designate --domains my.example.org run
lego --email you@example.com --dns designate --domains my.example.org run
# or
@ -32,7 +37,7 @@ OS_REGION_NAME=RegionOne \
OS_PROJECT_ID=23d4522a987d4ab529f722a007c27846
OS_USERNAME=myuser \
OS_PASSWORD=passw0rd \
lego --email myemail@example.com --dns designate --domains my.example.org run
lego --email you@example.com --dns designate --domains my.example.org run
# or
@ -41,7 +46,7 @@ OS_REGION_NAME=RegionOne \
OS_AUTH_TYPE=v3applicationcredential \
OS_APPLICATION_CREDENTIAL_ID=imn74uq0or7dyzz20dwo1ytls4me8dry \
OS_APPLICATION_CREDENTIAL_SECRET=68FuSPSdQqkFQYH5X1OoriEIJOwyLtQ8QSqXZOc9XxFK1A9tzZT6He2PfPw0OMja \
lego --email myemail@example.com --dns designate --domains my.example.org run
lego --email you@example.com --dns designate --domains my.example.org run
```
@ -62,7 +67,7 @@ lego --email myemail@example.com --dns designate --domains my.example.org run
| `OS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -76,7 +81,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `OS_TENANT_NAME` | Tenant name (deprecated see OS_PROJECT_NAME and OS_PROJECT_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_digitalocean.md
View file

@ -3,13 +3,16 @@ title: "Digital Ocean"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: digitalocean
dnsprovider:
since: "v0.3.0"
code: "digitalocean"
url: "https://www.digitalocean.com/docs/networking/dns/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/digitalocean/digitalocean.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Digital Ocean](https://www.digitalocean.com/docs/networking/dns/).
@ -17,12 +20,14 @@ Configuration for [Digital Ocean](https://www.digitalocean.com/docs/networking/d
<!--more-->
- Code: `digitalocean`
- Since: v0.3.0
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
lego --email you@example.com --dns digitalocean --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns digitalocean --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_dnsimple.md
View file

@ -3,13 +3,16 @@ title: "DNSimple"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dnsimple
dnsprovider:
since: "v0.3.0"
code: "dnsimple"
url: "https://dnsimple.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dnsimple/dnsimple.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [DNSimple](https://dnsimple.com/).
@ -17,12 +20,14 @@ Configuration for [DNSimple](https://dnsimple.com/).
<!--more-->
- Code: `dnsimple`
- Since: v0.3.0
Here is an example bash command using the DNSimple provider:
```bash
DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \
lego --email myemail@example.com --dns dnsimple --domains my.example.org run
lego --email you@example.com --dns dnsimple --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns dnsimple --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_dnsmadeeasy.md
View file

@ -3,13 +3,16 @@ title: "DNS Made Easy"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dnsmadeeasy
dnsprovider:
since: "v0.4.0"
code: "dnsmadeeasy"
url: "https://dnsmadeeasy.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dnsmadeeasy/dnsmadeeasy.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
@ -17,13 +20,15 @@ Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
<!--more-->
- Code: `dnsmadeeasy`
- Since: v0.4.0
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
lego --email you@example.com --dns dnsmadeeasy --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns dnsmadeeasy --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_dnspod.md
View file

@ -3,13 +3,16 @@ title: "DNSPod"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dnspod
dnsprovider:
since: "v0.4.0"
code: "dnspod"
url: "https://www.dnspod.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dnspod/dnspod.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [DNSPod](https://www.dnspod.com/).
@ -17,12 +20,14 @@ Configuration for [DNSPod](https://www.dnspod.com/).
<!--more-->
- Code: `dnspod`
- Since: v0.4.0
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
lego --email you@example.com --dns dnspod --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns dnspod --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_dode.md
View file

@ -3,13 +3,16 @@ title: "Domain Offensive (do.de)"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dode
dnsprovider:
since: "v2.4.0"
code: "dode"
url: "https://www.do.de/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dode/dode.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.4.0
Configuration for [Domain Offensive (do.de)](https://www.do.de/).
@ -17,12 +20,14 @@ Configuration for [Domain Offensive (do.de)](https://www.do.de/).
<!--more-->
- Code: `dode`
- Since: v2.4.0
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
lego --email you@example.com --dns dode --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns dode --domains my.example.org run
| `DODE_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `DODE_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_domeneshop.md
View file

@ -3,13 +3,16 @@ title: "Domeneshop"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: domeneshop
dnsprovider:
since: "v4.3.0"
code: "domeneshop"
url: "https://domene.shop"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/domeneshop/domeneshop.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.3.0
Configuration for [Domeneshop](https://domene.shop).
@ -17,6 +20,8 @@ Configuration for [Domeneshop](https://domene.shop).
<!--more-->
- Code: `domeneshop`
- Since: v4.3.0
Here is an example bash command using the Domeneshop provider:
@ -37,7 +42,7 @@ lego --email example@example.com --dns domeneshop --domains example.com run
| `DOMENESHOP_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `DOMENESHOP_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
### API credentials

13
docs/content/dns/zz_gen_dreamhost.md
View file

@ -3,13 +3,16 @@ title: "DreamHost"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dreamhost
dnsprovider:
since: "v1.1.0"
code: "dreamhost"
url: "https://www.dreamhost.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dreamhost/dreamhost.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [DreamHost](https://www.dreamhost.com).
@ -17,12 +20,14 @@ Configuration for [DreamHost](https://www.dreamhost.com).
<!--more-->
- Code: `dreamhost`
- Since: v1.1.0
Here is an example bash command using the DreamHost provider:
```bash
DREAMHOST_API_KEY="YOURAPIKEY" \
lego --email myemail@example.com --dns dreamhost --domains my.example.org run
lego --email you@example.com --dns dreamhost --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns dreamhost --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_duckdns.md
View file

@ -3,13 +3,16 @@ title: "Duck DNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: duckdns
dnsprovider:
since: "v0.5.0"
code: "duckdns"
url: "https://www.duckdns.org/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/duckdns/duckdns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Duck DNS](https://www.duckdns.org/).
@ -17,12 +20,14 @@ Configuration for [Duck DNS](https://www.duckdns.org/).
<!--more-->
- Code: `duckdns`
- Since: v0.5.0
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
lego --email you@example.com --dns duckdns --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns duckdns --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_dyn.md
View file

@ -3,13 +3,16 @@ title: "Dyn"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dyn
dnsprovider:
since: "v0.3.0"
code: "dyn"
url: "https://dyn.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dyn/dyn.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Dyn](https://dyn.com/).
@ -17,6 +20,8 @@ Configuration for [Dyn](https://dyn.com/).
<!--more-->
- Code: `dyn`
- Since: v0.3.0
Here is an example bash command using the Dyn provider:
@ -24,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 myemail@example.com --dns dyn --domains my.example.org run
lego --email you@example.com --dns dyn --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns dyn --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_dynu.md
View file

@ -3,13 +3,16 @@ title: "Dynu"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: dynu
dnsprovider:
since: "v3.5.0"
code: "dynu"
url: "https://www.dynu.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dynu/dynu.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.5.0
Configuration for [Dynu](https://www.dynu.com/).
@ -17,12 +20,14 @@ Configuration for [Dynu](https://www.dynu.com/).
<!--more-->
- Code: `dynu`
- Since: v3.5.0
Here is an example bash command using the Dynu provider:
```bash
DYNU_API_KEY=1234567890abcdefghijklmnopqrstuvwxyz \
lego --email myemail@example.com --dns dynu --domains my.example.org run
lego --email you@example.com --dns dynu --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns dynu --domains my.example.org run
| `DYNU_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `DYNU_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_easydns.md
View file

@ -3,13 +3,16 @@ title: "EasyDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: easydns
dnsprovider:
since: "v2.6.0"
code: "easydns"
url: "https://easydns.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/easydns/easydns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.6.0
Configuration for [EasyDNS](https://easydns.com/).
@ -17,13 +20,15 @@ Configuration for [EasyDNS](https://easydns.com/).
<!--more-->
- Code: `easydns`
- Since: v2.6.0
Here is an example bash command using the EasyDNS provider:
```bash
EASYDNS_TOKEN=<your token> \
EASYDNS_KEY=<your key> \
lego --email myemail@example.com --dns easydns --domains my.example.org run
lego --email you@example.com --dns easydns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns easydns --domains my.example.org run
| `EASYDNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `EASYDNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
To test with the sandbox environment set ```EASYDNS_ENDPOINT=https://sandbox.rest.easydns.net```

14
docs/content/dns/zz_gen_edgedns.md
View file

@ -3,14 +3,16 @@ title: "Akamai EdgeDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: edgedns
dnsprovider:
since: "v3.9.0"
code: "edgedns"
url: "https://www.akamai.com/us/en/products/security/edge-dns.jsp"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/edgedns/edgedns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.9.0
Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS
@ -18,6 +20,8 @@ Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the D
<!--more-->
- Code: `edgedns`
- Since: v3.9.0
Here is an example bash command using the Akamai EdgeDNS provider:
@ -26,7 +30,7 @@ AKAMAI_CLIENT_SECRET=abcdefghijklmnopqrstuvwxyz1234567890ABCDEFG= \
AKAMAI_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \
lego --email myemail@example.com --dns edgedns --domains my.example.org run
lego --email you@example.com --dns edgedns --domains my.example.org run
```
@ -44,7 +48,7 @@ lego --email myemail@example.com --dns edgedns --domains my.example.org run
| `AKAMAI_HOST` | API host, managed by the Akamai EdgeGrid client |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -56,7 +60,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
Akamai credentials are automatically detected in the following locations and prioritized in the following order:

13
docs/content/dns/zz_gen_epik.md
View file

@ -3,13 +3,16 @@ title: "Epik"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: epik
dnsprovider:
since: "v4.5.0"
code: "epik"
url: "https://www.epik.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/epik/epik.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Epik](https://www.epik.com/).
@ -17,12 +20,14 @@ Configuration for [Epik](https://www.epik.com/).
<!--more-->
- Code: `epik`
- Since: v4.5.0
Here is an example bash command using the Epik provider:
```bash
EPIK_SIGNATURE=xxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --email myemail@example.com --dns epik --domains my.example.org run
lego --email you@example.com --dns epik --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns epik --domains my.example.org run
| `EPIK_SIGNATURE` | Epik API signature (https://registrar.epik.com/account/api-settings/) |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `EPIK_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_exec.md
View file

@ -3,25 +3,30 @@ title: "External program"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: exec
dnsprovider:
since: "v0.5.0"
code: "exec"
url: "/dns/exec"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/exec/exec.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Solving the DNS-01 challenge using an external program.
<!--more-->
- Code: `exec`
- Since: v0.5.0
Here is an example bash command using the External program provider:
```bash
EXEC_PATH=/the/path/to/myscript.sh \
lego --email myemail@example.com --dns exec --domains my.example.org run
lego --email you@example.com --dns exec --domains my.example.org run
```
@ -56,7 +61,7 @@ For example, requesting a certificate for the domain 'my.example.org' can be ach
```bash
EXEC_PATH=./update-dns.sh \
lego --email myemail@example.com \
lego --email you@example.com \
--dns exec \
--domains my.example.org run
```
@ -78,7 +83,7 @@ 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 --email myemail@example.com \
lego --email you@example.com \
--dns exec \
--domains my.example.org run
```

13
docs/content/dns/zz_gen_exoscale.md
View file

@ -3,13 +3,16 @@ title: "Exoscale"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: exoscale
dnsprovider:
since: "v0.4.0"
code: "exoscale"
url: "https://www.exoscale.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/exoscale/exoscale.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Exoscale](https://www.exoscale.com/).
@ -17,13 +20,15 @@ Configuration for [Exoscale](https://www.exoscale.com/).
<!--more-->
- Code: `exoscale`
- Since: v0.4.0
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
lego --email you@example.com --dns exoscale --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns exoscale --domains my.example.org run
| `EXOSCALE_API_SECRET` | API 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_freemyip.md
View file

@ -3,13 +3,16 @@ title: "freemyip.com"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: freemyip
dnsprovider:
since: "v4.5.0"
code: "freemyip"
url: "https://freemyip.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/freemyip/freemyip.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [freemyip.com](https://freemyip.com/).
@ -17,12 +20,14 @@ Configuration for [freemyip.com](https://freemyip.com/).
<!--more-->
- Code: `freemyip`
- Since: v4.5.0
Here is an example bash command using the freemyip.com provider:
```bash
FREEMYIP_TOKEN=xxxxxx \
lego --email myemail@example.com --dns freemyip --domains my.example.org run
lego --email you@example.com --dns freemyip --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns freemyip --domains my.example.org run
| `FREEMYIP_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `FREEMYIP_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_gandi.md
View file

@ -3,13 +3,16 @@ title: "Gandi"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: gandi
dnsprovider:
since: "v0.3.0"
code: "gandi"
url: "https://www.gandi.net"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandi/gandi.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Gandi](https://www.gandi.net).
@ -17,12 +20,14 @@ Configuration for [Gandi](https://www.gandi.net).
<!--more-->
- Code: `gandi`
- Since: v0.3.0
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
lego --email you@example.com --dns gandi --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns gandi --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_gandiv5.md
View file

@ -3,13 +3,16 @@ title: "Gandi Live DNS (v5)"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: gandiv5
dnsprovider:
since: "v0.5.0"
code: "gandiv5"
url: "https://www.gandi.net"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandiv5/gandiv5.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Gandi Live DNS (v5)](https://www.gandi.net).
@ -17,12 +20,14 @@ Configuration for [Gandi Live DNS (v5)](https://www.gandi.net).
<!--more-->
- Code: `gandiv5`
- Since: v0.5.0
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
lego --email you@example.com --dns gandiv5 --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns gandiv5 --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_gcloud.md
View file

@ -3,13 +3,16 @@ title: "Google Cloud"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: gcloud
dnsprovider:
since: "v0.3.0"
code: "gcloud"
url: "https://cloud.google.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gcloud/gcloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Google Cloud](https://cloud.google.com).
@ -17,6 +20,8 @@ Configuration for [Google Cloud](https://cloud.google.com).
<!--more-->
- Code: `gcloud`
- Since: v0.3.0
{{% notice note %}}
_Please contribute by adding a CLI example._
@ -35,7 +40,7 @@ _Please contribute by adding a CLI example._
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_gcore.md
View file

@ -3,13 +3,16 @@ title: "G-Core Labs"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: gcore
dnsprovider:
since: "v4.5.0"
code: "gcore"
url: "https://gcorelabs.com/dns/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gcore/gcore.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [G-Core Labs](https://gcorelabs.com/dns/).
@ -17,12 +20,14 @@ Configuration for [G-Core Labs](https://gcorelabs.com/dns/).
<!--more-->
- Code: `gcore`
- Since: v4.5.0
Here is an example bash command using the G-Core Labs provider:
```bash
GCORE_PERMANENT_API_TOKEN=xxxxx \
lego --email myemail@example.com --dns gcore --domains my.example.org run
lego --email you@example.com --dns gcore --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns gcore --domains my.example.org run
| `GCORE_PERMANENT_API_TOKEN` | Permanent API tokene (https://gcorelabs.com/blog/permanent-api-token-explained/) |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `GCORE_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_glesys.md
View file

@ -3,13 +3,16 @@ title: "Glesys"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: glesys
dnsprovider:
since: "v0.5.0"
code: "glesys"
url: "https://glesys.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/glesys/glesys.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Glesys](https://glesys.com/).
@ -17,13 +20,15 @@ Configuration for [Glesys](https://glesys.com/).
<!--more-->
- Code: `glesys`
- Since: v0.5.0
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
lego --email you@example.com --dns glesys --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns glesys --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_godaddy.md
View file

@ -3,13 +3,16 @@ title: "Go Daddy"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: godaddy
dnsprovider:
since: "v0.5.0"
code: "godaddy"
url: "https://godaddy.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/godaddy/godaddy.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Go Daddy](https://godaddy.com).
@ -17,13 +20,15 @@ Configuration for [Go Daddy](https://godaddy.com).
<!--more-->
- Code: `godaddy`
- Since: v0.5.0
Here is an example bash command using the Go Daddy provider:
```bash
GODADDY_API_KEY=xxxxxxxx \
GODADDY_API_SECRET=yyyyyyyy \
lego --email myemail@example.com --dns godaddy --domains my.example.org run
lego --email you@example.com --dns godaddy --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns godaddy --domains my.example.org run
| `GODADDY_API_SECRET` | API 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_hetzner.md
View file

@ -3,13 +3,16 @@ title: "Hetzner"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: hetzner
dnsprovider:
since: "v3.7.0"
code: "hetzner"
url: "https://hetzner.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hetzner/hetzner.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [Hetzner](https://hetzner.com).
@ -17,12 +20,14 @@ Configuration for [Hetzner](https://hetzner.com).
<!--more-->
- Code: `hetzner`
- Since: v3.7.0
Here is an example bash command using the Hetzner provider:
```bash
HETZNER_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
lego -email myemail@example.com --dns hetzner --domains my.example.org -run
lego --email you@example.com --dns hetzner --domains my.example.org run
```
@ -35,7 +40,7 @@ lego -email myemail@example.com --dns hetzner --domains my.example.org -run
| `HETZNER_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `HETZNER_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_hostingde.md
View file

@ -3,13 +3,16 @@ title: "Hosting.de"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: hostingde
dnsprovider:
since: "v1.1.0"
code: "hostingde"
url: "https://www.hosting.de/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hostingde/hostingde.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Hosting.de](https://www.hosting.de/).
@ -17,12 +20,14 @@ Configuration for [Hosting.de](https://www.hosting.de/).
<!--more-->
- Code: `hostingde`
- Since: v1.1.0
Here is an example bash command using the Hosting.de provider:
```bash
HOSTINGDE_API_KEY=xxxxxxxx \
lego --email myemail@example.com --dns hostingde --domains my.example.org run
lego --email you@example.com --dns hostingde --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns hostingde --domains my.example.org run
| `HOSTINGDE_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `HOSTINGDE_ZONE_NAME` | Zone name in ACE format |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_hosttech.md
View file

@ -3,13 +3,16 @@ title: "Hosttech"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: hosttech
dnsprovider:
since: "v4.5.0"
code: "hosttech"
url: "https://www.hosttech.eu/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hosttech/hosttech.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Hosttech](https://www.hosttech.eu/).
@ -17,12 +20,14 @@ Configuration for [Hosttech](https://www.hosttech.eu/).
<!--more-->
- Code: `hosttech`
- Since: v4.5.0
Here is an example bash command using the Hosttech provider:
```bash
HOSTTECH_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --email myemail@example.com --dns hosttech --domains my.example.org run
lego --email you@example.com --dns hosttech --domains my.example.org run
```
@ -36,7 +41,7 @@ lego --email myemail@example.com --dns hosttech --domains my.example.org run
| `HOSTTECH_PASSWORD` | API 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `HOSTTECH_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_httpreq.md
View file

@ -3,13 +3,16 @@ title: "HTTP request"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: httpreq
dnsprovider:
since: "v2.0.0"
code: "httpreq"
url: "/lego/dns/httpreq/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/httpreq/httpreq.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.0.0
Configuration for [HTTP request](/lego/dns/httpreq/).
@ -17,12 +20,14 @@ Configuration for [HTTP request](/lego/dns/httpreq/).
<!--more-->
- Code: `httpreq`
- Since: v2.0.0
Here is an example bash command using the HTTP request provider:
```bash
HTTPREQ_ENDPOINT=http://my.server.com:9090 \
lego --email myemail@example.com --dns httpreq --domains my.example.org run
lego --email you@example.com --dns httpreq --domains my.example.org run
```
@ -36,7 +41,7 @@ lego --email myemail@example.com --dns httpreq --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `HTTPREQ_USERNAME` | Basic authentication 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_hurricane.md
View file

@ -3,13 +3,16 @@ title: "Hurricane Electric DNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: hurricane
dnsprovider:
since: "v4.3.0"
code: "hurricane"
url: "https://dns.he.net/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hurricane/hurricane.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.3.0
Configuration for [Hurricane Electric DNS](https://dns.he.net/).
@ -17,15 +20,17 @@ Configuration for [Hurricane Electric DNS](https://dns.he.net/).
<!--more-->
- Code: `hurricane`
- Since: v4.3.0
Here is an example bash command using the Hurricane Electric DNS provider:
```bash
HURRICANE_TOKENS=example.org:token \
lego --email myemail@example.com --dns hurricane -d example.org -d *.example.org run
lego --email you@example.com --dns hurricane --domains example.org --domains '*.example.org run'
HURRICANE_TOKENS=my.example.org:token1,demo.example.org:token2 \
lego -m myemail@example.com --dns hurricane -d my.example.org -d demo.example.org
lego --email you@example.com --dns hurricane --domains my.example.org --domains demo.example.org
```
@ -38,7 +43,7 @@ lego -m myemail@example.com --dns hurricane -d my.example.org -d demo.example.or
| `HURRICANE_TOKENS` | TXT record names and tokens |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_hyperone.md
View file

@ -3,13 +3,16 @@ title: "HyperOne"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: hyperone
dnsprovider:
since: "v3.9.0"
code: "hyperone"
url: "https://www.hyperone.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hyperone/hyperone.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.9.0
Configuration for [HyperOne](https://www.hyperone.com).
@ -17,11 +20,13 @@ Configuration for [HyperOne](https://www.hyperone.com).
<!--more-->
- Code: `hyperone`
- Since: v3.9.0
Here is an example bash command using the HyperOne provider:
```bash
lego --email myemail@example.com --dns hyperone --domains my.example.org run
lego --email you@example.com --dns hyperone --domains my.example.org run
```
@ -41,7 +46,7 @@ lego --email myemail@example.com --dns hyperone --domains my.example.org run
| `HYPERONE_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_ibmcloud.md
View file

@ -3,13 +3,16 @@ title: "IBM Cloud (SoftLayer)"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: ibmcloud
dnsprovider:
since: "v4.5.0"
code: "ibmcloud"
url: "https://www.ibm.com/cloud/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/ibmcloud/ibmcloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [IBM Cloud (SoftLayer)](https://www.ibm.com/cloud/).
@ -17,13 +20,15 @@ Configuration for [IBM Cloud (SoftLayer)](https://www.ibm.com/cloud/).
<!--more-->
- Code: `ibmcloud`
- Since: v4.5.0
Here is an example bash command using the IBM Cloud (SoftLayer) provider:
```bash
SOFTLAYER_USERNAME=xxxxx \
SOFTLAYER_API_KEY=yyyyy \
lego --email myemail@example.com --dns ibmcloud --domains my.example.org run
lego --email you@example.com --dns ibmcloud --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns ibmcloud --domains my.example.org run
| `SOFTLAYER_USERNAME` | User name (IBM Cloud is <accountID>_<emailAddress>) |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `SOFTLAYER_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_iij.md
View file

@ -3,13 +3,16 @@ title: "Internet Initiative Japan"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: iij
dnsprovider:
since: "v1.1.0"
code: "iij"
url: "https://www.iij.ad.jp/en/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/iij/iij.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Internet Initiative Japan](https://www.iij.ad.jp/en/).
@ -17,6 +20,8 @@ Configuration for [Internet Initiative Japan](https://www.iij.ad.jp/en/).
<!--more-->
- Code: `iij`
- Since: v1.1.0
Here is an example bash command using the Internet Initiative Japan provider:
@ -24,7 +29,7 @@ Here is an example bash command using the Internet Initiative Japan provider:
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
lego --email you@example.com --dns iij --domains my.example.org run
```
@ -39,7 +44,7 @@ lego -email myemail@example.com --dns iij --domains my.example.org -run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_iijdpf.md
View file

@ -3,13 +3,16 @@ title: "IIJ DNS Platform Service"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: iijdpf
dnsprovider:
since: "v4.7.0"
code: "iijdpf"
url: "https://www.iij.ad.jp/en/biz/dns-pfm/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/iijdpf/iijdpf.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.7.0
Configuration for [IIJ DNS Platform Service](https://www.iij.ad.jp/en/biz/dns-pfm/).
@ -17,13 +20,15 @@ Configuration for [IIJ DNS Platform Service](https://www.iij.ad.jp/en/biz/dns-pf
<!--more-->
- Code: `iijdpf`
- Since: v4.7.0
Here is an example bash command using the IIJ DNS Platform Service provider:
```bash
IIJ_DPF_API_TOKEN=xxxxxxxx \
IIJ_DPF_DPM_SERVICE_CODE=yyyyyy \
lego -email myemail@example.com --dns iijdpf --domains my.example.org run
lego --email you@example.com --dns iijdpf --domains my.example.org run
```
@ -37,7 +42,7 @@ lego -email myemail@example.com --dns iijdpf --domains my.example.org run
| `IIJ_DPF_DPM_SERVICE_CODE` | IIJ Managed DNS Service's 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `IIJ_DPF_TTL` | The TTL of the TXT record used for the DNS challenge, default to 300 |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_infoblox.md
View file

@ -3,13 +3,16 @@ title: "Infoblox"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: infoblox
dnsprovider:
since: "v4.4.0"
code: "infoblox"
url: "https://www.infoblox.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/infoblox/infoblox.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Infoblox](https://www.infoblox.com/).
@ -17,6 +20,8 @@ Configuration for [Infoblox](https://www.infoblox.com/).
<!--more-->
- Code: `infoblox`
- Since: v4.4.0
Here is an example bash command using the Infoblox provider:
@ -24,7 +29,7 @@ Here is an example bash command using the Infoblox provider:
INFOBLOX_USER=api-user-529 \
INFOBLOX_PASSWORD=b9841238feb177a84330febba8a83208921177bffe733 \
INFOBLOX_HOST=infoblox.example.org
lego --email myemail@example.com --dns infoblox --domains my.example.org run
lego --email you@example.com --dns infoblox --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns infoblox --domains my.example.org run
| `INFOBLOX_USER` | Account 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -56,7 +61,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `INFOBLOX_WAPI_VERSION` | The version of WAPI being used, default: 2.11 |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
When creating an API's user ensure it has the proper permissions for the view you are working with.

13
docs/content/dns/zz_gen_infomaniak.md
View file

@ -3,13 +3,16 @@ title: "Infomaniak"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: infomaniak
dnsprovider:
since: "v4.1.0"
code: "infomaniak"
url: "https://www.infomaniak.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/infomaniak/infomaniak.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.1.0
Configuration for [Infomaniak](https://www.infomaniak.com/).
@ -17,12 +20,14 @@ Configuration for [Infomaniak](https://www.infomaniak.com/).
<!--more-->
- Code: `infomaniak`
- Since: v4.1.0
Here is an example bash command using the Infomaniak provider:
```bash
INFOMANIAK_ACCESS_TOKEN=1234567898765432 \
lego --email myemail@example.com --dns infomaniak --domains my.example.org run
lego --email you@example.com --dns infomaniak --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns infomaniak --domains my.example.org run
| `INFOMANIAK_ACCESS_TOKEN` | Access 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `INFOMANIAK_TTL` | The TTL of the TXT record used for the DNS challenge in seconds |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Access token

13
docs/content/dns/zz_gen_internetbs.md
View file

@ -3,13 +3,16 @@ title: "Internet.bs"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: internetbs
dnsprovider:
since: "v4.5.0"
code: "internetbs"
url: "https://internetbs.net"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/internetbs/internetbs.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Internet.bs](https://internetbs.net).
@ -17,13 +20,15 @@ Configuration for [Internet.bs](https://internetbs.net).
<!--more-->
- Code: `internetbs`
- Since: v4.5.0
Here is an example bash command using the Internet.bs provider:
```bash
INTERNET_BS_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx \
INTERNET_BS_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \
lego --email myemail@example.com --dns internetbs --domains my.example.org run
lego --email you@example.com --dns internetbs --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns internetbs --domains my.example.org run
| `INTERNET_BS_PASSWORD` | API 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `INTERNET_BS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

15
docs/content/dns/zz_gen_inwx.md
View file

@ -3,13 +3,16 @@ title: "INWX"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: inwx
dnsprovider:
since: "v2.0.0"
code: "inwx"
url: "https://www.inwx.de/en"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/inwx/inwx.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.0.0
Configuration for [INWX](https://www.inwx.de/en).
@ -17,19 +20,21 @@ Configuration for [INWX](https://www.inwx.de/en).
<!--more-->
- Code: `inwx`
- Since: v2.0.0
Here is an example bash command using the INWX provider:
```bash
INWX_USERNAME=xxxxxxxxxx \
INWX_PASSWORD=yyyyyyyyyy \
lego --email myemail@example.com --dns inwx --domains my.example.org run
lego --email you@example.com --dns inwx --domains my.example.org run
# 2FA
INWX_USERNAME=xxxxxxxxxx \
INWX_PASSWORD=yyyyyyyyyy \
INWX_SHARED_SECRET=zzzzzzzzzz \
lego --email myemail@example.com --dns inwx --domains my.example.org run
lego --email you@example.com --dns inwx --domains my.example.org run
```
@ -43,7 +48,7 @@ lego --email myemail@example.com --dns inwx --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -57,7 +62,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_ionos.md
View file

@ -3,13 +3,16 @@ title: "Ionos"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: ionos
dnsprovider:
since: "v4.2.0"
code: "ionos"
url: "https://ionos.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/ionos/ionos.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.2.0
Configuration for [Ionos](https://ionos.com).
@ -17,12 +20,14 @@ Configuration for [Ionos](https://ionos.com).
<!--more-->
- Code: `ionos`
- Since: v4.2.0
Here is an example bash command using the Ionos provider:
```bash
IONOS_API_KEY=xxxxxxxx \
lego --email myemail@example.com --dns ionos --domains my.example.org run
lego --email you@example.com --dns ionos --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns ionos --domains my.example.org run
| `IONOS_API_KEY` | API key `<prefix>.<secret>` https://developer.hosting.ionos.com/docs/getstarted |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `IONOS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_iwantmyname.md
View file

@ -3,13 +3,16 @@ title: "iwantmyname"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: iwantmyname
dnsprovider:
since: "v4.7.0"
code: "iwantmyname"
url: "https://iwantmyname.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/iwantmyname/iwantmyname.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.7.0
Configuration for [iwantmyname](https://iwantmyname.com).
@ -17,13 +20,15 @@ Configuration for [iwantmyname](https://iwantmyname.com).
<!--more-->
- Code: `iwantmyname`
- Since: v4.7.0
Here is an example bash command using the iwantmyname provider:
```bash
IWANTMYNAME_USERNAME=xxxxxxxx \
IWANTMYNAME_PASSWORD=xxxxxxxx \
lego --email myemail@example.com --dns iwantmyname --domains my.example.org run
lego --email you@example.com --dns iwantmyname --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns iwantmyname --domains my.example.org run
| `IWANTMYNAME_USERNAME` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `IWANTMYNAME_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

17
docs/content/dns/zz_gen_joker.md
View file

@ -3,13 +3,16 @@ title: "Joker"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: joker
dnsprovider:
since: "v2.6.0"
code: "joker"
url: "https://joker.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/joker/joker.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.6.0
Configuration for [Joker](https://joker.com).
@ -17,6 +20,8 @@ Configuration for [Joker](https://joker.com).
<!--more-->
- Code: `joker`
- Since: v2.6.0
Here is an example bash command using the Joker provider:
@ -25,17 +30,17 @@ Here is an example bash command using the Joker provider:
JOKER_API_MODE=SVC \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --email myemail@example.com --dns joker --domains my.example.org run
lego --email you@example.com --dns joker --domains my.example.org run
# DMAPI
JOKER_API_MODE=DMAPI \
JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \
lego --email myemail@example.com --dns joker --domains my.example.org run
lego --email you@example.com --dns joker --domains my.example.org run
## or
JOKER_API_MODE=DMAPI \
JOKER_API_KEY=<your API key> \
lego --email myemail@example.com --dns joker --domains my.example.org run
lego --email you@example.com --dns joker --domains my.example.org run
```
@ -51,7 +56,7 @@ lego --email myemail@example.com --dns joker --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -65,7 +70,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `JOKER_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## SVC mode

11
docs/content/dns/zz_gen_lightsail.md
View file

@ -3,13 +3,16 @@ title: "Amazon Lightsail"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: lightsail
dnsprovider:
since: "v0.5.0"
code: "lightsail"
url: "https://aws.amazon.com/lightsail/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/lightsail/lightsail.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Amazon Lightsail](https://aws.amazon.com/lightsail/).
@ -17,6 +20,8 @@ Configuration for [Amazon Lightsail](https://aws.amazon.com/lightsail/).
<!--more-->
- Code: `lightsail`
- Since: v0.5.0
{{% notice note %}}
_Please contribute by adding a CLI example._
@ -34,7 +39,7 @@ _Please contribute by adding a CLI example._
| `DNS_ZONE` | Domain name of the 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -46,7 +51,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_linode.md
View file

@ -3,13 +3,16 @@ title: "Linode (v4)"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: linode
dnsprovider:
since: "v1.1.0"
code: "linode"
url: "https://www.linode.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/linode/linode.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Linode (v4)](https://www.linode.com/).
@ -17,12 +20,14 @@ Configuration for [Linode (v4)](https://www.linode.com/).
<!--more-->
- Code: `linode`
- Since: v1.1.0
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
lego --email you@example.com --dns linode --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns linode --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_liquidweb.md
View file

@ -3,13 +3,16 @@ title: "Liquid Web"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: liquidweb
dnsprovider:
since: "v3.1.0"
code: "liquidweb"
url: "https://liquidweb.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/liquidweb/liquidweb.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.1.0
Configuration for [Liquid Web](https://liquidweb.com).
@ -17,6 +20,8 @@ Configuration for [Liquid Web](https://liquidweb.com).
<!--more-->
- Code: `liquidweb`
- Since: v3.1.0
Here is an example bash command using the Liquid Web provider:
@ -24,7 +29,7 @@ Here is an example bash command using the Liquid Web provider:
LIQUID_WEB_USERNAME=someuser \
LIQUID_WEB_PASSWORD=somepass \
LIQUID_ZONE=tacoman.com.net \
lego --email myemail@example.com --dns liquidweb --domains my.example.org run
lego --email you@example.com --dns liquidweb --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns liquidweb --domains my.example.org run
| `LIQUID_WEB_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -53,7 +58,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `LIQUID_WEB_URL` | Storm API endpoint |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_loopia.md
View file

@ -3,13 +3,16 @@ title: "Loopia"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: loopia
dnsprovider:
since: "v4.2.0"
code: "loopia"
url: "https://loopia.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/loopia/loopia.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.2.0
Configuration for [Loopia](https://loopia.com).
@ -17,6 +20,8 @@ Configuration for [Loopia](https://loopia.com).
<!--more-->
- Code: `loopia`
- Since: v4.2.0
Here is an example bash command using the Loopia provider:
@ -37,7 +42,7 @@ lego --email my@email.com --dns loopia --domains my.domain.com run
| `LOOPIA_API_USER` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `LOOPIA_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
### API user

13
docs/content/dns/zz_gen_luadns.md
View file

@ -3,13 +3,16 @@ title: "LuaDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: luadns
dnsprovider:
since: "v3.7.0"
code: "luadns"
url: "https://luadns.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/luadns/luadns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [LuaDNS](https://luadns.com).
@ -17,13 +20,15 @@ Configuration for [LuaDNS](https://luadns.com).
<!--more-->
- Code: `luadns`
- Since: v3.7.0
Here is an example bash command using the LuaDNS provider:
```bash
LUADNS_API_USERNAME=youremail \
LUADNS_API_TOKEN=xxxxxxxx \
lego --email myemail@example.com --dns luadns --domains my.example.org run
lego --email you@example.com --dns luadns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns luadns --domains my.example.org run
| `LUADNS_API_USERNAME` | Username (your 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `LUADNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_mydnsjp.md
View file

@ -3,13 +3,16 @@ title: "MyDNS.jp"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: mydnsjp
dnsprovider:
since: "v1.2.0"
code: "mydnsjp"
url: "https://www.mydns.jp"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/mydnsjp/mydnsjp.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.2.0
Configuration for [MyDNS.jp](https://www.mydns.jp).
@ -17,13 +20,15 @@ Configuration for [MyDNS.jp](https://www.mydns.jp).
<!--more-->
- Code: `mydnsjp`
- Since: v1.2.0
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
lego --email you@example.com --dns mydnsjp --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns mydnsjp --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_mythicbeasts.md
View file

@ -3,13 +3,16 @@ title: "MythicBeasts"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: mythicbeasts
dnsprovider:
since: "v0.3.7"
code: "mythicbeasts"
url: "https://www.mythic-beasts.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/mythicbeasts/mythicbeasts.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.7
Configuration for [MythicBeasts](https://www.mythic-beasts.com/).
@ -17,13 +20,15 @@ Configuration for [MythicBeasts](https://www.mythic-beasts.com/).
<!--more-->
- Code: `mythicbeasts`
- Since: v0.3.7
Here is an example bash command using the MythicBeasts provider:
```bash
MYTHICBEASTS_USERNAME=myuser \
MYTHICBEASTS_PASSWORD=mypass \
lego --email myemail@example.com --dns mythicbeasts --domains my.example.org run
lego --email you@example.com --dns mythicbeasts --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns mythicbeasts --domains my.example.org run
| `MYTHICBEASTS_USERNAME` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `MYTHICBEASTS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
If you are using specific API keys, then the username is the API ID for your API key, and the password is the API secret.

17
docs/content/dns/zz_gen_namecheap.md
View file

@ -3,30 +3,37 @@ title: "Namecheap"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: namecheap
dnsprovider:
since: "v0.3.0"
code: "namecheap"
url: "https://www.namecheap.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namecheap/namecheap.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Namecheap](https://www.namecheap.com).
**To enable API access on the Namecheap production environment, some opaque requirements must be met.** More information in the section [Enabling API Access](https://www.namecheap.com/support/api/intro/) of the Namecheap documentation. (2020-08: Account balance of $50+, 20+ domains in your account, or purchases totaling $50+ within the last 2 years.)
**To enable API access on the Namecheap production environment, some opaque requirements must be met.**
More information in the section [Enabling API Access](https://www.namecheap.com/support/api/intro/) of the Namecheap documentation.
(2020-08: Account balance of $50+, 20+ domains in your account, or purchases totaling $50+ within the last 2 years.)
<!--more-->
- Code: `namecheap`
- Since: v0.3.0
Here is an example bash command using the Namecheap provider:
```bash
NAMECHEAP_API_USER=user \
NAMECHEAP_API_KEY=key \
lego --email myemail@example.com --dns namecheap --domains my.example.org run
lego --email you@example.com --dns namecheap --domains my.example.org run
```
@ -40,7 +47,7 @@ lego --email myemail@example.com --dns namecheap --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -54,7 +61,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_namedotcom.md
View file

@ -3,13 +3,16 @@ title: "Name.com"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: namedotcom
dnsprovider:
since: "v0.5.0"
code: "namedotcom"
url: "https://www.name.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namedotcom/namedotcom.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Name.com](https://www.name.com).
@ -17,13 +20,15 @@ Configuration for [Name.com](https://www.name.com).
<!--more-->
- Code: `namedotcom`
- Since: v0.5.0
Here is an example bash command using the Name.com provider:
```bash
NAMECOM_USERNAME=foo.bar \
NAMECOM_API_TOKEN=a379a6f6eeafb9a55e378c118034e2751e682fab \
lego --email myemail@example.com --dns namedotcom --domains my.example.org run
lego --email you@example.com --dns namedotcom --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns namedotcom --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_namesilo.md
View file

@ -3,13 +3,16 @@ title: "Namesilo"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: namesilo
dnsprovider:
since: "v2.7.0"
code: "namesilo"
url: "https://www.namesilo.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namesilo/namesilo.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.7.0
Configuration for [Namesilo](https://www.namesilo.com/).
@ -17,12 +20,14 @@ Configuration for [Namesilo](https://www.namesilo.com/).
<!--more-->
- Code: `namesilo`
- Since: v2.7.0
Here is an example bash command using the Namesilo provider:
```bash
NAMESILO_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \
lego --email myemail@example.com --dns namesilo --domains my.example.org run
lego --email you@example.com --dns namesilo --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns namesilo --domains my.example.org run
| `NAMESILO_API_KEY` | Client 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -47,7 +52,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `NAMESILO_TTL` | The TTL of the TXT record used for the DNS challenge, should be in [3600, 2592000] |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_nearlyfreespeech.md
View file

@ -3,13 +3,16 @@ title: "NearlyFreeSpeech.NET"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: nearlyfreespeech
dnsprovider:
since: "v4.8.0"
code: "nearlyfreespeech"
url: "https://nearlyfreespeech.net/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/nearlyfreespeech/nearlyfreespeech.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.8.0
Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/).
@ -17,13 +20,15 @@ Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/).
<!--more-->
- Code: `nearlyfreespeech`
- Since: v4.8.0
Here is an example bash command using the NearlyFreeSpeech.NET provider:
```bash
NEARLYFREESPEECH_API_KEY=xxxxxx \
NEARLYFREESPEECH_LOGIN=xxxx \
lego --email myemail@example.com --dns nearlyfreespeech --domains my.example.org run
lego --email you@example.com --dns nearlyfreespeech --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns nearlyfreespeech --domains my.example.org
| `NEARLYFREESPEECH_LOGIN` | Username for API requests |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `NEARLYFREESPEECH_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_netcup.md
View file

@ -3,13 +3,16 @@ title: "Netcup"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: netcup
dnsprovider:
since: "v1.1.0"
code: "netcup"
url: "https://www.netcup.eu/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/netcup/netcup.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Netcup](https://www.netcup.eu/).
@ -17,6 +20,8 @@ Configuration for [Netcup](https://www.netcup.eu/).
<!--more-->
- Code: `netcup`
- Since: v1.1.0
Here is an example bash command using the Netcup provider:
@ -24,7 +29,7 @@ Here is an example bash command using the Netcup provider:
NETCUP_CUSTOMER_NUMBER=xxxx \
NETCUP_API_KEY=yyyy \
NETCUP_API_PASSWORD=zzzz \
lego --email myemail@example.com --dns netcup --domains my.example.org run
lego --email you@example.com --dns netcup --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns netcup --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_netlify.md
View file

@ -3,13 +3,16 @@ title: "Netlify"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: netlify
dnsprovider:
since: "v3.7.0"
code: "netlify"
url: "https://www.netlify.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/netlify/netlify.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [Netlify](https://www.netlify.com).
@ -17,12 +20,14 @@ Configuration for [Netlify](https://www.netlify.com).
<!--more-->
- Code: `netlify`
- Since: v3.7.0
Here is an example bash command using the Netlify provider:
```bash
NETLIFY_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --email myemail@example.com --dns netlify --domains my.example.org run
lego --email you@example.com --dns netlify --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns netlify --domains my.example.org run
| `NETLIFY_TOKEN` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `NETLIFY_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

17
docs/content/dns/zz_gen_nicmanager.md
View file

@ -3,13 +3,16 @@ title: "Nicmanager"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: nicmanager
dnsprovider:
since: "v4.5.0"
code: "nicmanager"
url: "https://www.nicmanager.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/nicmanager/nicmanager.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Nicmanager](https://www.nicmanager.com/).
@ -17,19 +20,21 @@ Configuration for [Nicmanager](https://www.nicmanager.com/).
<!--more-->
- Code: `nicmanager`
- Since: v4.5.0
Here is an example bash command using the Nicmanager provider:
```bash
## Login using email
NICMANAGER_API_EMAIL = "foo@bar.baz" \
NICMANAGER_API_EMAIL = "you@example.com" \
NICMANAGER_API_PASSWORD = "password" \
# Optionally, if your account has TOTP enabled, set the secret here
NICMANAGER_API_OTP = "long-secret" \
lego --email myemail@example.com --dns nicmanager --domains my.example.org run
lego --email you@example.com --dns nicmanager --domains my.example.org run
## Login using account name + username
@ -40,7 +45,7 @@ NICMANAGER_API_PASSWORD = "password" \
# Optionally, if your account has TOTP enabled, set the secret here
NICMANAGER_API_OTP = "long-secret" \
lego --email myemail@example.com --dns nicmanager --domains my.example.org run
lego --email you@example.com --dns nicmanager --domains my.example.org run
```
@ -56,7 +61,7 @@ lego --email myemail@example.com --dns nicmanager --domains my.example.org run
| `NICMANAGER_API_USERNAME` | Username, used for Username-based login |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -71,7 +76,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `NICMANAGER_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_nifcloud.md
View file

@ -3,13 +3,16 @@ title: "NIFCloud"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: nifcloud
dnsprovider:
since: "v1.1.0"
code: "nifcloud"
url: "https://www.nifcloud.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/nifcloud/nifcloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [NIFCloud](https://www.nifcloud.com/).
@ -17,13 +20,15 @@ Configuration for [NIFCloud](https://www.nifcloud.com/).
<!--more-->
- Code: `nifcloud`
- Since: v1.1.0
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
lego --email you@example.com --dns nifcloud --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns nifcloud --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_njalla.md
View file

@ -3,13 +3,16 @@ title: "Njalla"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: njalla
dnsprovider:
since: "v4.3.0"
code: "njalla"
url: "https://njal.la"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/njalla/njalla.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.3.0
Configuration for [Njalla](https://njal.la).
@ -17,12 +20,14 @@ Configuration for [Njalla](https://njal.la).
<!--more-->
- Code: `njalla`
- Since: v4.3.0
Here is an example bash command using the Njalla provider:
```bash
NJALLA_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --email myemail@example.com --dns njalla --domains my.example.org run
lego --email you@example.com --dns njalla --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns njalla --domains my.example.org run
| `NJALLA_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `NJALLA_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_ns1.md
View file

@ -3,13 +3,16 @@ title: "NS1"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: ns1
dnsprovider:
since: "v0.4.0"
code: "ns1"
url: "https://ns1.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/ns1/ns1.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [NS1](https://ns1.com).
@ -17,12 +20,14 @@ Configuration for [NS1](https://ns1.com).
<!--more-->
- Code: `ns1`
- Since: v0.4.0
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
lego --email you@example.com --dns ns1 --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns ns1 --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_oraclecloud.md
View file

@ -3,13 +3,16 @@ title: "Oracle Cloud"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: oraclecloud
dnsprovider:
since: "v2.3.0"
code: "oraclecloud"
url: "https://cloud.oracle.com/home"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/oraclecloud/oraclecloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.3.0
Configuration for [Oracle Cloud](https://cloud.oracle.com/home).
@ -17,6 +20,8 @@ Configuration for [Oracle Cloud](https://cloud.oracle.com/home).
<!--more-->
- Code: `oraclecloud`
- Since: v2.3.0
Here is an example bash command using the Oracle Cloud provider:
@ -28,7 +33,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 --email myemail@example.com --dns oraclecloud --domains my.example.org run
lego --email you@example.com --dns oraclecloud --domains my.example.org run
```
@ -47,7 +52,7 @@ lego --email myemail@example.com --dns oraclecloud --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -59,7 +64,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_otc.md
View file

@ -3,13 +3,16 @@ title: "Open Telekom Cloud"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: otc
dnsprovider:
since: "v0.4.1"
code: "otc"
url: "https://cloud.telekom.de/en"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/otc/otc.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.1
Configuration for [Open Telekom Cloud](https://cloud.telekom.de/en).
@ -17,6 +20,8 @@ Configuration for [Open Telekom Cloud](https://cloud.telekom.de/en).
<!--more-->
- Code: `otc`
- Since: v0.4.1
{{% notice note %}}
_Please contribute by adding a CLI example._
@ -36,7 +41,7 @@ _Please contribute by adding a CLI example._
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_ovh.md
View file

@ -3,13 +3,16 @@ title: "OVH"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: ovh
dnsprovider:
since: "v0.4.0"
code: "ovh"
url: "https://www.ovh.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/ovh/ovh.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [OVH](https://www.ovh.com/).
@ -17,6 +20,8 @@ Configuration for [OVH](https://www.ovh.com/).
<!--more-->
- Code: `ovh`
- Since: v0.4.0
Here is an example bash command using the OVH provider:
@ -25,7 +30,7 @@ OVH_APPLICATION_KEY=1234567898765432 \
OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
OVH_CONSUMER_KEY=256vfsd347245sdfg \
OVH_ENDPOINT=ovh-eu \
lego --email myemail@example.com --dns ovh --domains my.example.org run
lego --email you@example.com --dns ovh --domains my.example.org run
```
@ -41,7 +46,7 @@ lego --email myemail@example.com --dns ovh --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -54,7 +59,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Application Key and Secret

13
docs/content/dns/zz_gen_pdns.md
View file

@ -3,13 +3,16 @@ title: "PowerDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: pdns
dnsprovider:
since: "v0.4.0"
code: "pdns"
url: "https://www.powerdns.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/pdns/pdns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [PowerDNS](https://www.powerdns.com/).
@ -17,13 +20,15 @@ Configuration for [PowerDNS](https://www.powerdns.com/).
<!--more-->
- Code: `pdns`
- Since: v0.4.0
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
lego --email you@example.com --dns pdns --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns pdns --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Information

13
docs/content/dns/zz_gen_porkbun.md
View file

@ -3,13 +3,16 @@ title: "Porkbun"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: porkbun
dnsprovider:
since: "v4.4.0"
code: "porkbun"
url: "https://porkbun.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/porkbun/porkbun.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Porkbun](https://porkbun.com/).
@ -17,13 +20,15 @@ Configuration for [Porkbun](https://porkbun.com/).
<!--more-->
- Code: `porkbun`
- Since: v4.4.0
Here is an example bash command using the Porkbun provider:
```bash
PORKBUN_SECRET_API_KEY=xxxxxx \
PORKBUN_API_KEY=yyyyyy \
lego --email myemail@example.com --dns porkbun --domains my.example.org run
lego --email you@example.com --dns porkbun --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns porkbun --domains my.example.org run
| `PORKBUN_SECRET_API_KEY` | secret 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `PORKBUN_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_rackspace.md
View file

@ -3,13 +3,16 @@ title: "Rackspace"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: rackspace
dnsprovider:
since: "v0.4.0"
code: "rackspace"
url: "https://www.rackspace.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rackspace/rackspace.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Rackspace](https://www.rackspace.com/).
@ -17,13 +20,15 @@ Configuration for [Rackspace](https://www.rackspace.com/).
<!--more-->
- Code: `rackspace`
- Since: v0.4.0
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
lego --email you@example.com --dns rackspace --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns rackspace --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_regru.md
View file

@ -3,13 +3,16 @@ title: "reg.ru"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: regru
dnsprovider:
since: "v3.5.0"
code: "regru"
url: "https://www.reg.ru/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/regru/regru.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.5.0
Configuration for [reg.ru](https://www.reg.ru/).
@ -17,13 +20,15 @@ Configuration for [reg.ru](https://www.reg.ru/).
<!--more-->
- Code: `regru`
- Since: v3.5.0
Here is an example bash command using the reg.ru provider:
```bash
REGRU_USERNAME=xxxxxx \
REGRU_PASSWORD=yyyyyy \
lego --email myemail@example.com --dns regru --domains my.example.org run
lego --email you@example.com --dns regru --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns regru --domains my.example.org run
| `REGRU_USERNAME` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `REGRU_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

15
docs/content/dns/zz_gen_rfc2136.md
View file

@ -3,13 +3,16 @@ title: "RFC2136"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: rfc2136
dnsprovider:
since: "v0.3.0"
code: "rfc2136"
url: "https://www.rfc-editor.org/rfc/rfc2136.html"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rfc2136/rfc2136.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [RFC2136](https://www.rfc-editor.org/rfc/rfc2136.html).
@ -17,6 +20,8 @@ Configuration for [RFC2136](https://www.rfc-editor.org/rfc/rfc2136.html).
<!--more-->
- Code: `rfc2136`
- Since: v0.3.0
Here is an example bash command using the RFC2136 provider:
@ -25,7 +30,7 @@ RFC2136_NAMESERVER=127.0.0.1 \
RFC2136_TSIG_KEY=lego \
RFC2136_TSIG_ALGORITHM=hmac-sha256. \
RFC2136_TSIG_SECRET=YWJjZGVmZGdoaWprbG1ub3BxcnN0dXZ3eHl6MTIzNDU= \
lego --email myemail@example.com --dns rfc2136 --domains my.example.org run
lego --email you@example.com --dns rfc2136 --domains my.example.org run
## ---
@ -35,7 +40,7 @@ RFC2136_NAMESERVER=127.0.0.1 \
RFC2136_TSIG_KEY="$keyname" \
RFC2136_TSIG_ALGORITHM="$( awk -F'[ ";]' '/algorithm/ { print $2 }' $keyfile )." \
RFC2136_TSIG_SECRET="$( awk -F'[ ";]' '/secret/ { print $3 }' $keyfile )" \
lego --email myemail@example.com --dns rfc2136 --domains my.example.org run
lego --email you@example.com --dns rfc2136 --domains my.example.org run
```
@ -51,7 +56,7 @@ lego --email myemail@example.com --dns rfc2136 --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -65,7 +70,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_rimuhosting.md
View file

@ -3,13 +3,16 @@ title: "RimuHosting"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: rimuhosting
dnsprovider:
since: "v0.3.5"
code: "rimuhosting"
url: "https://rimuhosting.com"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rimuhosting/rimuhosting.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.5
Configuration for [RimuHosting](https://rimuhosting.com).
@ -17,12 +20,14 @@ Configuration for [RimuHosting](https://rimuhosting.com).
<!--more-->
- Code: `rimuhosting`
- Since: v0.3.5
Here is an example bash command using the RimuHosting provider:
```bash
RIMUHOSTING_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
lego --email myemail@example.com --dns rimuhosting --domains my.example.org run
lego --email you@example.com --dns rimuhosting --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns rimuhosting --domains my.example.org run
| `RIMUHOSTING_API_KEY` | User 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `RIMUHOSTING_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

11
docs/content/dns/zz_gen_route53.md
View file

@ -3,13 +3,16 @@ title: "Amazon Route 53"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: route53
dnsprovider:
since: "v0.3.0"
code: "route53"
url: "https://aws.amazon.com/route53/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/route53/route53.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Amazon Route 53](https://aws.amazon.com/route53/).
@ -17,6 +20,8 @@ Configuration for [Amazon Route 53](https://aws.amazon.com/route53/).
<!--more-->
- Code: `route53`
- Since: v0.3.0
{{% notice note %}}
_Please contribute by adding a CLI example._
@ -38,7 +43,7 @@ _Please contribute by adding a CLI example._
| `AWS_SECRET_ACCESS_KEY` | Managed by the AWS client. Secret access key (`AWS_SECRET_ACCESS_KEY_FILE` is not supported, use `AWS_SHARED_CREDENTIALS_FILE` instead) |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Description

13
docs/content/dns/zz_gen_safedns.md
View file

@ -3,13 +3,16 @@ title: "UKFast SafeDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: safedns
dnsprovider:
since: "v4.6.0"
code: "safedns"
url: "https://www.ukfast.co.uk/dns-hosting.html"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/safedns/safedns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.6.0
Configuration for [UKFast SafeDNS](https://www.ukfast.co.uk/dns-hosting.html).
@ -17,12 +20,14 @@ Configuration for [UKFast SafeDNS](https://www.ukfast.co.uk/dns-hosting.html).
<!--more-->
- Code: `safedns`
- Since: v4.6.0
Here is an example bash command using the UKFast SafeDNS provider:
```bash
SAFEDNS_AUTH_TOKEN=xxxxxx \
lego --email myemail@example.com --dns safedns --domains my.example.org run
lego --email you@example.com --dns safedns --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns safedns --domains my.example.org run
| `SAFEDNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `SAFEDNS_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_sakuracloud.md
View file

@ -3,13 +3,16 @@ title: "Sakura Cloud"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: sakuracloud
dnsprovider:
since: "v1.1.0"
code: "sakuracloud"
url: "https://cloud.sakura.ad.jp/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/sakuracloud/sakuracloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Sakura Cloud](https://cloud.sakura.ad.jp/).
@ -17,13 +20,15 @@ Configuration for [Sakura Cloud](https://cloud.sakura.ad.jp/).
<!--more-->
- Code: `sakuracloud`
- Since: v1.1.0
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
lego --email you@example.com --dns sakuracloud --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns sakuracloud --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_scaleway.md
View file

@ -3,13 +3,16 @@ title: "Scaleway"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: scaleway
dnsprovider:
since: "v3.4.0"
code: "scaleway"
url: "https://developers.scaleway.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/scaleway/scaleway.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.4.0
Configuration for [Scaleway](https://developers.scaleway.com/).
@ -17,12 +20,14 @@ Configuration for [Scaleway](https://developers.scaleway.com/).
<!--more-->
- Code: `scaleway`
- Since: v3.4.0
Here is an example bash command using the Scaleway provider:
```bash
SCALEWAY_API_TOKEN=xxxxxxx-xxxxx-xxxx-xxx-xxxxxx \
lego --email myemail@example.com --dns scaleway --domains my.example.org run
lego --email you@example.com --dns scaleway --domains my.example.org run
```
@ -36,7 +41,7 @@ lego --email myemail@example.com --dns scaleway --domains my.example.org run
| `SCALEWAY_PROJECT_ID` | Project to use (optional) |
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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `SCALEWAY_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_selectel.md
View file

@ -3,13 +3,16 @@ title: "Selectel"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: selectel
dnsprovider:
since: "v1.2.0"
code: "selectel"
url: "https://kb.selectel.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/selectel/selectel.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.2.0
Configuration for [Selectel](https://kb.selectel.com/).
@ -17,12 +20,14 @@ Configuration for [Selectel](https://kb.selectel.com/).
<!--more-->
- Code: `selectel`
- Since: v1.2.0
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
lego --email you@example.com --dns selectel --domains my.example.org run
```
@ -35,7 +40,7 @@ lego --email myemail@example.com --dns selectel --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_servercow.md
View file

@ -3,13 +3,16 @@ title: "Servercow"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: servercow
dnsprovider:
since: "v3.4.0"
code: "servercow"
url: "https://servercow.de/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/servercow/servercow.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.4.0
Configuration for [Servercow](https://servercow.de/).
@ -17,13 +20,15 @@ Configuration for [Servercow](https://servercow.de/).
<!--more-->
- Code: `servercow`
- Since: v3.4.0
Here is an example bash command using the Servercow provider:
```bash
SERVERCOW_USERNAME=xxxxxxxx \
SERVERCOW_PASSWORD=xxxxxxxx \
lego --email myemail@example.com --dns servercow --domains my.example.org run
lego --email you@example.com --dns servercow --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns servercow --domains my.example.org run
| `SERVERCOW_USERNAME` | 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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `SERVERCOW_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_simply.md
View file

@ -3,13 +3,16 @@ title: "Simply.com"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: simply
dnsprovider:
since: "v4.4.0"
code: "simply"
url: "https://www.simply.com/en/domains/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/simply/simply.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Simply.com](https://www.simply.com/en/domains/).
@ -17,13 +20,15 @@ Configuration for [Simply.com](https://www.simply.com/en/domains/).
<!--more-->
- Code: `simply`
- Since: v4.4.0
Here is an example bash command using the Simply.com provider:
```bash
SIMPLY_ACCOUNT_NAME=xxxxxx \
SIMPLY_API_KEY=yyyyyy \
lego --email myemail@example.com --dns simply --domains my.example.org run
lego --email you@example.com --dns simply --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns simply --domains my.example.org run
| `SIMPLY_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `SIMPLY_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

65
docs/content/dns/zz_gen_softlayer.md
View file

@ -1,65 +0,0 @@
---
title: "SoftLayer (IBM Cloud)"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: softlayer
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/softlayer/softlayer.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [SoftLayer (IBM Cloud)](https://www.ibm.com/cloud/).
<!--more-->
- Code: `softlayer`
Here is an example bash command using the SoftLayer (IBM Cloud) provider:
```bash
SOFTLAYER_USERNAME=xxxxx \
SOFTLAYER_API_KEY=yyyyy \
lego --email myemail@example.com --dns softlayer --domains my.example.org run
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `SOFTLAYER_API_KEY` | Classic Infrastructure API key |
| `SOFTLAYER_USERNAME` | User name (IBM Cloud is <accountID>_<emailAddress>) |
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
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `SOFTLAYER_POLLING_INTERVAL` | Time between DNS propagation check |
| `SOFTLAYER_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `SOFTLAYER_TIMEOUT` | API request timeout |
| `SOFTLAYER_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).
## More information
- [API documentation](https://cloud.ibm.com/docs/dns?topic=dns-getting-started-with-the-dns-api)
- [Go client](https://github.com/softlayer/softlayer-go)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/softlayer/softlayer.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

13
docs/content/dns/zz_gen_sonic.md
View file

@ -3,13 +3,16 @@ title: "Sonic"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: sonic
dnsprovider:
since: "v4.4.0"
code: "sonic"
url: "https://www.sonic.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/sonic/sonic.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Sonic](https://www.sonic.com/).
@ -17,13 +20,15 @@ Configuration for [Sonic](https://www.sonic.com/).
<!--more-->
- Code: `sonic`
- Since: v4.4.0
Here is an example bash command using the Sonic provider:
```bash
SONIC_USER_ID=12345 \
SONIC_API_KEY=4d6fbf2f9ab0fa11697470918d37625851fc0c51 \
lego --email myemail@example.com --dns sonic --domains my.example.org run
lego --email you@example.com --dns sonic --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns sonic --domains my.example.org run
| `SONIC_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `SONIC_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## API keys

13
docs/content/dns/zz_gen_stackpath.md
View file

@ -3,13 +3,16 @@ title: "Stackpath"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: stackpath
dnsprovider:
since: "v1.1.0"
code: "stackpath"
url: "https://www.stackpath.com/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/stackpath/stackpath.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Stackpath](https://www.stackpath.com/).
@ -17,6 +20,8 @@ Configuration for [Stackpath](https://www.stackpath.com/).
<!--more-->
- Code: `stackpath`
- Since: v1.1.0
Here is an example bash command using the Stackpath provider:
@ -24,7 +29,7 @@ Here is an example bash command using the Stackpath provider:
STACKPATH_CLIENT_ID=xxxxx \
STACKPATH_CLIENT_SECRET=yyyyy \
STACKPATH_STACK_ID=zzzzz \
lego --email myemail@example.com --dns stackpath --domains my.example.org run
lego --email you@example.com --dns stackpath --domains my.example.org run
```
@ -39,7 +44,7 @@ lego --email myemail@example.com --dns stackpath --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_tencentcloud.md
View file

@ -3,13 +3,16 @@ title: "Tencent Cloud DNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: tencentcloud
dnsprovider:
since: "v4.6.0"
code: "tencentcloud"
url: "https://cloud.tencent.com/product/cns"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/tencentcloud/tencentcloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.6.0
Configuration for [Tencent Cloud DNS](https://cloud.tencent.com/product/cns).
@ -17,13 +20,15 @@ Configuration for [Tencent Cloud DNS](https://cloud.tencent.com/product/cns).
<!--more-->
- Code: `tencentcloud`
- Since: v4.6.0
Here is an example bash command using the Tencent Cloud DNS provider:
```bash
TENCENTCLOUD_SECRET_ID=abcdefghijklmnopqrstuvwx \
TENCENTCLOUD_SECRET_KEY=your-secret-key \
lego --email myemail@example.com --dns tencentcloud --domains my.example.org run
lego --email you@example.com --dns tencentcloud --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns tencentcloud --domains my.example.org run
| `TENCENTCLOUD_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `TENCENTCLOUD_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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

13
docs/content/dns/zz_gen_transip.md
View file

@ -3,13 +3,16 @@ title: "TransIP"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: transip
dnsprovider:
since: "v2.0.0"
code: "transip"
url: "https://www.transip.nl/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/transip/transip.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.0.0
Configuration for [TransIP](https://www.transip.nl/).
@ -17,13 +20,15 @@ Configuration for [TransIP](https://www.transip.nl/).
<!--more-->
- Code: `transip`
- Since: v2.0.0
Here is an example bash command using the TransIP provider:
```bash
TRANSIP_ACCOUNT_NAME = "Account name" \
TRANSIP_PRIVATE_KEY_PATH = "transip.key" \
lego --email myemail@example.com --dns transip --domains my.example.org run
lego --email you@example.com --dns transip --domains my.example.org run
```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns transip --domains my.example.org run
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `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).
More information [here]({{< ref "dns#configuration-and-credentials" >}}).

Some files were not shown because too many files have changed in this diff Show more