Data connections
...
Integrations
Source code managers

GitHub Enterprise Server

5min

The GitHub Enteprise Server (GHES) integration is functionally equivalent to the regular GitHub integration. However, the installation flow is different to accomodate the specificities of GHES (see GitHub Enterprise Server documentation).

The GitHub Enterprise Server integration is a recent addition to Echoes. Some of the manual steps in this documentation may be improved over time. Please don't hesitate to report any issues or feedback to [email protected].

Creating the GitHub App

You cannot install third-party GitHub Apps on organizations owned by your instance. Using the functionalities of Echoes GitHub App requires creating an App within your hosted GHES instance.

Use this page to create an Echoes GitHub App for your hosted GHES instance:

Echoes GHES App creation page
Echoes GHES App creation page


Enter the URL of your GHES organization which will own the GitHub App.

While the organization identified by the provided URL owns the Echoes GitHub App, this does not restrict the App from being installed to other organizations. After its creation, any organization within the GHES instance can install the App.

This will redirect you to GitHub where you can customize the name for the GitHub App:

GitHub App creation flow
GitHub App creation flow


Submitting the name will redirect you to Echoes to register this new App:

Echoes App confirmation message
Echoes App confirmation message


Installing the GitHub App

Your GitHub App is ready, but it is not yet installed on any of your GHES organizations. To proceed, navigate to the integration page (you can find the link on the confirmation page) and use the "install" button:

GitHub newly created App
GitHub newly created App


The installation of a GitHub Enterprise Server Echoes App to an organization happens out-of-band, outside of Echoes control. For that reason, an action from Echoes support is now necessary to link this new installation to your Echoes account.

After this action has been taken, a GitHub installation for your GHES-hosted organization will appear in your Echoes integrations page, labels will be automatically created on the selected set of repositories, and data will start populating your reports.

The Echoes team is notified when an out-of-band installation happens and will take the necessary action. Feel free to let us know on [email protected] or Slack if you don't see your installation appear on your Echoes instance in a timely manner.

Firewall rules

Your firewall must allow connections from Echoes toward your on-premises GHES instance. Please refer to Echoes IP addresses to find the IP addresses used by Echoes for outbound connections.

Updated 10 Aug 2023
Did this page help you?