docs: refactoring and cleanup (#1658)

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

View file

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

1
docs/.gitignore vendored
View file

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

View file

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

View file

@ -20,11 +20,12 @@ Let's Encrypt client and ACME library written in Go.
- DNS (dns-01) - DNS (dns-01)
- TLS (tls-alpn-01) - TLS (tls-alpn-01)
- SAN certificate support - SAN certificate support
- Comes with multiple optional [DNS providers](dns) - Comes with multiple optional [DNS providers]({{< ref "dns" >}})
- [Custom challenge solvers](usage/library/writing-a-challenge-solver/) - [Custom challenge solvers]({{< ref "usage/library/Writing-a-Challenge-Solver" >}})
- Certificate bundling - Certificate bundling
- OCSP helper function - 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. 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.

View file

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

View file

@ -3,6 +3,10 @@ title: "Manual"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: manual slug: manual
dnsprovider:
since: v0.3.0
code: manual
url:
--- ---
Solving the DNS-01 challenge using CLI prompt. Solving the DNS-01 challenge using CLI prompt.
@ -11,49 +15,58 @@ Solving the DNS-01 challenge using CLI prompt.
## Example ## Example
```txt To start using the CLI prompt "provider", start lego with `--dns manual`:
Do you accept the TOS? Y/n
[INFO] acme: Registering account for test@test.com
!!!! HEADS UP !!!!
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
Do you accept the TOS? Y/n
[INFO] acme: Registering account for test@test.com
!!!! HEADS UP !!!!
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
```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
```
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".
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] [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 as instructed, and create the TXT records, and hit `Enter`.
```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.
```
As mentioned, you can now remove the TXT record again.

View file

@ -3,13 +3,16 @@ title: "Joohoi's ACME-DNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: acme-dns slug: acme-dns
dnsprovider:
since: "v1.1.0"
code: "acme-dns"
url: "https://github.com/joohoi/acme-dns"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/acmedns/acmedns.toml --> <!-- providers/dns/acmedns/acmedns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Joohoi's ACME-DNS](https://github.com/joohoi/acme-dns). Configuration for [Joohoi's ACME-DNS](https://github.com/joohoi/acme-dns).
@ -17,13 +20,15 @@ Configuration for [Joohoi's ACME-DNS](https://github.com/joohoi/acme-dns).
<!--more--> <!--more-->
- Code: `acme-dns` - Code: `acme-dns`
- Since: v1.1.0
Here is an example bash command using the Joohoi's ACME-DNS provider: Here is an example bash command using the Joohoi's ACME-DNS provider:
```bash ```bash
ACME_DNS_API_BASE=http://10.0.0.8:4443 \ ACME_DNS_API_BASE=http://10.0.0.8:4443 \
ACME_DNS_STORAGE_PATH=/root/.lego-acme-dns-accounts.json \ 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. | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

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

View file

@ -3,13 +3,16 @@ title: "all-inkl"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: allinkl slug: allinkl
dnsprovider:
since: "v4.5.0"
code: "allinkl"
url: "https://all-inkl.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/allinkl/allinkl.toml --> <!-- providers/dns/allinkl/allinkl.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [all-inkl](https://all-inkl.com). Configuration for [all-inkl](https://all-inkl.com).
@ -17,13 +20,15 @@ Configuration for [all-inkl](https://all-inkl.com).
<!--more--> <!--more-->
- Code: `allinkl` - Code: `allinkl`
- Since: v4.5.0
Here is an example bash command using the all-inkl provider: Here is an example bash command using the all-inkl provider:
```bash ```bash
ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \ ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
ALL_INKL_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \ 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 | | `ALL_INKL_PASSWORD` | KAS password |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `ALL_INKL_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "ArvanCloud"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: arvancloud slug: arvancloud
dnsprovider:
since: "v3.8.0"
code: "arvancloud"
url: "https://arvancloud.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/arvancloud/arvancloud.toml --> <!-- providers/dns/arvancloud/arvancloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.8.0
Configuration for [ArvanCloud](https://arvancloud.com). Configuration for [ArvanCloud](https://arvancloud.com).
@ -17,12 +20,14 @@ Configuration for [ArvanCloud](https://arvancloud.com).
<!--more--> <!--more-->
- Code: `arvancloud` - Code: `arvancloud`
- Since: v3.8.0
Here is an example bash command using the ArvanCloud provider: Here is an example bash command using the ArvanCloud provider:
```bash ```bash
ARVANCLOUD_API_KEY="Apikey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \ 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 | | `ARVANCLOUD_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Aurora DNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: auroradns slug: auroradns
dnsprovider:
since: "v0.4.0"
code: "auroradns"
url: "https://www.pcextreme.com/aurora/dns"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/auroradns/auroradns.toml --> <!-- providers/dns/auroradns/auroradns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Aurora DNS](https://www.pcextreme.com/aurora/dns). Configuration for [Aurora DNS](https://www.pcextreme.com/aurora/dns).
@ -17,13 +20,15 @@ Configuration for [Aurora DNS](https://www.pcextreme.com/aurora/dns).
<!--more--> <!--more-->
- Code: `auroradns` - Code: `auroradns`
- Since: v0.4.0
Here is an example bash command using the Aurora DNS provider: Here is an example bash command using the Aurora DNS provider:
```bash ```bash
AURORA_USER_ID=xxxxx \ AURORA_USER_ID=xxxxx \
AURORA_KEY=yyyyyy \ 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 | | `AURORA_USER_ID` | User ID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Autodns"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: autodns slug: autodns
dnsprovider:
since: "v3.2.0"
code: "autodns"
url: "https://www.internetx.com/domains/autodns/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/autodns/autodns.toml --> <!-- providers/dns/autodns/autodns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.2.0
Configuration for [Autodns](https://www.internetx.com/domains/autodns/). Configuration for [Autodns](https://www.internetx.com/domains/autodns/).
@ -17,13 +20,15 @@ Configuration for [Autodns](https://www.internetx.com/domains/autodns/).
<!--more--> <!--more-->
- Code: `autodns` - Code: `autodns`
- Since: v3.2.0
Here is an example bash command using the Autodns provider: Here is an example bash command using the Autodns provider:
```bash ```bash
AUTODNS_API_USER=username \ AUTODNS_API_USER=username \
AUTODNS_API_PASSWORD=supersecretpassword \ 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 | | `AUTODNS_API_USER` | Username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Azure"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: azure slug: azure
dnsprovider:
since: "v0.4.0"
code: "azure"
url: "https://azure.microsoft.com/services/dns/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/azure/azure.toml --> <!-- providers/dns/azure/azure.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Azure](https://azure.microsoft.com/services/dns/). Configuration for [Azure](https://azure.microsoft.com/services/dns/).
@ -17,6 +20,8 @@ Configuration for [Azure](https://azure.microsoft.com/services/dns/).
<!--more--> <!--more-->
- Code: `azure` - Code: `azure`
- Since: v0.4.0
{{% notice note %}} {{% notice note %}}
_Please contribute by adding a CLI example._ _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). | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

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

View file

@ -3,13 +3,16 @@ title: "Bluecat"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: bluecat slug: bluecat
dnsprovider:
since: "v0.5.0"
code: "bluecat"
url: "https://www.bluecatnetworks.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/bluecat/bluecat.toml --> <!-- providers/dns/bluecat/bluecat.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Bluecat](https://www.bluecatnetworks.com). Configuration for [Bluecat](https://www.bluecatnetworks.com).
@ -17,6 +20,8 @@ Configuration for [Bluecat](https://www.bluecatnetworks.com).
<!--more--> <!--more-->
- Code: `bluecat` - Code: `bluecat`
- Since: v0.5.0
Here is an example bash command using the Bluecat provider: Here is an example bash command using the Bluecat provider:
@ -27,7 +32,7 @@ BLUECAT_USER_NAME=myusername \
BLUECAT_CONFIG_NAME=myconfig \ BLUECAT_CONFIG_NAME=myconfig \
BLUECAT_SERVER_URL=https://bam.example.com \ BLUECAT_SERVER_URL=https://bam.example.com \
BLUECAT_TTL=30 \ 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 | | `BLUECAT_USER_NAME` | API username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Checkdomain"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: checkdomain slug: checkdomain
dnsprovider:
since: "v3.3.0"
code: "checkdomain"
url: "https://checkdomain.de/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/checkdomain/checkdomain.toml --> <!-- providers/dns/checkdomain/checkdomain.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.3.0
Configuration for [Checkdomain](https://checkdomain.de/). Configuration for [Checkdomain](https://checkdomain.de/).
@ -17,12 +20,14 @@ Configuration for [Checkdomain](https://checkdomain.de/).
<!--more--> <!--more-->
- Code: `checkdomain` - Code: `checkdomain`
- Since: v3.3.0
Here is an example bash command using the Checkdomain provider: Here is an example bash command using the Checkdomain provider:
```bash ```bash
CHECKDOMAIN_TOKEN=yoursecrettoken \ 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 | | `CHECKDOMAIN_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "CloudDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: clouddns slug: clouddns
dnsprovider:
since: "v3.6.0"
code: "clouddns"
url: "https://vshosting.eu/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/clouddns/clouddns.toml --> <!-- providers/dns/clouddns/clouddns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.6.0
Configuration for [CloudDNS](https://vshosting.eu/). Configuration for [CloudDNS](https://vshosting.eu/).
@ -17,14 +20,16 @@ Configuration for [CloudDNS](https://vshosting.eu/).
<!--more--> <!--more-->
- Code: `clouddns` - Code: `clouddns`
- Since: v3.6.0
Here is an example bash command using the CloudDNS provider: Here is an example bash command using the CloudDNS provider:
```bash ```bash
CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \ CLOUDDNS_CLIENT_ID=bLsdFAks23429841238feb177a572aX \
CLOUDDNS_EMAIL=foo@bar.com \ CLOUDDNS_EMAIL=you@example.com \
CLOUDDNS_PASSWORD=b9841238feb177a84330f \ 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 | | `CLOUDDNS_PASSWORD` | Account password |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Cloudflare"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: cloudflare slug: cloudflare
dnsprovider:
since: "v0.3.0"
code: "cloudflare"
url: "https://www.cloudflare.com/dns/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/cloudflare/cloudflare.toml --> <!-- providers/dns/cloudflare/cloudflare.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Cloudflare](https://www.cloudflare.com/dns/). Configuration for [Cloudflare](https://www.cloudflare.com/dns/).
@ -17,18 +20,20 @@ Configuration for [Cloudflare](https://www.cloudflare.com/dns/).
<!--more--> <!--more-->
- Code: `cloudflare` - Code: `cloudflare`
- Since: v0.3.0
Here is an example bash command using the Cloudflare provider: Here is an example bash command using the Cloudflare provider:
```bash ```bash
CLOUDFLARE_EMAIL=foo@bar.com \ CLOUDFLARE_EMAIL=you@example.com \
CLOUDFLARE_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \ 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 # or
CLOUDFLARE_DNS_API_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \ 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

@ -3,13 +3,16 @@ title: "ClouDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: cloudns slug: cloudns
dnsprovider:
since: "v2.3.0"
code: "cloudns"
url: "https://www.cloudns.net"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/cloudns/cloudns.toml --> <!-- providers/dns/cloudns/cloudns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.3.0
Configuration for [ClouDNS](https://www.cloudns.net). Configuration for [ClouDNS](https://www.cloudns.net).
@ -17,13 +20,15 @@ Configuration for [ClouDNS](https://www.cloudns.net).
<!--more--> <!--more-->
- Code: `cloudns` - Code: `cloudns`
- Since: v2.3.0
Here is an example bash command using the ClouDNS provider: Here is an example bash command using the ClouDNS provider:
```bash ```bash
CLOUDNS_AUTH_ID=xxxx \ CLOUDNS_AUTH_ID=xxxx \
CLOUDNS_AUTH_PASSWORD=yyyy \ 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "CloudXNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: cloudxns slug: cloudxns
dnsprovider:
since: "v0.5.0"
code: "cloudxns"
url: "https://www.cloudxns.net/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/cloudxns/cloudxns.toml --> <!-- providers/dns/cloudxns/cloudxns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [CloudXNS](https://www.cloudxns.net/). Configuration for [CloudXNS](https://www.cloudxns.net/).
@ -17,13 +20,15 @@ Configuration for [CloudXNS](https://www.cloudxns.net/).
<!--more--> <!--more-->
- Code: `cloudxns` - Code: `cloudxns`
- Since: v0.5.0
Here is an example bash command using the CloudXNS provider: Here is an example bash command using the CloudXNS provider:
```bash ```bash
CLOUDXNS_API_KEY=xxxx \ CLOUDXNS_API_KEY=xxxx \
CLOUDXNS_SECRET_KEY=yyyy \ 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 | | `CLOUDXNS_SECRET_KEY` | The API secret key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "ConoHa"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: conoha slug: conoha
dnsprovider:
since: "v1.2.0"
code: "conoha"
url: "https://www.conoha.jp/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/conoha/conoha.toml --> <!-- providers/dns/conoha/conoha.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.2.0
Configuration for [ConoHa](https://www.conoha.jp/). Configuration for [ConoHa](https://www.conoha.jp/).
@ -17,6 +20,8 @@ Configuration for [ConoHa](https://www.conoha.jp/).
<!--more--> <!--more-->
- Code: `conoha` - Code: `conoha`
- Since: v1.2.0
Here is an example bash command using the ConoHa provider: 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_TENANT_ID=487727e3921d44e3bfe7ebb337bf085e \
CONOHA_API_USERNAME=xxxx \ CONOHA_API_USERNAME=xxxx \
CONOHA_API_PASSWORD=yyyy \ 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 | | `CONOHA_TENANT_ID` | Tenant ID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Constellix"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: constellix slug: constellix
dnsprovider:
since: "v3.4.0"
code: "constellix"
url: "https://constellix.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/constellix/constellix.toml --> <!-- providers/dns/constellix/constellix.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.4.0
Configuration for [Constellix](https://constellix.com). Configuration for [Constellix](https://constellix.com).
@ -17,13 +20,15 @@ Configuration for [Constellix](https://constellix.com).
<!--more--> <!--more-->
- Code: `constellix` - Code: `constellix`
- Since: v3.4.0
Here is an example bash command using the Constellix provider: Here is an example bash command using the Constellix provider:
```bash ```bash
CONSTELLIX_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ CONSTELLIX_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
CONSTELLIX_SECRET_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 | | `CONSTELLIX_SECRET_KEY` | User secret key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "deSEC.io"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: desec slug: desec
dnsprovider:
since: "v3.7.0"
code: "desec"
url: "https://desec.io"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/desec/desec.toml --> <!-- providers/dns/desec/desec.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [deSEC.io](https://desec.io). Configuration for [deSEC.io](https://desec.io).
@ -17,12 +20,14 @@ Configuration for [deSEC.io](https://desec.io).
<!--more--> <!--more-->
- Code: `desec` - Code: `desec`
- Since: v3.7.0
Here is an example bash command using the deSEC.io provider: Here is an example bash command using the deSEC.io provider:
```bash ```bash
DESEC_TOKEN=x-xxxxxxxxxxxxxxxxxxxxxxxxxx \ 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 | | `DESEC_TOKEN` | Domain token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Designate DNSaaS for Openstack"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: designate slug: designate
dnsprovider:
since: "v2.2.0"
code: "designate"
url: "https://docs.openstack.org/designate/latest/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/designate/designate.toml --> <!-- providers/dns/designate/designate.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.2.0
Configuration for [Designate DNSaaS for Openstack](https://docs.openstack.org/designate/latest/). Configuration for [Designate DNSaaS for Openstack](https://docs.openstack.org/designate/latest/).
@ -17,13 +20,15 @@ Configuration for [Designate DNSaaS for Openstack](https://docs.openstack.org/de
<!--more--> <!--more-->
- Code: `designate` - Code: `designate`
- Since: v2.2.0
Here is an example bash command using the Designate DNSaaS for Openstack provider: Here is an example bash command using the Designate DNSaaS for Openstack provider:
```bash ```bash
# With a `clouds.yaml` # With a `clouds.yaml`
OS_CLOUD=my_openstack \ 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 # or
@ -32,7 +37,7 @@ OS_REGION_NAME=RegionOne \
OS_PROJECT_ID=23d4522a987d4ab529f722a007c27846 OS_PROJECT_ID=23d4522a987d4ab529f722a007c27846
OS_USERNAME=myuser \ OS_USERNAME=myuser \
OS_PASSWORD=passw0rd \ 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 # or
@ -41,7 +46,7 @@ OS_REGION_NAME=RegionOne \
OS_AUTH_TYPE=v3applicationcredential \ OS_AUTH_TYPE=v3applicationcredential \
OS_APPLICATION_CREDENTIAL_ID=imn74uq0or7dyzz20dwo1ytls4me8dry \ OS_APPLICATION_CREDENTIAL_ID=imn74uq0or7dyzz20dwo1ytls4me8dry \
OS_APPLICATION_CREDENTIAL_SECRET=68FuSPSdQqkFQYH5X1OoriEIJOwyLtQ8QSqXZOc9XxFK1A9tzZT6He2PfPw0OMja \ 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 | | `OS_USER_ID` | User ID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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) | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

@ -3,13 +3,16 @@ title: "Digital Ocean"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: digitalocean slug: digitalocean
dnsprovider:
since: "v0.3.0"
code: "digitalocean"
url: "https://www.digitalocean.com/docs/networking/dns/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/digitalocean/digitalocean.toml --> <!-- providers/dns/digitalocean/digitalocean.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Digital Ocean](https://www.digitalocean.com/docs/networking/dns/). Configuration for [Digital Ocean](https://www.digitalocean.com/docs/networking/dns/).
@ -17,12 +20,14 @@ Configuration for [Digital Ocean](https://www.digitalocean.com/docs/networking/d
<!--more--> <!--more-->
- Code: `digitalocean` - Code: `digitalocean`
- Since: v0.3.0
Here is an example bash command using the Digital Ocean provider: Here is an example bash command using the Digital Ocean provider:
```bash ```bash
DO_AUTH_TOKEN=xxxxxx \ 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 | | `DO_AUTH_TOKEN` | Authentication token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "DNSimple"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dnsimple slug: dnsimple
dnsprovider:
since: "v0.3.0"
code: "dnsimple"
url: "https://dnsimple.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dnsimple/dnsimple.toml --> <!-- providers/dns/dnsimple/dnsimple.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [DNSimple](https://dnsimple.com/). Configuration for [DNSimple](https://dnsimple.com/).
@ -17,12 +20,14 @@ Configuration for [DNSimple](https://dnsimple.com/).
<!--more--> <!--more-->
- Code: `dnsimple` - Code: `dnsimple`
- Since: v0.3.0
Here is an example bash command using the DNSimple provider: Here is an example bash command using the DNSimple provider:
```bash ```bash
DNSIMPLE_OAUTH_TOKEN=1234567890abcdefghijklmnopqrstuvwxyz \ 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 | | `DNSIMPLE_OAUTH_TOKEN` | OAuth token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

@ -3,13 +3,16 @@ title: "DNS Made Easy"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dnsmadeeasy slug: dnsmadeeasy
dnsprovider:
since: "v0.4.0"
code: "dnsmadeeasy"
url: "https://dnsmadeeasy.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dnsmadeeasy/dnsmadeeasy.toml --> <!-- providers/dns/dnsmadeeasy/dnsmadeeasy.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [DNS Made Easy](https://dnsmadeeasy.com/). Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
@ -17,13 +20,15 @@ Configuration for [DNS Made Easy](https://dnsmadeeasy.com/).
<!--more--> <!--more-->
- Code: `dnsmadeeasy` - Code: `dnsmadeeasy`
- Since: v0.4.0
Here is an example bash command using the DNS Made Easy provider: Here is an example bash command using the DNS Made Easy provider:
```bash ```bash
DNSMADEEASY_API_KEY=xxxxxx \ DNSMADEEASY_API_KEY=xxxxxx \
DNSMADEEASY_API_SECRET=yyyyy \ 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 | | `DNSMADEEASY_API_SECRET` | The API Secret key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "DNSPod"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dnspod slug: dnspod
dnsprovider:
since: "v0.4.0"
code: "dnspod"
url: "https://www.dnspod.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dnspod/dnspod.toml --> <!-- providers/dns/dnspod/dnspod.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [DNSPod](https://www.dnspod.com/). Configuration for [DNSPod](https://www.dnspod.com/).
@ -17,12 +20,14 @@ Configuration for [DNSPod](https://www.dnspod.com/).
<!--more--> <!--more-->
- Code: `dnspod` - Code: `dnspod`
- Since: v0.4.0
Here is an example bash command using the DNSPod provider: Here is an example bash command using the DNSPod provider:
```bash ```bash
DNSPOD_API_KEY=xxxxxx \ 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 | | `DNSPOD_API_KEY` | The user token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Domain Offensive (do.de)"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dode slug: dode
dnsprovider:
since: "v2.4.0"
code: "dode"
url: "https://www.do.de/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dode/dode.toml --> <!-- providers/dns/dode/dode.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.4.0
Configuration for [Domain Offensive (do.de)](https://www.do.de/). Configuration for [Domain Offensive (do.de)](https://www.do.de/).
@ -17,12 +20,14 @@ Configuration for [Domain Offensive (do.de)](https://www.do.de/).
<!--more--> <!--more-->
- Code: `dode` - Code: `dode`
- Since: v2.4.0
Here is an example bash command using the Domain Offensive (do.de) provider: Here is an example bash command using the Domain Offensive (do.de) provider:
```bash ```bash
DODE_TOKEN=xxxxxx \ 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 | | `DODE_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Domeneshop"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: domeneshop slug: domeneshop
dnsprovider:
since: "v4.3.0"
code: "domeneshop"
url: "https://domene.shop"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/domeneshop/domeneshop.toml --> <!-- providers/dns/domeneshop/domeneshop.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.3.0
Configuration for [Domeneshop](https://domene.shop). Configuration for [Domeneshop](https://domene.shop).
@ -17,6 +20,8 @@ Configuration for [Domeneshop](https://domene.shop).
<!--more--> <!--more-->
- Code: `domeneshop` - Code: `domeneshop`
- Since: v4.3.0
Here is an example bash command using the Domeneshop provider: 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 | | `DOMENESHOP_API_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `DOMENESHOP_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | | `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. The environment variable names can be suffixed by `_FILE` 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 ### API credentials

View file

@ -3,13 +3,16 @@ title: "DreamHost"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dreamhost slug: dreamhost
dnsprovider:
since: "v1.1.0"
code: "dreamhost"
url: "https://www.dreamhost.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dreamhost/dreamhost.toml --> <!-- providers/dns/dreamhost/dreamhost.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [DreamHost](https://www.dreamhost.com). Configuration for [DreamHost](https://www.dreamhost.com).
@ -17,12 +20,14 @@ Configuration for [DreamHost](https://www.dreamhost.com).
<!--more--> <!--more-->
- Code: `dreamhost` - Code: `dreamhost`
- Since: v1.1.0
Here is an example bash command using the DreamHost provider: Here is an example bash command using the DreamHost provider:
```bash ```bash
DREAMHOST_API_KEY="YOURAPIKEY" \ 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 | | `DREAMHOST_API_KEY` | The API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Duck DNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: duckdns slug: duckdns
dnsprovider:
since: "v0.5.0"
code: "duckdns"
url: "https://www.duckdns.org/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/duckdns/duckdns.toml --> <!-- providers/dns/duckdns/duckdns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Duck DNS](https://www.duckdns.org/). Configuration for [Duck DNS](https://www.duckdns.org/).
@ -17,12 +20,14 @@ Configuration for [Duck DNS](https://www.duckdns.org/).
<!--more--> <!--more-->
- Code: `duckdns` - Code: `duckdns`
- Since: v0.5.0
Here is an example bash command using the Duck DNS provider: Here is an example bash command using the Duck DNS provider:
```bash ```bash
DUCKDNS_TOKEN=xxxxxx \ 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 | | `DUCKDNS_TOKEN` | Account token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Dyn"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dyn slug: dyn
dnsprovider:
since: "v0.3.0"
code: "dyn"
url: "https://dyn.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dyn/dyn.toml --> <!-- providers/dns/dyn/dyn.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Dyn](https://dyn.com/). Configuration for [Dyn](https://dyn.com/).
@ -17,6 +20,8 @@ Configuration for [Dyn](https://dyn.com/).
<!--more--> <!--more-->
- Code: `dyn` - Code: `dyn`
- Since: v0.3.0
Here is an example bash command using the Dyn provider: 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_CUSTOMER_NAME=xxxxxx \
DYN_USER_NAME=yyyyy \ DYN_USER_NAME=yyyyy \
DYN_PASSWORD=zzzz \ 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 | | `DYN_USER_NAME` | User name |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Dynu"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: dynu slug: dynu
dnsprovider:
since: "v3.5.0"
code: "dynu"
url: "https://www.dynu.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/dynu/dynu.toml --> <!-- providers/dns/dynu/dynu.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.5.0
Configuration for [Dynu](https://www.dynu.com/). Configuration for [Dynu](https://www.dynu.com/).
@ -17,12 +20,14 @@ Configuration for [Dynu](https://www.dynu.com/).
<!--more--> <!--more-->
- Code: `dynu` - Code: `dynu`
- Since: v3.5.0
Here is an example bash command using the Dynu provider: Here is an example bash command using the Dynu provider:
```bash ```bash
DYNU_API_KEY=1234567890abcdefghijklmnopqrstuvwxyz \ 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 | | `DYNU_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "EasyDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: easydns slug: easydns
dnsprovider:
since: "v2.6.0"
code: "easydns"
url: "https://easydns.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/easydns/easydns.toml --> <!-- providers/dns/easydns/easydns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.6.0
Configuration for [EasyDNS](https://easydns.com/). Configuration for [EasyDNS](https://easydns.com/).
@ -17,13 +20,15 @@ Configuration for [EasyDNS](https://easydns.com/).
<!--more--> <!--more-->
- Code: `easydns` - Code: `easydns`
- Since: v2.6.0
Here is an example bash command using the EasyDNS provider: Here is an example bash command using the EasyDNS provider:
```bash ```bash
EASYDNS_TOKEN=<your token> \ EASYDNS_TOKEN=<your token> \
EASYDNS_KEY=<your key> \ EASYDNS_KEY=<your key> \
lego --email myemail@example.com --dns easydns --domains my.example.org run lego --email you@example.com --dns easydns --domains my.example.org run
``` ```
@ -37,7 +42,7 @@ lego --email myemail@example.com --dns easydns --domains my.example.org run
| `EASYDNS_TOKEN` | API Token | | `EASYDNS_TOKEN` | API Token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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``` To test with the sandbox environment set ```EASYDNS_ENDPOINT=https://sandbox.rest.easydns.net```

View file

@ -3,14 +3,16 @@ title: "Akamai EdgeDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: edgedns slug: edgedns
dnsprovider:
since: "v3.9.0"
code: "edgedns"
url: "https://www.akamai.com/us/en/products/security/edge-dns.jsp"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/edgedns/edgedns.toml --> <!-- providers/dns/edgedns/edgedns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.9.0
Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the DNS-01 challenge using Akamai EdgeDNS
@ -18,6 +20,8 @@ Akamai edgedns supersedes FastDNS; implementing a DNS provider for solving the D
<!--more--> <!--more-->
- Code: `edgedns` - Code: `edgedns`
- Since: v3.9.0
Here is an example bash command using the Akamai EdgeDNS provider: 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_CLIENT_TOKEN=akab-mnbvcxzlkjhgfdsapoiuytrewq1234567 \
AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \ AKAMAI_HOST=akab-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.luna.akamaiapis.net \
AKAMAI_ACCESS_TOKEN=akab-1234567890qwerty-asdfghjklzxcvtnu \ 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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: Akamai credentials are automatically detected in the following locations and prioritized in the following order:

View file

@ -3,13 +3,16 @@ title: "Epik"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: epik slug: epik
dnsprovider:
since: "v4.5.0"
code: "epik"
url: "https://www.epik.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/epik/epik.toml --> <!-- providers/dns/epik/epik.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Epik](https://www.epik.com/). Configuration for [Epik](https://www.epik.com/).
@ -17,12 +20,14 @@ Configuration for [Epik](https://www.epik.com/).
<!--more--> <!--more-->
- Code: `epik` - Code: `epik`
- Since: v4.5.0
Here is an example bash command using the Epik provider: Here is an example bash command using the Epik provider:
```bash ```bash
EPIK_SIGNATURE=xxxxxxxxxxxxxxxxxxxxxxxxxx \ 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/) | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

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

View file

@ -3,13 +3,16 @@ title: "Exoscale"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: exoscale slug: exoscale
dnsprovider:
since: "v0.4.0"
code: "exoscale"
url: "https://www.exoscale.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/exoscale/exoscale.toml --> <!-- providers/dns/exoscale/exoscale.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Exoscale](https://www.exoscale.com/). Configuration for [Exoscale](https://www.exoscale.com/).
@ -17,13 +20,15 @@ Configuration for [Exoscale](https://www.exoscale.com/).
<!--more--> <!--more-->
- Code: `exoscale` - Code: `exoscale`
- Since: v0.4.0
Here is an example bash command using the Exoscale provider: Here is an example bash command using the Exoscale provider:
```bash ```bash
EXOSCALE_API_KEY=abcdefghijklmnopqrstuvwx \ EXOSCALE_API_KEY=abcdefghijklmnopqrstuvwx \
EXOSCALE_API_SECRET=xxxxxxx \ 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 | | `EXOSCALE_API_SECRET` | API secret |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "freemyip.com"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: freemyip slug: freemyip
dnsprovider:
since: "v4.5.0"
code: "freemyip"
url: "https://freemyip.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/freemyip/freemyip.toml --> <!-- providers/dns/freemyip/freemyip.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [freemyip.com](https://freemyip.com/). Configuration for [freemyip.com](https://freemyip.com/).
@ -17,12 +20,14 @@ Configuration for [freemyip.com](https://freemyip.com/).
<!--more--> <!--more-->
- Code: `freemyip` - Code: `freemyip`
- Since: v4.5.0
Here is an example bash command using the freemyip.com provider: Here is an example bash command using the freemyip.com provider:
```bash ```bash
FREEMYIP_TOKEN=xxxxxx \ 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 | | `FREEMYIP_TOKEN` | Account token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Gandi"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: gandi slug: gandi
dnsprovider:
since: "v0.3.0"
code: "gandi"
url: "https://www.gandi.net"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandi/gandi.toml --> <!-- providers/dns/gandi/gandi.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Gandi](https://www.gandi.net). Configuration for [Gandi](https://www.gandi.net).
@ -17,12 +20,14 @@ Configuration for [Gandi](https://www.gandi.net).
<!--more--> <!--more-->
- Code: `gandi` - Code: `gandi`
- Since: v0.3.0
Here is an example bash command using the Gandi provider: Here is an example bash command using the Gandi provider:
```bash ```bash
GANDI_API_KEY=abcdefghijklmnopqrstuvwx \ 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 | | `GANDI_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Gandi Live DNS (v5)"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: gandiv5 slug: gandiv5
dnsprovider:
since: "v0.5.0"
code: "gandiv5"
url: "https://www.gandi.net"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gandiv5/gandiv5.toml --> <!-- providers/dns/gandiv5/gandiv5.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Gandi Live DNS (v5)](https://www.gandi.net). Configuration for [Gandi Live DNS (v5)](https://www.gandi.net).
@ -17,12 +20,14 @@ Configuration for [Gandi Live DNS (v5)](https://www.gandi.net).
<!--more--> <!--more-->
- Code: `gandiv5` - Code: `gandiv5`
- Since: v0.5.0
Here is an example bash command using the Gandi Live DNS (v5) provider: Here is an example bash command using the Gandi Live DNS (v5) provider:
```bash ```bash
GANDIV5_API_KEY=abcdefghijklmnopqrstuvwx \ 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 | | `GANDIV5_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

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

View file

@ -3,13 +3,16 @@ title: "G-Core Labs"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: gcore slug: gcore
dnsprovider:
since: "v4.5.0"
code: "gcore"
url: "https://gcorelabs.com/dns/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/gcore/gcore.toml --> <!-- providers/dns/gcore/gcore.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [G-Core Labs](https://gcorelabs.com/dns/). Configuration for [G-Core Labs](https://gcorelabs.com/dns/).
@ -17,12 +20,14 @@ Configuration for [G-Core Labs](https://gcorelabs.com/dns/).
<!--more--> <!--more-->
- Code: `gcore` - Code: `gcore`
- Since: v4.5.0
Here is an example bash command using the G-Core Labs provider: Here is an example bash command using the G-Core Labs provider:
```bash ```bash
GCORE_PERMANENT_API_TOKEN=xxxxx \ 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/) | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Glesys"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: glesys slug: glesys
dnsprovider:
since: "v0.5.0"
code: "glesys"
url: "https://glesys.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/glesys/glesys.toml --> <!-- providers/dns/glesys/glesys.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Glesys](https://glesys.com/). Configuration for [Glesys](https://glesys.com/).
@ -17,13 +20,15 @@ Configuration for [Glesys](https://glesys.com/).
<!--more--> <!--more-->
- Code: `glesys` - Code: `glesys`
- Since: v0.5.0
Here is an example bash command using the Glesys provider: Here is an example bash command using the Glesys provider:
```bash ```bash
GLESYS_API_USER=xxxxx \ GLESYS_API_USER=xxxxx \
GLESYS_API_KEY=yyyyy \ 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 | | `GLESYS_API_USER` | API user |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Go Daddy"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: godaddy slug: godaddy
dnsprovider:
since: "v0.5.0"
code: "godaddy"
url: "https://godaddy.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/godaddy/godaddy.toml --> <!-- providers/dns/godaddy/godaddy.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Go Daddy](https://godaddy.com). Configuration for [Go Daddy](https://godaddy.com).
@ -17,13 +20,15 @@ Configuration for [Go Daddy](https://godaddy.com).
<!--more--> <!--more-->
- Code: `godaddy` - Code: `godaddy`
- Since: v0.5.0
Here is an example bash command using the Go Daddy provider: Here is an example bash command using the Go Daddy provider:
```bash ```bash
GODADDY_API_KEY=xxxxxxxx \ GODADDY_API_KEY=xxxxxxxx \
GODADDY_API_SECRET=yyyyyyyy \ 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 | | `GODADDY_API_SECRET` | API secret |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Hetzner"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: hetzner slug: hetzner
dnsprovider:
since: "v3.7.0"
code: "hetzner"
url: "https://hetzner.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hetzner/hetzner.toml --> <!-- providers/dns/hetzner/hetzner.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [Hetzner](https://hetzner.com). Configuration for [Hetzner](https://hetzner.com).
@ -17,12 +20,14 @@ Configuration for [Hetzner](https://hetzner.com).
<!--more--> <!--more-->
- Code: `hetzner` - Code: `hetzner`
- Since: v3.7.0
Here is an example bash command using the Hetzner provider: Here is an example bash command using the Hetzner provider:
```bash ```bash
HETZNER_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ 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 | | `HETZNER_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Hosting.de"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: hostingde slug: hostingde
dnsprovider:
since: "v1.1.0"
code: "hostingde"
url: "https://www.hosting.de/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hostingde/hostingde.toml --> <!-- providers/dns/hostingde/hostingde.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Hosting.de](https://www.hosting.de/). Configuration for [Hosting.de](https://www.hosting.de/).
@ -17,12 +20,14 @@ Configuration for [Hosting.de](https://www.hosting.de/).
<!--more--> <!--more-->
- Code: `hostingde` - Code: `hostingde`
- Since: v1.1.0
Here is an example bash command using the Hosting.de provider: Here is an example bash command using the Hosting.de provider:
```bash ```bash
HOSTINGDE_API_KEY=xxxxxxxx \ 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 | | `HOSTINGDE_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## Additional Configuration
@ -49,7 +54,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `HOSTINGDE_ZONE_NAME` | Zone name in ACE format | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Hosttech"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: hosttech slug: hosttech
dnsprovider:
since: "v4.5.0"
code: "hosttech"
url: "https://www.hosttech.eu/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hosttech/hosttech.toml --> <!-- providers/dns/hosttech/hosttech.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Hosttech](https://www.hosttech.eu/). Configuration for [Hosttech](https://www.hosttech.eu/).
@ -17,12 +20,14 @@ Configuration for [Hosttech](https://www.hosttech.eu/).
<!--more--> <!--more-->
- Code: `hosttech` - Code: `hosttech`
- Since: v4.5.0
Here is an example bash command using the Hosttech provider: Here is an example bash command using the Hosttech provider:
```bash ```bash
HOSTTECH_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx \ 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 | | `HOSTTECH_PASSWORD` | API password |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "HTTP request"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: httpreq slug: httpreq
dnsprovider:
since: "v2.0.0"
code: "httpreq"
url: "/lego/dns/httpreq/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/httpreq/httpreq.toml --> <!-- providers/dns/httpreq/httpreq.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.0.0
Configuration for [HTTP request](/lego/dns/httpreq/). Configuration for [HTTP request](/lego/dns/httpreq/).
@ -17,12 +20,14 @@ Configuration for [HTTP request](/lego/dns/httpreq/).
<!--more--> <!--more-->
- Code: `httpreq` - Code: `httpreq`
- Since: v2.0.0
Here is an example bash command using the HTTP request provider: Here is an example bash command using the HTTP request provider:
```bash ```bash
HTTPREQ_ENDPOINT=http://my.server.com:9090 \ 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 | | `HTTPREQ_MODE` | `RAW`, none |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## Additional Configuration
@ -50,7 +55,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `HTTPREQ_USERNAME` | Basic authentication username | | `HTTPREQ_USERNAME` | Basic authentication username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

@ -3,13 +3,16 @@ title: "Hurricane Electric DNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: hurricane slug: hurricane
dnsprovider:
since: "v4.3.0"
code: "hurricane"
url: "https://dns.he.net/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hurricane/hurricane.toml --> <!-- providers/dns/hurricane/hurricane.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.3.0
Configuration for [Hurricane Electric DNS](https://dns.he.net/). Configuration for [Hurricane Electric DNS](https://dns.he.net/).
@ -17,15 +20,17 @@ Configuration for [Hurricane Electric DNS](https://dns.he.net/).
<!--more--> <!--more-->
- Code: `hurricane` - Code: `hurricane`
- Since: v4.3.0
Here is an example bash command using the Hurricane Electric DNS provider: Here is an example bash command using the Hurricane Electric DNS provider:
```bash ```bash
HURRICANE_TOKENS=example.org:token \ 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 \ 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 | | `HURRICANE_TOKENS` | TXT record names and tokens |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "HyperOne"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: hyperone slug: hyperone
dnsprovider:
since: "v3.9.0"
code: "hyperone"
url: "https://www.hyperone.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/hyperone/hyperone.toml --> <!-- providers/dns/hyperone/hyperone.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.9.0
Configuration for [HyperOne](https://www.hyperone.com). Configuration for [HyperOne](https://www.hyperone.com).
@ -17,11 +20,13 @@ Configuration for [HyperOne](https://www.hyperone.com).
<!--more--> <!--more-->
- Code: `hyperone` - Code: `hyperone`
- Since: v3.9.0
Here is an example bash command using the HyperOne provider: Here is an example bash command using the HyperOne provider:
```bash ```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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

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

View file

@ -3,13 +3,16 @@ title: "Internet Initiative Japan"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: iij slug: iij
dnsprovider:
since: "v1.1.0"
code: "iij"
url: "https://www.iij.ad.jp/en/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/iij/iij.toml --> <!-- providers/dns/iij/iij.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Internet Initiative Japan](https://www.iij.ad.jp/en/). Configuration for [Internet Initiative Japan](https://www.iij.ad.jp/en/).
@ -17,6 +20,8 @@ Configuration for [Internet Initiative Japan](https://www.iij.ad.jp/en/).
<!--more--> <!--more-->
- Code: `iij` - Code: `iij`
- Since: v1.1.0
Here is an example bash command using the Internet Initiative Japan provider: 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_ACCESS_KEY=xxxxxxxx \
IIJ_API_SECRET_KEY=yyyyyy \ IIJ_API_SECRET_KEY=yyyyyy \
IIJ_DO_SERVICE_CODE=zzzzzz \ 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 | | `IIJ_DO_SERVICE_CODE` | DO service code |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "IIJ DNS Platform Service"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: iijdpf slug: iijdpf
dnsprovider:
since: "v4.7.0"
code: "iijdpf"
url: "https://www.iij.ad.jp/en/biz/dns-pfm/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/iijdpf/iijdpf.toml --> <!-- providers/dns/iijdpf/iijdpf.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.7.0
Configuration for [IIJ DNS Platform Service](https://www.iij.ad.jp/en/biz/dns-pfm/). Configuration for [IIJ DNS Platform Service](https://www.iij.ad.jp/en/biz/dns-pfm/).
@ -17,13 +20,15 @@ Configuration for [IIJ DNS Platform Service](https://www.iij.ad.jp/en/biz/dns-pf
<!--more--> <!--more-->
- Code: `iijdpf` - Code: `iijdpf`
- Since: v4.7.0
Here is an example bash command using the IIJ DNS Platform Service provider: Here is an example bash command using the IIJ DNS Platform Service provider:
```bash ```bash
IIJ_DPF_API_TOKEN=xxxxxxxx \ IIJ_DPF_API_TOKEN=xxxxxxxx \
IIJ_DPF_DPM_SERVICE_CODE=yyyyyy \ 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Infoblox"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: infoblox slug: infoblox
dnsprovider:
since: "v4.4.0"
code: "infoblox"
url: "https://www.infoblox.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/infoblox/infoblox.toml --> <!-- providers/dns/infoblox/infoblox.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Infoblox](https://www.infoblox.com/). Configuration for [Infoblox](https://www.infoblox.com/).
@ -17,6 +20,8 @@ Configuration for [Infoblox](https://www.infoblox.com/).
<!--more--> <!--more-->
- Code: `infoblox` - Code: `infoblox`
- Since: v4.4.0
Here is an example bash command using the Infoblox provider: 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_USER=api-user-529 \
INFOBLOX_PASSWORD=b9841238feb177a84330febba8a83208921177bffe733 \ INFOBLOX_PASSWORD=b9841238feb177a84330febba8a83208921177bffe733 \
INFOBLOX_HOST=infoblox.example.org 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 | | `INFOBLOX_USER` | Account Username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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. When creating an API's user ensure it has the proper permissions for the view you are working with.

View file

@ -3,13 +3,16 @@ title: "Infomaniak"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: infomaniak slug: infomaniak
dnsprovider:
since: "v4.1.0"
code: "infomaniak"
url: "https://www.infomaniak.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/infomaniak/infomaniak.toml --> <!-- providers/dns/infomaniak/infomaniak.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.1.0
Configuration for [Infomaniak](https://www.infomaniak.com/). Configuration for [Infomaniak](https://www.infomaniak.com/).
@ -17,12 +20,14 @@ Configuration for [Infomaniak](https://www.infomaniak.com/).
<!--more--> <!--more-->
- Code: `infomaniak` - Code: `infomaniak`
- Since: v4.1.0
Here is an example bash command using the Infomaniak provider: Here is an example bash command using the Infomaniak provider:
```bash ```bash
INFOMANIAK_ACCESS_TOKEN=1234567898765432 \ 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 | | `INFOMANIAK_ACCESS_TOKEN` | Access token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Access token

View file

@ -3,13 +3,16 @@ title: "Internet.bs"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: internetbs slug: internetbs
dnsprovider:
since: "v4.5.0"
code: "internetbs"
url: "https://internetbs.net"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/internetbs/internetbs.toml --> <!-- providers/dns/internetbs/internetbs.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Internet.bs](https://internetbs.net). Configuration for [Internet.bs](https://internetbs.net).
@ -17,13 +20,15 @@ Configuration for [Internet.bs](https://internetbs.net).
<!--more--> <!--more-->
- Code: `internetbs` - Code: `internetbs`
- Since: v4.5.0
Here is an example bash command using the Internet.bs provider: Here is an example bash command using the Internet.bs provider:
```bash ```bash
INTERNET_BS_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx \ INTERNET_BS_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx \
INTERNET_BS_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \ 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 | | `INTERNET_BS_PASSWORD` | API password |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "INWX"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: inwx slug: inwx
dnsprovider:
since: "v2.0.0"
code: "inwx"
url: "https://www.inwx.de/en"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/inwx/inwx.toml --> <!-- providers/dns/inwx/inwx.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.0.0
Configuration for [INWX](https://www.inwx.de/en). Configuration for [INWX](https://www.inwx.de/en).
@ -17,19 +20,21 @@ Configuration for [INWX](https://www.inwx.de/en).
<!--more--> <!--more-->
- Code: `inwx` - Code: `inwx`
- Since: v2.0.0
Here is an example bash command using the INWX provider: Here is an example bash command using the INWX provider:
```bash ```bash
INWX_USERNAME=xxxxxxxxxx \ INWX_USERNAME=xxxxxxxxxx \
INWX_PASSWORD=yyyyyyyyyy \ 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 # 2FA
INWX_USERNAME=xxxxxxxxxx \ INWX_USERNAME=xxxxxxxxxx \
INWX_PASSWORD=yyyyyyyyyy \ INWX_PASSWORD=yyyyyyyyyy \
INWX_SHARED_SECRET=zzzzzzzzzz \ 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 | | `INWX_USERNAME` | Username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

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

View file

@ -3,13 +3,16 @@ title: "iwantmyname"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: iwantmyname slug: iwantmyname
dnsprovider:
since: "v4.7.0"
code: "iwantmyname"
url: "https://iwantmyname.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/iwantmyname/iwantmyname.toml --> <!-- providers/dns/iwantmyname/iwantmyname.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.7.0
Configuration for [iwantmyname](https://iwantmyname.com). Configuration for [iwantmyname](https://iwantmyname.com).
@ -17,13 +20,15 @@ Configuration for [iwantmyname](https://iwantmyname.com).
<!--more--> <!--more-->
- Code: `iwantmyname` - Code: `iwantmyname`
- Since: v4.7.0
Here is an example bash command using the iwantmyname provider: Here is an example bash command using the iwantmyname provider:
```bash ```bash
IWANTMYNAME_USERNAME=xxxxxxxx \ IWANTMYNAME_USERNAME=xxxxxxxx \
IWANTMYNAME_PASSWORD=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 | | `IWANTMYNAME_USERNAME` | API username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Joker"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: joker slug: joker
dnsprovider:
since: "v2.6.0"
code: "joker"
url: "https://joker.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/joker/joker.toml --> <!-- providers/dns/joker/joker.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.6.0
Configuration for [Joker](https://joker.com). Configuration for [Joker](https://joker.com).
@ -17,6 +20,8 @@ Configuration for [Joker](https://joker.com).
<!--more--> <!--more-->
- Code: `joker` - Code: `joker`
- Since: v2.6.0
Here is an example bash command using the Joker provider: 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_API_MODE=SVC \
JOKER_USERNAME=<your email> \ JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \ JOKER_PASSWORD=<your password> \
lego --email myemail@example.com --dns joker --domains my.example.org run lego --email you@example.com --dns joker --domains my.example.org run
# DMAPI # DMAPI
JOKER_API_MODE=DMAPI \ JOKER_API_MODE=DMAPI \
JOKER_USERNAME=<your email> \ JOKER_USERNAME=<your email> \
JOKER_PASSWORD=<your password> \ JOKER_PASSWORD=<your password> \
lego --email myemail@example.com --dns joker --domains my.example.org run lego --email you@example.com --dns joker --domains my.example.org run
## or ## or
JOKER_API_MODE=DMAPI \ JOKER_API_MODE=DMAPI \
JOKER_API_KEY=<your API key> \ JOKER_API_KEY=<your API key> \
lego --email myemail@example.com --dns joker --domains my.example.org run lego --email you@example.com --dns joker --domains my.example.org run
``` ```
@ -51,7 +56,7 @@ lego --email myemail@example.com --dns joker --domains my.example.org run
| `JOKER_USERNAME` | Joker.com username | | `JOKER_USERNAME` | Joker.com username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## SVC mode

View file

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

View file

@ -3,13 +3,16 @@ title: "Linode (v4)"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: linode slug: linode
dnsprovider:
since: "v1.1.0"
code: "linode"
url: "https://www.linode.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/linode/linode.toml --> <!-- providers/dns/linode/linode.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Linode (v4)](https://www.linode.com/). Configuration for [Linode (v4)](https://www.linode.com/).
@ -17,12 +20,14 @@ Configuration for [Linode (v4)](https://www.linode.com/).
<!--more--> <!--more-->
- Code: `linode` - Code: `linode`
- Since: v1.1.0
Here is an example bash command using the Linode (v4) provider: Here is an example bash command using the Linode (v4) provider:
```bash ```bash
LINODE_TOKEN=xxxxx \ 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 | | `LINODE_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Liquid Web"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: liquidweb slug: liquidweb
dnsprovider:
since: "v3.1.0"
code: "liquidweb"
url: "https://liquidweb.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/liquidweb/liquidweb.toml --> <!-- providers/dns/liquidweb/liquidweb.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.1.0
Configuration for [Liquid Web](https://liquidweb.com). Configuration for [Liquid Web](https://liquidweb.com).
@ -17,6 +20,8 @@ Configuration for [Liquid Web](https://liquidweb.com).
<!--more--> <!--more-->
- Code: `liquidweb` - Code: `liquidweb`
- Since: v3.1.0
Here is an example bash command using the Liquid Web provider: 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_USERNAME=someuser \
LIQUID_WEB_PASSWORD=somepass \ LIQUID_WEB_PASSWORD=somepass \
LIQUID_ZONE=tacoman.com.net \ 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 | | `LIQUID_WEB_ZONE` | DNS Zone |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## Additional Configuration
@ -53,7 +58,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| `LIQUID_WEB_URL` | Storm API endpoint | | `LIQUID_WEB_URL` | Storm API endpoint |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Loopia"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: loopia slug: loopia
dnsprovider:
since: "v4.2.0"
code: "loopia"
url: "https://loopia.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/loopia/loopia.toml --> <!-- providers/dns/loopia/loopia.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.2.0
Configuration for [Loopia](https://loopia.com). Configuration for [Loopia](https://loopia.com).
@ -17,6 +20,8 @@ Configuration for [Loopia](https://loopia.com).
<!--more--> <!--more-->
- Code: `loopia` - Code: `loopia`
- Since: v4.2.0
Here is an example bash command using the Loopia provider: 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 | | `LOOPIA_API_USER` | API username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ### API user

View file

@ -3,13 +3,16 @@ title: "LuaDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: luadns slug: luadns
dnsprovider:
since: "v3.7.0"
code: "luadns"
url: "https://luadns.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/luadns/luadns.toml --> <!-- providers/dns/luadns/luadns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [LuaDNS](https://luadns.com). Configuration for [LuaDNS](https://luadns.com).
@ -17,13 +20,15 @@ Configuration for [LuaDNS](https://luadns.com).
<!--more--> <!--more-->
- Code: `luadns` - Code: `luadns`
- Since: v3.7.0
Here is an example bash command using the LuaDNS provider: Here is an example bash command using the LuaDNS provider:
```bash ```bash
LUADNS_API_USERNAME=youremail \ LUADNS_API_USERNAME=youremail \
LUADNS_API_TOKEN=xxxxxxxx \ 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) | | `LUADNS_API_USERNAME` | Username (your email) |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "MyDNS.jp"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: mydnsjp slug: mydnsjp
dnsprovider:
since: "v1.2.0"
code: "mydnsjp"
url: "https://www.mydns.jp"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/mydnsjp/mydnsjp.toml --> <!-- providers/dns/mydnsjp/mydnsjp.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.2.0
Configuration for [MyDNS.jp](https://www.mydns.jp). Configuration for [MyDNS.jp](https://www.mydns.jp).
@ -17,13 +20,15 @@ Configuration for [MyDNS.jp](https://www.mydns.jp).
<!--more--> <!--more-->
- Code: `mydnsjp` - Code: `mydnsjp`
- Since: v1.2.0
Here is an example bash command using the MyDNS.jp provider: Here is an example bash command using the MyDNS.jp provider:
```bash ```bash
MYDNSJP_MASTER_ID=xxxxx \ MYDNSJP_MASTER_ID=xxxxx \
MYDNSJP_PASSWORD=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 | | `MYDNSJP_PASSWORD` | Password |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "MythicBeasts"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: mythicbeasts slug: mythicbeasts
dnsprovider:
since: "v0.3.7"
code: "mythicbeasts"
url: "https://www.mythic-beasts.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/mythicbeasts/mythicbeasts.toml --> <!-- providers/dns/mythicbeasts/mythicbeasts.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.7
Configuration for [MythicBeasts](https://www.mythic-beasts.com/). Configuration for [MythicBeasts](https://www.mythic-beasts.com/).
@ -17,13 +20,15 @@ Configuration for [MythicBeasts](https://www.mythic-beasts.com/).
<!--more--> <!--more-->
- Code: `mythicbeasts` - Code: `mythicbeasts`
- Since: v0.3.7
Here is an example bash command using the MythicBeasts provider: Here is an example bash command using the MythicBeasts provider:
```bash ```bash
MYTHICBEASTS_USERNAME=myuser \ MYTHICBEASTS_USERNAME=myuser \
MYTHICBEASTS_PASSWORD=mypass \ 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 | | `MYTHICBEASTS_USERNAME` | User name |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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. 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.

View file

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

View file

@ -3,13 +3,16 @@ title: "Name.com"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: namedotcom slug: namedotcom
dnsprovider:
since: "v0.5.0"
code: "namedotcom"
url: "https://www.name.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namedotcom/namedotcom.toml --> <!-- providers/dns/namedotcom/namedotcom.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.5.0
Configuration for [Name.com](https://www.name.com). Configuration for [Name.com](https://www.name.com).
@ -17,13 +20,15 @@ Configuration for [Name.com](https://www.name.com).
<!--more--> <!--more-->
- Code: `namedotcom` - Code: `namedotcom`
- Since: v0.5.0
Here is an example bash command using the Name.com provider: Here is an example bash command using the Name.com provider:
```bash ```bash
NAMECOM_USERNAME=foo.bar \ NAMECOM_USERNAME=foo.bar \
NAMECOM_API_TOKEN=a379a6f6eeafb9a55e378c118034e2751e682fab \ 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 | | `NAMECOM_USERNAME` | Username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Namesilo"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: namesilo slug: namesilo
dnsprovider:
since: "v2.7.0"
code: "namesilo"
url: "https://www.namesilo.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/namesilo/namesilo.toml --> <!-- providers/dns/namesilo/namesilo.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.7.0
Configuration for [Namesilo](https://www.namesilo.com/). Configuration for [Namesilo](https://www.namesilo.com/).
@ -17,12 +20,14 @@ Configuration for [Namesilo](https://www.namesilo.com/).
<!--more--> <!--more-->
- Code: `namesilo` - Code: `namesilo`
- Since: v2.7.0
Here is an example bash command using the Namesilo provider: Here is an example bash command using the Namesilo provider:
```bash ```bash
NAMESILO_API_KEY=b9841238feb177a84330febba8a83208921177bffe733 \ 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 | | `NAMESILO_API_KEY` | Client ID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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] | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "NearlyFreeSpeech.NET"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: nearlyfreespeech slug: nearlyfreespeech
dnsprovider:
since: "v4.8.0"
code: "nearlyfreespeech"
url: "https://nearlyfreespeech.net/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/nearlyfreespeech/nearlyfreespeech.toml --> <!-- providers/dns/nearlyfreespeech/nearlyfreespeech.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.8.0
Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/). Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/).
@ -17,13 +20,15 @@ Configuration for [NearlyFreeSpeech.NET](https://nearlyfreespeech.net/).
<!--more--> <!--more-->
- Code: `nearlyfreespeech` - Code: `nearlyfreespeech`
- Since: v4.8.0
Here is an example bash command using the NearlyFreeSpeech.NET provider: Here is an example bash command using the NearlyFreeSpeech.NET provider:
```bash ```bash
NEARLYFREESPEECH_API_KEY=xxxxxx \ NEARLYFREESPEECH_API_KEY=xxxxxx \
NEARLYFREESPEECH_LOGIN=xxxx \ 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 | | `NEARLYFREESPEECH_LOGIN` | Username for API requests |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Netcup"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: netcup slug: netcup
dnsprovider:
since: "v1.1.0"
code: "netcup"
url: "https://www.netcup.eu/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/netcup/netcup.toml --> <!-- providers/dns/netcup/netcup.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Netcup](https://www.netcup.eu/). Configuration for [Netcup](https://www.netcup.eu/).
@ -17,6 +20,8 @@ Configuration for [Netcup](https://www.netcup.eu/).
<!--more--> <!--more-->
- Code: `netcup` - Code: `netcup`
- Since: v1.1.0
Here is an example bash command using the Netcup provider: 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_CUSTOMER_NUMBER=xxxx \
NETCUP_API_KEY=yyyy \ NETCUP_API_KEY=yyyy \
NETCUP_API_PASSWORD=zzzz \ 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 | | `NETCUP_CUSTOMER_NUMBER` | Customer number |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Netlify"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: netlify slug: netlify
dnsprovider:
since: "v3.7.0"
code: "netlify"
url: "https://www.netlify.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/netlify/netlify.toml --> <!-- providers/dns/netlify/netlify.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.7.0
Configuration for [Netlify](https://www.netlify.com). Configuration for [Netlify](https://www.netlify.com).
@ -17,12 +20,14 @@ Configuration for [Netlify](https://www.netlify.com).
<!--more--> <!--more-->
- Code: `netlify` - Code: `netlify`
- Since: v3.7.0
Here is an example bash command using the Netlify provider: Here is an example bash command using the Netlify provider:
```bash ```bash
NETLIFY_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \ 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 | | `NETLIFY_TOKEN` | Token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Nicmanager"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: nicmanager slug: nicmanager
dnsprovider:
since: "v4.5.0"
code: "nicmanager"
url: "https://www.nicmanager.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/nicmanager/nicmanager.toml --> <!-- providers/dns/nicmanager/nicmanager.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [Nicmanager](https://www.nicmanager.com/). Configuration for [Nicmanager](https://www.nicmanager.com/).
@ -17,19 +20,21 @@ Configuration for [Nicmanager](https://www.nicmanager.com/).
<!--more--> <!--more-->
- Code: `nicmanager` - Code: `nicmanager`
- Since: v4.5.0
Here is an example bash command using the Nicmanager provider: Here is an example bash command using the Nicmanager provider:
```bash ```bash
## Login using email ## Login using email
NICMANAGER_API_EMAIL = "foo@bar.baz" \ NICMANAGER_API_EMAIL = "you@example.com" \
NICMANAGER_API_PASSWORD = "password" \ NICMANAGER_API_PASSWORD = "password" \
# Optionally, if your account has TOTP enabled, set the secret here # Optionally, if your account has TOTP enabled, set the secret here
NICMANAGER_API_OTP = "long-secret" \ 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 ## Login using account name + username
@ -40,7 +45,7 @@ NICMANAGER_API_PASSWORD = "password" \
# Optionally, if your account has TOTP enabled, set the secret here # Optionally, if your account has TOTP enabled, set the secret here
NICMANAGER_API_OTP = "long-secret" \ 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

@ -3,13 +3,16 @@ title: "NIFCloud"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: nifcloud slug: nifcloud
dnsprovider:
since: "v1.1.0"
code: "nifcloud"
url: "https://www.nifcloud.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/nifcloud/nifcloud.toml --> <!-- providers/dns/nifcloud/nifcloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [NIFCloud](https://www.nifcloud.com/). Configuration for [NIFCloud](https://www.nifcloud.com/).
@ -17,13 +20,15 @@ Configuration for [NIFCloud](https://www.nifcloud.com/).
<!--more--> <!--more-->
- Code: `nifcloud` - Code: `nifcloud`
- Since: v1.1.0
Here is an example bash command using the NIFCloud provider: Here is an example bash command using the NIFCloud provider:
```bash ```bash
NIFCLOUD_ACCESS_KEY_ID=xxxx \ NIFCLOUD_ACCESS_KEY_ID=xxxx \
NIFCLOUD_SECRET_ACCESS_KEY=yyyy \ 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 | | `NIFCLOUD_SECRET_ACCESS_KEY` | Secret access key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Njalla"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: njalla slug: njalla
dnsprovider:
since: "v4.3.0"
code: "njalla"
url: "https://njal.la"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/njalla/njalla.toml --> <!-- providers/dns/njalla/njalla.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.3.0
Configuration for [Njalla](https://njal.la). Configuration for [Njalla](https://njal.la).
@ -17,12 +20,14 @@ Configuration for [Njalla](https://njal.la).
<!--more--> <!--more-->
- Code: `njalla` - Code: `njalla`
- Since: v4.3.0
Here is an example bash command using the Njalla provider: Here is an example bash command using the Njalla provider:
```bash ```bash
NJALLA_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx \ 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 | | `NJALLA_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "NS1"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: ns1 slug: ns1
dnsprovider:
since: "v0.4.0"
code: "ns1"
url: "https://ns1.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/ns1/ns1.toml --> <!-- providers/dns/ns1/ns1.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [NS1](https://ns1.com). Configuration for [NS1](https://ns1.com).
@ -17,12 +20,14 @@ Configuration for [NS1](https://ns1.com).
<!--more--> <!--more-->
- Code: `ns1` - Code: `ns1`
- Since: v0.4.0
Here is an example bash command using the NS1 provider: Here is an example bash command using the NS1 provider:
```bash ```bash
NS1_API_KEY=xxxx \ 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 | | `NS1_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Oracle Cloud"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: oraclecloud slug: oraclecloud
dnsprovider:
since: "v2.3.0"
code: "oraclecloud"
url: "https://cloud.oracle.com/home"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/oraclecloud/oraclecloud.toml --> <!-- providers/dns/oraclecloud/oraclecloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.3.0
Configuration for [Oracle Cloud](https://cloud.oracle.com/home). Configuration for [Oracle Cloud](https://cloud.oracle.com/home).
@ -17,6 +20,8 @@ Configuration for [Oracle Cloud](https://cloud.oracle.com/home).
<!--more--> <!--more-->
- Code: `oraclecloud` - Code: `oraclecloud`
- Since: v2.3.0
Here is an example bash command using the Oracle Cloud provider: 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_PUBKEY_FINGERPRINT="00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00" \
OCI_REGION="us-phoenix-1" \ OCI_REGION="us-phoenix-1" \
OCI_COMPARTMENT_OCID="ocid1.tenancy.oc1..secret" \ 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 | | `OCI_USER_OCID` | User OCID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

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

View file

@ -3,13 +3,16 @@ title: "OVH"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: ovh slug: ovh
dnsprovider:
since: "v0.4.0"
code: "ovh"
url: "https://www.ovh.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/ovh/ovh.toml --> <!-- providers/dns/ovh/ovh.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [OVH](https://www.ovh.com/). Configuration for [OVH](https://www.ovh.com/).
@ -17,6 +20,8 @@ Configuration for [OVH](https://www.ovh.com/).
<!--more--> <!--more-->
- Code: `ovh` - Code: `ovh`
- Since: v0.4.0
Here is an example bash command using the OVH provider: Here is an example bash command using the OVH provider:
@ -25,7 +30,7 @@ OVH_APPLICATION_KEY=1234567898765432 \
OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \ OVH_APPLICATION_SECRET=b9841238feb177a84330febba8a832089 \
OVH_CONSUMER_KEY=256vfsd347245sdfg \ OVH_CONSUMER_KEY=256vfsd347245sdfg \
OVH_ENDPOINT=ovh-eu \ 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) | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Application Key and Secret

View file

@ -3,13 +3,16 @@ title: "PowerDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: pdns slug: pdns
dnsprovider:
since: "v0.4.0"
code: "pdns"
url: "https://www.powerdns.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/pdns/pdns.toml --> <!-- providers/dns/pdns/pdns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [PowerDNS](https://www.powerdns.com/). Configuration for [PowerDNS](https://www.powerdns.com/).
@ -17,13 +20,15 @@ Configuration for [PowerDNS](https://www.powerdns.com/).
<!--more--> <!--more-->
- Code: `pdns` - Code: `pdns`
- Since: v0.4.0
Here is an example bash command using the PowerDNS provider: Here is an example bash command using the PowerDNS provider:
```bash ```bash
PDNS_API_URL=http://pdns-server:80/ \ PDNS_API_URL=http://pdns-server:80/ \
PDNS_API_KEY=xxxx \ 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 | | `PDNS_API_URL` | API URL |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Information

View file

@ -3,13 +3,16 @@ title: "Porkbun"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: porkbun slug: porkbun
dnsprovider:
since: "v4.4.0"
code: "porkbun"
url: "https://porkbun.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/porkbun/porkbun.toml --> <!-- providers/dns/porkbun/porkbun.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Porkbun](https://porkbun.com/). Configuration for [Porkbun](https://porkbun.com/).
@ -17,13 +20,15 @@ Configuration for [Porkbun](https://porkbun.com/).
<!--more--> <!--more-->
- Code: `porkbun` - Code: `porkbun`
- Since: v4.4.0
Here is an example bash command using the Porkbun provider: Here is an example bash command using the Porkbun provider:
```bash ```bash
PORKBUN_SECRET_API_KEY=xxxxxx \ PORKBUN_SECRET_API_KEY=xxxxxx \
PORKBUN_API_KEY=yyyyyy \ 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 | | `PORKBUN_SECRET_API_KEY` | secret API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Rackspace"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: rackspace slug: rackspace
dnsprovider:
since: "v0.4.0"
code: "rackspace"
url: "https://www.rackspace.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rackspace/rackspace.toml --> <!-- providers/dns/rackspace/rackspace.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.4.0
Configuration for [Rackspace](https://www.rackspace.com/). Configuration for [Rackspace](https://www.rackspace.com/).
@ -17,13 +20,15 @@ Configuration for [Rackspace](https://www.rackspace.com/).
<!--more--> <!--more-->
- Code: `rackspace` - Code: `rackspace`
- Since: v0.4.0
Here is an example bash command using the Rackspace provider: Here is an example bash command using the Rackspace provider:
```bash ```bash
RACKSPACE_USER=xxxx \ RACKSPACE_USER=xxxx \
RACKSPACE_API_KEY=yyyy \ 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 | | `RACKSPACE_USER` | API user |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "reg.ru"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: regru slug: regru
dnsprovider:
since: "v3.5.0"
code: "regru"
url: "https://www.reg.ru/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/regru/regru.toml --> <!-- providers/dns/regru/regru.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.5.0
Configuration for [reg.ru](https://www.reg.ru/). Configuration for [reg.ru](https://www.reg.ru/).
@ -17,13 +20,15 @@ Configuration for [reg.ru](https://www.reg.ru/).
<!--more--> <!--more-->
- Code: `regru` - Code: `regru`
- Since: v3.5.0
Here is an example bash command using the reg.ru provider: Here is an example bash command using the reg.ru provider:
```bash ```bash
REGRU_USERNAME=xxxxxx \ REGRU_USERNAME=xxxxxx \
REGRU_PASSWORD=yyyyyy \ 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 | | `REGRU_USERNAME` | API username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "RFC2136"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: rfc2136 slug: rfc2136
dnsprovider:
since: "v0.3.0"
code: "rfc2136"
url: "https://www.rfc-editor.org/rfc/rfc2136.html"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rfc2136/rfc2136.toml --> <!-- providers/dns/rfc2136/rfc2136.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [RFC2136](https://www.rfc-editor.org/rfc/rfc2136.html). Configuration for [RFC2136](https://www.rfc-editor.org/rfc/rfc2136.html).
@ -17,6 +20,8 @@ Configuration for [RFC2136](https://www.rfc-editor.org/rfc/rfc2136.html).
<!--more--> <!--more-->
- Code: `rfc2136` - Code: `rfc2136`
- Since: v0.3.0
Here is an example bash command using the RFC2136 provider: 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_KEY=lego \
RFC2136_TSIG_ALGORITHM=hmac-sha256. \ RFC2136_TSIG_ALGORITHM=hmac-sha256. \
RFC2136_TSIG_SECRET=YWJjZGVmZGdoaWprbG1ub3BxcnN0dXZ3eHl6MTIzNDU= \ 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_KEY="$keyname" \
RFC2136_TSIG_ALGORITHM="$( awk -F'[ ";]' '/algorithm/ { print $2 }' $keyfile )." \ RFC2136_TSIG_ALGORITHM="$( awk -F'[ ";]' '/algorithm/ { print $2 }' $keyfile )." \
RFC2136_TSIG_SECRET="$( awk -F'[ ";]' '/secret/ { print $3 }' $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. | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "RimuHosting"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: rimuhosting slug: rimuhosting
dnsprovider:
since: "v0.3.5"
code: "rimuhosting"
url: "https://rimuhosting.com"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/rimuhosting/rimuhosting.toml --> <!-- providers/dns/rimuhosting/rimuhosting.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.5
Configuration for [RimuHosting](https://rimuhosting.com). Configuration for [RimuHosting](https://rimuhosting.com).
@ -17,12 +20,14 @@ Configuration for [RimuHosting](https://rimuhosting.com).
<!--more--> <!--more-->
- Code: `rimuhosting` - Code: `rimuhosting`
- Since: v0.3.5
Here is an example bash command using the RimuHosting provider: Here is an example bash command using the RimuHosting provider:
```bash ```bash
RIMUHOSTING_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \ 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 | | `RIMUHOSTING_API_KEY` | User API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Amazon Route 53"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: route53 slug: route53
dnsprovider:
since: "v0.3.0"
code: "route53"
url: "https://aws.amazon.com/route53/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/route53/route53.toml --> <!-- providers/dns/route53/route53.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v0.3.0
Configuration for [Amazon Route 53](https://aws.amazon.com/route53/). Configuration for [Amazon Route 53](https://aws.amazon.com/route53/).
@ -17,6 +20,8 @@ Configuration for [Amazon Route 53](https://aws.amazon.com/route53/).
<!--more--> <!--more-->
- Code: `route53` - Code: `route53`
- Since: v0.3.0
{{% notice note %}} {{% notice note %}}
_Please contribute by adding a CLI example._ _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) | | `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. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## Description

View file

@ -3,13 +3,16 @@ title: "UKFast SafeDNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: safedns slug: safedns
dnsprovider:
since: "v4.6.0"
code: "safedns"
url: "https://www.ukfast.co.uk/dns-hosting.html"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/safedns/safedns.toml --> <!-- providers/dns/safedns/safedns.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.6.0
Configuration for [UKFast SafeDNS](https://www.ukfast.co.uk/dns-hosting.html). Configuration for [UKFast SafeDNS](https://www.ukfast.co.uk/dns-hosting.html).
@ -17,12 +20,14 @@ Configuration for [UKFast SafeDNS](https://www.ukfast.co.uk/dns-hosting.html).
<!--more--> <!--more-->
- Code: `safedns` - Code: `safedns`
- Since: v4.6.0
Here is an example bash command using the UKFast SafeDNS provider: Here is an example bash command using the UKFast SafeDNS provider:
```bash ```bash
SAFEDNS_AUTH_TOKEN=xxxxxx \ 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 | | `SAFEDNS_AUTH_TOKEN` | Authentication token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Sakura Cloud"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: sakuracloud slug: sakuracloud
dnsprovider:
since: "v1.1.0"
code: "sakuracloud"
url: "https://cloud.sakura.ad.jp/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/sakuracloud/sakuracloud.toml --> <!-- providers/dns/sakuracloud/sakuracloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Sakura Cloud](https://cloud.sakura.ad.jp/). Configuration for [Sakura Cloud](https://cloud.sakura.ad.jp/).
@ -17,13 +20,15 @@ Configuration for [Sakura Cloud](https://cloud.sakura.ad.jp/).
<!--more--> <!--more-->
- Code: `sakuracloud` - Code: `sakuracloud`
- Since: v1.1.0
Here is an example bash command using the Sakura Cloud provider: Here is an example bash command using the Sakura Cloud provider:
```bash ```bash
SAKURACLOUD_ACCESS_TOKEN=xxxxx \ SAKURACLOUD_ACCESS_TOKEN=xxxxx \
SAKURACLOUD_ACCESS_TOKEN_SECRET=yyyyy \ 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 | | `SAKURACLOUD_ACCESS_TOKEN_SECRET` | Access token secret |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Scaleway"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: scaleway slug: scaleway
dnsprovider:
since: "v3.4.0"
code: "scaleway"
url: "https://developers.scaleway.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/scaleway/scaleway.toml --> <!-- providers/dns/scaleway/scaleway.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.4.0
Configuration for [Scaleway](https://developers.scaleway.com/). Configuration for [Scaleway](https://developers.scaleway.com/).
@ -17,12 +20,14 @@ Configuration for [Scaleway](https://developers.scaleway.com/).
<!--more--> <!--more-->
- Code: `scaleway` - Code: `scaleway`
- Since: v3.4.0
Here is an example bash command using the Scaleway provider: Here is an example bash command using the Scaleway provider:
```bash ```bash
SCALEWAY_API_TOKEN=xxxxxxx-xxxxx-xxxx-xxx-xxxxxx \ 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) | | `SCALEWAY_PROJECT_ID` | Project to use (optional) |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Selectel"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: selectel slug: selectel
dnsprovider:
since: "v1.2.0"
code: "selectel"
url: "https://kb.selectel.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/selectel/selectel.toml --> <!-- providers/dns/selectel/selectel.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.2.0
Configuration for [Selectel](https://kb.selectel.com/). Configuration for [Selectel](https://kb.selectel.com/).
@ -17,12 +20,14 @@ Configuration for [Selectel](https://kb.selectel.com/).
<!--more--> <!--more-->
- Code: `selectel` - Code: `selectel`
- Since: v1.2.0
Here is an example bash command using the Selectel provider: Here is an example bash command using the Selectel provider:
```bash ```bash
SELECTEL_API_TOKEN=xxxxx \ 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 | | `SELECTEL_API_TOKEN` | API token |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Servercow"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: servercow slug: servercow
dnsprovider:
since: "v3.4.0"
code: "servercow"
url: "https://servercow.de/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/servercow/servercow.toml --> <!-- providers/dns/servercow/servercow.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v3.4.0
Configuration for [Servercow](https://servercow.de/). Configuration for [Servercow](https://servercow.de/).
@ -17,13 +20,15 @@ Configuration for [Servercow](https://servercow.de/).
<!--more--> <!--more-->
- Code: `servercow` - Code: `servercow`
- Since: v3.4.0
Here is an example bash command using the Servercow provider: Here is an example bash command using the Servercow provider:
```bash ```bash
SERVERCOW_USERNAME=xxxxxxxx \ SERVERCOW_USERNAME=xxxxxxxx \
SERVERCOW_PASSWORD=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 | | `SERVERCOW_USERNAME` | API username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Simply.com"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: simply slug: simply
dnsprovider:
since: "v4.4.0"
code: "simply"
url: "https://www.simply.com/en/domains/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/simply/simply.toml --> <!-- providers/dns/simply/simply.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Simply.com](https://www.simply.com/en/domains/). Configuration for [Simply.com](https://www.simply.com/en/domains/).
@ -17,13 +20,15 @@ Configuration for [Simply.com](https://www.simply.com/en/domains/).
<!--more--> <!--more-->
- Code: `simply` - Code: `simply`
- Since: v4.4.0
Here is an example bash command using the Simply.com provider: Here is an example bash command using the Simply.com provider:
```bash ```bash
SIMPLY_ACCOUNT_NAME=xxxxxx \ SIMPLY_ACCOUNT_NAME=xxxxxx \
SIMPLY_API_KEY=yyyyyy \ 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 | | `SIMPLY_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -1,65 +0,0 @@
---
title: "SoftLayer (IBM Cloud)"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: softlayer
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/softlayer/softlayer.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.5.0
Configuration for [SoftLayer (IBM Cloud)](https://www.ibm.com/cloud/).
<!--more-->
- Code: `softlayer`
Here is an example bash command using the SoftLayer (IBM Cloud) provider:
```bash
SOFTLAYER_USERNAME=xxxxx \
SOFTLAYER_API_KEY=yyyyy \
lego --email myemail@example.com --dns softlayer --domains my.example.org run
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `SOFTLAYER_API_KEY` | Classic Infrastructure API key |
| `SOFTLAYER_USERNAME` | User name (IBM Cloud is <accountID>_<emailAddress>) |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `SOFTLAYER_POLLING_INTERVAL` | Time between DNS propagation check |
| `SOFTLAYER_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `SOFTLAYER_TIMEOUT` | API request timeout |
| `SOFTLAYER_TTL` | The TTL of the TXT record used for the DNS challenge |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials).
## More information
- [API documentation](https://cloud.ibm.com/docs/dns?topic=dns-getting-started-with-the-dns-api)
- [Go client](https://github.com/softlayer/softlayer-go)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/softlayer/softlayer.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

View file

@ -3,13 +3,16 @@ title: "Sonic"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: sonic slug: sonic
dnsprovider:
since: "v4.4.0"
code: "sonic"
url: "https://www.sonic.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/sonic/sonic.toml --> <!-- providers/dns/sonic/sonic.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.4.0
Configuration for [Sonic](https://www.sonic.com/). Configuration for [Sonic](https://www.sonic.com/).
@ -17,13 +20,15 @@ Configuration for [Sonic](https://www.sonic.com/).
<!--more--> <!--more-->
- Code: `sonic` - Code: `sonic`
- Since: v4.4.0
Here is an example bash command using the Sonic provider: Here is an example bash command using the Sonic provider:
```bash ```bash
SONIC_USER_ID=12345 \ SONIC_USER_ID=12345 \
SONIC_API_KEY=4d6fbf2f9ab0fa11697470918d37625851fc0c51 \ 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 | | `SONIC_USER_ID` | User ID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` 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 ## API keys

View file

@ -3,13 +3,16 @@ title: "Stackpath"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: stackpath slug: stackpath
dnsprovider:
since: "v1.1.0"
code: "stackpath"
url: "https://www.stackpath.com/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/stackpath/stackpath.toml --> <!-- providers/dns/stackpath/stackpath.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v1.1.0
Configuration for [Stackpath](https://www.stackpath.com/). Configuration for [Stackpath](https://www.stackpath.com/).
@ -17,6 +20,8 @@ Configuration for [Stackpath](https://www.stackpath.com/).
<!--more--> <!--more-->
- Code: `stackpath` - Code: `stackpath`
- Since: v1.1.0
Here is an example bash command using the Stackpath provider: 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_ID=xxxxx \
STACKPATH_CLIENT_SECRET=yyyyy \ STACKPATH_CLIENT_SECRET=yyyyy \
STACKPATH_STACK_ID=zzzzz \ 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 | | `STACKPATH_STACK_ID` | Stack ID |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "Tencent Cloud DNS"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: tencentcloud slug: tencentcloud
dnsprovider:
since: "v4.6.0"
code: "tencentcloud"
url: "https://cloud.tencent.com/product/cns"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/tencentcloud/tencentcloud.toml --> <!-- providers/dns/tencentcloud/tencentcloud.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v4.6.0
Configuration for [Tencent Cloud DNS](https://cloud.tencent.com/product/cns). Configuration for [Tencent Cloud DNS](https://cloud.tencent.com/product/cns).
@ -17,13 +20,15 @@ Configuration for [Tencent Cloud DNS](https://cloud.tencent.com/product/cns).
<!--more--> <!--more-->
- Code: `tencentcloud` - Code: `tencentcloud`
- Since: v4.6.0
Here is an example bash command using the Tencent Cloud DNS provider: Here is an example bash command using the Tencent Cloud DNS provider:
```bash ```bash
TENCENTCLOUD_SECRET_ID=abcdefghijklmnopqrstuvwx \ TENCENTCLOUD_SECRET_ID=abcdefghijklmnopqrstuvwx \
TENCENTCLOUD_SECRET_KEY=your-secret-key \ 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 | | `TENCENTCLOUD_SECRET_KEY` | Access Key secret |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

View file

@ -3,13 +3,16 @@ title: "TransIP"
date: 2019-03-03T16:39:46+01:00 date: 2019-03-03T16:39:46+01:00
draft: false draft: false
slug: transip slug: transip
dnsprovider:
since: "v2.0.0"
code: "transip"
url: "https://www.transip.nl/"
--- ---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/transip/transip.toml --> <!-- providers/dns/transip/transip.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Since: v2.0.0
Configuration for [TransIP](https://www.transip.nl/). Configuration for [TransIP](https://www.transip.nl/).
@ -17,13 +20,15 @@ Configuration for [TransIP](https://www.transip.nl/).
<!--more--> <!--more-->
- Code: `transip` - Code: `transip`
- Since: v2.0.0
Here is an example bash command using the TransIP provider: Here is an example bash command using the TransIP provider:
```bash ```bash
TRANSIP_ACCOUNT_NAME = "Account name" \ TRANSIP_ACCOUNT_NAME = "Account name" \
TRANSIP_PRIVATE_KEY_PATH = "transip.key" \ 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 | | `TRANSIP_PRIVATE_KEY_PATH` | Private key path |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. The environment variable names can be suffixed by `_FILE` 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 ## 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 | | `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. The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here](/lego/dns/#configuration-and-credentials). More information [here]({{< ref "dns#configuration-and-credentials" >}}).

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