Skip to main content

Setup user authentication with GitHub

This article provides a quick start guide for adding GitHub Login to Authress, so that your users can use their GitHub Account Login to authenticate into your software.

info

If you are looking to enable admin login access into the Authress Management Portal using your corporate IdP see the Authress Management Portal SSO Configuration.

In this guide we’ll set up GitHub Accounts login. Setting up authentication requires the following parts:

  1. Authress-GitHub OAuth configuration
  2. GitHub Accounts OAuth App creation
  3. Testing the configuration

Prerequisite: GitHub Account

In order to enable your users to log in with their GitHub Account, you will first need a GitHub account yourself. You can do that by Registering for a GitHub account. Then we recommend also creating an GitHub organization for your company to manage the OAuth login: Registering for a GitHub organization account.

Authress Connection configuration

The first step is enabling the GitHub preconfigured Authress connection in the Authress Management Portal.

Authress preconfigured GitHub connection

You will see there are the missing fields Client ID and Client Secret.

GitHub OAuth App creation

Now we can create a new OAuth App. This OAuth App is what your users will see when the choose to sign in with GitHub.

You can either review the Official GitHub App creation documentation or follow along here.

  • Navigate to your newly created account, and create a new App
  • Or to your newly created organization GitHub Organization and navigate to Settings > Developer Settings > OAuth Apps.

Then Click New OAuth app:

Create a GitHub OAuth app

  • Enter the Application name as Authress, and set the Homepage URL to be your application main page.

App Registration type selection

  • Set the Authorized callback URL to be your Authress Custom Domain url. This is the domain you set up in your Authress account. We'll assume for this example it is https://login.company.com and therefore the redirect URI is https://login.company.com/login. And then click Register. This value is available in your new Authress Connection for Microsoft in the Complete Setup section of the connection.

Complete Authress Setup

GitHub Service Client Configuration

Now that the App is created in GitHub we can copy the Client ID and the Client Secret from the console and store it in Authress:

GitHub server registration client ID

Validate the configuration

Now the setup is complete and you are ready to test connection. You can test the connection in the Authress Connection configuration by clicking Test Connection:

Test Connection in Authress

When everything is configured correctly you'll see the test login success screen:

Correct GitHub configuration in Authress