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
[DNS] More details for use with Domain Connect (cloudflare#23752)
* Create dedicated section for properties and link to it from #setup
* Mention linter tool once again and add section for Apply template URL
* Add section for template porperties
* Add placeholder section for DNS records and disclaimer paragraph
* Fill specifics around DNS record fields and adjust heading
Copy file name to clipboardExpand all lines: src/content/docs/dns/reference/domain-connect.mdx
+54-5Lines changed: 54 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +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.
9
-
7
+
description: Learn how to onboard your templates to use Domain Connect with Cloudflare as DNS provider.
10
8
---
11
9
12
10
If you are a service provider, consider this page for information on how Cloudflare supports [Domain Connect](https://www.domainconnect.org/) and how you can onboard your template.
@@ -32,7 +30,10 @@ Domain Connect templates are published and maintained on a GitHub repository.
32
30
33
31
1. Create a fork of the [templates repository](https://github.com/Domain-Connect/Templates).
34
32
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.
33
+
* 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.
34
+
:::note
35
+
Not all fields (properties) are supported by Cloudflare, and some will be mandatory for onboarding your template. Refer to the [properties support](#properties-support) section below for details.
36
+
:::
36
37
* 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
38
* You must also provide a synchronous public key domain (`syncPubKeyDomain`[^1]). When your template is in use, synchronous calls will be digitally signed.
38
39
3. Make sure you follow the naming format defined by Domain Connect: `<providerId>.<serviceId>.json`.
@@ -64,6 +65,54 @@ Send an email to `[email protected]`, including the following inform
64
65
65
66
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
67
68
+
## Properties support
69
+
70
+
In the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc) you will find the following properties:
71
+
72
+
- 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).
73
+
- Properties for [defining the template itself](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#template-definition).
74
+
- Properties for defining the individual [DNS records](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#template-record).
75
+
76
+
While most of these are supported by Cloudflare, some are required and others are not supported.
77
+
78
+
:::note[Linter tool]
79
+
Use Domain Connect's [linter tool](https://github.com/Domain-Connect/dc-template-linter) with the option `-cloudflare` enabled to check your template against Cloudflare specific rules.
80
+
:::
81
+
82
+
### Apply template URL
83
+
84
+
For the full list, refer to the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc). Below are the details specific to Cloudflare.
85
+
86
+
-**Redirect URI**: Domain Connect's documentation states that it must be scoped to the `syncRedirectDomain` from the template, or the request must be signed. Cloudflare requires the request to be signed and, as such, does not check if the `redirect_uri` is scoped to the `syncRedirectDomain`.
87
+
-**State**: Is not supported and will be ignored.
88
+
-**Service Name**: Is not supported and will be ignored.
89
+
-**Signature**: Required. It also must be the last query parameter.
90
+
-**Key**: Required. You must publish your public key and place it in a DNS TXT record on a domain specified in the template as `syncPubKeyDomain`. To allow for key rotation, the hostname of the TXT record must be appended as another variable on the query string of the form.
91
+
92
+
### Template definition
93
+
94
+
For the full list, refer to the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc). Below are the details specific to Cloudflare.
95
+
96
+
-**Service Provider Name**: Will be displayed on the user interface.
97
+
-**Service Name**: Will **not** be displayed on the user interface.
98
+
-**Logo**: If present, will be displayed on the user interface.
99
+
-**Synchronous Block**: Is not supported and will be ignored. Cloudflare only supports the synchronous flow.
100
+
-**Shared**: Is not supported and will be ignored.
101
+
-**Shared Service Name**: Is not supported and will be ignored.
102
+
-**Synchronous Public Key Domain**: Required. Cloudflare only supports the synchronous flow and always checks for signature.
103
+
-**Synchronous Redirect Domains**: Is not supported and will be ignored. Cloudflare looks at the `redirect_uri` provided in the signed apply template URL.
104
+
-**Multiple Instance**: Is not supported and will be ignored.
105
+
-**Warn Phishing**: Is not supported and will be ignored.
106
+
-**Host Required**: Is not supported and will be ignored.
107
+
108
+
### DNS records
109
+
110
+
For the full list, refer to the [Domain Connect Specification](https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc). Below are the details specific to Cloudflare.
111
+
112
+
-**Essential**: Is not supported and will be ignored.
113
+
-**TXT Conflict Matching Mode**: Is not supported and will be ignored.
114
+
-**TXT Conflict Matching Prefix**: Is not supported and will be ignored.
115
+
67
116
## Template updates
68
117
69
118
Since September, 2024, template updates are picked up by an automation.
@@ -89,4 +138,4 @@ Send an email to `[email protected]` with the following information:
89
138
90
139
2. A [HAR file](/support/troubleshooting/general-troubleshooting/gathering-information-for-troubleshooting-sites/#generate-a-har-file) attachment containing the problematic update.
91
140
92
-
[^1]: A domain that can be queried for `TXT` records containing a public key to verify your digital signature.
141
+
[^1]: A domain that can be queried for `TXT` records containing a public key to verify your digital signature.
0 commit comments