mirror of
https://github.com/actions/runner.git
synced 2025-12-11 04:46:58 +00:00
3.1 KiB
3.1 KiB
GitHub Actions Runner Documentation
Welcome to the GitHub Actions Runner documentation. This guide will help you get started with self-hosted runners, contribute to the project, and troubleshoot common issues.
🚀 Getting Started
Installation and Setup
- Linux Prerequisites - Complete setup guide for Linux systems
- Windows Prerequisites - Complete setup guide for Windows systems
- macOS Prerequisites - Complete setup guide for macOS systems
Quick Start
- Download the latest runner release
- Follow the platform-specific prerequisites guide above
- Configure your runner with
./config.sh(Linux/macOS) or.\config.cmd(Windows) - Start the runner with
./run.sh(Linux/macOS) or.\run.cmd(Windows)
🔧 Administration and Automation
- Automation Scripts - Automate runner deployment and management
- Troubleshooting Guides - Common issues and solutions
🏗️ Development and Contributing
- Contributing Guide - Development setup, building, and testing
- Architecture Decision Records - Important architectural decisions and design patterns
📋 Reference Materials
System Checks and Troubleshooting
- Network Connectivity - Troubleshoot network issues
- Git Configuration - Git-related problems
- Actions Troubleshooting - Action-specific issues
- SSL Certificate Issues - Certificate and TLS problems
- Node.js Issues - Node.js runtime problems
- Internet Connectivity - General connectivity issues
Development Resources
- Visual Studio Code Setup - IDE configuration for development
- Design Documentation - Technical design documents
🆘 Getting Help
Community Support
- GitHub Community Discussions - Ask questions and get help from the community
- GitHub Support - Report critical bugs or get professional support
Reporting Issues
- Bug Reports: Open an issue in this repository
- Feature Requests: Use GitHub Community Discussions
- Security Issues: Follow our security policy
📖 Additional Resources
- GitHub Actions Documentation - Official GitHub Actions documentation
- Self-hosted Runners Guide - GitHub's official self-hosted runner documentation
- Runner Releases - Download the latest runner versions
Note
: This documentation is maintained by the GitHub Actions team and the community. If you find any issues or have suggestions for improvement, please open an issue or contribute a pull request.