GitBook Test Site

Guides

Custom domains

Replace your auto-generated subdomain with your own domain, with automatic SSL.

By default, every project is published at a subdomain of the platform. You can replace this with your own domain on any paid plan.

SSL certificates are issued automatically once your domain is verified — there's nothing to install or renew yourself.

Before you start

You'll need:

  • A paid plan (Pro or above)
  • Access to your domain registrar's DNS settings
  • A successful deploy of the project you want to attach

Steps

1

Add your domain in the dashboard

Go to Project settings → Domains and click Add domain. Enter the domain or subdomain you want to use:

docs.yourcompany.com

The dashboard will show you the DNS record values you need.

2

Configure your DNS

Add a CNAME record pointing your subdomain at the platform:

Type:  CNAME
Name:  docs
Value: sites.example-platform.com
TTL:   3600

For an apex domain (e.g. yourcompany.com without a subdomain), you'll need an ALIAS or ANAME record instead — not all DNS providers support these. Check your provider's docs.

DNS changes can take up to 48 hours to propagate, but in practice most see them resolve within a few minutes.

3

Verify and activate

Return to Project settings → Domains and click Verify. Once verified, the platform will issue an SSL certificate automatically — usually within a couple of minutes.

When verification completes, your domain is live.

Multiple domains per project

You can attach multiple domains to a single project — useful for redirecting old URLs or supporting multiple regions:

domains:
  primary: docs.yourcompany.com
  redirects:
    - from: help.yourcompany.com
      to: docs.yourcompany.com
      status: 301

Troubleshooting

Removing a domain

To remove a domain, go to Project settings → Domains, click the menu next to the domain, and select Remove.

Removing a domain stops serving traffic immediately. If you've shared this URL externally, set up a redirect first to avoid breaking inbound links.