Custom Domains

We support hosting your docs on custom domains, so you have docs on your own subdomains (e.g: docs.example.com).

🏢 Organization domains

Organization domains are useful for large organizations with multiple projects they want to host on a single domain (with a subfolder per project).

For example, if my organization domain is docs.example.com, all your public projects will be available under docs.example.com/{project-id}

To set up an organization domain, go to your organization's settings:

Example

A large tech startup with multiple separate SDKs would set up a single org domain calleddocs.devtools.com. The different projects will be accessible as folders:

  • iOS SDK: docs.devtools.com/ios/

  • Android SDK: docs.devtools.com/android/

  • Web SDK: docs.devtools.com/web/

🌌 Space domains

Space domains are what you will want to use most of the time, especially if you only have personal spaces.

To set up a space domain, go to your space and click on the Advanced tab:

Example

A small startup with a single documentation project can set up the domain docs.coolstartup.com.

A larger startup with a help center and an API documentation can set up a domain for each project: developer.startup.com and help.startup.com.

DNS Settings

In short, CNAME to hosting.gitbook.com.

If you are a v1 user, you may have been used to using www.gitbooks.io , which only works for legacy.gitbook.com and will not work for new users.

🧠 Note: GitBook legacy will soon be deprecated. Contact us to help you migrate your content.

💻 CDN and HTTPS

GitBook spaces are served over our own CDN with HTTPS enabled by default. The certs are issued by LetsEncrypt.

🧠 Note: You don't need to setup anything in front of GitBook to benefit from it. If you do want to use your own CDN such as Cloudflare, have a look at the common errors.

Supported domains

Not all domains are supported. Apex domains, for example, cannot be used. See the table below:

Custom domain type

Example domain

Support

www subdomain

www.example.com

custom subdomain

blog.example.com

apex domain

example.com