Skip to main content

Custom domain

Route/authoring/slate/domain PreviewSlate previewslate

Custom Domain — "Serve site from your own domain with free TLS via Let's Encrypt." — attaches hostnames to the site's production lane: "Point your own hostname at this documentation site. Once DNS ownership is verified, the edge obtains a Let's Encrypt certificate for it on the first request and renews it automatically…" Domains are stored on the deployment control plane, so the page needs a managed site: "This project has no managed documentation site yet, so there is no lane for a custom domain to route to. Publish a release from the Release Center first."

Add a domain​

Type the hostname (payments-docs.acme.io) and Add domain. Wildcards, IP addresses, single labels and invalid characters are refused. On success: "host attached. Publish the record below, then select Verify."

Each domain​

The Attached domains header counts "N of M serving over TLS"; with none, "No custom domain is attached yet, so this site is reachable only at its platform address…" Each card shows:

  • A Canonical badge on the primary domain.
  • Verification: Domain verified, Verification failed or Awaiting DNS.
  • DNS configuration — the records to publish, with a copy button and a TTL of 300: one CNAME for a subdomain; a TXT record at _apiome-challenge.<host> plus an ALIAS/ANAME for an apex.
  • SSL / TLS certificate — Certificate active, Awaiting certificate, Certificate expired, Certificate error or No certificate, with the issuer and days to expiry.
  • A checklist: the record verified; "TLS 1.3 enforced · HSTS max-age=31536000"; "Auto-renewal enabled" — each suffixed "— not confirmed" until it is.
  • Actions: Verify ("Checking DNS…"), Check certificate, Make canonical (after DNS is verified), Switch off auto-renewal / Switch on auto-renewal, Detach; and "DNS last checked …".

Renewal runs at the edge on a schedule, 30 days before expiry — there is no Renew now.