For GitHub Enterprise (GHE) integrations, there are 4 high-level steps
Open GHE firewall to Haystack IPs
Create the Haystack Github App
Generate App secrets
Install organization to the newly created GitHub App
Provide Haystack with the App secrets
Afterward, you’ll be able to see your organization's data on https://dash.usehaystack.io and get all updates at the same speed as Cloud users.
You can find detailed instructions on each step below.
1. Open GHE firewall to Haystack IPs
Haystack API uses the following IP addresses to connect to GHE.
For Haystack to access your servers, we'll need open firewall access to the given IPs.
2. Create the Haystack GitHub App
Open the organization you want Haystack to access, and go to the Settings page. Then, go to GitHub Apps in the Developer Settings.
Click New GitHub App.
Here, fill in the following fields according to the detail below:
Register new GitHub App
GitHub App name: Haystack Enterprise
Homepage URL: https://dash.usehaystack.io
User authorization callback URL: https://dash.usehaystack.io/onboarding/github-enterprise/complete
Webhook secret: Generate one using (make sure to store this securely)
openssl rand -base64 500 | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1
Haystack requires the following permissions to give you insights. These permissions are in read-only mode:
No access to all
Subscribe to events
Check the following items
In the final step, make sure to select Any account and click Create Github App:
3. Generate App secrets
Take notes on the following items in a secure place.
Webhook Secret (generated in the previous step)
On the same page, go to the Private keys section and press Generate a private key.
4. Install organization to the newly created GitHub App
We have created a GitHub App. Now we should allow the app to have access to the organizations you'd like to get insights.
On the left bar, go to Install App and press the Install button for the organizations you want Haystack to have access to.
Note: You can install one or more organizations.
Afterward, select the repositories you'd like to get insights into and press Install.
5. Provide Haystack with the App secrets
Haystack needs the following information to complete the installation process. Send us the following information via a secure channel.
You have installed Haystack on your GitHub Enterprise organization successfully! We will contact you once your data is fetched.