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.

Environment Variables#

Make sure to add the necessary environment variables for the above options in .env:

Code
GITHUB_CLIENT_ID=<YOUR_GITHUB_CLIENT_ID>
GITHUB_CLIENT_SECRET=<YOUR_GITHUB_CLIENT_SECRET>
GITHUB_CALLBACK_URL=<YOUR_GITHUB_CALLBACK_URL>

Module Options#

Configuration	Description	Required
`clientId`	A string indicating the client ID of your GitHub app.	Yes
`clientSecret`	A string indicating the client secret of your GitHub app.	Yes
`callbackUrl`	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 `code` query parameter. It then sends that `code` query parameter to the MedusaGo application's `/auth/{actor_type}/github/callback` route.	Yes

Configuration

Description

Required

clientId

A string indicating the client ID of your GitHub app.

Yes

clientSecret

A string indicating the client secret of your GitHub app.

Yes

callbackUrl

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 code query parameter. It then sends that code query parameter to the MedusaGo application's /auth/{actor_type}/github/callback route.

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.

Examples#

How to implement third-party / social login in the storefront

Found a problem with this page?Report Issue

Edited Nov 14·Edit this page