Collection-level custom domain

Please follow the steps to set a custom domain in this order:

1. Choosing a subdomain

2. Deciding where to set the custom domain

3. Initiating the custom domain setup (at the organization, collection, or space level) (you are here)

4. Configuring DNS

5. Confirming the custom domain setup

The custom domain will be used as-is for the default space in the collection. Other spaces in the collection will have a URL in this format: [yourcustomdomain]/v/[spaceURL].

You'll find the options for setting a custom domain for a collection within the collection's Share modal. To get there, click on the name of the collection in the sidebar, and then click on the Share button near the top-right corner. It will look something like this:

Click the button to open the share modal

First, your collection needs to be published. Any setting other than unpublished will work — public, unlisted, share link, or visitor authentication. (Depending on the plan you have chosen, it might be that only some of these publishing options are available to you.)

Once you have published your collection on either the Publish to the web or the Share to an audience tab, you'll see a section titled Customize URL. Click on the Connect a domain button:

The share modal

Now, enter the custom domain you'd like to set, and then click the Next: Configure DNS button:

Connect a custom domain

We'll then provide the name and value to use in the next step when you create your CNAME DNS record. You can copy the name or value to your clipboard by clicking on the icon on the right-hand side of each field.

The CNAME value for your custom domain

The value for the CNAME record will be in the format [something]-hosting.gitbook.io, where that [something] will be unique to you. Make sure to use the value displayed to you in the GitBook app, and not the value in the screenshot above! 🙂

Now, you're ready to move onto the next step: configuring DNS.