Skip to content

GH runners

GH runners

x86-64 aarch64 armhf riscv64 · Documentation

This module automates the installation, removal, and status checking of GitHub self-hosted runners for the Armbian project. It supports batch operations and user input through dialog prompts when running interactively.

Install from armbian-config → Software → Armbian → GH runners

CLI install
1
armbian-config --cmd GHR001
  • install
    Installs one or more GitHub runners using the provided configuration or interactively prompted values.
  • purge / remove
    Removes runners based on the provided runner name series and target organization or repository.
  • status
    Quietly checks if any actions.runner services are currently running on the system.
Switch Description
gh_token GitHub token with admin rights to manage self-hosted runners.
runner_name Name prefix for the runner series (default: armbian).
start Start index of the runner series (e.g., 01).
stop End index of the runner series (e.g., 05).
label_primary Labels for the first runner (default: alfa).
label_secondary Labels for additional runners (default: fast,images).
organisation GitHub organization name (default: armbian).
owner GitHub user or organization owner (used for repo-level runners).
repository GitHub repository name (used for repo-level runners).
  • Prompts the user for missing switches via dialog only in interactive mode.
  • Supports bulk installation of runners using sequential numbering (start to stop).
  • Calls internal actions.runner.install and actions.runner.remove helpers.
  • Returns 0 if any runner services are active, 1 otherwise (for scripting use).
  • Suppresses errors and outputs when checking status to remain quiet in background use.

All armbian-config commands

Action Command
Install armbian-config --api module_armbian_runners install
Remove GitHub runners for Armbian automation armbian-config --api module_armbian_runners remove

Part of Armbian’s Armbian infrastructure services software.