> For the complete documentation index, see [llms.txt](https://docs.elimity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elimity.com/reference-manual/v3.44.2/built-in-connectors/github.md).

# 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:

1. 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=read`
2. Choose a GitHub App name (e.g. `elimity-insights`) and homepage (e.g the URL of your Elimity Insights tenant); these settings are purely descriptive.
3. 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:

1. From the app’s settings page, click the button to install the app, which should be in the top-left menu.
2. Click the install button for the organization account.
3. 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:

<table data-full-width="true"><thead><tr><th>Configuration option</th><th>Description</th></tr></thead><tbody><tr><td>App ID</td><td>Application identifier you noted down in step 1.</td></tr><tr><td>Private key</td><td>Private key you generated in step 2.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.elimity.com/reference-manual/v3.44.2/built-in-connectors/github.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.