Docs · GitHub
Set up the Runex GitHub App.
The Runex GitHub App gives Runex read access to the repositories you choose and sends a webhook on every push and pull request. This page covers installation, repository access, and how webhooks trigger deploys.
- Least-privilege access
- Verified webhooks
- Personal or org accounts
- installed on
- acme · organization
- repository access
- selected · 2 repos
- events
- push · pull_request
- signature
- verified
Definition
What is a GitHub App?
An integration you install on a GitHub account or organization, with permissions you control. It's how Runex can deploy from GitHub without your password or a personal access token.
Unlike a personal access token, a GitHub App isn't tied to one person. It acts on its own identity, with only the permissions and repositories granted at install time.
The Runex GitHub App reads your code to build it and subscribes to push and pull request events so Runex knows when to deploy.
Install
How do you install the Runex GitHub App?
From the Runex dashboard, in under a minute.
- In the Runex dashboard, choose Connect GitHub.
- Pick the personal account or organization that owns the repo.
- Choose Only select repositories and pick the ones to deploy.
- Approve. You return to Runex with those repos available.
Access
Why isn't my repository listed in Runex?
The GitHub App doesn't have access to it yet. Add it in the App's settings on GitHub.
Runex only sees repositories the App was granted. Open GitHub → Settings → Applications (or your organization's settings) → Runex → Configure, then add the repository.
For organization repos, an organization owner may need to approve the installation first.
Webhooks
Which GitHub events trigger a deploy?
Pushes deploy your branch; pull requests create previews. Every webhook's signature is verified first. Each pull request gets a preview deployment with its own URL.
| What Runex does | |
|---|---|
| Push to your deploy branch | Builds and deploys the commit to production |
| Pull request opened | Creates a preview deployment with its own URL |
| New commit on a pull request | Rebuilds that preview |
| Pull request merged or closed | Removes the preview |
FAQ
GitHub App questions
Access, events, and security.
What permissions does the Runex GitHub App request?
Read access to code and metadata for the repositories you select, plus push and pull request events. It can't read repositories you didn't grant.
How do I give Runex access to another repository?
On GitHub, open the Runex app's installation settings, choose Configure, and add the repository under repository access.
How does Runex verify GitHub webhooks?
Each webhook carries a signature computed with a shared secret. Runex recomputes it and rejects any request that doesn't match.
What happens if I uninstall the Runex GitHub App?
Runex can no longer read the repositories or receive webhooks, so new pushes won't deploy. Running apps keep serving their current version.
Next step
Connect GitHub.
Install the App on one repository and deploy it.