Documentation
Custom domains
Every project gets a docs URL on octri.dev immediately. A custom domain puts your docs on your own hostname, which is what you want before you link them from your marketing site.
Custom domains are not gated by tier. Your project's default subdomain is a random id, so a custom domain is the route to a branded docs URL, and that shouldn't depend on what you pay.
Setting one up
- Add the hostname
Enter the domain you want in project settings, e.g.
docs.acme.com. A subdomain is the usual choice. - Point a CNAME at Octri
Add a CNAME record from your hostname to the target Octri gives you.
- Add the TXT record
Octri gives you a verification token. Add it as a TXT record at
_octri-verify.<your hostname>. - Verify
Octri resolves both records and confirms the domain is yours. Once verified, the docs serve from it.
Why two records
The CNAME routes traffic. The TXT proves the domain is yours.
Anyone can point a CNAME at any host. If routing were the only requirement, someone could aim docs.your-competitor.com at their own Octri project. The TXT record is what ties the claim to whoever controls the DNS zone.
Rules
Propagation
DNS changes take time to propagate. Verification checks the records as they resolve right now, so if you've just added them and verification fails, wait and retry rather than re-entering everything.
Some resolvers cache a failed lookup for as long as a successful one. If you verified too early, the retry may keep failing for the length of your zone's negative TTL even after the record is live.
After it's live
The Octri subdomain keeps working; the custom domain is additional, not a replacement. Links to the old URL don't break.