GitHub
The GitHub connector for Elimity Insights fetches users, roles, teams, permissions and repositories from GitHub so you can keep in control of your environment. Follow the instructions below to set up the connector for your environment.
1. Creating a GitHub App
To ensure Elimity Insights can request the necessary information from the GitHub API, we need to provide it with a private key. GitHub only generates these keys for GitHub Apps, so we need to create a GitHub App first. To do so, follow these steps:
Go to the following link in your browser (filling the
{organization}parameter) and log in with an organization administrator account:https://github.com/organizations/{organization}/settings/apps/new?administration=read&members=readChoose a GitHub App name (e.g.
elimity-insights) and homepage (e.g the URL of your Elimity Insights tenant); these settings are purely descriptive.Untick the active checkbox under the webhooks section, and click the confirmation button.
Note down the new app's ID for later use.
2. Generating a private key for the app
Having created a GitHub App, now we can generate a private key for it. On the new app's settings page, scroll down to the private keys section, and click the button to generate a private key, which should download a file to your machine. Keep this file for the last step.
3. Installing the app for your organization
Elimity Insights will only be able to use the private key you just generated if the GitHub App is effectively installed for your organization:
From the app’s settings page, click the button to install the app, which should be in the top-left menu.
Click the install button for the organization account.
Review the requested permissions and click the confirmation button.
4. Creating a source in Elimity Insights
In Elimity Insights you can now create a new GitHub source providing the following configuration options:
App ID
Application identifier you noted down in step 1.
Private key
Private key you generated in step 2.
Last updated