Skip to content
sproutboat
Esc
↑↓navigate↵open⌘Jpreview
On this page

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

bunx sproutboat domains add example.com
npx sproutboat domains add example.com

It 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

bunx sproutboat domains verify example.com
npx sproutboat domains verify example.com

Verify 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.

Was this page helpful?