Quick Start

⚡ Prerequisites

🚀 5-Minute Setup

Step 1: Clone the Repository (30 seconds)

git clone https://github.com/GrammaTonic/github-runner.git
cd github-runner

Step 2: Configure Environment (2 minutes)

# Copy configuration example
# Copy the example environment file into a working runner.env before editing
cp config/runner.env.example config/runner.env
# Edit with your settings
nano config/runner.env

GITHUB_TOKEN=ghp_your_personal_access_token_here
GITHUB_REPOSITORY=your-username/your-repository

Step 3: Deploy Runner (2 minutes)

# Standard runner (most common)
docker compose -f docker/docker-compose.production.yml up -d
# Chrome runner (for UI testing)
docker compose -f docker/docker-compose.chrome.yml up -d
# Check status
docker compose -f docker/docker-compose.production.yml logs github-runner

Step 4: Verify in GitHub (30 seconds)

✅ Test Your Runner

# .github/workflows/test-runner.yml
name: Test Self-Hosted Runner
on:
 workflow_dispatch:
jobs:
 test:
 runs-on: self-hosted
 steps:
 - name: Test runner
 run: |
 echo "🎉 Self-hosted runner is working!"
 docker --version
 git --version

🔧 Common Quick Fixes

Runner not appearing?

# Check logs
docker compose logs runner
# Verify token permissions
curl -H "Authorization: token YOUR_TOKEN" https://api.github.com/user

Permission denied errors?

# Add user to docker group
sudo usermod -aG docker $USER
newgrp docker

Out of space?

# Clean up Docker
docker system prune -a -f

🎯 What's Next?

💡 Quick Tips

📞 Need Help?

📝 Documentation Parity & Recent Improvements (2025年11月14日)