Skip to content

Commit 3b4ab27

Browse files
Create dedicated section for properties and link to it from #setup
1 parent 209a2e9 commit 3b4ab27

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

src/content/docs/dns/reference/domain-connect.mdx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ title: Domain Connect
44
sidebar:
55
order: 5
66
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.
98

109
---
1110

@@ -32,7 +31,10 @@ Domain Connect templates are published and maintained on a GitHub repository.
3231

3332
1. Create a fork of the [templates repository](https://github.com/Domain-Connect/Templates).
3433
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+
:::
3638
* 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.
3739
* You must also provide a synchronous public key domain (`syncPubKeyDomain` [^1]). When your template is in use, synchronous calls will be digitally signed.
3840
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
6466

6567
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.
6668

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+
6779
## Template updates
6880

6981
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:
89101

90102
2. A [HAR file](/support/troubleshooting/general-troubleshooting/gathering-information-for-troubleshooting-sites/#generate-a-har-file) attachment containing the problematic update.
91103

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

Comments
 (0)