GitHub

Resources

• GitHub OAuth App Docs
• GitHub OAuth App Settings

Environment variables

.env

GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=

Callback URL

GitHub doesn’t allow configuring multiple callback URLs for an OAuth App, so create multiple OAuth Apps for development and production.

/api/auth/github/callback

Config

The user:email scope is requested by default to retrieve the user’s email address.

auth.ts

import process from 'node:process'
import { createAuth } from '@rttnd/gau/core'
import { GitHub } from '@rttnd/gau/oauth'

export const auth = createAuth({
  providers: [
    GitHub({
      clientId: process.env.GITHUB_CLIENT_ID,
      clientSecret: process.env.GITHUB_CLIENT_SECRET,
    }),
  ],
})

Provider params

params

Type: Record<string, string>

Default: —

Extra query params appended to the authorization URL.