Visitor authentication

Set up custom authentication for your published content.

This feature is available as part of the Ultimate site plan and Enterprise plan. To find out more, visit our pricing page.

Visitor authentication allows you to publish your content while requiring authentication from any visitors who want to view it. When enabled, GitBook lets your authentication provider handle who has access to the content.

Use cases

Common use cases for visitor authentication include:

• Publishing sensitive product documentation that should only be accessible to paying customers, sales prospects or partners.

• Publishing internal knowledge base content that should only be accessible to employees of your company.

Setting up visitor authentication

There are two methods you can choose from when setting up visitor authentication:

1. Installing one of our authentication integrations — we currently support Okta, Azure, and Auth0. We highly recommend this option if you’re using an authentication provider we support.

2. Create and host your own server to handle the authentication. Many different technologies can be used, but it’s up to you to code and maintain the solution you choose. Read the guides in our developer documentation to learn more.

Publish with visitor authentication

To publish your docs with visitor authentication, head to the docs site you want to publish, click Publish, and choose the Visitor Authentication option.

If you’re using an external service to authenticate your users, follow the guides below to get up and running.

https://developer.gitbook.com/visitor-authentication/guides/integrations/how-to-use-auth0-integration-for-visitor-authenticationdeveloper.gitbook.com

https://developer.gitbook.com/visitor-authentication/guides/integrations/how-to-use-azure-ad-integration-for-visitor-authenticationdeveloper.gitbook.com

https://developer.gitbook.com/visitor-authentication/guides/integrations/how-to-use-okta-integration-for-visitor-authenticationdeveloper.gitbook.com

Publish as unlisted

By default, your site will be indexed by search engines. You can alternatively choose to publish as unlisted — meaning the docs are still available to authorized, but they won’t be indexed by search engines such as Google.

Unlisted spaces can be particularly helpful if you want to publish a beta version of your docs, or do large-scale user testing without impacting your SEO with potentially duplicate content.