Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.dev

GitHub

How to set up social connection with GitHub

Overview

Adding social connection with GitHub to your app with Clerk is simple - you only need to set the Client ID, Client Secret and Authorized redirect URI in your instance settings.

To make the development flow as smooth as possible, Clerk uses preconfigured shared OAuth credentials and redirect URIs for development instances - no other configuration is needed.

For production instances, you will need to generate your own Client ID and Client secret using your GitHub account.

The purpose of this guide is to help you create a GitHub account and a GitHub OAuth app - if you're looking for step-by-step instructions using Clerk to add social connection (OAuth) to your application, follow the Social connection (OAuth) guide.

Before you start

Configuring GitHub social connection

First, you need to register a new OAuth GitHub app. Follow the official GitHub instructions on how to create an OAuth app.

Registering an OAuth GitHub app

Go to the Social Connections page and enable GitHub. In the modal that opened, ensure Use custom credentials is enabled and copy Authorized redirect URI. Go back to the GitHub panel, paste the value into the Authorization callback URL field and complete the registration.

Once registration is complete, you'll get redirected to project's admin panel. Click the Generate a new client secret button to get your new client secret. Then, copy the Client ID and Client secret. Go back to the Clerk Dashboard and paste them into the respective fields.

Obtaining the Client ID and Client secret

Don't forget to click Apply in the Clerk dashboard. Social connection with GitHub is now configured.

Was this helpful?

Clerk © 2022