Setting up AWS Cognito
Set up an AWS Cognito login screen for visitors to your docs.
Last updated
Was this helpful?
Set up an AWS Cognito login screen for visitors to your docs.
Last updated
Was this helpful?
This guide takes your through setting up a protected sign-in screen for your docs. Before going through this guide, make sure you’ve first gone through “Enabling visitor authentication”.
To setup your GitBook site with visitor authentication using AWS Cognito, the process looks as follows:
Go to your desired User Pool in Cognito, and click on App integration. Make a note of the Cognito domain, we will need it to configure the integration.
Scroll to the bottom and click "Create app client". For the app type, select "Confidential client." Scroll down to Hosted UI settings. In allowed Callback URLs, enter the Callback URL you got from GitBook upon installing the integration on a space.
Scroll further down to "OAuth 2.0 grant types"- make sure "Authorization code grant" is selected.
For "OpenID connect scopes", make sure OpenID is selected.
Scroll down and click "Create app client".
Click on the created app client and make a note of the Client ID and Client Secret.
Navigate to integrations within the GitBook app, select Visitor Authentication as the category, and install the AWS Cognito integration.
Once you've installed it on your site, go to configuration and make a note of the Callback URL right above the Save button. We will need it to set up Cognito.
Open up the Cognito integration's configuration screen for the space you installed the integration on.
It should look like the following image:
For Client ID, Cognito Domain, and Client Secret, paste in the values you got from Cognito.
Hit Save.
Now, in GitBook, close the integrations modal and click on the Manage site button. Navigate to Audience, select Visitor Authentication, and choose Cognito as the backend. and click Update audience. Go to the site's screen and click Publish. The site is now published behind Visitor Authentication controlled by your Cognito application. To try it out, click on Visit. You will be asked to sign in with Cognito, which confirms that your site is published behind Visitor Authentication using AWS Cognito.
This feature is still under development and coming soon.
Please sign up for the waitlist at https://www.gitbook.com/
