GitHub Auth Module Provider
In this guide, you’ll learn about the GitHub Auth Module Provider and how to configure it.
The GitHub Auth Module Provider allows you to authenticate users with their GitHub account.
Register the GitHub Auth Module Provider#
To use the GitHub Auth Module Provider, add the module to the array of providers passed to the Auth Module in your medusa-config.ts:
1import { Modules, ContainerRegistrationKeys } from "@medusajs/framework/utils"2 3// ...4 5module.exports = defineConfig({6 // ...7 modules: [8 {9 resolve: "@medusajs/medusa/auth",10 dependencies: [Modules.CACHE, ContainerRegistrationKeys.LOGGER],11 options: {12 providers: [13 // other providers...14 {15 resolve: "@medusajs/medusa/auth-github",16 id: "github",17 options: {18 clientId: process.env.GITHUB_CLIENT_ID,19 clientSecret: process.env.GITHUB_CLIENT_SECRET,20 callbackUrl: process.env.GITHUB_CALLBACK_URL,21 },22 },23 ],24 },25 },26 ],27})
Environment Variables#
Make sure to add the necessary environment variables for the above options in .env:
Module Options#
| Configuration | Description | Required |
|---|---|---|
| A string indicating the client ID of your GitHub app. | Yes |
| A string indicating the client secret of your GitHub app. | Yes |
| A string indicating the URL to redirect to in your frontend after the user completes their authentication in GitHub. At this URL, the frontend will receive a | Yes |
Override Callback URL During Authentication#
In many cases, you may have different callback URLs for actor types. For example, you may redirect admin users to a different URL than customers after authentication.
The Authenticate or Login API Route accepts a callback_url body parameter to override the provider's callbackUrl option. Learn more in the Auth Flows with Routes guide.
