Skip to main content
Connect your GitHub account to Nixopus for seamless, automatic deployments every time you push code.

​
Why Connect GitHub?

  • Automatic Deployments - Push to your branch, we deploy automatically
  • Branch Selection - Deploy from any branch in your repository
  • Repository Browser - Browse and select from all your repositories
  • No Manual Uploads - We pull your code directly from GitHub

​
Connecting Your GitHub Account

1

Go to Onboarding or Settings

From your dashboard, navigate to the onboarding page or click on Repositories tab
2

Click Connect GitHub

Click the Connect Repository button
3

Authorize Nixopus

You’ll be redirected to GitHub. Review the permissions and click Authorize
4

Select Repositories

Choose which repositories Nixopus can access - all repositories or select specific ones
5

Complete Installation

You’ll be redirected back to Nixopus with your repositories ready to deploy

​
Selecting a Repository

Once connected, you’ll see your repositories in a searchable grid:
  • Search - Find repositories by name
  • Sort - Order by name, stars, or last updated
  • Filter - View public or private repositories
Click on any repository card to start creating a project.

​
Repository Information

Each repository card shows:
InfoDescription
NameRepository name
DescriptionRepository description from GitHub
VisibilityPublic or Private badge
LanguagePrimary programming language
StarsGitHub star count
ForksNumber of forks
TopicsRepository topics/tags

​
Creating a Project from a Repository

After selecting a repository:
  1. Project Name - Give your project a unique name
  2. Branch - Select which branch to deploy (e.g., main, develop)
  3. Build Pack - Choose Dockerfile or Docker Compose
  4. Domain - Optionally add a custom domain
We automatically detect branches from your repository. Make sure the branch you want to deploy exists and has a Dockerfile.

​
Automatic Deployments

Once your project is created and linked to GitHub:
  1. Push code to your configured branch
  2. Nixopus receives a webhook notification
  3. A new deployment is automatically triggered
  4. View the deployment progress in your dashboard

​
Managing GitHub Connections

​
View Connected Accounts

Go to Settings > Connectors to see your GitHub connections:
  • Installation ID
  • Connection status (Connected/Not Connected)

​
Disconnect GitHub

To disconnect your GitHub account:
  1. Go to Settings > Connectors
  2. Remove the connector from Nixopus
  3. Optionally, revoke access from GitHub Settings > Applications
Disconnecting GitHub will stop automatic deployments for all projects linked to that account. You can still deploy manually using the CLI.

​
Permissions Required

Nixopus requests the following GitHub permissions:
PermissionWhy We Need It
Repository AccessRead your code to build and deploy
WebhooksReceive push notifications for auto-deploy
MetadataDisplay repository information in your dashboard
We never:
  • Write to your repositories
  • Access your personal GitHub data
  • Share your code with third parties

​
Troubleshooting

​
Repositories Not Showing

  1. Make sure you authorized Nixopus in GitHub
  2. Check that you selected the repositories you want to access
  3. Try disconnecting and reconnecting your GitHub account

​
Webhooks Not Working

  1. Verify your project is linked to the correct branch
  2. Check that the repository has Nixopus webhooks enabled in GitHub Settings
  3. View deployment history to see if builds are being triggered

​
Private Repositories

Private repositories work exactly like public ones - just make sure you selected them during the GitHub authorization step.