Set a custom domain
Set a custom domain for your docs sites
Last updated
Was this helpful?
Set a custom domain for your docs sites
Last updated
Was this helpful?
This page shows how to configure a custom domain and subdomain. If you would like to configure a custom subdirectory (such as example.com/docs), see the Setting a custom subdirectory page.
By default, your sites are accessible on a [subdomain].gitbook.io domain.
You can customize this by setting a custom domain, meaning your audience can access your documentation on a chosen domain.
At this stage, you'll see a window with three fields: Type, Name, Target.
Those are the details you'll use to set your custom domain in your DNS provider. This is done outside GitBook, in the provider you are using for your domain.
Copy the contents of the Name and Target fields to use in your DNS provider. Each provider is different, so when in doubt, check directly with them how to add this record. You should be able to pick the Type of record from a list in your provider.
After adding the record, it might take some time for the changes to propagate. We recommend waiting at least 1 hour before moving to the next step. Click Next when you are ready.
After adding the record and it being propagated, it's time to go live! GitBook will verify the domain, the record you added and will automatically configure the SSL certificate for your domain.
Once done, you'll receive a notification and can click Finish. You can also close the window if you need, and we'll send you a notification once the process is done on our side.
Setting up a custom domain can occasionally run into obstacles. Below, we outline frequent problems encountered during this process and provide detailed solutions to each of them.