Skip to main content
This guide explains how to set up GitHub as an authentication provider with Hexclave. GitHub allows users to sign in to your Hexclave-enabled app using their GitHub account.
For Development purposes, Hexclave uses shared keys for this provider. Shared keys are automatically created by Stack, but show Stack’s logo on the OAuth sign-in page. You should replace these before you go into production.

​
Integration Steps

If you are unsure if you need to create a GitHub App, or a GitHub OAuth App, check the Differences On GitHub. More than likely, you will want to create a GitHub App. The installation process is the same for both.
1

​
Create a GitHub App

  1. Navigate to your GitHub Developer App Settings.
  2. Click the New GitHub App button.
  3. Enter a name for your application, homepage URL, and a description.
  4. For Authorization callback URL, add https://api.hexclave.com/api/v1/auth/oauth/callback/github
  5. For permissions, at a minimum, you will need Account Permissions > Email Addresses set to Read Only. Your sign-in flow will not work without this permission.
  6. Select Any Account under the Where can this GitHub App be installed section.
  7. Click Create GitHub App
  8. Save the Client ID and click Generate a new client secret to create your Client Secret.
2

​
Enable GitHub Provider in Hexclave

  1. On the Hexclave dashboard, select Auth Methods in the left sidebar.
  2. Click Add SSO Providers and select GitHub as the provider.
  3. Set the Client ID and Client Secret you obtained from your GitHub App earlier.
1

​
Create an OAuth App

  1. Navigate to your GitHub Developer Settings.
  2. Click the New OAuth App button.
  3. Enter a name for your application, homepage URL, and a description.
  4. For Authorization callback URL, add https://api.hexclave.com/api/v1/auth/oauth/callback/github
  5. Click Register application
  6. Save the Client ID and click Generate a new client secret to create your Client Secret.
2

​
Enable GitHub OAuth in Hexclave

  1. On the Hexclave dashboard, select Auth Methods in the left sidebar.
  2. Click Add SSO Providers and select GitHub as the provider.
  3. Set the Client ID and Client Secret you obtained from GitHub earlier.

​
Need More Help?