Skip to content

Domain-Connect/Templates

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
December 6, 2022 13:22
January 13, 2023 13:06
June 22, 2022 10:49
October 21, 2023 15:26
October 10, 2023 12:52
September 22, 2022 15:09
September 22, 2022 15:09
October 21, 2021 18:06
September 24, 2021 18:32
October 1, 2020 18:03
December 3, 2020 19:42

Templates

Build Status

Templates for use in the Domain Connect Protocol These map to the individual service providers for domain connect. See https://www.domainconnect.org/getting-started/

For details on how to constuct a Domain Connect template, refer to section 5.2 and 5.3 of the Domain Connect Spec:

https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#template-definition https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc#template-record

Online Editor

An Online Editor is available, with features like syntax check, testing of variables replacement and groups.

Template Naming Format

Templates should be named according the following pattern: providerId.serviceId.json

For example: myprovider.com.website.json

Template verification

Template can verify for correctness using JSON Schema template.schema. Passing the schema check is required for the Pull Request to be accepted into the repository.

Example Template Format

Following is an example of a complete Domain Connect template, with examples of various DNS records included:

{
    "providerId": "<Enter providerId>",
    "providerName": "<Enter providerName>",
    "serviceId": "<Enter serviceId>",
    "serviceName": "<Enter serviceName>",
    "version": 1,
    "logoUrl": "<Enter logoUrl>",
    "description": "<Enter description>",
    "variableDescription": "<Enter variableDescription>",
    "syncPubKeyDomain": "<Enter syncPubKeyDomain>",
    "syncRedirectDomain": "<Enter syncRedirectDomain>",
    "warnPhishing": true,
    "records": [
        {
            "type": "A",
            "host": "@",
            "pointsTo": "192.0.2.1",
            "ttl": 3600
        },
        {
            "type": "A",
            "host": "@",
            "pointsTo": "%a%",
            "ttl": 3600
        },
        {
            "type": "CNAME",
            "host": "www",
            "pointsTo": "@",
            "ttl": 3600
        },
        {
            "type": "CNAME",
            "host": "sub",
            "pointsTo": "%sub%.mydomain.com",
            "ttl": 3600
        },
        {
            "type": "CNAME",
            "host": "%cnamehost%",
            "pointsTo": "%sub%.mydomain.com",
            "ttl": 3600
        },
        {
            "type": "TXT",
            "host": "@",
            "ttl": 3600,
            "data": "%txt%"
        },
        {
            "type": "SPFM",
            "host": "@",
            "ttl": 0,
            "spfRules": "include:spf.mydomain.com"
        },
        {
            "type": "MX",
            "host": "@",
            "pointsTo": "%mx%",
            "ttl": 3600,
            "priority": 5
        },
        {
            "type": "MX",
            "host": "@",
            "pointsTo": "192.0.2.2",
            "ttl": 3600,
            "priority": 10
        },
        {
            "type": "SRV",
            "name": "@",
            "ttl": 3600,
            "priority": 10,
            "weight": 20,
            "port": 443,
            "protocol": "_tls",
            "service": "_sip",
            "target": "%target%"
        }
    ]
}

Template validation tool

Please see https://github.com/Domain-Connect/dc-template-linter

About

Templates for use in the Domain Connect Protocol

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published