diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
index f6e37f3e..6e11c747 100644
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@@ -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:
diff --git a/docs/.gitignore b/docs/.gitignore
index 7b822970..b5430137 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,2 +1,3 @@
themes/
public/
+.hugo_build.lock
diff --git a/docs/config.toml b/docs/config.toml
index d32846c7..1d2ce3f5 100644
--- a/docs/config.toml
+++ b/docs/config.toml
@@ -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 = " Discussions"
+ url = "https://github.com/go-acme/lego/discussions"
+ weight = 12
+
[outputs]
home = [ "HTML", "RSS", "JSON"]
diff --git a/docs/content/_index.md b/docs/content/_index.md
index 55e26c45..3fd709c7 100644
--- a/docs/content/_index.md
+++ b/docs/content/_index.md
@@ -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.
diff --git a/docs/content/dns/_index.md b/docs/content/dns/_index.md
index 174f583a..0bdc1ba2 100644
--- a/docs/content/dns/_index.md
+++ b/docs/content/dns/_index.md
@@ -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" %}}
\ No newline at end of file
+{{% tableofdnsproviders %}}
diff --git a/docs/content/dns/manual.md b/docs/content/dns/manual.md
index 8a9c125e..54f81d6a 100644
--- a/docs/content/dns/manual.md
+++ b/docs/content/dns/manual.md
@@ -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
-
-```
\ No newline at end of file
+As mentioned, you can now remove the TXT record again.
diff --git a/docs/content/dns/zz_gen_acme-dns.md b/docs/content/dns/zz_gen_acme-dns.md
index c06277eb..de51827e 100644
--- a/docs/content/dns/zz_gen_acme-dns.md
+++ b/docs/content/dns/zz_gen_acme-dns.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_alidns.md b/docs/content/dns/zz_gen_alidns.md
index 17c7177a..3cece096 100644
--- a/docs/content/dns/zz_gen_alidns.md
+++ b/docs/content/dns/zz_gen_alidns.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_allinkl.md b/docs/content/dns/zz_gen_allinkl.md
index 318ee637..05d8ce01 100644
--- a/docs/content/dns/zz_gen_allinkl.md
+++ b/docs/content/dns/zz_gen_allinkl.md
@@ -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"
---
-Since: v4.5.0
Configuration for [all-inkl](https://all-inkl.com).
@@ -17,13 +20,15 @@ Configuration for [all-inkl](https://all-inkl.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_arvancloud.md b/docs/content/dns/zz_gen_arvancloud.md
index 8ddd08a7..531a95ba 100644
--- a/docs/content/dns/zz_gen_arvancloud.md
+++ b/docs/content/dns/zz_gen_arvancloud.md
@@ -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"
---
-Since: v3.8.0
Configuration for [ArvanCloud](https://arvancloud.com).
@@ -17,12 +20,14 @@ Configuration for [ArvanCloud](https://arvancloud.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_auroradns.md b/docs/content/dns/zz_gen_auroradns.md
index e75fb55f..b0480f98 100644
--- a/docs/content/dns/zz_gen_auroradns.md
+++ b/docs/content/dns/zz_gen_auroradns.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_autodns.md b/docs/content/dns/zz_gen_autodns.md
index 0f2620b4..167dea83 100644
--- a/docs/content/dns/zz_gen_autodns.md
+++ b/docs/content/dns/zz_gen_autodns.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_azure.md b/docs/content/dns/zz_gen_azure.md
index 51c728cb..5cc6f898 100644
--- a/docs/content/dns/zz_gen_azure.md
+++ b/docs/content/dns/zz_gen_azure.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_bindman.md b/docs/content/dns/zz_gen_bindman.md
index 4b491030..c83147ff 100644
--- a/docs/content/dns/zz_gen_bindman.md
+++ b/docs/content/dns/zz_gen_bindman.md
@@ -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"
---
-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).
- Code: `bindman`
+- Since: v2.6.0
+
Here is an example bash command using the Bindman provider:
```bash
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" >}}).
diff --git a/docs/content/dns/zz_gen_bluecat.md b/docs/content/dns/zz_gen_bluecat.md
index 381819ca..80a8fb8a 100644
--- a/docs/content/dns/zz_gen_bluecat.md
+++ b/docs/content/dns/zz_gen_bluecat.md
@@ -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"
---
-Since: v0.5.0
Configuration for [Bluecat](https://www.bluecatnetworks.com).
@@ -17,6 +20,8 @@ Configuration for [Bluecat](https://www.bluecatnetworks.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_checkdomain.md b/docs/content/dns/zz_gen_checkdomain.md
index 449a350e..4f990170 100644
--- a/docs/content/dns/zz_gen_checkdomain.md
+++ b/docs/content/dns/zz_gen_checkdomain.md
@@ -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/"
---
-Since: v3.3.0
Configuration for [Checkdomain](https://checkdomain.de/).
@@ -17,12 +20,14 @@ Configuration for [Checkdomain](https://checkdomain.de/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_clouddns.md b/docs/content/dns/zz_gen_clouddns.md
index 6374301c..839b745f 100644
--- a/docs/content/dns/zz_gen_clouddns.md
+++ b/docs/content/dns/zz_gen_clouddns.md
@@ -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/"
---
-Since: v3.6.0
Configuration for [CloudDNS](https://vshosting.eu/).
@@ -17,14 +20,16 @@ Configuration for [CloudDNS](https://vshosting.eu/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_cloudflare.md b/docs/content/dns/zz_gen_cloudflare.md
index 66db361c..e4cd6dfd 100644
--- a/docs/content/dns/zz_gen_cloudflare.md
+++ b/docs/content/dns/zz_gen_cloudflare.md
@@ -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/"
---
-Since: v0.3.0
Configuration for [Cloudflare](https://www.cloudflare.com/dns/).
@@ -17,18 +20,20 @@ Configuration for [Cloudflare](https://www.cloudflare.com/dns/).
- 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
diff --git a/docs/content/dns/zz_gen_cloudns.md b/docs/content/dns/zz_gen_cloudns.md
index e1528062..32592e61 100644
--- a/docs/content/dns/zz_gen_cloudns.md
+++ b/docs/content/dns/zz_gen_cloudns.md
@@ -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"
---
-Since: v2.3.0
Configuration for [ClouDNS](https://www.cloudns.net).
@@ -17,13 +20,15 @@ Configuration for [ClouDNS](https://www.cloudns.net).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_cloudxns.md b/docs/content/dns/zz_gen_cloudxns.md
index a6a134fb..00d7a08b 100644
--- a/docs/content/dns/zz_gen_cloudxns.md
+++ b/docs/content/dns/zz_gen_cloudxns.md
@@ -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/"
---
-Since: v0.5.0
Configuration for [CloudXNS](https://www.cloudxns.net/).
@@ -17,13 +20,15 @@ Configuration for [CloudXNS](https://www.cloudxns.net/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_conoha.md b/docs/content/dns/zz_gen_conoha.md
index 1358de2c..a24fef2d 100644
--- a/docs/content/dns/zz_gen_conoha.md
+++ b/docs/content/dns/zz_gen_conoha.md
@@ -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/"
---
-Since: v1.2.0
Configuration for [ConoHa](https://www.conoha.jp/).
@@ -17,6 +20,8 @@ Configuration for [ConoHa](https://www.conoha.jp/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_constellix.md b/docs/content/dns/zz_gen_constellix.md
index b90c3b74..6375b25c 100644
--- a/docs/content/dns/zz_gen_constellix.md
+++ b/docs/content/dns/zz_gen_constellix.md
@@ -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"
---
-Since: v3.4.0
Configuration for [Constellix](https://constellix.com).
@@ -17,13 +20,15 @@ Configuration for [Constellix](https://constellix.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_desec.md b/docs/content/dns/zz_gen_desec.md
index a9b862fc..b9faecc4 100644
--- a/docs/content/dns/zz_gen_desec.md
+++ b/docs/content/dns/zz_gen_desec.md
@@ -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"
---
-Since: v3.7.0
Configuration for [deSEC.io](https://desec.io).
@@ -17,12 +20,14 @@ Configuration for [deSEC.io](https://desec.io).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_designate.md b/docs/content/dns/zz_gen_designate.md
index 9141ebb3..d1254ec8 100644
--- a/docs/content/dns/zz_gen_designate.md
+++ b/docs/content/dns/zz_gen_designate.md
@@ -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/"
---
-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
- 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
diff --git a/docs/content/dns/zz_gen_digitalocean.md b/docs/content/dns/zz_gen_digitalocean.md
index ef8b1e14..5b5698be 100644
--- a/docs/content/dns/zz_gen_digitalocean.md
+++ b/docs/content/dns/zz_gen_digitalocean.md
@@ -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/"
---
-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
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_dnsimple.md b/docs/content/dns/zz_gen_dnsimple.md
index e0d096c2..addfaaa6 100644
--- a/docs/content/dns/zz_gen_dnsimple.md
+++ b/docs/content/dns/zz_gen_dnsimple.md
@@ -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/"
---
-Since: v0.3.0
Configuration for [DNSimple](https://dnsimple.com/).
@@ -17,12 +20,14 @@ Configuration for [DNSimple](https://dnsimple.com/).
- 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
diff --git a/docs/content/dns/zz_gen_dnsmadeeasy.md b/docs/content/dns/zz_gen_dnsmadeeasy.md
index 7ad6d4be..26a26fc4 100644
--- a/docs/content/dns/zz_gen_dnsmadeeasy.md
+++ b/docs/content/dns/zz_gen_dnsmadeeasy.md
@@ -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/"
---
-Since: v0.4.0
Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
@@ -17,13 +20,15 @@ Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_dnspod.md b/docs/content/dns/zz_gen_dnspod.md
index c482a4b7..3547c838 100644
--- a/docs/content/dns/zz_gen_dnspod.md
+++ b/docs/content/dns/zz_gen_dnspod.md
@@ -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/"
---
-Since: v0.4.0
Configuration for [DNSPod](https://www.dnspod.com/).
@@ -17,12 +20,14 @@ Configuration for [DNSPod](https://www.dnspod.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_dode.md b/docs/content/dns/zz_gen_dode.md
index c53acab3..8473da7f 100644
--- a/docs/content/dns/zz_gen_dode.md
+++ b/docs/content/dns/zz_gen_dode.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_domeneshop.md b/docs/content/dns/zz_gen_domeneshop.md
index ec12b943..4a35b7b9 100644
--- a/docs/content/dns/zz_gen_domeneshop.md
+++ b/docs/content/dns/zz_gen_domeneshop.md
@@ -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"
---
-Since: v4.3.0
Configuration for [Domeneshop](https://domene.shop).
@@ -17,6 +20,8 @@ Configuration for [Domeneshop](https://domene.shop).
- 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
diff --git a/docs/content/dns/zz_gen_dreamhost.md b/docs/content/dns/zz_gen_dreamhost.md
index c4dac42b..542a6f22 100644
--- a/docs/content/dns/zz_gen_dreamhost.md
+++ b/docs/content/dns/zz_gen_dreamhost.md
@@ -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"
---
-Since: v1.1.0
Configuration for [DreamHost](https://www.dreamhost.com).
@@ -17,12 +20,14 @@ Configuration for [DreamHost](https://www.dreamhost.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_duckdns.md b/docs/content/dns/zz_gen_duckdns.md
index def76ddc..0851753c 100644
--- a/docs/content/dns/zz_gen_duckdns.md
+++ b/docs/content/dns/zz_gen_duckdns.md
@@ -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/"
---
-Since: v0.5.0
Configuration for [Duck DNS](https://www.duckdns.org/).
@@ -17,12 +20,14 @@ Configuration for [Duck DNS](https://www.duckdns.org/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_dyn.md b/docs/content/dns/zz_gen_dyn.md
index ec0a66d9..53a91039 100644
--- a/docs/content/dns/zz_gen_dyn.md
+++ b/docs/content/dns/zz_gen_dyn.md
@@ -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/"
---
-Since: v0.3.0
Configuration for [Dyn](https://dyn.com/).
@@ -17,6 +20,8 @@ Configuration for [Dyn](https://dyn.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_dynu.md b/docs/content/dns/zz_gen_dynu.md
index 31184c7b..58b2136c 100644
--- a/docs/content/dns/zz_gen_dynu.md
+++ b/docs/content/dns/zz_gen_dynu.md
@@ -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/"
---
-Since: v3.5.0
Configuration for [Dynu](https://www.dynu.com/).
@@ -17,12 +20,14 @@ Configuration for [Dynu](https://www.dynu.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_easydns.md b/docs/content/dns/zz_gen_easydns.md
index 3d3b24ef..e7b1f8ee 100644
--- a/docs/content/dns/zz_gen_easydns.md
+++ b/docs/content/dns/zz_gen_easydns.md
@@ -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/"
---
-Since: v2.6.0
Configuration for [EasyDNS](https://easydns.com/).
@@ -17,13 +20,15 @@ Configuration for [EasyDNS](https://easydns.com/).
- Code: `easydns`
+- Since: v2.6.0
+
Here is an example bash command using the EasyDNS provider:
```bash
EASYDNS_TOKEN= \
EASYDNS_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```
diff --git a/docs/content/dns/zz_gen_edgedns.md b/docs/content/dns/zz_gen_edgedns.md
index 854f6796..b1c89f8b 100644
--- a/docs/content/dns/zz_gen_edgedns.md
+++ b/docs/content/dns/zz_gen_edgedns.md
@@ -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"
---
-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
- 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:
diff --git a/docs/content/dns/zz_gen_epik.md b/docs/content/dns/zz_gen_epik.md
index 8acfed37..8f946fc3 100644
--- a/docs/content/dns/zz_gen_epik.md
+++ b/docs/content/dns/zz_gen_epik.md
@@ -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/"
---
-Since: v4.5.0
Configuration for [Epik](https://www.epik.com/).
@@ -17,12 +20,14 @@ Configuration for [Epik](https://www.epik.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_exec.md b/docs/content/dns/zz_gen_exec.md
index c82e0fcf..9af7f34f 100644
--- a/docs/content/dns/zz_gen_exec.md
+++ b/docs/content/dns/zz_gen_exec.md
@@ -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"
---
-Since: v0.5.0
Solving the DNS-01 challenge using an external program.
- 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
```
diff --git a/docs/content/dns/zz_gen_exoscale.md b/docs/content/dns/zz_gen_exoscale.md
index 430e288e..de6697aa 100644
--- a/docs/content/dns/zz_gen_exoscale.md
+++ b/docs/content/dns/zz_gen_exoscale.md
@@ -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/"
---
-Since: v0.4.0
Configuration for [Exoscale](https://www.exoscale.com/).
@@ -17,13 +20,15 @@ Configuration for [Exoscale](https://www.exoscale.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_freemyip.md b/docs/content/dns/zz_gen_freemyip.md
index 76bd77fa..929f62d5 100644
--- a/docs/content/dns/zz_gen_freemyip.md
+++ b/docs/content/dns/zz_gen_freemyip.md
@@ -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/"
---
-Since: v4.5.0
Configuration for [freemyip.com](https://freemyip.com/).
@@ -17,12 +20,14 @@ Configuration for [freemyip.com](https://freemyip.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_gandi.md b/docs/content/dns/zz_gen_gandi.md
index fa25d97b..70321361 100644
--- a/docs/content/dns/zz_gen_gandi.md
+++ b/docs/content/dns/zz_gen_gandi.md
@@ -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"
---
-Since: v0.3.0
Configuration for [Gandi](https://www.gandi.net).
@@ -17,12 +20,14 @@ Configuration for [Gandi](https://www.gandi.net).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_gandiv5.md b/docs/content/dns/zz_gen_gandiv5.md
index d9adf66e..9e54d9c0 100644
--- a/docs/content/dns/zz_gen_gandiv5.md
+++ b/docs/content/dns/zz_gen_gandiv5.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_gcloud.md b/docs/content/dns/zz_gen_gcloud.md
index 0d93f183..ba60f1df 100644
--- a/docs/content/dns/zz_gen_gcloud.md
+++ b/docs/content/dns/zz_gen_gcloud.md
@@ -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"
---
-Since: v0.3.0
Configuration for [Google Cloud](https://cloud.google.com).
@@ -17,6 +20,8 @@ Configuration for [Google Cloud](https://cloud.google.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_gcore.md b/docs/content/dns/zz_gen_gcore.md
index 40fd9cca..15e3ef21 100644
--- a/docs/content/dns/zz_gen_gcore.md
+++ b/docs/content/dns/zz_gen_gcore.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_glesys.md b/docs/content/dns/zz_gen_glesys.md
index afe5771c..1e8322d6 100644
--- a/docs/content/dns/zz_gen_glesys.md
+++ b/docs/content/dns/zz_gen_glesys.md
@@ -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/"
---
-Since: v0.5.0
Configuration for [Glesys](https://glesys.com/).
@@ -17,13 +20,15 @@ Configuration for [Glesys](https://glesys.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_godaddy.md b/docs/content/dns/zz_gen_godaddy.md
index edbf8114..2b37f5e2 100644
--- a/docs/content/dns/zz_gen_godaddy.md
+++ b/docs/content/dns/zz_gen_godaddy.md
@@ -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"
---
-Since: v0.5.0
Configuration for [Go Daddy](https://godaddy.com).
@@ -17,13 +20,15 @@ Configuration for [Go Daddy](https://godaddy.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_hetzner.md b/docs/content/dns/zz_gen_hetzner.md
index 76e6cd9a..38b5e888 100644
--- a/docs/content/dns/zz_gen_hetzner.md
+++ b/docs/content/dns/zz_gen_hetzner.md
@@ -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"
---
-Since: v3.7.0
Configuration for [Hetzner](https://hetzner.com).
@@ -17,12 +20,14 @@ Configuration for [Hetzner](https://hetzner.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_hostingde.md b/docs/content/dns/zz_gen_hostingde.md
index 545e5d0b..a2986d3a 100644
--- a/docs/content/dns/zz_gen_hostingde.md
+++ b/docs/content/dns/zz_gen_hostingde.md
@@ -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/"
---
-Since: v1.1.0
Configuration for [Hosting.de](https://www.hosting.de/).
@@ -17,12 +20,14 @@ Configuration for [Hosting.de](https://www.hosting.de/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_hosttech.md b/docs/content/dns/zz_gen_hosttech.md
index 244b7314..c77165b0 100644
--- a/docs/content/dns/zz_gen_hosttech.md
+++ b/docs/content/dns/zz_gen_hosttech.md
@@ -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/"
---
-Since: v4.5.0
Configuration for [Hosttech](https://www.hosttech.eu/).
@@ -17,12 +20,14 @@ Configuration for [Hosttech](https://www.hosttech.eu/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_httpreq.md b/docs/content/dns/zz_gen_httpreq.md
index de9398f1..987a6c98 100644
--- a/docs/content/dns/zz_gen_httpreq.md
+++ b/docs/content/dns/zz_gen_httpreq.md
@@ -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/"
---
-Since: v2.0.0
Configuration for [HTTP request](/lego/dns/httpreq/).
@@ -17,12 +20,14 @@ Configuration for [HTTP request](/lego/dns/httpreq/).
- 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
diff --git a/docs/content/dns/zz_gen_hurricane.md b/docs/content/dns/zz_gen_hurricane.md
index 995d6cb6..dadb9f3c 100644
--- a/docs/content/dns/zz_gen_hurricane.md
+++ b/docs/content/dns/zz_gen_hurricane.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_hyperone.md b/docs/content/dns/zz_gen_hyperone.md
index 0fdbf6ea..f976bf4e 100644
--- a/docs/content/dns/zz_gen_hyperone.md
+++ b/docs/content/dns/zz_gen_hyperone.md
@@ -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"
---
-Since: v3.9.0
Configuration for [HyperOne](https://www.hyperone.com).
@@ -17,11 +20,13 @@ Configuration for [HyperOne](https://www.hyperone.com).
- 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
diff --git a/docs/content/dns/zz_gen_ibmcloud.md b/docs/content/dns/zz_gen_ibmcloud.md
index 0881a256..41e0f466 100644
--- a/docs/content/dns/zz_gen_ibmcloud.md
+++ b/docs/content/dns/zz_gen_ibmcloud.md
@@ -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/"
---
-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/).
- 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 _) |
The 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" >}}).
diff --git a/docs/content/dns/zz_gen_iij.md b/docs/content/dns/zz_gen_iij.md
index 1141dbfb..62df8306 100644
--- a/docs/content/dns/zz_gen_iij.md
+++ b/docs/content/dns/zz_gen_iij.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_iijdpf.md b/docs/content/dns/zz_gen_iijdpf.md
index 265f4162..eb240a38 100644
--- a/docs/content/dns/zz_gen_iijdpf.md
+++ b/docs/content/dns/zz_gen_iijdpf.md
@@ -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/"
---
-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
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_infoblox.md b/docs/content/dns/zz_gen_infoblox.md
index d192aa7e..4f8a6308 100644
--- a/docs/content/dns/zz_gen_infoblox.md
+++ b/docs/content/dns/zz_gen_infoblox.md
@@ -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/"
---
-Since: v4.4.0
Configuration for [Infoblox](https://www.infoblox.com/).
@@ -17,6 +20,8 @@ Configuration for [Infoblox](https://www.infoblox.com/).
- 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.
diff --git a/docs/content/dns/zz_gen_infomaniak.md b/docs/content/dns/zz_gen_infomaniak.md
index a33130fd..695cb370 100644
--- a/docs/content/dns/zz_gen_infomaniak.md
+++ b/docs/content/dns/zz_gen_infomaniak.md
@@ -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/"
---
-Since: v4.1.0
Configuration for [Infomaniak](https://www.infomaniak.com/).
@@ -17,12 +20,14 @@ Configuration for [Infomaniak](https://www.infomaniak.com/).
- 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
diff --git a/docs/content/dns/zz_gen_internetbs.md b/docs/content/dns/zz_gen_internetbs.md
index f187dd88..510d2279 100644
--- a/docs/content/dns/zz_gen_internetbs.md
+++ b/docs/content/dns/zz_gen_internetbs.md
@@ -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"
---
-Since: v4.5.0
Configuration for [Internet.bs](https://internetbs.net).
@@ -17,13 +20,15 @@ Configuration for [Internet.bs](https://internetbs.net).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_inwx.md b/docs/content/dns/zz_gen_inwx.md
index 7d696a9b..ef3a2b0f 100644
--- a/docs/content/dns/zz_gen_inwx.md
+++ b/docs/content/dns/zz_gen_inwx.md
@@ -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"
---
-Since: v2.0.0
Configuration for [INWX](https://www.inwx.de/en).
@@ -17,19 +20,21 @@ Configuration for [INWX](https://www.inwx.de/en).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_ionos.md b/docs/content/dns/zz_gen_ionos.md
index abe960e7..4698dc4f 100644
--- a/docs/content/dns/zz_gen_ionos.md
+++ b/docs/content/dns/zz_gen_ionos.md
@@ -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"
---
-Since: v4.2.0
Configuration for [Ionos](https://ionos.com).
@@ -17,12 +20,14 @@ Configuration for [Ionos](https://ionos.com).
- 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 `.` 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" >}}).
diff --git a/docs/content/dns/zz_gen_iwantmyname.md b/docs/content/dns/zz_gen_iwantmyname.md
index 572996d7..34669d33 100644
--- a/docs/content/dns/zz_gen_iwantmyname.md
+++ b/docs/content/dns/zz_gen_iwantmyname.md
@@ -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"
---
-Since: v4.7.0
Configuration for [iwantmyname](https://iwantmyname.com).
@@ -17,13 +20,15 @@ Configuration for [iwantmyname](https://iwantmyname.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_joker.md b/docs/content/dns/zz_gen_joker.md
index c6598efa..b51f596b 100644
--- a/docs/content/dns/zz_gen_joker.md
+++ b/docs/content/dns/zz_gen_joker.md
@@ -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"
---
-Since: v2.6.0
Configuration for [Joker](https://joker.com).
@@ -17,6 +20,8 @@ Configuration for [Joker](https://joker.com).
- 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= \
JOKER_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= \
JOKER_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= \
-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
diff --git a/docs/content/dns/zz_gen_lightsail.md b/docs/content/dns/zz_gen_lightsail.md
index 713a7db7..b32ee1b3 100644
--- a/docs/content/dns/zz_gen_lightsail.md
+++ b/docs/content/dns/zz_gen_lightsail.md
@@ -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/"
---
-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/).
- 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
diff --git a/docs/content/dns/zz_gen_linode.md b/docs/content/dns/zz_gen_linode.md
index b5dc4d8c..b73b5ed6 100644
--- a/docs/content/dns/zz_gen_linode.md
+++ b/docs/content/dns/zz_gen_linode.md
@@ -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/"
---
-Since: v1.1.0
Configuration for [Linode (v4)](https://www.linode.com/).
@@ -17,12 +20,14 @@ Configuration for [Linode (v4)](https://www.linode.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_liquidweb.md b/docs/content/dns/zz_gen_liquidweb.md
index 82e7c079..f35450ab 100644
--- a/docs/content/dns/zz_gen_liquidweb.md
+++ b/docs/content/dns/zz_gen_liquidweb.md
@@ -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"
---
-Since: v3.1.0
Configuration for [Liquid Web](https://liquidweb.com).
@@ -17,6 +20,8 @@ Configuration for [Liquid Web](https://liquidweb.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_loopia.md b/docs/content/dns/zz_gen_loopia.md
index f47063dc..1769b68e 100644
--- a/docs/content/dns/zz_gen_loopia.md
+++ b/docs/content/dns/zz_gen_loopia.md
@@ -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"
---
-Since: v4.2.0
Configuration for [Loopia](https://loopia.com).
@@ -17,6 +20,8 @@ Configuration for [Loopia](https://loopia.com).
- 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
diff --git a/docs/content/dns/zz_gen_luadns.md b/docs/content/dns/zz_gen_luadns.md
index 536205af..0f8eac95 100644
--- a/docs/content/dns/zz_gen_luadns.md
+++ b/docs/content/dns/zz_gen_luadns.md
@@ -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"
---
-Since: v3.7.0
Configuration for [LuaDNS](https://luadns.com).
@@ -17,13 +20,15 @@ Configuration for [LuaDNS](https://luadns.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_mydnsjp.md b/docs/content/dns/zz_gen_mydnsjp.md
index b5178b7a..abc1b638 100644
--- a/docs/content/dns/zz_gen_mydnsjp.md
+++ b/docs/content/dns/zz_gen_mydnsjp.md
@@ -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"
---
-Since: v1.2.0
Configuration for [MyDNS.jp](https://www.mydns.jp).
@@ -17,13 +20,15 @@ Configuration for [MyDNS.jp](https://www.mydns.jp).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_mythicbeasts.md b/docs/content/dns/zz_gen_mythicbeasts.md
index 99c47a1a..97ff996c 100644
--- a/docs/content/dns/zz_gen_mythicbeasts.md
+++ b/docs/content/dns/zz_gen_mythicbeasts.md
@@ -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/"
---
-Since: v0.3.7
Configuration for [MythicBeasts](https://www.mythic-beasts.com/).
@@ -17,13 +20,15 @@ Configuration for [MythicBeasts](https://www.mythic-beasts.com/).
- 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.
diff --git a/docs/content/dns/zz_gen_namecheap.md b/docs/content/dns/zz_gen_namecheap.md
index 8adaa015..20962d87 100644
--- a/docs/content/dns/zz_gen_namecheap.md
+++ b/docs/content/dns/zz_gen_namecheap.md
@@ -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"
---
-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.)
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_namedotcom.md b/docs/content/dns/zz_gen_namedotcom.md
index c93ba558..2bff94b5 100644
--- a/docs/content/dns/zz_gen_namedotcom.md
+++ b/docs/content/dns/zz_gen_namedotcom.md
@@ -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"
---
-Since: v0.5.0
Configuration for [Name.com](https://www.name.com).
@@ -17,13 +20,15 @@ Configuration for [Name.com](https://www.name.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_namesilo.md b/docs/content/dns/zz_gen_namesilo.md
index f11e4732..4e4cbd44 100644
--- a/docs/content/dns/zz_gen_namesilo.md
+++ b/docs/content/dns/zz_gen_namesilo.md
@@ -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/"
---
-Since: v2.7.0
Configuration for [Namesilo](https://www.namesilo.com/).
@@ -17,12 +20,14 @@ Configuration for [Namesilo](https://www.namesilo.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_nearlyfreespeech.md b/docs/content/dns/zz_gen_nearlyfreespeech.md
index 2fec39c8..dd3745fc 100644
--- a/docs/content/dns/zz_gen_nearlyfreespeech.md
+++ b/docs/content/dns/zz_gen_nearlyfreespeech.md
@@ -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/"
---
-Since: v4.8.0
Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/).
@@ -17,13 +20,15 @@ Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_netcup.md b/docs/content/dns/zz_gen_netcup.md
index 5c520221..4a19f127 100644
--- a/docs/content/dns/zz_gen_netcup.md
+++ b/docs/content/dns/zz_gen_netcup.md
@@ -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/"
---
-Since: v1.1.0
Configuration for [Netcup](https://www.netcup.eu/).
@@ -17,6 +20,8 @@ Configuration for [Netcup](https://www.netcup.eu/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_netlify.md b/docs/content/dns/zz_gen_netlify.md
index 23e1a7d6..dd82bd87 100644
--- a/docs/content/dns/zz_gen_netlify.md
+++ b/docs/content/dns/zz_gen_netlify.md
@@ -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"
---
-Since: v3.7.0
Configuration for [Netlify](https://www.netlify.com).
@@ -17,12 +20,14 @@ Configuration for [Netlify](https://www.netlify.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_nicmanager.md b/docs/content/dns/zz_gen_nicmanager.md
index be0e7d79..bcad5eac 100644
--- a/docs/content/dns/zz_gen_nicmanager.md
+++ b/docs/content/dns/zz_gen_nicmanager.md
@@ -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/"
---
-Since: v4.5.0
Configuration for [Nicmanager](https://www.nicmanager.com/).
@@ -17,19 +20,21 @@ Configuration for [Nicmanager](https://www.nicmanager.com/).
- 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
diff --git a/docs/content/dns/zz_gen_nifcloud.md b/docs/content/dns/zz_gen_nifcloud.md
index f9ad3227..a5afebfa 100644
--- a/docs/content/dns/zz_gen_nifcloud.md
+++ b/docs/content/dns/zz_gen_nifcloud.md
@@ -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/"
---
-Since: v1.1.0
Configuration for [NIFCloud](https://www.nifcloud.com/).
@@ -17,13 +20,15 @@ Configuration for [NIFCloud](https://www.nifcloud.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_njalla.md b/docs/content/dns/zz_gen_njalla.md
index c20a4df2..a570fd35 100644
--- a/docs/content/dns/zz_gen_njalla.md
+++ b/docs/content/dns/zz_gen_njalla.md
@@ -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"
---
-Since: v4.3.0
Configuration for [Njalla](https://njal.la).
@@ -17,12 +20,14 @@ Configuration for [Njalla](https://njal.la).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_ns1.md b/docs/content/dns/zz_gen_ns1.md
index 27678b0c..6394f5f2 100644
--- a/docs/content/dns/zz_gen_ns1.md
+++ b/docs/content/dns/zz_gen_ns1.md
@@ -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"
---
-Since: v0.4.0
Configuration for [NS1](https://ns1.com).
@@ -17,12 +20,14 @@ Configuration for [NS1](https://ns1.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_oraclecloud.md b/docs/content/dns/zz_gen_oraclecloud.md
index 7d6631b4..9828c028 100644
--- a/docs/content/dns/zz_gen_oraclecloud.md
+++ b/docs/content/dns/zz_gen_oraclecloud.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_otc.md b/docs/content/dns/zz_gen_otc.md
index bd04d26f..836f623e 100644
--- a/docs/content/dns/zz_gen_otc.md
+++ b/docs/content/dns/zz_gen_otc.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_ovh.md b/docs/content/dns/zz_gen_ovh.md
index ef69cc0f..150f4c84 100644
--- a/docs/content/dns/zz_gen_ovh.md
+++ b/docs/content/dns/zz_gen_ovh.md
@@ -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/"
---
-Since: v0.4.0
Configuration for [OVH](https://www.ovh.com/).
@@ -17,6 +20,8 @@ Configuration for [OVH](https://www.ovh.com/).
- 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
diff --git a/docs/content/dns/zz_gen_pdns.md b/docs/content/dns/zz_gen_pdns.md
index 5c511a8b..c6febaaf 100644
--- a/docs/content/dns/zz_gen_pdns.md
+++ b/docs/content/dns/zz_gen_pdns.md
@@ -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/"
---
-Since: v0.4.0
Configuration for [PowerDNS](https://www.powerdns.com/).
@@ -17,13 +20,15 @@ Configuration for [PowerDNS](https://www.powerdns.com/).
- 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
diff --git a/docs/content/dns/zz_gen_porkbun.md b/docs/content/dns/zz_gen_porkbun.md
index 0ef1ae64..7c0567bc 100644
--- a/docs/content/dns/zz_gen_porkbun.md
+++ b/docs/content/dns/zz_gen_porkbun.md
@@ -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/"
---
-Since: v4.4.0
Configuration for [Porkbun](https://porkbun.com/).
@@ -17,13 +20,15 @@ Configuration for [Porkbun](https://porkbun.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_rackspace.md b/docs/content/dns/zz_gen_rackspace.md
index 91fbfa3f..f7c842e9 100644
--- a/docs/content/dns/zz_gen_rackspace.md
+++ b/docs/content/dns/zz_gen_rackspace.md
@@ -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/"
---
-Since: v0.4.0
Configuration for [Rackspace](https://www.rackspace.com/).
@@ -17,13 +20,15 @@ Configuration for [Rackspace](https://www.rackspace.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_regru.md b/docs/content/dns/zz_gen_regru.md
index 8ce4e1d8..0bf667ae 100644
--- a/docs/content/dns/zz_gen_regru.md
+++ b/docs/content/dns/zz_gen_regru.md
@@ -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/"
---
-Since: v3.5.0
Configuration for [reg.ru](https://www.reg.ru/).
@@ -17,13 +20,15 @@ Configuration for [reg.ru](https://www.reg.ru/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_rfc2136.md b/docs/content/dns/zz_gen_rfc2136.md
index 711ad39c..d84fa4ea 100644
--- a/docs/content/dns/zz_gen_rfc2136.md
+++ b/docs/content/dns/zz_gen_rfc2136.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_rimuhosting.md b/docs/content/dns/zz_gen_rimuhosting.md
index 345c15f3..a28a5683 100644
--- a/docs/content/dns/zz_gen_rimuhosting.md
+++ b/docs/content/dns/zz_gen_rimuhosting.md
@@ -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"
---
-Since: v0.3.5
Configuration for [RimuHosting](https://rimuhosting.com).
@@ -17,12 +20,14 @@ Configuration for [RimuHosting](https://rimuhosting.com).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_route53.md b/docs/content/dns/zz_gen_route53.md
index 626f0438..c6aabff1 100644
--- a/docs/content/dns/zz_gen_route53.md
+++ b/docs/content/dns/zz_gen_route53.md
@@ -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/"
---
-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/).
- 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
diff --git a/docs/content/dns/zz_gen_safedns.md b/docs/content/dns/zz_gen_safedns.md
index b506485a..b07b0591 100644
--- a/docs/content/dns/zz_gen_safedns.md
+++ b/docs/content/dns/zz_gen_safedns.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_sakuracloud.md b/docs/content/dns/zz_gen_sakuracloud.md
index 1024a3b1..ecc15fc1 100644
--- a/docs/content/dns/zz_gen_sakuracloud.md
+++ b/docs/content/dns/zz_gen_sakuracloud.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_scaleway.md b/docs/content/dns/zz_gen_scaleway.md
index f4b8d7bb..376f1b59 100644
--- a/docs/content/dns/zz_gen_scaleway.md
+++ b/docs/content/dns/zz_gen_scaleway.md
@@ -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/"
---
-Since: v3.4.0
Configuration for [Scaleway](https://developers.scaleway.com/).
@@ -17,12 +20,14 @@ Configuration for [Scaleway](https://developers.scaleway.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_selectel.md b/docs/content/dns/zz_gen_selectel.md
index fdb8b6e8..7fbce111 100644
--- a/docs/content/dns/zz_gen_selectel.md
+++ b/docs/content/dns/zz_gen_selectel.md
@@ -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/"
---
-Since: v1.2.0
Configuration for [Selectel](https://kb.selectel.com/).
@@ -17,12 +20,14 @@ Configuration for [Selectel](https://kb.selectel.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_servercow.md b/docs/content/dns/zz_gen_servercow.md
index 219b8b78..86f63168 100644
--- a/docs/content/dns/zz_gen_servercow.md
+++ b/docs/content/dns/zz_gen_servercow.md
@@ -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/"
---
-Since: v3.4.0
Configuration for [Servercow](https://servercow.de/).
@@ -17,13 +20,15 @@ Configuration for [Servercow](https://servercow.de/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_simply.md b/docs/content/dns/zz_gen_simply.md
index 2fefe746..bce1410a 100644
--- a/docs/content/dns/zz_gen_simply.md
+++ b/docs/content/dns/zz_gen_simply.md
@@ -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/"
---
-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/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_softlayer.md b/docs/content/dns/zz_gen_softlayer.md
deleted file mode 100644
index 79ed6675..00000000
--- a/docs/content/dns/zz_gen_softlayer.md
+++ /dev/null
@@ -1,65 +0,0 @@
----
-title: "SoftLayer (IBM Cloud)"
-date: 2019-03-03T16:39:46+01:00
-draft: false
-slug: softlayer
----
-
-
-
-
-
-Since: v4.5.0
-
-Configuration for [SoftLayer (IBM Cloud)](https://www.ibm.com/cloud/).
-
-
-
-
-- 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 _) |
-
-The 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)
-
-
-
-
diff --git a/docs/content/dns/zz_gen_sonic.md b/docs/content/dns/zz_gen_sonic.md
index 653eed6f..5e0ad197 100644
--- a/docs/content/dns/zz_gen_sonic.md
+++ b/docs/content/dns/zz_gen_sonic.md
@@ -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/"
---
-Since: v4.4.0
Configuration for [Sonic](https://www.sonic.com/).
@@ -17,13 +20,15 @@ Configuration for [Sonic](https://www.sonic.com/).
- 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
diff --git a/docs/content/dns/zz_gen_stackpath.md b/docs/content/dns/zz_gen_stackpath.md
index d6b38fcb..d07b3040 100644
--- a/docs/content/dns/zz_gen_stackpath.md
+++ b/docs/content/dns/zz_gen_stackpath.md
@@ -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/"
---
-Since: v1.1.0
Configuration for [Stackpath](https://www.stackpath.com/).
@@ -17,6 +20,8 @@ Configuration for [Stackpath](https://www.stackpath.com/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_tencentcloud.md b/docs/content/dns/zz_gen_tencentcloud.md
index 9c52cdc9..b2c5c3d6 100644
--- a/docs/content/dns/zz_gen_tencentcloud.md
+++ b/docs/content/dns/zz_gen_tencentcloud.md
@@ -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"
---
-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).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_transip.md b/docs/content/dns/zz_gen_transip.md
index ac2c758e..a4c19634 100644
--- a/docs/content/dns/zz_gen_transip.md
+++ b/docs/content/dns/zz_gen_transip.md
@@ -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/"
---
-Since: v2.0.0
Configuration for [TransIP](https://www.transip.nl/).
@@ -17,13 +20,15 @@ Configuration for [TransIP](https://www.transip.nl/).
- 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" >}}).
diff --git a/docs/content/dns/zz_gen_variomedia.md b/docs/content/dns/zz_gen_variomedia.md
index f6481507..a34d857f 100644
--- a/docs/content/dns/zz_gen_variomedia.md
+++ b/docs/content/dns/zz_gen_variomedia.md
@@ -3,13 +3,16 @@ title: "Variomedia"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: variomedia
+dnsprovider:
+ since: "v4.8.0"
+ code: "variomedia"
+ url: "https://www.variomedia.de/"
---
-Since: v4.8.0
Configuration for [Variomedia](https://www.variomedia.de/).
@@ -17,12 +20,14 @@ Configuration for [Variomedia](https://www.variomedia.de/).
- Code: `variomedia`
+- Since: v4.8.0
+
Here is an example bash command using the Variomedia provider:
```bash
VARIOMEDIA_API_TOKEN=xxxx \
-lego --email myemail@example.com --dns variomedia --domains my.example.org run
+lego --email you@example.com --dns variomedia --domains my.example.org run
```
@@ -35,7 +40,7 @@ lego --email myemail@example.com --dns variomedia --domains my.example.org run
| `VARIOMEDIA_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).
| `VARIOMEDIA_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" >}}).
diff --git a/docs/content/dns/zz_gen_vegadns.md b/docs/content/dns/zz_gen_vegadns.md
index b683cc76..0dafc7ef 100644
--- a/docs/content/dns/zz_gen_vegadns.md
+++ b/docs/content/dns/zz_gen_vegadns.md
@@ -3,13 +3,16 @@ title: "VegaDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: vegadns
+dnsprovider:
+ since: "v1.1.0"
+ code: "vegadns"
+ url: "https://github.com/shupp/VegaDNS-API"
---
-Since: v1.1.0
Configuration for [VegaDNS](https://github.com/shupp/VegaDNS-API).
@@ -17,6 +20,8 @@ Configuration for [VegaDNS](https://github.com/shupp/VegaDNS-API).
- Code: `vegadns`
+- Since: v1.1.0
+
{{% notice note %}}
_Please contribute by adding a CLI example._
@@ -34,7 +39,7 @@ _Please contribute by adding a CLI example._
| `VEGADNS_URL` | API endpoint URL |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@@ -46,7 +51,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `VEGADNS_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
diff --git a/docs/content/dns/zz_gen_vercel.md b/docs/content/dns/zz_gen_vercel.md
index 985c959a..817f4764 100644
--- a/docs/content/dns/zz_gen_vercel.md
+++ b/docs/content/dns/zz_gen_vercel.md
@@ -3,13 +3,16 @@ title: "Vercel"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: vercel
+dnsprovider:
+ since: "v4.7.0"
+ code: "vercel"
+ url: "https://vercel.com"
---
-Since: v4.7.0
Configuration for [Vercel](https://vercel.com).
@@ -17,12 +20,14 @@ Configuration for [Vercel](https://vercel.com).
- Code: `vercel`
+- Since: v4.7.0
+
Here is an example bash command using the Vercel provider:
```bash
VERCEL_API_TOKEN=xxxxxx \
-lego --email myemail@example.com --dns vercel --domains my.example.org run
+lego --email you@example.com --dns vercel --domains my.example.org run
```
@@ -35,7 +40,7 @@ lego --email myemail@example.com --dns vercel --domains my.example.org run
| `VERCEL_API_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
@@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `VERCEL_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" >}}).
diff --git a/docs/content/dns/zz_gen_versio.md b/docs/content/dns/zz_gen_versio.md
index 3b3166fe..f6f98773 100644
--- a/docs/content/dns/zz_gen_versio.md
+++ b/docs/content/dns/zz_gen_versio.md
@@ -3,13 +3,16 @@ title: "Versio.[nl|eu|uk]"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: versio
+dnsprovider:
+ since: "v2.7.0"
+ code: "versio"
+ url: "https://www.versio.nl/domeinnamen"
---
-Since: v2.7.0
Configuration for [Versio.[nl|eu|uk]](https://www.versio.nl/domeinnamen).
@@ -17,13 +20,15 @@ Configuration for [Versio.[nl|eu|uk]](https://www.versio.nl/domeinnamen).
- Code: `versio`
+- Since: v2.7.0
+
Here is an example bash command using the Versio.[nl|eu|uk] provider:
```bash
VERSIO_USERNAME= \
VERSIO_PASSWORD= \
-lego --email myemail@example.com --dns versio --domains my.example.org run
+lego --email you@example.com --dns versio --domains my.example.org run
```
@@ -37,7 +42,7 @@ lego --email myemail@example.com --dns versio --domains my.example.org run
| `VERSIO_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" >}}).
## Additional Configuration
@@ -52,7 +57,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `VERSIO_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 ```VERSIO_ENDPOINT=https://www.versio.nl/testapi/v1/```
diff --git a/docs/content/dns/zz_gen_vinyldns.md b/docs/content/dns/zz_gen_vinyldns.md
index 1375e7e7..5007f963 100644
--- a/docs/content/dns/zz_gen_vinyldns.md
+++ b/docs/content/dns/zz_gen_vinyldns.md
@@ -3,13 +3,16 @@ title: "VinylDNS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: vinyldns
+dnsprovider:
+ since: "v4.4.0"
+ code: "vinyldns"
+ url: "https://www.vinyldns.io"
---
-Since: v4.4.0
Configuration for [VinylDNS](https://www.vinyldns.io).
@@ -17,6 +20,8 @@ Configuration for [VinylDNS](https://www.vinyldns.io).
- Code: `vinyldns`
+- Since: v4.4.0
+
Here is an example bash command using the VinylDNS provider:
@@ -24,7 +29,7 @@ Here is an example bash command using the VinylDNS provider:
VINYLDNS_ACCESS_KEY=xxxxxx \
VINYLDNS_SECRET_KEY=yyyyy \
VINYLDNS_HOST=https://api.vinyldns.example.org:9443 \
-lego --email myemail@example.com --dns vinyldns --domains my.example.org run
+lego --email you@example.com --dns vinyldns --domains my.example.org run
```
@@ -39,7 +44,7 @@ lego --email myemail@example.com --dns vinyldns --domains my.example.org run
| `VINYLDNS_SECRET_KEY` | The VinylDNS 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).
| `VINYLDNS_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" >}}).
The vinyldns integration makes use of dotted hostnames to ease permission management.
Users are required to have DELETE ACL level or zone admin permissions on the VinylDNS zone containing the target host.
diff --git a/docs/content/dns/zz_gen_vscale.md b/docs/content/dns/zz_gen_vscale.md
index 26c69460..37c48ae4 100644
--- a/docs/content/dns/zz_gen_vscale.md
+++ b/docs/content/dns/zz_gen_vscale.md
@@ -3,13 +3,16 @@ title: "Vscale"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: vscale
+dnsprovider:
+ since: "v2.0.0"
+ code: "vscale"
+ url: "https://vscale.io/"
---
-Since: v2.0.0
Configuration for [Vscale](https://vscale.io/).
@@ -17,12 +20,14 @@ Configuration for [Vscale](https://vscale.io/).
- Code: `vscale`
+- Since: v2.0.0
+
Here is an example bash command using the Vscale provider:
```bash
VSCALE_API_TOKEN=xxxxx \
-lego --email myemail@example.com --dns vscale --domains my.example.org run
+lego --email you@example.com --dns vscale --domains my.example.org run
```
@@ -35,7 +40,7 @@ lego --email myemail@example.com --dns vscale --domains my.example.org run
| `VSCALE_API_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `VSCALE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
diff --git a/docs/content/dns/zz_gen_vultr.md b/docs/content/dns/zz_gen_vultr.md
index f5dc14a2..9f2d55c5 100644
--- a/docs/content/dns/zz_gen_vultr.md
+++ b/docs/content/dns/zz_gen_vultr.md
@@ -3,13 +3,16 @@ title: "Vultr"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: vultr
+dnsprovider:
+ since: "v0.3.1"
+ code: "vultr"
+ url: "https://www.vultr.com/"
---
-Since: v0.3.1
Configuration for [Vultr](https://www.vultr.com/).
@@ -17,12 +20,14 @@ Configuration for [Vultr](https://www.vultr.com/).
- Code: `vultr`
+- Since: v0.3.1
+
Here is an example bash command using the Vultr provider:
```bash
VULTR_API_KEY=xxxxx \
-lego --email myemail@example.com --dns vultr --domains my.example.org run
+lego --email you@example.com --dns vultr --domains my.example.org run
```
@@ -35,7 +40,7 @@ lego --email myemail@example.com --dns vultr --domains my.example.org run
| `VULTR_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `VULTR_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
diff --git a/docs/content/dns/zz_gen_wedos.md b/docs/content/dns/zz_gen_wedos.md
index 819f9af5..bc45dfe1 100644
--- a/docs/content/dns/zz_gen_wedos.md
+++ b/docs/content/dns/zz_gen_wedos.md
@@ -3,13 +3,16 @@ title: "WEDOS"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: wedos
+dnsprovider:
+ since: "v4.4.0"
+ code: "wedos"
+ url: "https://www.wedos.com"
---
-Since: v4.4.0
Configuration for [WEDOS](https://www.wedos.com).
@@ -17,13 +20,15 @@ Configuration for [WEDOS](https://www.wedos.com).
- Code: `wedos`
+- Since: v4.4.0
+
Here is an example bash command using the WEDOS provider:
```bash
WEDOS_USERNAME=xxxxxxxx \
WEDOS_WAPI_PASSWORD=xxxxxxxx \
-lego --email myemail@example.com --dns wedos --domains my.example.org -run
+lego --email you@example.com --dns wedos --domains my.example.org run
```
@@ -37,7 +42,7 @@ lego --email myemail@example.com --dns wedos --domains my.example.org -run
| `WEDOS_WAPI_PASSWORD` | Password needs to be generated and IP allowed in the admin interface |
The 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).
| `WEDOS_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" >}}).
diff --git a/docs/content/dns/zz_gen_yandex.md b/docs/content/dns/zz_gen_yandex.md
index 4795eb34..cb2241bf 100644
--- a/docs/content/dns/zz_gen_yandex.md
+++ b/docs/content/dns/zz_gen_yandex.md
@@ -3,13 +3,16 @@ title: "Yandex"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: yandex
+dnsprovider:
+ since: "v3.7.0"
+ code: "yandex"
+ url: "https://yandex.com/"
---
-Since: v3.7.0
Configuration for [Yandex](https://yandex.com/).
@@ -17,12 +20,14 @@ Configuration for [Yandex](https://yandex.com/).
- Code: `yandex`
+- Since: v3.7.0
+
Here is an example bash command using the Yandex provider:
```bash
YANDEX_PDD_TOKEN= \
-lego --email myemail@example.com --dns yandex --domains my.example.org run
+lego --email you@example.com --dns yandex --domains my.example.org run
```
@@ -35,7 +40,7 @@ lego --email myemail@example.com --dns yandex --domains my.example.org run
| `YANDEX_PDD_TOKEN` | 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" >}}).
## Additional Configuration
@@ -48,7 +53,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `YANDEX_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" >}}).
diff --git a/docs/content/dns/zz_gen_zoneee.md b/docs/content/dns/zz_gen_zoneee.md
index 845573b3..473d2428 100644
--- a/docs/content/dns/zz_gen_zoneee.md
+++ b/docs/content/dns/zz_gen_zoneee.md
@@ -3,13 +3,16 @@ title: "Zone.ee"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: zoneee
+dnsprovider:
+ since: "v2.1.0"
+ code: "zoneee"
+ url: "https://www.zone.ee/"
---
-Since: v2.1.0
Configuration for [Zone.ee](https://www.zone.ee/).
@@ -17,13 +20,15 @@ Configuration for [Zone.ee](https://www.zone.ee/).
- Code: `zoneee`
+- Since: v2.1.0
+
Here is an example bash command using the Zone.ee provider:
```bash
ZONEEE_API_USER=xxxxx \
ZONEEE_API_KEY=yyyyy \
-lego --email myemail@example.com --dns zoneee --domains my.example.org run
+lego --email you@example.com --dns zoneee --domains my.example.org run
```
@@ -37,7 +42,7 @@ lego --email myemail@example.com --dns zoneee --domains my.example.org run
| `ZONEEE_API_USER` | API user |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
## Additional Configuration
@@ -51,7 +56,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `ZONEEE_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
-More information [here](/lego/dns/#configuration-and-credentials).
+More information [here]({{< ref "dns#configuration-and-credentials" >}}).
diff --git a/docs/content/dns/zz_gen_zonomi.md b/docs/content/dns/zz_gen_zonomi.md
index f9f54473..99168734 100644
--- a/docs/content/dns/zz_gen_zonomi.md
+++ b/docs/content/dns/zz_gen_zonomi.md
@@ -3,13 +3,16 @@ title: "Zonomi"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: zonomi
+dnsprovider:
+ since: "v3.5.0"
+ code: "zonomi"
+ url: "https://zonomi.com"
---
-Since: v3.5.0
Configuration for [Zonomi](https://zonomi.com).
@@ -17,12 +20,14 @@ Configuration for [Zonomi](https://zonomi.com).
- Code: `zonomi`
+- Since: v3.5.0
+
Here is an example bash command using the Zonomi provider:
```bash
ZONOMI_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
-lego --email myemail@example.com --dns zonomi --domains my.example.org run
+lego --email you@example.com --dns zonomi --domains my.example.org run
```
@@ -35,7 +40,7 @@ lego --email myemail@example.com --dns zonomi --domains my.example.org run
| `ZONOMI_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).
| `ZONOMI_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" >}}).
diff --git a/docs/content/installation/_index.md b/docs/content/installation/_index.md
index 64146425..a1b440c6 100644
--- a/docs/content/installation/_index.md
+++ b/docs/content/installation/_index.md
@@ -18,25 +18,23 @@ docker run goacme/lego -h
## From package managers
-- [ArchLinux (AUR)](https://aur.archlinux.org/packages/lego):
+- [ArchLinux (AUR)](https://aur.archlinux.org/packages/lego) (official):
-```bash
-yay -S lego
-```
+ ```bash
+ yay -S lego
+ ```
-**Note**: only the package manager for Arch Linux is officially supported by the lego team.
+- [FreeBSD (Ports)](https://www.freshports.org/security/lego) (unofficial):
-- [FreeBSD (Ports)](https://www.freshports.org/security/lego):
+ ```bash
+ cd /usr/ports/security/lego && make install clean
+ ```
-```bash
-cd /usr/ports/security/lego && make install clean
-```
+ or
-or
-
-```bash
-pkg install lego
-```
+ ```bash
+ pkg install lego
+ ```
## From sources
diff --git a/docs/content/usage/_index.md b/docs/content/usage/_index.md
index 7a4b3f48..b2e9b24c 100644
--- a/docs/content/usage/_index.md
+++ b/docs/content/usage/_index.md
@@ -5,4 +5,4 @@ draft: false
weight: 2
---
-{{%children style="h2" description="true" %}}
+{{% children style="h2" description="true" %}}
diff --git a/docs/content/usage/cli/General-Instructions.md b/docs/content/usage/cli/General-Instructions.md
new file mode 100644
index 00000000..6962a79c
--- /dev/null
+++ b/docs/content/usage/cli/General-Instructions.md
@@ -0,0 +1,17 @@
+---
+title: General Instructions
+date: 2019-03-03T16:39:46+01:00
+draft: false
+summary: Read this first to clarify some assumptions made by the following guides.
+weight: 1
+---
+
+These examples assume you have [lego installed]({{< ref "installation" >}}).
+You can get a pre-built binary from the [releases](https://github.com/go-acme/lego/releases) page.
+
+The web server examples require that the `lego` binary has permission to bind to ports 80 and 443.
+If your environment does not allow you to bind to these ports, please read [Running without root privileges]({{< ref "usage/cli/Options#running-without-root-privileges" >}}) and [Port Usage]({{< ref "usage/cli/Options#port-usage" >}}).
+
+Unless otherwise instructed with the `--path` command line flag, lego will look for a directory named `.lego` in the *current working directory*.
+If you run `cd /dir/a && lego ... run`, lego will create a directory `/dir/a/.lego` where it will save account registration and certificate files into.
+If you later try to renew a certificate with `cd /dir/b && lego ... renew`, lego will likely produce an error.
diff --git a/docs/content/usage/cli/Obtain-a-Certificate.md b/docs/content/usage/cli/Obtain-a-Certificate.md
new file mode 100644
index 00000000..4e22838f
--- /dev/null
+++ b/docs/content/usage/cli/Obtain-a-Certificate.md
@@ -0,0 +1,129 @@
+---
+title: Obtain a Certificate
+date: 2019-03-03T16:39:46+01:00
+draft: false
+weight: 2
+---
+
+This guide explains various ways to obtain a new certificate.
+
+
+
+## Using the built-in web server
+
+Open a terminal, and execute the following command (insert your own email address and domain):
+
+```bash
+lego --email="you@example.com" --domains="example.com" --http run
+```
+
+You will find your certificate in the `.lego` folder of the current working directory:
+
+```console
+$ ls -1 ./.lego/certificates
+example.com.crt
+example.com.issuer.crt
+example.com.json
+example.com.key
+[maybe more files for different domains...]
+```
+
+where
+
+- `example.com.crt` is the server certificate (including the CA certificate),
+- `example.com.key` is the private key needed for the server certificate,
+- `example.com.issuer.crt` is the CA certificate, and
+- `example.com.json` contains some JSON encoded meta information.
+
+For each domain, you will have a set of these four files.
+For wildcard certificates (`*.example.com`), the filenames will look like `_.example.com.crt`.
+
+The `.crt` and `.key` files are PEM-encoded x509 certificates and private keys.
+If you're looking for a `cert.pem` and `privkey.pem`, you can just use `example.com.crt` and `example.com.key`.
+
+
+## Using a DNS provider
+
+If you can't or don't want to start a web server, you need to use a DNS provider.
+lego comes with [support for many]({{< ref "dns#dns-providers" >}}) providers,
+and you need to pick the one where your domain's DNS settings are set up.
+Typically, this is the registrar where you bought the domain, but in some cases this can be another third-party provider.
+
+For this example, let's assume you have setup CloudFlare for your domain.
+
+Execute this command:
+
+```bash
+CLOUDFLARE_EMAIL="you@example.com" \
+CLOUDFLARE_API_KEY="yourprivatecloudflareapikey" \
+lego --email "you@example.com" --dns cloudflare --domains "example.org" run
+```
+
+
+## Using a custom certificate signing request (CSR)
+
+The first step in the process of obtaining certificates involves creating a signing request.
+This CSR bundles various information, including the domain name(s) and a public key.
+By default, lego will hide this step from you, but if you already have a CSR, you can easily reuse it:
+
+```bash
+lego --email="you@example.com" --http --csr="/path/to/csr.pem" run
+```
+
+lego will infer the domains to be validated based on the contents of the CSR, so make sure the CSR's Common Name and optional SubjectAltNames are set correctly.
+
+
+## Using an existing, running web server
+
+If you have an existing server running on port 80, the `--http` option also requires the `--http.webroot` option.
+This just writes the http-01 challenge token to the given directory in the folder `.well-known/acme-challenge` and does not start a server.
+
+The given directory **should** be publicly served as `/` on the domain(s) for the validation to complete.
+
+If the given directory is not publicly served you will have to support rewriting the request to the directory;
+
+You could also implement a rewrite to rewrite `.well-known/acme-challenge` to the given directory `.well-known/acme-challenge`.
+
+You should be able to run an existing webserver on port 80 and have lego write the token file with the HTTP-01 challenge key authorization to `/.well-known/acme-challenge/` by running something like:
+
+```bash
+lego --accept-tos --email you@example.com --http --http.webroot /path/to/webroot --domains example.com run
+```
+
+## Running a script afterward
+
+You can easily hook into the certificate-obtaining process by providing the path to a script:
+
+```bash
+lego --email="you@example.com" --domains="example.com" --http run --run-hook="./myscript.sh"
+```
+
+Some information is provided through environment variables:
+
+- `LEGO_ACCOUNT_EMAIL`: the email of the account.
+- `LEGO_CERT_DOMAIN`: the main domain of the certificate.
+- `LEGO_CERT_PATH`: the path of the certificate.
+- `LEGO_CERT_KEY_PATH`: the path of the certificate key.
+
+### Use case
+
+A typical use case is distribute the certificate for other services and reload them if necessary.
+Since PEM-formatted TLS certificates are understood by many programs, it is relatively simple to use certificates for more than a web server.
+
+This example script installs the new certificate for a mail server, and reloads it.
+Beware: this is just a starting point, error checking is omitted for brevity.
+
+```bash
+#!/bin/bash
+
+# copy certificates to a directory controlled by Postfix
+postfix_cert_dir="/etc/postfix/certificates"
+
+# our Postfix server only handles mail for @example.com domain
+if [ "$LEGO_CERT_DOMAIN" = "example.com" ]; then
+ install -u postfix -g postfix -m 0644 "$LEGO_CERT_PATH" "$postfix_cert_dir"
+ install -u postfix -g postfix -m 0640 "$LEGO_KEY_PATH" "$postfix_cert_dir"
+
+ systemctl reload postfix@-service
+fi
+```
diff --git a/docs/content/usage/cli/Options.md b/docs/content/usage/cli/Options.md
new file mode 100644
index 00000000..905c4136
--- /dev/null
+++ b/docs/content/usage/cli/Options.md
@@ -0,0 +1,133 @@
+---
+title: "Options"
+date: 2019-03-03T16:39:46+01:00
+draft: false
+summary: This page describes various command line options.
+weight: 4
+---
+
+## Usage
+
+{{< tabs >}}
+{{% tab name="lego --help" %}}
+```slim
+NAME:
+ lego - Let's Encrypt client written in Go
+
+USAGE:
+ lego [global options] command [command options] [arguments...]
+
+COMMANDS:
+ run Register an account, then create and install a certificate
+ revoke Revoke a certificate
+ renew Renew a certificate
+ dnshelp Shows additional help for the '--dns' global option
+ list Display certificates and accounts information.
+ help, h Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+ --domains value, -d value Add a domain to the process. Can be specified multiple times.
+ --server value, -s value CA hostname (and optionally :port). The server certificate must be trusted in order to avoid further modifications to the client. (default: "https://acme-v02.api.letsencrypt.org/directory")
+ --accept-tos, -a By setting this flag to true you indicate that you accept the current Let's Encrypt terms of service. (default: false)
+ --email value, -m value Email used for registration and recovery contact.
+ --csr value, -c value Certificate signing request filename, if an external CSR is to be used.
+ --eab Use External Account Binding for account registration. Requires --kid and --hmac. (default: false)
+ --kid value Key identifier from External CA. Used for External Account Binding.
+ --hmac value MAC key from External CA. Should be in Base64 URL Encoding without padding format. Used for External Account Binding.
+ --key-type value, -k value Key type to use for private keys. Supported: rsa2048, rsa4096, rsa8192, ec256, ec384. (default: "ec256")
+ --filename value (deprecated) Filename of the generated certificate.
+ --path value Directory to use for storing the data. (default: "./.lego") [$LEGO_PATH]
+ --http Use the HTTP challenge to solve challenges. Can be mixed with other types of challenges. (default: false)
+ --http.port value Set the port and interface to use for HTTP based challenges to listen on.Supported: interface:port or :port. (default: ":80")
+ --http.proxy-header value Validate against this HTTP header when solving HTTP based challenges behind a reverse proxy. (default: "Host")
+ --http.webroot value Set the webroot folder to use for HTTP based challenges to write directly in a file in .well-known/acme-challenge. This disables the built-in server and expects the given directory to be publicly served with access to .well-known/acme-challenge
+ --http.memcached-host value Set the memcached host(s) to use for HTTP based challenges. Challenges will be written to all specified hosts.
+ --tls Use the TLS challenge to solve challenges. Can be mixed with other types of challenges. (default: false)
+ --tls.port value Set the port and interface to use for TLS based challenges to listen on. Supported: interface:port or :port. (default: ":443")
+ --dns value Solve a DNS challenge using the specified provider. Can be mixed with other types of challenges. Run 'lego dnshelp' for help on usage.
+ --dns.disable-cp By setting this flag to true, disables the need to wait the propagation of the TXT record to all authoritative name servers. (default: false)
+ --dns.resolvers value Set the resolvers to use for performing recursive DNS queries. Supported: host:port. The default is to use the system resolvers, or Google's DNS resolvers if the system's cannot be determined.
+ --http-timeout value Set the HTTP timeout value to a specific value in seconds. (default: 0)
+ --dns-timeout value Set the DNS timeout value to a specific value in seconds. Used only when performing authoritative name servers queries. (default: 10)
+ --pem Generate a .pem file by concatenating the .key and .crt files together. (default: false)
+ --pfx Generate a .pfx (PKCS#12) file by with the .key and .crt and issuer .crt files together. (default: false)
+ --pfx.pass value The password used to encrypt the .pfx (PCKS#12) file. (default: "changeit")
+ --cert.timeout value Set the certificate timeout value to a specific value in seconds. Only used when obtaining certificates. (default: 30)
+ --help, -h show help (default: false)
+ --version, -v print the version (default: false)
+```
+{{% /tab %}}
+{{% tab name="lego run --help" %}}
+```slim
+NAME:
+ lego run - Register an account, then create and install a certificate
+
+USAGE:
+ lego run [command options] [arguments...]
+
+OPTIONS:
+ --no-bundle Do not create a certificate bundle by adding the issuers certificate to the new certificate. (default: false)
+ --must-staple Include the OCSP must staple TLS extension in the CSR and generated certificate. Only works if the CSR is generated by lego. (default: false)
+ --run-hook value Define a hook. The hook is executed when the certificates are effectively created.
+ --preferred-chain value If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If no match, the default offered chain will be used.
+ --always-deactivate-authorizations value Force the authorizations to be relinquished even if the certificate request was successful.
+```
+{{% /tab %}}
+{{% tab name="lego renew --help" %}}
+```slim
+NAME:
+ lego renew - Renew a certificate
+
+USAGE:
+ lego renew [command options] [arguments...]
+
+OPTIONS:
+ --days value The number of days left on a certificate to renew it. (default: 30)
+ --reuse-key Used to indicate you want to reuse your current private key for the new certificate. (default: false)
+ --no-bundle Do not create a certificate bundle by adding the issuers certificate to the new certificate. (default: false)
+ --must-staple Include the OCSP must staple TLS extension in the CSR and generated certificate. Only works if the CSR is generated by lego. (default: false)
+ --renew-hook value Define a hook. The hook is executed only when the certificates are effectively renewed.
+ --preferred-chain value If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If no match, the default offered chain will be used.
+ --always-deactivate-authorizations value Force the authorizations to be relinquished even if the certificate request was successful.
+ --no-random-sleep Do not add a random sleep before the renewal. We do not recommend using this flag if you are doing your renewals in an automated way. (default: false)
+```
+{{% /tab %}}
+{{< /tabs >}}
+
+When using the standard `--path` option, all certificates and account configurations are saved to a folder `.lego` in the current working directory.
+
+
+## Let's Encrypt ACME server
+
+lego defaults to communicating with the production Let's Encrypt ACME server.
+If you'd like to test something without issuing real certificates, consider using the staging endpoint instead:
+
+```bash
+lego --server=https://acme-staging-v02.api.letsencrypt.org/directory …
+```
+
+## Running without root privileges
+
+The CLI does not require root permissions but needs to bind to port 80 and 443 for certain challenges.
+To run the CLI without `sudo`, you have four options:
+
+- Use `setcap 'cap_net_bind_service=+ep' /path/to/lego` (Linux only)
+- Pass the `--http.port` or/and the `--tls.port` option and specify a custom port to bind to. In this case you have to forward port 80/443 to these custom ports (see [Port Usage](#port-usage)).
+- Pass the `--http.webroot` option and specify the path to your webroot folder. In this case the challenge will be written in a file in `.well-known/acme-challenge/` inside your webroot.
+- Pass the `--dns` option and specify a DNS provider.
+
+## Port Usage
+
+By default lego assumes it is able to bind to ports 80 and 443 to solve challenges.
+If this is not possible in your environment, you can use the `--http.port` and `--tls.port` options to instruct
+lego to listen on that interface:port for any incoming challenges.
+
+If you are using this option, make sure you proxy all of the following traffic to these ports.
+
+**HTTP Port:** All plaintext HTTP requests to port **80** which begin with a request path of `/.well-known/acme-challenge/` for the HTTP challenge.[^header]
+
+**TLS Port:** All TLS handshakes on port **443** for the TLS-ALPN challenge.
+
+This traffic redirection is only needed as long as lego solves challenges. As soon as you have received your certificates you can deactivate the forwarding.
+
+[^header]: You must ensure that incoming validation requests contains the correct value for the HTTP `Host` header. If you operate lego behind a non-transparent reverse proxy (such as Apache or NGINX), you might need to alter the header field using `--http.proxy-header X-Forwarded-Host`.
diff --git a/docs/content/usage/cli/Renew-a-Certificate.md b/docs/content/usage/cli/Renew-a-Certificate.md
new file mode 100644
index 00000000..c449cf18
--- /dev/null
+++ b/docs/content/usage/cli/Renew-a-Certificate.md
@@ -0,0 +1,110 @@
+---
+title: Renew a Certificate
+date: 2019-03-03T16:39:46+01:00
+draft: false
+weight: 3
+---
+
+This guide describes how to renew existing certificates.
+
+
+
+Certificates issues by Let's Encrypt are valid for a period of 90 days.
+To avoid certificate errors, you need to ensure that you renew your certificate *before* it expires.
+
+In order to renew a certificate, follow the general instructions laid out under [Obtain a Certificate]({{< ref "usage/cli/Obtain-a-Certificate" >}}), and replace `lego ... run` with `lego ... renew`.
+Note that the `renew` sub-command supports a slightly different set of some command line flags.
+
+## Using the built-in web server
+
+By default, and following best practices, a certificate is only renewed if its expiry date is less than 30 days in the future.
+
+```bash
+lego --email="you@example.com" --domains="example.com" --http renew
+```
+
+If the certificate needs to renewed earlier, you can specify the number of remaining days:
+
+```bash
+lego --email="you@example.com" --domains="example.com" --http renew --days 45
+```
+
+## Using a DNS provider
+
+If you can't or don't want to start a web server, you need to use a DNS provider.
+lego comes with [support for many]({{< ref "dns#dns-providers" >}}) providers,
+and you need to pick the one where your domain's DNS settings are set up.
+Typically, this is the registrar where you bought the domain, but in some cases this can be another third-party provider.
+
+For this example, let's assume you have setup CloudFlare for your domain.
+
+Execute this command:
+
+```bash
+CLOUDFLARE_EMAIL="you@example.com" \
+CLOUDFLARE_API_KEY="yourprivatecloudflareapikey" \
+lego --email "you@example.com" --dns cloudflare --domains "example.org" renew
+```
+
+## Running a script afterward
+
+You can easily hook into the certificate-obtaining process by providing the path to a script.
+The hook is executed only when the certificates are effectively renewed.
+
+```bash
+lego --email="you@example.com" --domains="example.com" --http renew --renew-hook="./myscript.sh"
+```
+
+Some information is provided through environment variables:
+
+- `LEGO_ACCOUNT_EMAIL`: the email of the account.
+- `LEGO_CERT_DOMAIN`: the main domain of the certificate.
+- `LEGO_CERT_PATH`: the path of the certificate.
+- `LEGO_CERT_KEY_PATH`: the path of the certificate key.
+
+See [Obtain a Certificate → Use case]({{< ref "usage/cli/Obtain-a-Certificate#use-case" >}}) for an example script.
+
+## Automatic renewal
+
+It is tempting to create a cron job (or systemd timer) to automatically renew all you certificates.
+
+When doing so, please note that some cron defaults will cause measurable load on the ACME provider's infrastructure.
+Notably `@daily` jobs run at midnight.
+
+To both counteract load spikes (caused by all lego users) and reduce subsequent renewal failures, we were asked to implement a small random delay for non-interactive renewals.[^loadspikes]
+Since v4.8.0, lego will pause for up to 8 minutes to help spread the load.
+
+You can help further, by adjusting your crontab entry, like so:
+
+```ruby
+# avoid:
+#@daily /usr/bin/lego ... renew
+#@midnight /usr/bin/lego ... renew
+#0 0 * * * /usr/bin/lego ... renew
+
+# instead, use a randomly chosen time:
+3 35 * * * /usr/bin/lego ... renew
+```
+
+If you use systemd timers, consider doing something similar, and/or introduce a `RandomizedDelaySec`:
+
+```ini
+[Unit]
+Description=Renew certificates
+
+[Timer]
+Persistent=true
+# avoid:
+#OnCalendar=*-*-* 00:00:00
+#OnCalendar=daily
+
+# instead, use a randomly chosen time:
+OnCalendar=*-*-* 3:35
+# add extra delay, here up to 1 hour:
+RandomizedDelaySec=1h
+
+[Install]
+WantedBy=timers.target
+```
+
+[^loadspikes]: See [Github issue #1656](https://github.com/go-acme/lego/issues/1656) for an excellent problem description.
diff --git a/docs/content/usage/cli/_index.md b/docs/content/usage/cli/_index.md
index 155e7400..395bbc82 100644
--- a/docs/content/usage/cli/_index.md
+++ b/docs/content/usage/cli/_index.md
@@ -8,89 +8,4 @@ Lego can be use as a CLI.
-## Usage
-
-```slim
-NAME:
- lego - Let's Encrypt client written in Go
-
-USAGE:
- lego [global options] command [command options] [arguments...]
-
-COMMANDS:
- run Register an account, then create and install a certificate
- revoke Revoke a certificate
- renew Renew a certificate
- dnshelp Shows additional help for the '--dns' global option
- list Display certificates and accounts information.
- help, h Shows a list of commands or help for one command
-
-GLOBAL OPTIONS:
- --domains value, -d value Add a domain to the process. Can be specified multiple times.
- --server value, -s value CA hostname (and optionally :port). The server certificate must be trusted in order to avoid further modifications to the client. (default: "https://acme-v02.api.letsencrypt.org/directory")
- --accept-tos, -a By setting this flag to true you indicate that you accept the current Let's Encrypt terms of service. (default: false)
- --email value, -m value Email used for registration and recovery contact.
- --csr value, -c value Certificate signing request filename, if an external CSR is to be used.
- --eab Use External Account Binding for account registration. Requires --kid and --hmac. (default: false)
- --kid value Key identifier from External CA. Used for External Account Binding.
- --hmac value MAC key from External CA. Should be in Base64 URL Encoding without padding format. Used for External Account Binding.
- --key-type value, -k value Key type to use for private keys. Supported: rsa2048, rsa4096, rsa8192, ec256, ec384. (default: "ec256")
- --filename value (deprecated) Filename of the generated certificate.
- --path value Directory to use for storing the data. (default: "./.lego") [$LEGO_PATH]
- --http Use the HTTP challenge to solve challenges. Can be mixed with other types of challenges. (default: false)
- --http.port value Set the port and interface to use for HTTP based challenges to listen on.Supported: interface:port or :port. (default: ":80")
- --http.proxy-header value Validate against this HTTP header when solving HTTP based challenges behind a reverse proxy. (default: "Host")
- --http.webroot value Set the webroot folder to use for HTTP based challenges to write directly in a file in .well-known/acme-challenge. This disables the built-in server and expects the given directory to be publicly served with access to .well-known/acme-challenge
- --http.memcached-host value Set the memcached host(s) to use for HTTP based challenges. Challenges will be written to all specified hosts.
- --tls Use the TLS challenge to solve challenges. Can be mixed with other types of challenges. (default: false)
- --tls.port value Set the port and interface to use for TLS based challenges to listen on. Supported: interface:port or :port. (default: ":443")
- --dns value Solve a DNS challenge using the specified provider. Can be mixed with other types of challenges. Run 'lego dnshelp' for help on usage.
- --dns.disable-cp By setting this flag to true, disables the need to wait the propagation of the TXT record to all authoritative name servers. (default: false)
- --dns.resolvers value Set the resolvers to use for performing recursive DNS queries. Supported: host:port. The default is to use the system resolvers, or Google's DNS resolvers if the system's cannot be determined.
- --http-timeout value Set the HTTP timeout value to a specific value in seconds. (default: 0)
- --dns-timeout value Set the DNS timeout value to a specific value in seconds. Used only when performing authoritative name servers queries. (default: 10)
- --pem Generate a .pem file by concatenating the .key and .crt files together. (default: false)
- --pfx Generate a .pfx (PKCS#12) file by with the .key and .crt and issuer .crt files together. (default: false)
- --pfx.pass value The password used to encrypt the .pfx (PCKS#12) file. (default: "changeit")
- --cert.timeout value Set the certificate timeout value to a specific value in seconds. Only used when obtaining certificates. (default: 30)
- --help, -h show help (default: false)
- --version, -v print the version (default: false)
-```
-
-When using the standard `--path` option, all certificates and account configurations are saved to a folder `.lego` in the current working directory.
-
-
-## Let's Encrypt ACME server
-
-lego defaults to communicating with the production Let's Encrypt ACME server.
-If you'd like to test something without issuing real certificates, consider using the staging endpoint instead:
-
-```bash
-lego --server=https://acme-staging-v02.api.letsencrypt.org/directory …
-```
-
-## Running without root privileges
-
-The CLI does not require root permissions but needs to bind to port 80 and 443 for certain challenges.
-To run the CLI without `sudo`, you have four options:
-
-- Use `setcap 'cap_net_bind_service=+ep' /path/to/lego` (Linux only)
-- Pass the `--http.port` or/and the `--tls.port` option and specify a custom port to bind to. In this case you have to forward port 80/443 to these custom ports (see [Port Usage](#port-usage)).
-- Pass the `--http.webroot` option and specify the path to your webroot folder. In this case the challenge will be written in a file in `.well-known/acme-challenge/` inside your webroot.
-- Pass the `--dns` option and specify a DNS provider.
-
-## Port Usage
-
-By default lego assumes it is able to bind to ports 80 and 443 to solve challenges.
-If this is not possible in your environment, you can use the `--http.port` and `--tls.port` options to instruct
-lego to listen on that interface:port for any incoming challenges.
-
-If you are using this option, make sure you proxy all of the following traffic to these ports.
-
-**HTTP Port:** All plaintext HTTP requests to port **80** which begin with a request path of `/.well-known/acme-challenge/` for the HTTP challenge.[^header]
-
-**TLS Port:** All TLS handshakes on port **443** for the TLS-ALPN challenge.
-
-This traffic redirection is only needed as long as lego solves challenges. As soon as you have received your certificates you can deactivate the forwarding.
-
-[^header]: You must ensure that incoming validation requests contains the correct value for the HTTP `Host` header. If you operate lego behind a non-transparent reverse proxy (such as Apache or NGINX), you might need to alter the header field using `--http.proxy-header X-Forwarded-Host`.
+{{% children style="h2" description="true" %}}
diff --git a/docs/content/usage/cli/examples.md b/docs/content/usage/cli/examples.md
index b4ec0ee6..b752b1df 100644
--- a/docs/content/usage/cli/examples.md
+++ b/docs/content/usage/cli/examples.md
@@ -1,119 +1,30 @@
---
-title: "Examples"
-date: 2019-11-15T23:25:46+01:00
+title: Examples
+date: 2019-03-03T16:39:46+01:00
draft: false
+hidden: true
---
-## CLI Examples
+{{% notice note %}}
+**Heads up!** We've restructured the content a bit.
+{{% /notice %}}
-Assumes the `lego` binary has permission to bind to ports 80 and 443.
-You can get a pre-built binary from the [releases](https://github.com/go-acme/lego/releases) page.
-If your environment does not allow you to bind to these ports, please read [Port Usage](usage/cli#port-usage).
+You'll find the content now at one of these pages:
-### Obtain a certificate
-
-```bash
-lego --email="foo@bar.com" --domains="example.com" --http run
-```
-
-You will find your certificate in the `.lego` folder of the current working directory:
-
-```console
-$ ls -1 ./.lego/certificates
-example.com.crt
-example.com.issuer.crt
-example.com.json
-example.com.key
-[maybe more files for different domains...]
-```
-
-where
-
-- `example.com.crt` is the server certificate (including the CA certificate),
-- `example.com.key` is the private key needed for the server certificate,
-- `example.com.issuer.crt` is the CA certificate, and
-- `example.com.json` contains some JSON encoded meta information.
-
-For each domain, you will have a set of these four files.
-Please note, that for wildcard certificates (`*.example.com`), the filenames will look like `_.example.com.crt`.
-The `.crt` and `.key` files are PEM encoded x509 certificates and private keys.
-If you're looking for a `cert.pem` and `privkey.pem`, you can just use `example.com.crt` and `example.com.key`.
-
-
-### Obtain a certificate (and hook)
-
-The hook is executed only when the certificates are effectively created.
-
-```bash
-lego --email="foo@bar.com" --domains="example.com" --http run --run-hook="./myscript.sh"
-```
-
-Some information are added to the environment variables when the hook is used:
-
-- `LEGO_ACCOUNT_EMAIL`: the email of the account.
-- `LEGO_CERT_DOMAIN`: the main domain of the certificate.
-- `LEGO_CERT_PATH`: the path of the certificate.
-- `LEGO_CERT_KEY_PATH`: the path of the certificate key.
-
-### To renew the certificate
-
-```bash
-lego --email="foo@bar.com" --domains="example.com" --http renew
-```
-
-### To renew the certificate only if it expires within 45 days
-
-```bash
-lego --email="foo@bar.com" --domains="example.com" --http renew --days 45
-```
-
-### To renew the certificate (and hook)
-
-The hook is executed only when the certificates are effectively renewed.
-
-```bash
-lego --email="foo@bar.com" --domains="example.com" --http renew --renew-hook="./myscript.sh"
-```
-
-Some information are added to the environment variables when the hook is used:
-
-- `LEGO_ACCOUNT_EMAIL`: the email of the account.
-- `LEGO_CERT_DOMAIN`: the main domain of the certificate.
-- `LEGO_CERT_PATH`: the path of the certificate.
-- `LEGO_CERT_KEY_PATH`: the path of the certificate key.
-
-### Obtain a certificate using the DNS challenge
-
-```bash
-AWS_REGION=us-east-1 \
-AWS_ACCESS_KEY_ID=my_id \
-AWS_SECRET_ACCESS_KEY=my_key \
-lego --email="foo@bar.com" --domains="example.com" --dns="route53" run
-```
-
-### Obtain a certificate given a certificate signing request (CSR) generated by something else
-
-```bash
-lego --email="foo@bar.com" --http --csr=/path/to/csr.pem run
-```
-
-(lego will infer the domains to be validated based on the contents of the CSR, so make sure the CSR's Common Name and optional SubjectAltNames are set correctly.)
-
-## Misc HTTP-01 CLI Examples
-
-### Write HTTP-01 token to already "served" directory
-
-If you have an existing server running on port 80 the `--http` option needs to also use the `--http.webroot` option.
-This just writes the token to the given directory in the folder `.well-known/acme-challenge` and does not start a server.
-
-The given directory **should** be publicly served as `/` on the domain(s) for the validation to complete.
-
-If the given directory is not publicly served you will have to support rewriting the request to the directory;
-
-You could also implement a rewrite to rewrite `.well-known/acme-challenge` to the given directory `.well-known/acme-challenge`.
-
-You should be able to run an existing webserver on port 80 and have lego write the token file with the HTTP-01 challenge key authorization to `/.well-known/acme-challenge/` by running something like:
-
-```bash
-lego --accept-tos -m foo@bar.com --http --http.webroot /path/to/webroot -d example.com run
-```
+- Guide: [**How to obtain a certificate**]({{< ref "usage/cli/Obtain-a-Certificate" >}})
+ - Using the built-in web server
+ - Using a DNS provider
+ - Using a custom certificate signing request (CSR)
+ - Using an existing, running web server
+ - Running a script afterward
+ - Use case
+- Guide: [**How to renew a certificate**]({{< ref "usage/cli/Renew-a-Certificate" >}})
+ - Using the built-in web server
+ - Using a DNS provider
+ - Running a script afterward
+ - Automatic renewal
+- Reference: [**Command line options**]({{< ref "usage/cli/Options" >}})
+ - Usage
+ - Let's Encrypt ACME server
+ - Running without root privileges
+ - Port Usage
diff --git a/docs/content/usage/library/Writing-a-Challenge-Solver.md b/docs/content/usage/library/Writing-a-Challenge-Solver.md
index 3b01c8c1..d56e9c0b 100644
--- a/docs/content/usage/library/Writing-a-Challenge-Solver.md
+++ b/docs/content/usage/library/Writing-a-Challenge-Solver.md
@@ -15,7 +15,7 @@ For example, the HTTP-01 challenge doesn't work well behind a load balancer or C
But even if using HTTP-01 or TLS-ALPN-01 challenges, you may have specific needs that lego does not consider by default.
-You can write something called a `challenge.Provider` that implements [this interface](https://godoc.org/github.com/go-acme/lego/challenge#Provider):
+You can write something called a `challenge.Provider` that implements [this interface](https://pkg.go.dev/github.com/go-acme/lego/v4/challenge#Provider):
```go
type Provider interface {
@@ -85,7 +85,7 @@ In our case, we'd just make another API request to have the DNS record deleted;
## Using your new challenge.Provider
-To use your new challenge provider, call [`client.Challenge.SetDNS01Provider`](https://godoc.org/github.com/go-acme/lego/challenge/resolver#SolverManager.SetDNS01Provider) to tell lego, "For this challenge, use this provider".
+To use your new challenge provider, call [`client.Challenge.SetDNS01Provider`](https://pkg.go.dev/github.com/go-acme/lego/v4/challenge/resolver#SolverManager.SetDNS01Provider) to tell lego, "For this challenge, use this provider".
In our case:
```go
diff --git a/docs/content/usage/library/_index.md b/docs/content/usage/library/_index.md
index ddb9d6d4..60adf98d 100644
--- a/docs/content/usage/library/_index.md
+++ b/docs/content/usage/library/_index.md
@@ -10,7 +10,7 @@ Lego can be use as a Go Library.
## GoDoc
-The GoDoc can be found here: [GoDoc](https://godoc.org/github.com/go-acme/lego/acme)
+The GoDoc can be found here: [GoDoc](https://pkg.go.dev/mod/github.com/go-acme/lego/v4).
## Usage
diff --git a/docs/layouts/shortcodes/tableofdnsproviders.html b/docs/layouts/shortcodes/tableofdnsproviders.html
new file mode 100644
index 00000000..0011364b
--- /dev/null
+++ b/docs/layouts/shortcodes/tableofdnsproviders.html
@@ -0,0 +1,32 @@
+{{ $_hugo_config := `{ "version": 1 }` }}
+
+
+
+
+
Provider name
+
CLI flag name
+
Required lego version
+
+
+
+ {{- range .Site.AllPages.ByWeight -}}
+ {{- if .Params.dnsprovider -}}
+ {{- $params := .Params.dnsprovider -}}
+