Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for Loopia DNS challenge #3821

Merged
merged 5 commits into from
Nov 25, 2024
+54 −2
Merged

Add support for Loopia DNS challenge #3821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4a0411b
Add support for Loopia DNS challenge
agnon Nov 10, 2024
44c6034
Bump letsencrypt to 5.3.0 instead of 5.2.4
agnon Nov 10, 2024
9e68ed8
Update DOCS.md for Loopia DNS challenge
agnon Nov 10, 2024
7b8202b
Update DOCS.md for Loopia DNS challenge
agnon Nov 10, 2024
5d925e3
Use patch version to add new DNS support
agners Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions letsencrypt/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 5.2.4

Comment on lines +3 to +4
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider bumping minor version instead of patch.

Adding support for a new DNS provider is a feature addition rather than a bug fix. Based on semantic versioning principles and the pattern seen in previous DNS provider additions (e.g., IONOS DNS in 5.2.2), this should be version 5.3.0 instead of 5.2.4.

-## 5.2.4
+## 5.3.0
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 5.2.4
## 5.3.0

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This add-on used patch version to add new DNS providers, so let's stay consistent and continue with that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@agners Understood, we'll maintain consistency with the existing versioning scheme.

- Add Loopia DNS support

## 5.2.3

- Fix syntax error in run script
Expand Down
31 changes: 31 additions & 0 deletions letsencrypt/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ dns-infomaniak
dns-ionos
dns-joker
dns-linode
dns-loopia
dns-luadns
dns-njalla
dns-noris
Expand Down Expand Up @@ -118,6 +119,8 @@ joker_password: ''
joker_domain: ''
linode_key: ''
linode_version: ''
loopia_username: ''
loopia_password: ''
luadns_email: ''
luadns_token: ''
njalla_token: ''
Expand Down Expand Up @@ -567,6 +570,33 @@ To use this addon with Linode DNS, first [create a new API/access key](https://w

</details>

<details>
<summary>Loopia</summary>

To use this addon with Loopia DNS, first [create a new API user](https://customerzone.loopia.com/api/), with the following minimum required permissions:

- `addZoneRecord` - Required to create DNS records
- `getZoneRecords` - Required to verify DNS records
- `removeZoneRecord` - Required to clean up DNS records
- `removeSubdomain` - Required for complete cleanup

Example configuration in YAML edit mode:

```yaml
email: [email protected]
domains:
- ha.yourdomain.com
certfile: fullchain.pem
keyfile: privkey.pem
challenge: dns
dns:
provider: dns-loopia
loopia_username: example@loopiaapi
loopia_password: supersecretpasswordhere
```

</details>

<details>
<summary>DirectAdmin</summary>

Expand Down Expand Up @@ -1075,6 +1105,7 @@ dns-hetzner
dns-infomaniak
dns-ionos
dns-linode
dns-loopia
dns-luadns
dns-njalla
dns-noris
Expand Down
2 changes: 2 additions & 0 deletions letsencrypt/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ ARG \
CERTBOT_DNS_INWX_VERSION \
CERTBOT_DNS_IONOS_VERSION \
CERTBOT_DNS_JOKER_VERSION \
CERTBOT_DNS_LOOPIA_VERSION \
CERTBOT_DNS_NAMECHEAP_VERSION \
CERTBOT_DNS_NORISNETWORK_VERSION \
CERTBOT_DNS_SIMPLY_VERSION \
Expand Down Expand Up @@ -70,6 +71,7 @@ RUN \
certbot-dns-ionos==${CERTBOT_DNS_IONOS_VERSION} \
certbot-dns-joker==${CERTBOT_DNS_JOKER_VERSION} \
certbot-dns-linode==${CERTBOT_VERSION} \
certbot-dns-loopia==${CERTBOT_DNS_LOOPIA_VERSION} \
certbot-dns-luadns==${CERTBOT_VERSION} \
certbot-dns-njalla==${CERTBOT_NJALLA_VERSION} \
certbot-dns-norisnetwork==${CERTBOT_DNS_NORISNETWORK_VERSION} \
Expand Down
1 change: 1 addition & 0 deletions letsencrypt/build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ args:
CERTBOT_DNS_INWX_VERSION: 2.2.0
CERTBOT_DNS_IONOS_VERSION: 2024.1.8
CERTBOT_DNS_JOKER_VERSION: 1.1.0
CERTBOT_DNS_LOOPIA_VERSION: 1.0.1
CERTBOT_DNS_NAMECHEAP_VERSION: 1.0.0
CERTBOT_DNS_NORISNETWORK_VERSION: 0.2.1
CERTBOT_DNS_TRANSIP_VERSION: 0.5.2
Expand Down
6 changes: 4 additions & 2 deletions letsencrypt/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
version: 5.2.3
version: 5.2.4
slug: letsencrypt
name: Let's Encrypt
description: Manage certificate from Let's Encrypt
Expand Down Expand Up @@ -75,6 +75,8 @@ schema:
ionos_endpoint: str?
linode_key: str?
linode_version: str?
loopia_username: str?
loopia_password: str?
luadns_email: email?
luadns_token: str?
joker_username: str?
Expand Down Expand Up @@ -103,7 +105,7 @@ schema:
provider: "list(dns-azure|dns-cloudflare|dns-cloudns|dns-desec|\
dns-digitalocean|dns-directadmin|dns-dnsimple|dns-dnsmadeeasy|\
dns-duckdns|dns-dynu|dns-gehirn|dns-godaddy|dns-google|\
dns-hetzner|dns-infomaniak|dns-ionos|dns-joker|dns-linode|dns-luadns|dns-njalla|dns-nsone|\
dns-hetzner|dns-infomaniak|dns-ionos|dns-joker|dns-linode|dns-loopia|dns-luadns|dns-njalla|dns-nsone|\
dns-porkbun|dns-ovh|dns-rfc2136|dns-route53|dns-sakuracloud|\
dns-namecheap|dns-netcup|dns-simply|dns-gandi|dns-transip|dns-inwx|dns-dreamhost|\
dns-he|dns-easydns|dns-domainoffensive|dns-websupport|dns-noris|dns-plesk)?"
Expand Down
2 changes: 2 additions & 0 deletions letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ echo -e "dns_desec_token = $(bashio::config 'dns.desec_token')\n" \
"dns_plesk_api_url = $(bashio::config 'dns.plesk_api_url')\n" \
"dns_linode_key = $(bashio::config 'dns.linode_key')\n" \
"dns_linode_version = $(bashio::config 'dns.linode_version')\n" \
"dns_loopia_username = $(bashio::config 'dns.loopia_username')\n" \
"dns_loopia_password = $(bashio::config 'dns.loopia_password')\n" \
"dns_luadns_email = $(bashio::config 'dns.luadns_email')\n" \
"dns_luadns_token = $(bashio::config 'dns.luadns_token')\n" \
"dns_namecheap_username = $(bashio::config 'dns.namecheap_username')\n" \
Expand Down
10 changes: 10 additions & 0 deletions letsencrypt/rootfs/etc/services.d/lets-encrypt/run
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,16 @@ elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-joker" ]; then
bashio::config.require 'dns.joker_password'
PROVIDER_ARGUMENTS+=("--authenticator" "${DNS_PROVIDER}" "--${DNS_PROVIDER}-credentials" "/data/dnsapikey" "--${DNS_PROVIDER}-propagation-seconds" "${PROPAGATION_SECONDS}")

# Loopia
elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-loopia" ]; then
bashio::config.require 'dns.loopia_username'
bashio::config.require 'dns.loopia_password'
if (( PROPAGATION_SECONDS < 900 )); then
bashio::log.info "Increasing DNS propagation limit for Loopia to at least 900 seconds due to caching issues."
PROPAGATION_SECONDS=900
fi
PROVIDER_ARGUMENTS+=("--authenticator" "${DNS_PROVIDER}" "--${DNS_PROVIDER}-credentials" "/data/dnsapikey" "--${DNS_PROVIDER}-propagation-seconds" "${PROPAGATION_SECONDS}")

# Plesk
elif [ "${CHALLENGE}" == "dns" ] && [ "${DNS_PROVIDER}" == "dns-plesk" ]; then
bashio::config.require 'dns.plesk_username'
Expand Down