GitHub Runner

Development2048MB+ RAM

Self-hosted GitHub Actions runner for CI/CD pipelines

Download Server Compass Install GitHub Runner to VPS

ci-cdgithubrunneractionsdevops

Deploy GitHub Runner in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select GitHub Runner

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Step-by-step deployment guide

Deploy GitHub Runner on a VPS with Server Compass

Use the GitHub Runner template in Server Compass to deploy a clean, ready-to-register GitHub Actions runner service on your VPS, then verify the official runner scripts before registering it with GitHub.

About 10 minutesBrowser verified

Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a GitHub Runner app

Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template

Step 3

Search for GitHub Runner

Use the template picker search to find GitHub Runner in the Server Compass template catalog.

Searching for GitHub Runner in the Server Compass template picker

Step 4

Select the GitHub Runner template

Choose the GitHub Runner template. Server Compass fills the official runner image, the persistent work directory volume, and the Docker socket mount.

GitHub Runner template selected in Server Compass

Step 5

Review the GitHub Runner settings

Confirm the app name and compose services. In this run, the app was named github-runner-demo; GitHub Runner does not expose a public web port by default.

Reviewing GitHub Runner project settings and compose service

Step 6

Deploy GitHub Runner

Review the generated compose settings, confirm the runner service and work volume, and click Deploy.

Reviewing GitHub Runner compose services before deployment

Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the GitHub Runner image, starts the container, and verifies the stack.

Server Compass deploying the GitHub Runner template on the VPS

Step 8

Confirm GitHub Runner is running

After deployment finishes, return to the Apps tab and confirm the GitHub Runner app is marked Running.

GitHub Runner template running in the Server Compass Apps tab

Step 9

Verify GitHub Runner from the container

Verify the runner container is running, the official config and run scripts are present, the runner help output reports a version, and the Docker socket and work directory are ready for registration.

GitHub Runner service verification output from logs

After GitHub Runner Opens

Register the runner with a GitHub repository, organization, or enterprise runner registration token.
Choose labels and protected-runner settings for trusted workloads only.
Avoid sharing this runner with untrusted public projects because it has Docker socket access.
Back up the runner work volume and recreate registration when rotating runner tokens or moving hosts.

Verified Result

The runner container was running, `/home/runner/config.sh` and `/home/runner/run.sh` were executable, `config.sh --help` reported the installed runner version, and both the persistent work directory and Docker socket were available.

Download Server Compass Docs

GitHub Runner deployment questions

What does the GitHub Runner template deploy?

It deploys GitHub's official actions-runner container with a persistent work directory and Docker socket access, ready for manual registration after deployment.

Which port did the tutorial use?

GitHub Runner does not expose a public web port in this template. Verification happens through container status, runner script checks, version/help output, and Docker socket readiness.

Does GitHub Runner need setup after deployment?

Yes. The template starts a ready-to-register service, then you generate a short-lived registration token in GitHub and run `./config.sh --url ... --token ...` inside the container.

Should this become a blog post?

No. The deployment guide should live on the GitHub Runner template detail page and be linked from the reusable template deployment docs page.

Why Self-Host GitHub Runner?

Self-hosted GitHub Actions runners give you full control over your CI/CD compute — custom hardware, pre-installed dependencies, and access to private network resources. No more waiting in shared runner queues or worrying about GitHub's usage limits.

No GitHub Actions minutes limits — run unlimited builds

Custom hardware — use GPUs, ARM, or high-memory servers

Access private network resources during builds

Pre-installed dependencies for faster build times

Full control over the build environment and caching

GitHub Runner vs Alternatives

GitHub Runner vs GitHub-hosted runners

GitHub runners have usage limits and run on shared hardware. Self-hosted runners offer unlimited builds on your own infrastructure.

GitHub Runner vs GitLab Runner

GitLab Runner requires GitLab. GitHub Runner works with GitHub Actions, the most popular CI/CD platform.

GitHub Runner vs Jenkins

Jenkins is a full CI/CD server. GitHub Runner integrates natively with GitHub Actions without managing a separate system.

Why Deploy GitHub Runner with Server Compass?

Server Compass deploys the GitHub Actions runner container with persistent work directories. Configure your runner token and it automatically registers with your repository or organization.

Download Server Compass

After Deployment

After deploying GitHub Runner with Server Compass, complete these steps to finish setup

Configure runner token from GitHub repo/org settings

Verify runner appears in GitHub

Create workflows targeting self-hosted runner

Need help? Check out our documentation for detailed guides.

GitHub Runner FAQ

Common questions about self-hosting GitHub Runner

How do I deploy GitHub Runner with Server Compass?

Simply download Server Compass, connect to your VPS, and select GitHub Runner from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for GitHub Runner?

GitHub Runner requires a minimum of 2048MB RAM. We recommend a VPS with at least 4096MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing GitHub Runner data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard GitHub Runner backup and restore procedures.

How do I update GitHub Runner to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest GitHub Runner image will be pulled and deployed with zero downtime.

Is GitHub Runner free to self-host?

GitHub Runner is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Related Templates

View all Development

PocketBase

Open-source backend in a single file with realtime database, auth, and file storage

Appwrite

Open-source backend-as-a-service - self-hosted Firebase alternative

Parse Server

Open-source backend framework with dashboard

Supabase

Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio

Ready to Self-Host GitHub Runner?

Download Server Compass and deploy GitHub Runner to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass