Skip to content

Commit

Permalink
NAS-133594 / 25.04 / feat: Digitalocean ACME (#3452)
Browse files Browse the repository at this point in the history
* NAS-133594 / 25.04 / feat: Digitalocean ACME

Related: truenas/middleware#15315
Signed-off-by: Thomas Bettler <[email protected]>

* Update AddACMESCALE.md

* Update SettingUpLetsEncryptCertificates.md

* Update AddDNSAuthenticatorDigitalocean.png

* Update AddDNSAuthenticatorShell.png

* Update words-to-ignore.txt

---------

Signed-off-by: Thomas Bettler <[email protected]>
Co-authored-by: DjP-iX <[email protected]>
  • Loading branch information
t0b3 and DjP-iX authored Jan 22, 2025
1 parent d5d9f42 commit a95401a
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ Click **Add** on the **ACME DNS-Authenticator** widget to open the **Add DNS Aut
{{< trueimage src="/images/SCALE/Credentials/AddDNSAuthenticatorCloudflare.png" alt="Add DNS Authenticator" id="Add DNS Authenticator" >}}

Enter a name, and select the authenticator you want to configure.
Options are **[cloudflare](https://www.cloudflare.com)**, Amazon **[route53](https://aws.amazon.com/route53/)**, [**OVH**](https://www.ovhcloud.com/en/domains/), and **shell**.
Supported authenticator options are [Cloudflare](https://www.cloudflare.com), [DigitalOcean](https://www.digitalocean.com/), [Amazon Route 53](https://aws.amazon.com/route53/), [OVHcloud](https://www.ovhcloud.com/en/domains/), and **shell**.
**Authenticator** selection changes the configuration fields.

If you select **cloudflare** as the authenticator, you must enter your Cloudflare account email address, API key, and API token.

If you select **digitalocean** as the authenticator, you must enter your DigitalOcean Token.

If you select **route53** as the authenticator, you must enter your Route53 Access key ID and secret access key.

If you select **OVH** as the authenticator, you must enter your OVH application key, application secret, consumer key, and endpoint.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TrueNAS allows users to automatically generate custom domain certificates using
## Requirements

* An email address for your TrueNAS admin user.
* A custom domain that uses Cloudflare, AWS Route 53, or OVH.
* A custom domain that uses Cloudflare, DigitalOcean, Amazon Route 53, or OVHcloud.
* A DNS server that does not cache for your TrueNAS system.

## Create an ACME DNS-Authenticator
Expand All @@ -29,6 +29,8 @@ Enter the required fields depending on your provider, then click **Save**.
For Cloudflare, enter either your **Cloudflare Email** and **API Key**, or enter an **API Token**.
If you create an [API Token](https://dash.cloudflare.com/profile/api-tokens), make sure to give the token the permission **Zone.DNS:Edit**, as it's [required by certbot](https://certbot-dns-cloudflare.readthedocs.io/en/stable/).

For DigitalOcean, enter your **Digitalocean Token**.

For Route53, enter your **Access Key ID** and **Secret Access Key**. The associated IAM user must have permission to perform the Route53 actions `ListHostedZones`, `ChangeResourceRecordSets`, and `GetChange`.

For OVH, enter your **OVH Application Key**, **OVH Application Secret**, **OVH Consumer Key**, and **OVH Endpoint**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,18 @@ Fields change based on **Authenticator** selection.
| **API Token** | Enter the API token. |
{{< /truetable >}}

### DigitalOcean

**digitalocean** activates the **Digitalocean Token** field.

{{< trueimage src="/images/SCALE/Credentials/AddDNSAuthenticatorDigitalocean.png" alt="Add DNS Authenticator - DigitalOcean" id="Add DNS Authenticator - DigitalOcean" >}}

{{< truetable >}}
| Setting | Description |
|-----------|-------------|
| **Digitalocean Token** | Enter the DigitalOcean Token. |
{{< /truetable >}}

### Route 53

**route53** activates the **Access Key Id** and **Secret Access Key** fields.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/SCALE/Credentials/AddDNSAuthenticatorShell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions words-to-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2157,3 +2157,4 @@ TrueNASStencilsPreview
MiniFamilyFront
SOV
MiniNetworkPortID
InstallWizardResourceConfig

0 comments on commit a95401a

Please sign in to comment.