GitHub

Get your GitHub credentials

To use GitHub sign in, you need a client ID and client secret. You can get them from the GitHub Developer Portal.

Make sure to set the redirect URL to http://localhost:3000/api/auth/callback/github for local development. For production, you should set it to the URL of your application. If you change the base path of the auth routes, you should update the redirect URL accordingly.

Important: You MUST include the user.email scope in your Github app. See details below.

Configure the provider

To configure the provider, you need to import the provider and pass it to the socialProviders option of the auth instance.

import { betterAuth } from "better-auth"
 
export const auth = betterAuth({
    socialProviders: {
        github: { 
            clientId: process.env.GITHUB_CLIENT_ID as string, 
            clientSecret: process.env.GITHUB_CLIENT_SECRET as string, 
        }, 
    },
})

Sign In with GitHub

To sign in with GitHub, you can use the signIn.social function provided by the client. The signIn function takes an object with the following properties:

• provider: The provider to use. It should be set to github.

import { createAuthClient } from "better-auth/client"
const authClient =  createAuthClient()
 
const signIn = async () => {
    const data = await authClient.signIn.social({
        provider: "github"
    })
}