Your first job
Send a job here
Section titled “Send a job here”In a workflow of a repository runnerd.toml serves:
jobs: build: runs-on: [self-hosted, linux, x64]A job runs here only when every label in its runs-on is in its repository’s labels in runnerd.toml. Other jobs, such as runs-on: ubuntu-latest, stay on GitHub’s runners. To send some jobs of a repository to a smaller runner, see Split light and heavy jobs.
Push, then watch it start:
runnerctl status # slots, queues, and why each queued job waitsrunnerctl web # the dashboard, signed inrunnerctl tui # the same in the terminalA job that waits says why. Why is my job waiting? lists the reasons.
The service
Section titled “The service”runnerd init writes a user unit that runs runnerd serve:
[Unit]Description=runnerd: ephemeral GitHub Actions runnersDocumentation=https://ayagmar.github.io/runnerd/
[Service]Type=execExecStart="/home/dana/.local/bin/runnerd" serve --config "/home/dana/.config/runnerd/runnerd.toml"Restart=on-failureRestartSec=10
[Install]WantedBy=default.targetsystemctl --user enable --now runnerd # start now and at loginloginctl enable-linger "$USER" # keep it running while you are logged outjournalctl --user -u runnerd -f # its logsystemctl --user restart runnerd # after editing runnerd.toml by handsystemctl --user stop runnerd # exits within 45s; running jobs carry onsystemctl stop, SIGTERM and SIGINT remove idle and warm runners and exit within 45 seconds, even if Docker or GitHub do not answer. Runners of running jobs and the registry mirror stay up for the next start to adopt; meanwhile those jobs restore and save nothing in the caches runnerd serves. A second signal kills running jobs.
runnerd stop waits for running jobs, then removes every runner and the mirror, so nothing is left behind. runnerd stop --force kills running jobs instead.
A config saved through the dashboard applies without a restart; Reloading says what waits for one.