GitHub Authentication

Applies to Collaborator 13.8, last modified on October 15, 2021

This topic describes how to enable authentication to Collaborator server using GitHub account. To achieve this, you need create OAuth application on the GitHub side and specify its parameters in Collaborator server. To learn about other authentication options, see Additional Authentication Options.

For existing users: To login to Collaborator using your GitHub account, you need to specify your GitHub account in Remote Accounts tab of User Preferences. See Linking User Accounts.
GitHub authentication for Collaborator can be used on organization level only.

Configure GitHub OAuth

  1. Log into GitHub under organization you have administrative access to.

  2. In the upper-right corner of any page, click your profile photo, then click Settings.

  3. In the left sidebar, click Developer settings and then OAuth Apps.

  4. Click New OAuth App. This will display the register new application settings.

    Register new application settings

    Click the image to enlarge it.

  5. Specify the setting values:

    Application name Any meaningful name.
    Homepage URL Collaborator server URL as defined by the External URL setting.
    Your Collaborator server must be accessible to GitHub server. Configure a firewall or enable tunneled connections to do so.
    Application description A short description of the application.
    Authorization callback URL The URL where the OAuth response will be sent to.
    Collaborator servers have this service at the following endpoint: https://yourcollabserver.com/services/github/oauth/response

    Click Register application. This will create an application and display its settings.

  6. In the OAuth application settings page, click Generate a new client secret.

  7. Make sure to copy the values of newly generated client secret, as well as Client ID, as we will user them a bit latter.

    OAuth application settings

    Click the image to enlarge it.

Configure Collaborator Server

  1. Open the Collaborator login page in a browser and log in to Collaborator as an administrator.

  2. In Collaborator, go to Admin > Additional Login Options.

  3. Locate the GitHub OAuth configuration and click Edit. This will display the configuration settings.

    The GitHub OAuth settings page

    Click the image to enlarge it.

  4. Specify the setting values:

    GitHub server URL The URL of your GitHub server. Default is https://github.com. If you use on-premises GitHub Enterprise server, specify its URL instead.
    OAuth Client ID and OAuth Client secret The Client ID and secret of OAuth application for Collaborator integration.
    This is the application that we have created on the GitHub server earlier.
    GitHub organization The name of your GitHub organization account. To allow access only to users that belong to this organization.
    Enable Sign in with GitHub OAuth Specifies whether to enable authentication using GitHub accounts.

Now the integration between Collaborator and your GitHub OAuth application is configured and running.

Technical details

GitHub authentication for Collaborator can be used on organization level only.

Collaborator retrieves user information from the GitHub server and checks if any of existing users have linked this GitHub account to their Collaborator account. Once such user is found, it logs the user in. Otherwise, it creates a new user account in Collaborator and links it to GitHub account.

See Also

Additional Authentication Options
Link User Accounts

Highlight search results