From 132666a2a0db6400e9c178815027a0fd9a1adcee Mon Sep 17 00:00:00 2001 From: Duck42 Date: Thu, 14 Jul 2022 23:01:56 -0500 Subject: [PATCH] Added acmedns validation plugin for certbot --- Dockerfile | 1 + Dockerfile.aarch64 | 1 + Dockerfile.armhf | 1 + readme-vars.yml | 3 ++- root/defaults/dns-conf/acmedns-registration.json | 9 +++++++++ root/defaults/dns-conf/acmedns.ini | 5 +++++ root/etc/cont-init.d/50-certbot | 2 +- 7 files changed, 20 insertions(+), 2 deletions(-) create mode 100644 root/defaults/dns-conf/acmedns-registration.json create mode 100644 root/defaults/dns-conf/acmedns.ini diff --git a/Dockerfile b/Dockerfile index b74dd2f..ae0bedc 100755 --- a/Dockerfile +++ b/Dockerfile @@ -102,6 +102,7 @@ RUN \ pip wheel && \ pip install -U --find-links https://wheel-index.linuxserver.io/alpine-3.15/ \ ${CERTBOT} \ + certbot-dns-acmedns \ certbot-dns-aliyun \ certbot-dns-azure \ certbot-dns-cloudflare \ diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64 index 69254e7..0099bd8 100755 --- a/Dockerfile.aarch64 +++ b/Dockerfile.aarch64 @@ -102,6 +102,7 @@ RUN \ pip wheel && \ pip install -U --find-links https://wheel-index.linuxserver.io/alpine-3.15/ \ ${CERTBOT} \ + certbot-dns-acmedns \ certbot-dns-aliyun \ certbot-dns-azure \ certbot-dns-cloudflare \ diff --git a/Dockerfile.armhf b/Dockerfile.armhf index 503f525..ba78601 100755 --- a/Dockerfile.armhf +++ b/Dockerfile.armhf @@ -102,6 +102,7 @@ RUN \ pip wheel && \ pip install -U --find-links https://wheel-index.linuxserver.io/alpine-3.15/ \ ${CERTBOT} \ + certbot-dns-acmedns \ certbot-dns-aliyun \ certbot-dns-azure \ certbot-dns-cloudflare \ diff --git a/readme-vars.yml b/readme-vars.yml index ee47a80..979b968 100755 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -51,7 +51,7 @@ opt_param_usage_include_env: true opt_param_env_vars: - { env_var: "SUBDOMAINS", env_value: "www,", desc: "Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` (wildcard cert is available via `dns` and `duckdns` validation only)" } - { env_var: "CERTPROVIDER", env_value: "", desc: "Optionally define the cert provider. Set to `zerossl` for ZeroSSL certs (requires existing [ZeroSSL account](https://app.zerossl.com/signup) and the e-mail address entered in `EMAIL` env var). Otherwise defaults to Let's Encrypt." } - - { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `aliyun`, `azure`, `cloudflare`, `cloudxns`, `cpanel`, `desec`, `digitalocean`, `directadmin`, `dnsimple`, `dnsmadeeasy`, `dnspod`, `domeneshop`, `dynu`, `gandi`, `gehirn`, `google`, `he`, `hetzner`, `infomaniak`, `inwx`, `ionos`, `linode`, `loopia`, `luadns`, `netcup`, `njalla`, `nsone`, `ovh`, `rfc2136`, `route53`, `sakuracloud`, `standalone`, `transip` and `vultr`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`." } + - { env_var: "DNSPLUGIN", env_value: "cloudflare", desc: "Required if `VALIDATION` is set to `dns`. Options are `acmedns`,`aliyun`, `azure`, `cloudflare`, `cloudxns`, `cpanel`, `desec`, `digitalocean`, `directadmin`, `dnsimple`, `dnsmadeeasy`, `dnspod`, `domeneshop`, `dynu`, `gandi`, `gehirn`, `google`, `he`, `hetzner`, `infomaniak`, `inwx`, `ionos`, `linode`, `loopia`, `luadns`, `netcup`, `njalla`, `nsone`, `ovh`, `rfc2136`, `route53`, `sakuracloud`, `standalone`, `transip` and `vultr`. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under `/config/dns-conf`." } - { env_var: "PROPAGATION", env_value: "", desc: "Optionally override (in seconds) the default propagation time for the dns plugins." } - { env_var: "DUCKDNSTOKEN", env_value: "", desc: "Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org" } - { env_var: "EMAIL", env_value: "", desc: "Optional e-mail address used for cert expiration notifications (Required for ZeroSSL)." } @@ -155,6 +155,7 @@ app_setup_nginx_reverse_proxy_block: "" # changelog changelogs: + - { date: "22.09.22:", desc: "Added certbot-dns-acmedns for DNS01 validation." } - { date: "20.08.22:", desc: "[Existing users should update:](https://github.com/linuxserver/docker-swag/blob/master/README.md#updating-configs) nginx.conf - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))." } - { date: "10.08.22:", desc: "Added support for Dynu DNS validation." } - { date: "18.05.22:", desc: "Added support for Azure DNS validation." } diff --git a/root/defaults/dns-conf/acmedns-registration.json b/root/defaults/dns-conf/acmedns-registration.json new file mode 100644 index 0000000..997955d --- /dev/null +++ b/root/defaults/dns-conf/acmedns-registration.json @@ -0,0 +1,9 @@ +{ + "yourdomain.com": { + "username":"yourusername", + "password":"yourpassword", + "fulldomain":".acme.yourdomain.com", + "subdomain":"", + "allowfrom":[] + } + } diff --git a/root/defaults/dns-conf/acmedns.ini b/root/defaults/dns-conf/acmedns.ini new file mode 100644 index 0000000..4523ffd --- /dev/null +++ b/root/defaults/dns-conf/acmedns.ini @@ -0,0 +1,5 @@ +# See https://pypi.org/project/certbot-dns-acmedns/ +# https://github.com/joohoi/acme-dns +# +dns_acmedns_api_url = http://your-acme-dns-server.example.com/ +dns_acmedns_registration_file = /config/dns-conf/acmedns-registration.json diff --git a/root/etc/cont-init.d/50-certbot b/root/etc/cont-init.d/50-certbot index fe64a78..89a480e 100644 --- a/root/etc/cont-init.d/50-certbot +++ b/root/etc/cont-init.d/50-certbot @@ -28,7 +28,7 @@ cp -n /defaults/dns-conf/* /config/dns-conf/ chown -R abc:abc /config/dns-conf # check to make sure DNSPLUGIN is selected if dns validation is used -if [[ "$VALIDATION" = "dns" ]] && [[ ! "$DNSPLUGIN" =~ ^(aliyun|azure|cloudflare|cloudxns|cpanel|desec|digitalocean|directadmin|dnsimple|dnsmadeeasy|dnspod|domeneshop|dynu|gandi|gehirn|google|he|hetzner|infomaniak|inwx|ionos|linode|loopia|luadns|netcup|njalla|nsone|ovh|rfc2136|route53|sakuracloud|standalone|transip|vultr)$ ]]; then +if [[ "$VALIDATION" = "dns" ]] && [[ ! "$DNSPLUGIN" =~ ^(acmedns|aliyun|azure|cloudflare|cloudxns|cpanel|desec|digitalocean|directadmin|dnsimple|dnsmadeeasy|dnspod|domeneshop|dynu|gandi|gehirn|google|he|hetzner|infomaniak|inwx|ionos|linode|loopia|luadns|netcup|njalla|nsone|ovh|rfc2136|route53|sakuracloud|standalone|transip|vultr)$ ]]; then echo "Please set the DNSPLUGIN variable to a valid plugin name. See docker info for more details." sleep infinity fi