Publishing Domains
A domain is the host a public documentation site is served on. This page explains how to add one, what the value must look like and what limits apply.
Roles: Only an
adminmanages domains. It needs thepublishlicense feature and is limited by the domain count of your tier. See License and Tiers.
Open the Publishing section#
The Publishing item of the main menu switches the whole interface to publishing mode. The left menu then lists Domains, Styles and brands and Versions, and the top bar gets a picker of the domain that the Versions page works on. The Documentation button of the top bar brings you back.
Add a domain#
- Open Publishing → Domains and click Add domain.
- Type the host, for example
docs.example.com. - Choose a style, or keep the default look.
- Save.
What you type is normalized: lower case, without a scheme, path or query, without user info or a trailing dot, and without the default ports 80 and 443. https://Docs.Example.com/ is stored as docs.example.com. A port other than the default is kept, because localhost:3000 and localhost are different sites. An address that is not a host name or an IP address is refused, and so is a domain that already exists.
The value must be the host readers actually open, because the portal sends it to SelfDocHub with every request. See Deploy the Public Site.
Change or delete a domain#
- Edit changes the style of the domain, or the domain itself.
- Delete removes the domain together with all versions published on it. This cannot be undone.
Limits#
| Free | Team | Business | Unlimited | |
|---|---|---|---|---|
| Domains | not available | 1 | 5 | no limit |
| Versions per domain | not available | 5 | 20 | no limit |
When the limit is reached, adding one more is refused. Existing domains stay as they are.