GitHub OAuth Setup

You can allow users to sign in to your Rocket.Chat workspace using their GitHub or GitHub Enterprise accounts.

Prerequisites

Before setting up GitHub OAuth, you need:

• A GitHub or GitHub Enterprise account

• A GitHub OAuth app

• The app’s Client ID and Client Secret

To create a GitHub OAuth app:

1. Go to GitHub Developer Settings

2. Select OAuth Apps > New OAuth App.

3. Enter the required app details, including the Authorization callback URL.

4. Save the app.

5. After GitHub creates the app, copy the Client ID and generate a Client Secret.

Important

• Copy the GitHub Callback URL from Rocket.Chat and use it as the Authorization callback URL in your GitHub OAuth app.

• If the callback URLs do not match exactly, GitHub may not show an error, but sign-in will fail with:
  No matching login attempt found.

Configure GitHub OAuth

After you have your GitHub OAuth app credentials:

1. In Rocket.Chat, go to Manage > Workspace > Settings > OAuth.

2. Expand the GitHub section.

3. Turn OAuth Enabled on.

4. Enter the following values:

   • Client ID: The Client ID from your GitHub OAuth app

   • Client Secret: The Client Secret from your GitHub OAuth app

   • GitHub Callback URL: Copy this value from Rocket.Chat and paste it into your GitHub app settings as the Authorization callback URL

   • Server URL: Required only for GitHub Enterprise. Enter the base URL of your GitHub Enterprise instance

5. Select Save changes.

After you save, the Sign in with GitHub button appears on the workspace sign-in page. Users can then sign in with their GitHub accounts.