You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dns/providers/certifydns.md
+24-23Lines changed: 24 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,36 +5,35 @@ title: Certify DNS
5
5
6
6
# Certify DNS
7
7
8
-
Certify DNS is used to answer DNS challenges when your domains normal DNS provider isn't supported for automation.
8
+
*Certify DNS* is an optional service used to answer DNS challenges when your domains normal DNS provider isn't supported for automation. It can be used with any *acme-dns* compatible ACME client.
9
9
10
-
The service is a cloud hosted version of the [acme-dns](https://github.com/joohoi/acme-dns) standard and uses CNAME delegation of acme challenge TXT records to a dedicated challenge response service.
10
+
- The service is a cloud hosted version of the [acme-dns](https://github.com/joohoi/acme-dns) protocol and uses CNAME delegation of acme challenge TXT records to a dedicated challenge response service.
11
+
- The service requires a separately purchased *Certify DNS* license, available through the https://certifytheweb.com License Keys tab (when signed in). It is not included in other product licenses from us you may already have, e.g. other products like *Certify Certificate Manager***do not** include a license for *Certify DNS*.
12
+
-*Certify DNS* is not required in order to use the Certify Certificate Manager app, it's only required if you specifically want to use DNS challenges and can't use standard DNS automation.
13
+
- The service is compatible with most other existing _acme-dns_ clients so it can be used with other ACME clients on all operating systems.
11
14
12
-
This service can be purchased through the https://certifytheweb.com License Keys tab when signed in, it is not currently available as a bundled product with other product license types.
15
+
**With *Certify DNS*, you create a special CNAME record in your domain DNS, instead of a TXT record. This CNAME record points to the Certify DNS cloud service and handles ACME challenge responses for your domain.**
13
16
14
-
Certify DNS is not required in order to use the Certify Certificate Manager app, it's only required if you specifically want to use DNS challenges and can't use DNS automation. The service is compatible with most existing _acme-dns_ clients so it can be used with other ACME clients on all operating systems.
17
+
## Using *Certify DNS*in Certify Certificate Manager
15
18
16
-
**With Certify DNS, you create a special CNAME record in your domain DNS, instead of a TXT record. This CNAME record points to the Certify DNS cloud service and handles ACME challenge responses for your domain.**
17
-
18
-
## Using Certify DNS in Certify The Web
19
-
20
-
- Purchase a *Certify DNS* license key under your https://certifytheweb.com profile (License Keys > Add a License Key).
21
-
- In the app, Select Certify DNS as the DNS update method under Authorization.
22
-
- Create your Certify DNS credentials using your account email address (as `API Username`) and license key (as `API Key`). You only need to do this once.
23
-
- Click `Request Certificate` to perform a one-time registration with the Certify DNS service (per domain).
24
-
- You will be prompted to create a CNAME pointing to the TXT record hosted by the Certify DNS service. If you miss this prompt check back in the log file for your managed certificate (see the Status tab).
19
+
- Purchase a *Certify DNS* license key under your https://certifytheweb.com profile (License Keys > Add a License Key, choose *Certify DNS*).
20
+
- In the app, Select *Certify DNS* as the DNS update method under Authorization.
21
+
- Create your *Certify DNS* credentials using your account email address (as `API Username`) and license key (as `API Key`). You only need to do this once.
22
+
- Click `Request Certificate` to perform a one-time registration with the *Certify DNS* service (per domain). If you receive an error such as `Failed to register with Certify DNS` you have probably not used the correct *Certify DNS* license key credentials.
23
+
- You will be prompted to create a CNAME pointing to the TXT record hosted by the *Certify DNS* service. If you miss this prompt check back in the log file for your managed certificate (see the Status tab).
25
24
- Once you have created your CNAME record, delete any existing \_acme-challenge TXT record in the same zone to avoid confusion.
26
-
- Resume the request using `Request Certificate`, the Certify DNS service will automatically provide the required TXT record responses on your behalf.
25
+
- Resume the request using `Request Certificate`, the *Certify DNS* service will automatically provide the required TXT record responses on your behalf.
27
26
- Automatic renewals will then perform this process again without manual intervention.
28
27
29
-
## Using Certify DNS with other acme-dns compatible clients
28
+
## Using *Certify DNS* with other acme-dns compatible clients
30
29
31
-
- Once activated on your https://certifytheweb.com account as special URL will be shown under the License Keys tab. This passes your license key info as basic credentials to the Certify DNS service.
30
+
- Once activated on your https://certifytheweb.com account as special URL will be shown under the License Keys tab. This passes your license key info as basic credentials to the *Certify DNS* service.
32
31
- Follow the normal instructions for your acme-dns client, using the provided URL as the base URL for the acme-dns service.
33
32
34
33
### Example: Certbot with acme-dns-auth.py (linux)
35
34
36
35
- Install Certbot and download acme-dns-auth.py (https://github.com/joohoi/acme-dns-certbot-joohoi)
37
-
- Update acme-dns-auth.py to set `ACMEDNS_URL = "https://<your key credentials>@certify-dns.certifytheweb.com"`. Your url with credentials if found on your certifytheweb.com License Keys tab when Certify DNS is enabled.
36
+
- Update acme-dns-auth.py to set `ACMEDNS_URL = "https://<your key credentials>@certify-dns.certifytheweb.com"`. Your url with credentials if found on your certifytheweb.com License Keys tab when *Certify DNS* is enabled.
- On first run you will be prompted to create a specific CNAME in your domains DNS after registration completes.
@@ -43,13 +42,15 @@ Certify DNS is not required in order to use the Certify Certificate Manager app,
43
42
44
43
If the error in the app is `NXDOMAIN for _acme-challenge...` , the Certificate Authority has been unable to find or follow the CNAME you have configured in your DNS. You should review your DNS records to ensure you have created the required CNAME record.
45
44
46
-
Cloudflare users: If you have Universal SSL configured for your domain in Cloudflare, this will result in *hidden* TXT records being created for your domain and subdomain (called _acme-challenge.yourdomain.com). This will directly conflict with the CNAME record you need to create for Certify DNS to work. You should either disable Universal SSL in Cloudflare or contact Cloudflare for other solutions.
45
+
Cloudflare users: If you have Universal SSL configured for your domain in Cloudflare, this will result in *hidden* TXT records being created for your domain and subdomain (called _acme-challenge.yourdomain.com). This will directly conflict with the CNAME record you need to create for *Certify DNS* to work. You should either disable Universal SSL in Cloudflare or contact Cloudflare for other solutions.
46
+
47
+
A common source of confusion is the difference between your *Certify DNS* license key and your *Certify Certificate Manager* license key. Each one is unique and specific to the product type.
47
48
48
49
## Sharing CNAME registrations across multiple machines
49
-
If you need to have multiple machines fetch certificates for the same domain (such as a wildcard cert) you will find that your CNAME record needs to be the same Certify DNS pointer, which in turn means you need to share the Certify DNS registration config across each machine. To do this, copy the respective config file from C:\ProgramData\certify\certifydns\ (or acme-dns on managed certificates configured using older versions) on one machine all of to the other machines (into C:\ProgramData\certify\certifydns\). Thereafter their renewals will all use the same Certify DNS registration for that domain.
50
+
If you need to have multiple machines fetch certificates for the same domain (such as a wildcard cert) you will find that your CNAME record needs to be the same *Certify DNS* pointer, which in turn means you need to share the Certify DNS registration config across each machine. To do this, copy the respective config file from C:\ProgramData\certify\certifydns\ (or acme-dns on managed certificates configured using older versions) on one machine all of to the other machines (into C:\ProgramData\certify\certifydns\). Thereafter their renewals will all use the same *Certify DNS* registration for that domain.
50
51
51
-
## Migrating from acme-dns to Certify DNS or vice-versa
52
-
To switch from acme-dns to Certify DNS, first delete the respective domain config from C:\ProgramData\certify\acmedns and switch the DNS provider to Certify DNS. Perform a normal renewal - the first renewal will prompt for a CNAME record to be updated pointing to the service. You can also check the log for this managed certificate and find the new CNAME value you need to populate. Thereafter you can then renew normally.
52
+
## Migrating from acme-dns to *Certify DNS* or vice-versa
53
+
To switch from acme-dns to *Certify DNS*, first delete the respective domain config from C:\ProgramData\certify\acmedns and switch the DNS provider to *Certify DNS*. Perform a normal renewal - the first renewal will prompt for a CNAME record to be updated pointing to the service. You can also check the log for this managed certificate and find the new CNAME value you need to populate. Thereafter you can then renew normally.
53
54
54
55
## Securing Issuance
55
56
Delegating DNS validation to an external service theoretically allows the service to complete validation for certificates on your domain. To guard against issuance by a different account some CAs implement the CAA extensions for RFC8657 https://datatracker.ietf.org/doc/html/rfc8657
@@ -64,7 +65,7 @@ This feature requires support from your chosen CA. Your CA account URI is availa
64
65
65
66
## Advantages and Disadvantages
66
67
67
-
There are a number of factors to consider before delegating validation to a service like Certify DNS (or any acme-dns style service).
68
+
There are a number of factors to consider before delegating validation to a service like *Certify DNS* (or any acme-dns style service).
68
69
69
70
Advantages:
70
71
@@ -77,7 +78,7 @@ Disadvantages:
77
78
78
79
## Pricing
79
80
80
-
Certify DNS is a commercial service and the following pricing options are available.
81
+
*Certify DNS* is a commercial service and the following pricing options are available.
0 commit comments