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: src/content/docs/dns/reference/domain-connect.mdx
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,7 @@ title: Domain Connect
4
4
sidebar:
5
5
order: 5
6
6
head: []
7
-
description: Learn how to onboard your templates to use Domain Connect with
8
-
Cloudflare as DNS provider.
7
+
description: Learn how to onboard your templates to use Domain Connect with Cloudflare as DNS provider.
9
8
10
9
---
11
10
@@ -32,7 +31,10 @@ Domain Connect templates are published and maintained on a GitHub repository.
32
31
33
32
1. Create a fork of the [templates repository](https://github.com/Domain-Connect/Templates).
34
33
2. Add your template. You can create a copy of one of the existing templates and edit it according to your needs.
35
-
* Refer to the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#52-template-definition) for details on the different available fields.
34
+
* Refer to the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc) for details on the different available fields.
35
+
:::note
36
+
Not all properties and fields are supported by Cloudflare, and some will be mandatory for onboarding your template. Refer to the [supported properties](#supported-properties) section below for details.
37
+
:::
36
38
* If present, you must set the `syncBlock` field on your template to `false`. This means the template flow will be synchronous, which is the only option supported by Cloudflare.
37
39
* You must also provide a synchronous public key domain (`syncPubKeyDomain`[^1]). When your template is in use, synchronous calls will be digitally signed.
38
40
3. Make sure you follow the naming format defined by Domain Connect: `<providerId>.<serviceId>.json`.
@@ -64,6 +66,16 @@ Send an email to `[email protected]`, including the following inform
64
66
65
67
If you have a [DNS provider discovery](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#dns-provider-discovery) automation in place and will not list new DNS providers manually, Cloudflare can initially restrict your template to be exposed to the specified account only. Once you confirm everything is working as expected, Cloudflare will publish your template on the discovery endpoint, to be picked up by your automation.
66
68
69
+
## Supported properties
70
+
71
+
In the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc) you will find the following properties:
72
+
73
+
- Properties that you can use with your [apply template URL](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#apply-template).
74
+
- Properties for [defining the template itself](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#template-definition).
75
+
- Properties for defining the individual [DNS records](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#template-record).
76
+
77
+
While most of these are supported by Cloudflare, some are required and others are not supported. Below is what you need to know when creating your Domain Connect templates to use with Cloudflare.
78
+
67
79
## Template updates
68
80
69
81
Since September, 2024, template updates are picked up by an automation.
@@ -89,4 +101,4 @@ Send an email to `[email protected]` with the following information:
89
101
90
102
2. A [HAR file](/support/troubleshooting/general-troubleshooting/gathering-information-for-troubleshooting-sites/#generate-a-har-file) attachment containing the problematic update.
91
103
92
-
[^1]: A domain that can be queried for `TXT` records containing a public key to verify your digital signature.
104
+
[^1]: A domain that can be queried for `TXT` records containing a public key to verify your digital signature.
0 commit comments