Custom domains
Attach your own hostname to a deployment: the DNS records, verification, and TLS issuance.
Every project is served at https://<name>.<username>.<platform-domain>, for example https://hello.ada.fn.example.com. A project needs one deploy before it can take a custom domain. To add your own hostname:
Add the domain
npx sproutboat domains add example.compnpm sproutboat domains add example.combunx sproutboat domains add example.comyarn sproutboat domains add example.comIt prints two records to create in your DNS:
| Type | Name | Value | Notes |
|---|---|---|---|
TXT |
_sproutboat.example.com |
sproutboat-verify=<token> |
proves you control the zone |
A or AAAA |
example.com |
the server address it prints | DNS-only, not proxied. Routes the name to the server. |
Verify
npx sproutboat domains verify example.compnpm sproutboat domains verify example.combunx sproutboat domains verify example.comyarn sproutboat domains verify example.comVerify checks the TXT record. If the hostname does not resolve to the server yet, it still verifies but warns; re-run it once DNS has propagated.
Related
- CLI reference: domains
- Platform limits: custom domains per project