Custom Domains

This feature is included in the Startup/Business plan.

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

Project domains

Project domains are what you will want to use most of the time, especially if you only have a single project.

To setup a project domain, go to your project's settings and navigate to the Custom Domain subsection or simply click on Advanced tab:

Example

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

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

Organization domains

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

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

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

You can configure your custom domain from your organization's settings

Or just configure it by clicking on Advanced tab then Custom Domain panel:

Example

A large tech startup with multiple separate SDKs would setup 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/

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 , that only works for legacy.gitbook.com and will not work for new users.

CDN and HTTPS

GitBook spaces are served over our own CDN with HTTPS enabled by default. The certs are issued by LetsEncrypt. 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