Forgejo Runner Guide

Forgejo Runner is a program that fetches workflows to run from a Forgejo instance and executes them. It is installed and configured separately from Forgejo.

To get started with Forgejo Runner:

1. Install Forgejo Runner
   • using a binary installation, or
   • using a Docker container, or
   • using Linux distribution packaged binaries.
2. Register Forgejo Runner to connect it to Forgejo,
3. Configure Forgejo Runner to define what jobs it executes and how it operates.
   • Choosing labels for the runner is the minimum required configuration.

A single Forgejo Runner can be connected to multiple Forgejo instances, or different users, organizations, or repositories within a single instance. Multiple Forgejo Runner installations can be connected to a single Forgejo instance to distribute jobs over a cluster of available compute resources.

Forgejo Runner performs remote code execution. That poses significant security threats for the host and network that it operates upon. Securing Forgejo Actions Deployments walks through the security considerations and choices that an administrator should be aware of.

To build container images in workflows or run actions that use Docker, additional configuration is required.