Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.85 KB

File metadata and controls

63 lines (46 loc) · 2.85 KB
title description
Add GitHub as a social connection
Learn how to allow users to sign up and sign in to your Clerk app with their GitHub account using OAuth.

<TutorialHero beforeYouStart={[ { title: "A Clerk app is required.", link: "/docs/quickstarts/setup-clerk", icon: "clerk", }, { title: "A GitHub account is required.", link: "https://github.com/signup", icon: "user-circle", }, ]} />

Enabling OAuth with GitHub allows your users to sign up and sign in to your Clerk app with their GitHub account.

Configure for your development instance

For development instances, Clerk uses preconfigured shared OAuth credentials and redirect URIs—no other configuration is needed.

  1. In the Clerk Dashboard, navigate to the SSO connections page.
  2. Select Add connection and select For all users.
  3. In the Choose provider dropdown, select GitHub.
  4. Select Add connection.

Configure for your production instance

For production instances, you must provide custom credentials.

To make the setup process easier, it's recommended to keep two browser tabs open: one for the Clerk Dashboard and one for GitHub's Developer Settings.

### Enable GitHub as a social connection in Clerk
  1. In the Clerk Dashboard, navigate to the SSO connections page.
  2. Select Add connection and choose For all users.
  3. In the Choose provider dropdown, select GitHub.
  4. Ensure that both Enable for sign-up and sign-in and Use custom credentials are toggled on.
  5. Save the Authorization Callback URL somewhere secure. Keep the modal and page open.

Create a GitHub app

  1. In the left sidenav of your GitHub's Developer Settings, select OAuth Apps.
  2. Select New OAuth app. You'll be redirected to the Register a new OAuth app page.
  3. Complete the required fields. In Authorization Callback URL, paste the Authorization Callback URL you saved from the Clerk Dashboard.
  4. Select Register application. You'll be redirected to your app's General page.
  5. Select Generate a new client secret. Save the Client ID and Client Secret somewhere secure.

Set the Client ID and Client Secret in the Clerk Dashboard

Test your connection