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.
Prerequisite
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.
Variable definitions
$GITHUB_URL: Hostname where GitHub is hosted
$AV_HOSTNAME: Hostname where Aviator is hosted (e.g. aviator.example.com)
$GITHUB_APP_ID: ID generated when a GitHub app is created
$MERGEQUEUE_PEM_FILE: Private key generated by GitHub for Aviator
Steps
Step 1
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:https://$GITHUB_URL/settings/apps
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.
Homepage URL: https://aviator.co/​
Callback URL: https://$AV_HOSTNAME/api/setup/complete
Expire user authorization tokens: YES
Request user authorization (OAuth) during installation: NO
Enable Device Flow: NO
Setup URL: https://$AV_HOSTNAME/api/setup/complete
Redirect on update: YES
Webhook
Active: YES
Webhook URL: https://$AV_HOSTNAME/api/webhook
Webhook Secret: Optional. If you setup Webhook secret, you should also define set that at GITHUB_WEBHOOK_SECRET to validate webhook signature.
Permissions:
Please review the following carefully, any mismatch here could result in unexpected behavior of the app.
Repository permissions
Name
Access
Administration
Read-only
Checks
Read and write
Commit statuses
Read-only
Contents
Read and write
Issues
Read and write
Metadata
Read-only
Pull requests
Read and write
Workflows
Read and write
Organization permissions
Name
Access
Members
Read-only
Subscribe to events:
Check the followings
Branch Protection rules
Check Run
Check Suite
Issue Comment
Label
Member
Public
Pull request
Pull request review
Pull request review comment
Pull request review thread
Push
Status
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.
Step 2
From the GitHub app page for Aviator, take a note of the App ID specified on the top. This is your $GITHUB_APP_ID.
Step 3
Generate a private key from the bottom of the page. This is your $MERGEQUEUE_PEM_FILE.

Name	Access
Administration	Read-only
Checks	Read and write
Commit statuses	Read-only
Contents	Read and write
Issues	Read and write
Metadata	Read-only
Pull requests	Read and write
Workflows	Read and write

Name	Access
Members	Read-only

Manage - Previous

On-premise Installation

Use Helm

Last modified 24d ago