01
Get started
Install GitRun, connect a repository, and verify the host.
GitRun / Handbook
Documentation that gets you running.
Start with installation, then follow the architecture and security guides as you bring your own runners online. The handbook reads from the project repository, so it stays aligned with the source of truth.
LEARNING PATHS
Choose what you need to do
Four focused paths, from first install to the details needed to operate a secure runner host.
02
Understand the system
Learn how jobs, runners, containers, and the control plane fit together.
03
Security boundaries
Review secrets, runner policy, workflow checks, and recovery.
04
Workflow operations
Use the named Git*Run API and understand optional Kitty scheduling.
REPOSITORY INDEX
All documentation files
Live listing of Markdown files in docs/ on main.
Files in docs/ on main
Listing the folder…
Core reference pages
Direct links to the project's most useful guides.
- Repository guideWhat it does, requirements, install, first steps.README.md
- ArchitectureThe system and its trust boundaries.docs/ARCHITECTURE.md
- Workflow APIThe closed Git*Run operations and their rules.docs/GITRUN_API.md
- Virtual machinesRouting a job to KVM, libvirt, or VirtualBox.docs/VM.md
- Security modelWhat is protected, and what is still your job.docs/SECURITY_MODEL.md
- KittyThe optional scheduler. It is not an LLM, and it is off.docs/SMART_SCHEDULER.md
- SupportHow to diagnose a problem and where to report it.SUPPORT.md
- Security policyHow to report a vulnerability.SECURITY.md