Skip to content

Add coreware.app Website DNS template#1058

Open
joshatcoreware wants to merge 27 commits into
Domain-Connect:masterfrom
joshatcoreware:master
Open

Add coreware.app Website DNS template#1058
joshatcoreware wants to merge 27 commits into
Domain-Connect:masterfrom
joshatcoreware:master

Conversation

@joshatcoreware
Copy link
Copy Markdown
Contributor

@joshatcoreware joshatcoreware commented Apr 30, 2026

Description

Template for DNS records to point the user's domain to the coreware-hosted websites.

Type of change

Please mark options that are relevant.

  • New template
  • Bug fix (non-breaking change which fixes an issue in the template)
  • New feature (non-breaking change which adds functionality to the template)
  • Breaking change (fix or feature that would cause existing template behavior to be not backward compatible)

How Has This Been Tested?

Please mark the following checks done

  • Template functionality checked using Online Editor
  • Template file name follows the pattern <providerId>.<serviceId>.json
  • resource URL provided with logoUrl is actually served by a webserver

Checklist of common problems

Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
See Template Quality Guidelines for details and rationale on each rule.

  • syncPubKeyDomain is set — this is mandatory; omitting it requires explicit justification in the PR description or the PR will be rejected
  • warnPhishing is not set alongside syncPubKeyDomain — the two must not appear together
  • syncRedirectDomain is set whenever the template uses redirect_uri in the synchronous flow
  • no TXT record contains SPF content ("v=spf1 ...") — use the SPFM record type instead
  • txtConflictMatchingMode is set on every TXT record that must be unique per label or content prefix (e.g. DMARC)
  • no variable is used as a bare full record value (e.g. @ TXT "%foo%") unless necessary — prefer @ TXT "service-foo=%foo%"; if bare, justify in the PR description
  • no bare variable is used as the full host label — the non-variable parts are fixed to limit misuse (e.g. %dkimkey%._domainkey, not %dkimhost%); if bare, justify in the PR description
  • no variable is used in the host field to create a subdomain — use the host parameter or multiInstance instead
  • %host% does not appear explicitly in any host attribute
  • essential is set to OnApply on records the end user may need to modify or remove without breaking the template (e.g. DMARC)

Online Editor test results

Editor test link(s):

Test coreware.app/websitedns example.com/www

@github-actions github-actions Bot added Checklist of common problems not complete See PR template and mark *all* checkboxes, even if not applicable. Explain any discrepancies. PR description incomplete The PR description template was not filled in at all, altered or filled in improperly. Test links missing No test links from Online Editor provided labels Apr 30, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 30, 2026

JSON Filename Check Passed

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 30, 2026

JSON Schema Validation Passed

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 30, 2026

Linter OK

coreware.app.websitedns.json

Level Code Note
info DCTL1024 use of %host% variable name is problematic
info DCTL1037 hostRequired template should be combined with NS or CNAME record that uses host @ or empty

@github-actions github-actions Bot removed the Test links missing No test links from Online Editor provided label Apr 30, 2026
@github-actions github-actions Bot added PR description incomplete The PR description template was not filled in at all, altered or filled in improperly. and removed PR description incomplete The PR description template was not filled in at all, altered or filled in improperly. Checklist of common problems not complete See PR template and mark *all* checkboxes, even if not applicable. Explain any discrepancies. labels Apr 30, 2026
Comment thread coreware.app.websitedns.json Outdated
{
"type": "CNAME",
"host": "%acmValidationName%",
"pointsTo": "%acmValidationValue%",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per variable description this variable could be limited in scope by adding a suffix.

@github-actions github-actions Bot added the Test links missing No test links from Online Editor provided label May 4, 2026
@github-actions github-actions Bot added hostRequired hostRequired is set and removed Test links missing No test links from Online Editor provided labels May 4, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 4, 2026

PR Description Check Passed

All required sections are filled in correctly.

Details
  OK  Type of change: 1/4 checkboxes ticked
  OK  How Has This Been Tested?: all 3 checkboxes ticked
  OK  Checklist of common problems: 9/10 checkboxes ticked
  OK  Online Editor test results: 1 link(s) found
  OK  Template coverage: all 1 template(s) covered
Labels to remove: Checklist of common problems not complete, Forged editor links, PR description incomplete, Test links missing

PR description check PASSED

"records": [
{
"type": "CNAME",
"host": "%host%",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please observe the checklist for the usage of %host% variable.
You example test in the editor shows the obvious error you should take care of.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hostRequired hostRequired is set

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants