Welcome to the comprehensive documentation for the GitHub Actions Self-Hosted Runner project!

• Home - Overview and quick start
• Installation Guide - Step-by-step installation
• Quick Start - Get up and running in 5 minutes
• System Requirements - Hardware and software requirements

• Environment Configuration - Environment variables and settings
• Docker Configuration - Docker and Docker Compose setup
• Security Configuration - Security policies and token management
• Network Configuration - Networking and firewall setup

• Local Development - Development environment setup
• Production Deployment - Production-ready deployment
• Multi-Environment Setup - Dev, staging, and production environments
• Scaling and Load Balancing - Auto-scaling and load distribution

• Health Monitoring - Health checks and monitoring setup
• Prometheus Metrics - Metrics collection and alerting
• Grafana Dashboards - Visualization and dashboards
• Log Management - Centralized logging and analysis
• Backup and Recovery - Data protection strategies

• Common Issues - Frequently encountered problems
• Debugging Guide - Step-by-step debugging procedures
• Performance Tuning - Optimization techniques
• Error Codes - Complete error reference

• Custom Docker Images - Building custom runner images
• CI/CD Integration - Pipeline integration patterns
• API Reference - REST API documentation
• Architecture Deep Dive - Technical architecture details

• Contributing - How to contribute to the project
• Development Workflow - Development processes and standards
• Testing Strategy - Testing approaches and frameworks
• Release Process - Version management and releases

• Installation Guide - Start here for first-time setup
• Docker Configuration - Essential Docker setup
• Production Deployment - Production checklist
• Common Issues - Troubleshooting help

• GitHub Actions Documentation
• Self-Hosted Runners Guide
• Docker Documentation
• Docker Compose Reference

Found something missing or incorrect? We welcome contributions to improve this documentation:

1. Visit the main repository
2. Open an issue or submit a pull request
3. Help us keep the documentation accurate and up-to-date

Last updated: September 4, 2025