Connecting a GitHub repo
Connecting a GitHub repo
Before you can deploy with Orbit, you need to connect your GitHub account and grant Kapsule access to the repositories you want to deploy.
Step 1, Install the Kapsule Orbit GitHub App
- In KPanel, go to Orbit in the left sidebar
- Click New project
- On the provider selection screen, click Connect GitHub
You'll be redirected to GitHub to install the Kapsule Orbit GitHub App. On that page, choose whether to grant access to All repositories or Only select repositories. You can change this at any time from your GitHub settings.
Tip: If you only want Orbit to access specific repos, choose Only select repositories and tick the ones you need. You can add more repos later without reconnecting.
After installing, GitHub redirects you back to KPanel with your repositories loaded.
Step 2, Select a repository
Once connected, your accessible repositories appear in a list. Click Select next to the repo you want to deploy.
Private repositories are labelled Private. Orbit can deploy both public and private repos.
If you don't see a repository you expect:
- Click Manage on GitHub to open your GitHub App settings
- Grant access to the missing repo
- Return to KPanel, the repo list refreshes automatically
Step 3, Configure your project
After selecting a repo, fill in:
| Field | What it does |
|---|---|
| Project Name | Display name in KPanel (e.g. my-app) |
| Deploy URL | The subdomain for your project under kaps.run (e.g. my-app.kaps.run) |
The deploy URL slug is set once at creation. You can attach your own domain later from the Domain tab.
Click Create project. Orbit clones your repository, queues your first build, and you land on the project overview.
Reconnecting or changing your GitHub installation
If you need to revoke access or change which repos are accessible:
- Go to any project, then Settings
- Under the Git integration section, click Reconnect to re-run the GitHub App install flow
- Or go to github.com/settings/installations and manage the Kapsule Orbit app directly
Disconnecting GitHub
To disconnect your GitHub account from Orbit entirely, go to Settings on any project and click Disconnect. This removes the OAuth link but does not delete your projects or their deployment history.
Note: Disconnecting GitHub stops future push-triggered deployments. Existing deployments continue to serve traffic.
