Comment on page
GitHub App for On-Prem
On-Prem installation requires a GitHub App. This page describes how to create one for your on-prem setup.
- You need to have the priviledge to create a GitHub App and authorize the app for your repositories.
- A domain name that will be used for your on-prem installation.
$GITHUB_URL: Hostname where GitHub is hosted
$AV_HOSTNAME: Hostname where Aviator is hosted (e.g.
$GITHUB_APP_ID: ID generated when a GitHub app is created
$MERGEQUEUE_PEM_FILE: Private key generated by GitHub for Aviator
Go to GitHub Developer settings and Click “New GitHub App”.
Click Developer settings on the Settings page
Click New GitHub App button
The developer settings can be found through your user settings or url of the format:
Use the following settings to create the app:
GitHub App name: Aviator
Description: Automate merge workflows for GitHub, manage queues in teams and improve code quality.
Expire user authorization tokens: YES
Request user authorization (OAuth) during installation: NO
Enable Device Flow: NO
Redirect on update: YES
Webhook Secret: Optional. If you setup Webhook secret, you should also define set that at
GITHUB_WEBHOOK_SECRETto validate webhook signature.
Please review the following carefully, any mismatch here could result in unexpected behavior of the app.
Subscribe to events:
Check the followings
- Branch Protection rules
- Check Run
- Check Suite
- Issue Comment
- Pull request
- Pull request review
- Pull request review comment
- Pull request review thread
Where can GitHub App be installed: Any account
After creating the GitHub app, you can add a logo. Find a copy of Aviator Logo in the attached assets.
From the GitHub app page for Aviator, take a note of the App ID specified on the top. This is your
Generate a private key from the bottom of the page. This is your