This setup is based on https://forgejo.org/docs/latest/admin/actions/runner-installation/#oci-image-installation
- Just 86.2%
- Shell 13.8%
| compose.yaml | ||
| justfile | ||
| README.md | ||
| setup-helper.sh | ||
Forgejo Runner
A Docker-based Forgejo Runner using Docker-in-Docker (DinD) for isolated job execution.
Prerequisites
- Docker with Compose
- just command runner
- Nushell (used as the shell for just)
- A Forgejo instance runner registration token (obtained from your Forgejo site admin or repository/org settings under Actions → Runners)
Setup
Run the setup command with a name for the runner and your registration token:
just setup <runner-name> <registration-token> [instance-url]
| Parameter | Description | Default |
|---|---|---|
runner-name |
Name to register the runner under | (required) |
registration-token |
Token from your Forgejo instance's Actions settings | (required) |
instance-url |
URL of the Forgejo instance | https://git.astrago.de/ |
This will:
- Create the required
data/directory with correct permissions - Pull the Docker images
- Generate the runner configuration (
data/config.yml) - Register the runner with the Forgejo instance
- Start the runner
Usage
| Command | Description |
|---|---|
just start |
Pull images and start the runner |
just stop |
Stop the runner |
just pull |
Pull latest Docker images |
just logs |
View container logs |
just uninstall |
Stop the runner and delete all data |