What you will need
A target GitHub Enterprise (GHE) installation.
A target GitHub organization within GHE.
A GitHub user within GHE with permissions over the target GitHub organization.
Register the Athenian application in GHE
Install the Athenian application in the organization
Provide Athenian with the details of the application
1. Register the Athenian application in GHE
1.1. Create the Athenian Github App
Once on your GitHub Enterprise deployment, go to the Settings page of the target GitHub organization which will use Athenian. 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: Athenian
Homepage URL: https://app.athenian.co
User authorization callback URL:
Webhook secret: <see in the email>
In order to provide full visibility over your software delivery pipeline, we require the following permissions in read-only mode:
Environments (if available)
Subscribe to events
In this last section, check the following events:
Finally, ensure the app can be installed on any account and click Create GitHub App:
1.2. Take note of the Application details
Once the app created, take note of the following details in a secure place, as you we will need those to finalize the installation on Athenian's side.
On the same page, scroll down to the bottom and Generate a private key.
2. Install Athenian Application
Now that the application is registered, you can install the Athenian App on one or more GitHub organizations.
Go to Install App on the left and select Install the target organizations you want to install Athenian on.
Note: It is also possible to do install the app by going to its Public page.
Both paths will let lead you to a screen where you can choose the repositories you want to install the app on.
3. Provide Athenian with the details of the application
In order to complete the installation on our side, we need you to provide us the following details:
Generated private key
Congratulations! You have successfully installed Athenian on your GitHub Enterprise organization! We will come back to you once your data is loaded.