Skip to content

GitHub App Setup

Create and configure the GitHub App that GitWire uses to interact with your repositories.

Step 1: Create the App

  1. Go to GitHub Settings → Developer Settings → GitHub Apps → New GitHub App
  2. Fill in the basic info:
FieldValue
GitHub App nameGitWire HQ (or your preferred name)
Homepage URLhttps://gitwire.yourdomain.com
Webhook URLhttps://gitwire.yourdomain.com/webhooks/github
Webhook secretA random string (save this for .env)
  1. Under Where can this GitHub App be installed? choose:
    • Any account (if you want to install on multiple orgs)
    • Only on this account (for personal use only)

Step 2: Set Permissions

Under Permissions → Repository permissions, set:

PermissionAccessWhy
ActionsRead & writeRead CI run results, trigger re-runs
AdministrationRead & writeManage branch protection, repo settings
ChecksRead & writeCreate Check Runs on PRs
ContentsRead & writeRead files for AI fixes, create branches, commit
IssuesRead & writeTriaging, labeling, commenting, closing
MetadataRead-onlyBasic repo info (required)
Pull requestsRead & writeReview, merge, comment, create PRs
StatusesRead-onlyRead commit statuses
WorkflowsRead & writeTrigger and manage GitHub Actions

Under Permissions → Organization permissions, set:

PermissionAccessWhy
MembersRead-onlySync org members
AdministrationRead & writeManage org-level settings

Step 3: Subscribe to Events

Under Subscribe to events, check:

  • Issue comment/gitwire commands in comments
  • Issues — New issues for triage
  • Pull request — PR triage, AI review
  • Pull request review — Review feedback
  • Push — Config validation on push
  • Repository — Detect new/deleted repos
  • Workflow run — CI healing on failures

Step 4: Generate Private Key

After creating the app:

  1. Scroll to Private keys
  2. Click Generate a private key
  3. Save the .pem file — this is your GITHUB_PRIVATE_KEY_PATH

Step 5: Note Your App ID

Copy the App ID from the top of the app settings page. This is your GITHUB_APP_ID.

Step 6: Install the App

  1. In the left sidebar, click Install App
  2. Click Install on the account or org where you want it
  3. Choose All repositories or Only select repositories
  4. After installation, note the installation ID from the URL

Step 7: Configure GitWire

Add these values to your .env:

bash
GITHUB_APP_ID=3727207
GITHUB_APP_CLIENT_ID=Iv1.xxxxxxx
GITHUB_APP_CLIENT_SECRET=your-client-secret
GITHUB_WEBHOOK_SECRET=your-webhook-secret
GITHUB_PRIVATE_KEY_PATH=/opt/gitwire/secrets/gitwire-hq.private-key.pem

Verifying

After deployment, push a test issue to any installed repo. You should see a webhook delivery in the GitWire dashboard under Webhooks.

Next Step

Environment Variables Reference

Released under the MIT License.