GitHub Authentication

Instructions for integrating GitHub OAuth with Garnet

Adding 1-click login with GitHub makes it really easy for your users to authenticate with Garnet

Note: If you want to have this application as part of an organization, you'll need to go to your organization's settings -> OAuth apps -> New OAuth App.

  • Register your application with GitHub

    • Homepage URL needs to be the url of your Garnet instance

      • e.g. http://localhost:3000

    • Authorization callback URL needs to be the url of your Garnet instance + /api/auth/social/github/callback

      • e.g. http://localhost:8080/api/auth/social/github/callback

  • Fetch your Client ID and Client Secret

  • Add these parameters to the AUTH_SOCIAL_GITHUB_CLIENT_ID and AUTH_SOCIAL_GITHUB_CLIENT_SECRET env variables, and restart Garnet.

  • GitHub login should now be visible on the login page of the Garnet Dashboard.