Login with GitHub

To enable GitHub Auth for your project, you need to set up a GitHub OAuth application and add the application credentials to your Supabase Dashboard.

Overview#

Setting up GitHub logins for your application consists of 3 parts:

The next step requires a callback URL, which looks like this: https://<project-ref>.supabase.co/auth/v1/callback

Go to your Supabase Project Dashboard
Click on the Authentication icon in the left sidebar
Click on Providers under the Configuration section
Click on GitHub from the accordion list to expand and you'll find your Redirect URL, you can click Copy to copy it to the clipboard

Navigate to Settings/Developer settings/OAuth Apps
Click Register a new application. If you've created an app before, click New OAuth App here.
In Application name, type the name of your app.
In Homepage URL, type the full URL to your app's website.
In Authorization callback URL, type the callback URL of your app.
Enter the URL in the Valid OAuth Redirect URIs box.
Click Save Changes at the bottom right.
Click Register Application.

Copy your new OAuth credentials

Go to your Supabase Project Dashboard
In the left sidebar, click the Authentication icon (near the top)
Click on Providers under the Configuration section
Click on GitHub from the accordion list to expand and turn GitHub Enabled to ON
Enter your GitHub Client ID and GitHub Client Secret saved in the previous step
Click Save

When your user signs in, call signInWithOAuth() with github as the provider:

async function signInWithGithub() {
  const { data, error } = await supabase.auth.signInWithOAuth({
    provider: 'github',
  })
}

When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:

async function signOut() {
  const { error } = await supabase.auth.signOut()
}