Manage OAuth Apps

This page will help you managing your OAuth applications.

If you are running a team instance of Reviewpad it will be convenient to setup authentication to the code hosts via OAuth apps instead of asking users to manual create and add access tokens.

Assuming that your instance is running at https://SERVER_URL, you will be able to access the administrator panel for OAuth apps at https://SERVER_URL/admin/oauthapps.

Before you can add a new OAuth app to Reviewpad, you will need to register it with the code host.

GitHub OAuth App

Follow the official instructions to create a new GitHub OAuth App here.

The important bit is that on Step 8: Authorization callback URL you will need to put:

https://SERVER_URL/sessions/authorized

To add a new GitHub OAuth app to Reviewpad go to https://SERVER_URL/admin/oauthapps/new:

  1. Select https://github.com as the Code Host Service
  2. Fill in the Client Id provided when you registered the GitHub App
  3. Generate a new Client Secret in the GitHub OAuth app and fill it in the Client Secret field
  4. Fill in the same exact Redirect Uri (https://SERVER_URL/sessions/authorized)that you used to register the OAuth app.

GitLab Group Application

Follow the official instructions to create a new GitLab Group application here.

On the Redirect URI you will need to put:

https://SERVER_URL/sessions/authorized

You also need to select all Scopes except read_registry, write_registry and sudo.

To add a new GitHub OAuth app to Reviewpad go to https://SERVER_URL/admin/oauthapps/new:

  1. Select https://gitlab.com as the Code Host Service
  2. Fill in the Client Id with the Application ID provided by GitLab
  3. Copy the Client Secret from the GitLab Application and paste it in the Client Secret field
  4. Fill in the same exact Redirect Uri (https://SERVER_URL/sessions/authorized)that you used to register the GitLab Application.

After adding the OAuth app to Reviewpad, users will be able to use it to Connect to code host.

Bitbucket OAuth Consumer

Follow the official instructions to create a Bitbucket OAuth Consumer here.

On the Redirect URI you will need to put:

https://SERVER_URL/sessions/authorized

For a properly functioning instance of Reviewpad, we recommend the following permissions:

image

To add a new GitHub OAuth app to Reviewpad go to https://SERVER_URL/admin/oauthapps/new:

  1. Select https://bitbucket.org as the Code Host Service
  2. Fill in the Client Id with the Key provided by Bitbucket
  3. Copy the Secret from the Bitbucket OAuth consumer and paste it in the Client Secret field
  4. Fill in the same exact Redirect Uri (https://SERVER_URL/sessions/authorized)that you used to register the OAuth consumer.

After adding the OAuth app to Reviewpad, users will be able to use it to Connect to code host.