Octri

docs domain

Shows your docs site's custom domain: the hostname, whether it's verified, and the address it serves. Until it's verified, it also prints the CNAME and TXT records to add at your DNS provider. Changes are live straight away. See custom domains.

bash
octri docs domain [show | set <hostname> | verify | remove --yes]

octri docs domain set <hostname>

Registers the hostname. Run octri docs domain afterwards for the exact record values.

Arguments

<hostname>stringrequired

Such as docs.acme.com.

octri docs domain verify

Checks the records through public DNS now. DNS can take a while to spread, so if it fails just after you added them, wait and run it again.

octri docs domain remove --yes

Stops serving your docs on the hostname. Your default address keeps working. Without --yes it only warns you.

Flags

--yesbooleanrequired

Confirms the removal.

Examples

Show the domain

bash
octri docs domain
Output
✔ Loading custom domain

Docs domain
  No custom domain. Run `octri docs domain set docs.example.com`.
  CNAME target: cname.octri.dev