Back to documentation
Deployment

Deploying from GitHub Repository

Deploy your own applications directly from GitHub with automatic framework detection.

Intermediate8 min readUpdated 2024-02-01

Connect GitHub

First, connect your GitHub account:

  1. Go to Settings > GitHub
  2. Click "Connect GitHub"
  3. Authorize Server Compass via OAuth
  4. Your repositories are now accessible

You can connect multiple GitHub accounts (personal and organization).

Select repository

  1. Click "Deploy New App"
  2. Select "GitHub" as the source
  3. Choose your GitHub account
  4. Search or browse your repositories
  5. Select the repository to deploy

Configure deployment

Server Compass auto-detects your framework and suggests:

  • Build command: npm run build, etc.
  • Start command: npm start, etc.
  • Dockerfile: Generated or detected

You can customize:

  • Branch to deploy
  • Environment variables
  • Build arguments
  • Port configuration

Build options

Choose your build method:

  • Server-side build: Build on your VPS (uses server resources)
  • GitHub Actions: Build using GitHub's free CI minutes (recommended)

GitHub Actions builds keep your server resources free for running apps.

Deploy and monitor

  1. Review your configuration
  2. Click "Deploy"
  3. Watch build logs in real-time
  4. Monitor deployment progress
  5. Access your app when complete

Screenshots

Deploying from GitHub Repository - Screenshot 1
Deploying from GitHub Repository - Screenshot 2
Deploying from GitHub Repository - Screenshot 3

Screenshots may vary slightly from the current version

Video Tutorials

Related Features

Ready to try Server Compass?

Download the app and deploy your first application in under 5 minutes. No terminal knowledge required.