A

Auth github

Name: Auth github
Author: Medusa

Github OAuth authentication provider for Medusa

Included in @medusajs/medusa, no separate install needed

@medusajs/auth-github

Documentation | Website

Building blocks for digital commerce

GitHub Auth Module Provider for Medusa: lets users and customers log in with their GitHub account through OAuth 2. Use it to add "Log in with GitHub" for customers, admin users, or custom actor types. It ships with and is registered through the path.

At a glance


Package
Type	Module Provider (Auth Module)
Provider ID
Registered by default	No
Import from

Installation

No installation needed. The provider is a dependency of .

Usage

Register the provider in the Auth Module's array in . Passing replaces the default list, so keep if you still need email/password login:

1import { defineConfig } from "@medusajs/framework/utils"
2
3module.exports = defineConfig({
// ...
modules: [
  {
    resolve: "@medusajs/medusa/auth",
    options: {
      providers: [
        {
          resolve: "@medusajs/medusa/auth-emailpass",
          id: "emailpass",
        },
        {
          resolve: "@medusajs/medusa/auth-github",
          id: "github",
          options: {
            clientId: process.env.GITHUB_CLIENT_ID,
            clientSecret: process.env.GITHUB_CLIENT_SECRET,
            callbackUrl: process.env.GITHUB_CALLBACK_URL,
          },
        },
      ],
    },
  },
],
27})

The provider's is the one used in authentication routes, such as .

Configuration

Option	Type	Description	Default
		Required. The OAuth client ID of your GitHub app.	-
		Required. The OAuth client secret of your GitHub app.	-
		Required. The URL GitHub redirects to after authentication. Can be overridden per request with a body parameter.	-