Domain file
A Domain file states what one Domain hosts, where it redirects and which mailboxes it has; registrar and certificate state are observed, never written.
| Property | Value |
|---|---|
| Path | domains/ |
| Holds | Domain |
| Kind | file |
| Leaders | db-first, git-first |
| Team | Engineering Team |
| Written by | Domain.connect, Change.merge |
| Compiled by | SiteBuilder |
Example
domains/ in a Startup repository.
---
role: primary
hosts: sites/Props
The frontmatter keys the file takes. The body is its prose.
| Prop | Type | Required | Description |
|---|---|---|---|
role | string | required | What the Domain is for: primary, redirect or email. |
hosts | string | The Site it serves, by path: sites/. | |
email | json | The mailboxes at the Domain. | |
redirects | json | Hosts that redirect to it. |
Generates
SiteBuilder compiles it into these records, Verbs and routes.
| Kind | What |
|---|---|
| Records | Domain |
| Verbs | Domain.connect |
| Routes | None. |