diff --git a/ct/github-actions-runner.sh b/ct/github-actions-runner.sh new file mode 100644 index 0000000000..d5ed89d92e --- /dev/null +++ b/ct/github-actions-runner.sh @@ -0,0 +1,186 @@ +#!/usr/bin/env bash +_CS_DEFAULT_URL="https://raw.githubusercontent.com/community-scripts/DevScripts/main" +_cs_boot="${COMMUNITY_SCRIPTS_CORE_DIR:-$(dirname "${BASH_SOURCE[0]}")/../../core}/core/build.func" +source "$_cs_boot" 2>/dev/null || source <(curl -fsSL "${COMMUNITY_SCRIPTS_CORE_URL:-https://raw.githubusercontent.com/community-scripts/core/main}/core/build.func") + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: Baker (Baker) +# License: MIT | https://github.com/community-scripts/DevScripts/raw/main/LICENSE +# Source: https://github.com/actions/runner + +APP="GitHub-Actions-Runner" +var_tags="${var_tags:-ci;github;actions}" +var_cpu="${var_cpu:-4}" +var_ram="${var_ram:-12288}" +var_disk="${var_disk:-40}" +var_os="${var_os:-debian}" +var_version="${var_version:-13}" +var_arm64="${var_arm64:-yes}" +var_unprivileged="${var_unprivileged:-1}" +# Workflow jobs start containers, so the LXC needs nesting and keyctl. +var_nesting="${var_nesting:-1}" +var_keyctl="${var_keyctl:-1}" + +header_info "$APP" +variables +color +catch_errors + +# A personal GitHub account cannot share one registration across repositories, +# and each runner process takes one job. Ask on the host, before the container +# exists, so a bad token never creates an LXC. Updates run inside the container +# and only refresh binaries, so they skip this. +_cs_platform="" +declare -f detect_lxc_platform >/dev/null 2>&1 && _cs_platform="$(detect_lxc_platform)" +if [[ "${_cs_platform}" != "container" && "${_cs_platform}" != "incus-container" ]]; then + if is_unattended; then + var_runner_count="${var_runner_count:-2}" + var_runner_name="${var_runner_name:-github-runner}" + if [[ -z "${var_gh_owner:-}" || -z "${var_gh_repos:-}" || -z "${var_gh_token:-}" ]]; then + msg_error "Unattended install needs var_gh_owner, var_gh_repos, and var_gh_token" + exit 1 + fi + else + if [[ -z "${var_gh_owner:-}" ]]; then + var_gh_owner="$(prompt_input_required "GitHub owner" "UNSET" 180 "var_gh_owner")" + fi + if [[ -z "${var_gh_repos:-}" ]]; then + var_gh_repos="$(prompt_input_required "Repositories, comma-separated" "UNSET" 180 "var_gh_repos")" + fi + if [[ -z "${var_gh_token:-}" ]]; then + var_gh_token="$(prompt_password "GitHub token with Administration on each repository" "" 180 20)" + fi + if [[ -z "${var_runner_count:-}" ]]; then + var_runner_count="$(prompt_input "Runners per repository" "2" 120)" + fi + if [[ -z "${var_runner_name:-}" ]]; then + var_runner_name="$(prompt_input "Runner name prefix" "github-runner" 120)" + fi + fi + + var_gh_repos="${var_gh_repos//[[:space:]]/}" + var_runner_count="${var_runner_count:-2}" + var_runner_name="${var_runner_name:-github-runner}" + + if [[ "${var_gh_owner}" == "UNSET" || ! "${var_gh_owner}" =~ ^[A-Za-z0-9][A-Za-z0-9._-]*$ ]]; then + msg_error "GitHub owner is invalid" + exit 1 + fi + if [[ -z "${var_gh_repos}" || "${var_gh_repos}" == "UNSET" || "${var_gh_repos}" == *,,* || "${var_gh_repos}" == ,* || "${var_gh_repos}" == *, ]]; then + msg_error "At least one repository is required" + exit 1 + fi + if [[ -z "${var_gh_token}" ]]; then + msg_error "GitHub token is required" + exit 1 + fi + if [[ ! "${var_runner_count}" =~ ^[1-9][0-9]*$ ]]; then + msg_error "Runners per repository must be a positive integer" + exit 1 + fi + if [[ ! "${var_runner_name}" =~ ^[A-Za-z0-9][A-Za-z0-9._-]*$ ]]; then + msg_error "Runner name is invalid" + exit 1 + fi + + command -v curl >/dev/null 2>&1 || { + msg_error "curl is required on the host" + exit 1 + } + IFS=',' read -r -a _gh_repos <<< "${var_gh_repos}" + for _gh_repo in "${_gh_repos[@]}"; do + [[ "${_gh_repo}" == */* ]] || _gh_repo="${var_gh_owner}/${_gh_repo}" + if [[ ! "${_gh_repo}" =~ ^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$ ]]; then + msg_error "Repository name is invalid" + exit 1 + fi + _gh_http="$(curl --connect-timeout 10 --max-time 30 -sS -o /dev/null -w '%{http_code}' -X POST \ + -H "Accept: application/vnd.github+json" \ + -H "Authorization: Bearer ${var_gh_token}" \ + -H "X-GitHub-Api-Version: 2022-11-28" \ + "https://api.github.com/repos/${_gh_repo}/actions/runners/registration-token" || true)" + if [[ "${_gh_http}" != "201" ]]; then + msg_error "GitHub refused a registration token for ${_gh_repo} (HTTP ${_gh_http}). The token needs Administration on that repository." + exit 1 + fi + done + unset _gh_repos _gh_repo _gh_http +fi + +export var_gh_owner="${var_gh_owner:-}" +export var_gh_repos="${var_gh_repos:-}" +export var_gh_token="${var_gh_token:-}" +export var_runner_count="${var_runner_count:-2}" +export var_runner_name="${var_runner_name:-github-runner}" + +update_deb_based() { + if [[ ! -x /opt/actions-runner/config.sh ]]; then + msg_error "No ${APP} Installation Found!" + exit 1 + fi + + local unit dest + if check_for_gh_release "github-actions-runner" "actions/runner"; then + msg_info "Stopping GitHub Actions Runner" + shopt -s nullglob + for unit in /etc/systemd/system/actions-runner-*.service; do + systemctl stop "$(basename "${unit}")" + done + shopt -u nullglob + msg_ok "Stopped GitHub Actions Runner" + + # Registrations live in /opt/actions-runners and must survive this wipe. + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "github-actions-runner" "actions/runner" "prebuild" "latest" "/opt/actions-runner" "actions-runner-linux-$(arch_resolve "x64" "arm64")-*.tar.gz" + + msg_info "Updating runner copies" + shopt -s nullglob + for dest in /opt/actions-runners/*/; do + cp -a /opt/actions-runner/. "${dest}" + done + shopt -u nullglob + msg_ok "Updated runner copies" + + if [[ -x /opt/actions-runner/bin/installdependencies.sh ]]; then + msg_info "Installing runner dependencies" + $STD /opt/actions-runner/bin/installdependencies.sh + msg_ok "Installed runner dependencies" + elif [[ -x /opt/actions-runner/installdependencies.sh ]]; then + msg_info "Installing runner dependencies" + $STD /opt/actions-runner/installdependencies.sh + msg_ok "Installed runner dependencies" + fi + + msg_info "Starting GitHub Actions Runner" + shopt -s nullglob + for unit in /etc/systemd/system/actions-runner-*.service; do + systemctl start "$(basename "${unit}")" + done + shopt -u nullglob + msg_ok "Started GitHub Actions Runner" + msg_ok "Updated successfully!" + fi + exit +} + +function update_script() { + header_info + check_container_storage + check_container_resources + run_os_update +} + +start +build_container +description + +msg_ok "Completed Successfully!\n" +echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}" +if [[ -n "${var_gh_repos:-}" ]]; then + echo -e "${INFO}${YW}Runner settings:${CL}" + IFS=',' read -r -a _gh_repos <<< "${var_gh_repos//[[:space:]]/}" + for _gh_repo in "${_gh_repos[@]}"; do + [[ "${_gh_repo}" == */* ]] || _gh_repo="${var_gh_owner}/${_gh_repo}" + echo -e "${TAB}${BGN}https://github.com/${_gh_repo}/settings/actions/runners${CL}" + done +fi +echo -e "${INFO}${YW}Jobs on this container share one network namespace. A workflow that publishes a fixed host port will collide with a second job that publishes the same port.${CL}" diff --git a/install/github-actions-runner-install.sh b/install/github-actions-runner-install.sh new file mode 100644 index 0000000000..f5908d4106 --- /dev/null +++ b/install/github-actions-runner-install.sh @@ -0,0 +1,184 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: Baker (Baker) +# License: MIT | https://github.com/community-scripts/DevScripts/raw/main/LICENSE +# Source: https://github.com/actions/runner + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +setup_deb_based() { + local repos=() repo owner_repo unit i dest name reg_file reg_token http_code dep + + var_gh_repos="${var_gh_repos//[[:space:]]/}" + var_runner_count="${var_runner_count:-2}" + var_runner_name="${var_runner_name:-github-runner}" + + [[ "${var_gh_owner:-}" =~ ^[A-Za-z0-9][A-Za-z0-9._-]*$ ]] || { + msg_error "GitHub owner is invalid" + exit 1 + } + [[ "${var_runner_count}" =~ ^[1-9][0-9]*$ ]] || { + msg_error "Runners per repository must be a positive integer" + exit 1 + } + [[ "${var_runner_name}" =~ ^[A-Za-z0-9][A-Za-z0-9._-]*$ ]] || { + msg_error "Runner name is invalid" + exit 1 + } + [[ -n "${var_gh_token:-}" ]] || { + msg_error "GitHub token is required" + exit 1 + } + [[ -n "${var_gh_repos:-}" ]] || { + msg_error "At least one repository is required" + exit 1 + } + + IFS=',' read -r -a repos <<< "${var_gh_repos}" + for repo in "${repos[@]}"; do + [[ -n "${repo}" ]] || { + msg_error "Empty repository name" + exit 1 + } + if [[ "${repo}" == */* ]]; then + owner_repo="${repo}" + else + owner_repo="${var_gh_owner}/${repo}" + fi + [[ "${owner_repo}" =~ ^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$ ]] || { + msg_error "Repository '${repo}' is invalid" + exit 1 + } + done + + msg_info "Installing build tools" + $STD apt install -y git make gcc libc6-dev + msg_ok "Installed build tools" + + # Job steps run in containers. The runner binaries stay on the system. + setup_docker + + fetch_and_deploy_gh_release "github-actions-runner" "actions/runner" "prebuild" "latest" "/opt/actions-runner" "actions-runner-linux-$(arch_resolve "x64" "arm64")-*.tar.gz" + + if [[ -x /opt/actions-runner/bin/installdependencies.sh ]]; then + dep="/opt/actions-runner/bin/installdependencies.sh" + elif [[ -x /opt/actions-runner/installdependencies.sh ]]; then + dep="/opt/actions-runner/installdependencies.sh" + else + msg_error "Runner package has no installdependencies.sh" + exit 1 + fi + if [[ -f /opt/actions-runner/config.sh ]]; then + chmod +x /opt/actions-runner/config.sh + fi + if [[ -f /opt/actions-runner/bin/runsvc.sh ]]; then + chmod +x /opt/actions-runner/bin/runsvc.sh + fi + if [[ -f "${dep}" ]]; then + chmod +x "${dep}" + fi + msg_info "Installing runner dependencies" + $STD "${dep}" + msg_ok "Installed runner dependencies" + + mkdir -p /opt/actions-runners /opt/runner-tool-cache + + msg_info "Registering GitHub Actions runners" + for repo in "${repos[@]}"; do + if [[ "${repo}" == */* ]]; then + owner_repo="${repo}" + else + owner_repo="${var_gh_owner}/${repo}" + fi + unit="${owner_repo//\//-}" + for ((i = 1; i <= var_runner_count; i++)); do + dest="/opt/actions-runners/${unit}-${i}" + name="${var_runner_name}-${i}" + mkdir -p "${dest}" + cp -a /opt/actions-runner/. "${dest}/" + chmod 700 "${dest}" + + reg_file="$(mktemp)" + chmod 600 "${reg_file}" + http_code="$(curl --connect-timeout 10 --max-time 30 -sS -o "${reg_file}" -w '%{http_code}' -X POST \ + -H "Accept: application/vnd.github+json" \ + -H "Authorization: Bearer ${var_gh_token}" \ + -H "X-GitHub-Api-Version: 2022-11-28" \ + "https://api.github.com/repos/${owner_repo}/actions/runners/registration-token" || true)" + reg_token="$(jq -r '.token // empty' "${reg_file}" 2>/dev/null || true)" + rm -f "${reg_file}" + if [[ "${http_code}" != "201" || -z "${reg_token}" ]]; then + unset reg_token + msg_error "GitHub refused a registration token for ${owner_repo} (HTTP ${http_code})" + exit 1 + fi + + # config.sh refuses uid 0 unless RUNNER_ALLOW_RUNASROOT is set. + if ! ( + cd "${dest}" + RUNNER_ALLOW_RUNASROOT=1 ./config.sh \ + --unattended \ + --replace \ + --url "https://github.com/${owner_repo}" \ + --token "${reg_token}" \ + --name "${name}" \ + --work "_work" + ) "${dest}/.env" +RUNNER_TOOL_CACHE=/opt/runner-tool-cache +EOF + chmod 600 "${dest}/.env" + if [[ -f "${dest}/.credentials" ]]; then + chmod 600 "${dest}/.credentials" + fi + if [[ -f "${dest}/.runner" ]]; then + chmod 600 "${dest}/.runner" + fi + chmod 700 "${dest}" + + cat </etc/systemd/system/actions-runner-${unit}-${i}.service +[Unit] +Description=GitHub Actions runner ${i} for ${owner_repo} +After=network-online.target docker.service +Wants=network-online.target docker.service + +[Service] +User=root +Environment=RUNNER_ALLOW_RUNASROOT=1 +EnvironmentFile=${dest}/.env +ExecStart=${dest}/bin/runsvc.sh +WorkingDirectory=${dest} +KillMode=process +KillSignal=SIGTERM +TimeoutStopSec=5min +Restart=always +RestartSec=10 + +[Install] +WantedBy=multi-user.target +EOF + systemctl enable -q --now "actions-runner-${unit}-${i}.service" + done + done + msg_ok "Registered GitHub Actions runners" + unset var_gh_token +} + +run_os_setup + +motd_ssh +customize +cleanup_lxc diff --git a/json/github-actions-runner.json b/json/github-actions-runner.json new file mode 100644 index 0000000000..1374f5c2b8 --- /dev/null +++ b/json/github-actions-runner.json @@ -0,0 +1,99 @@ +{ + "name": "GitHub Actions Runner", + "slug": "github-actions-runner", + "categories": [ + 20 + ], + "date_created": "2026-10-13", + "type": "ct", + "updateable": true, + "privileged": false, + "architectures": [ + "amd64", + "arm64" + ], + "interface_port": null, + "documentation": "https://docs.github.com/en/actions/hosting-your-own-runners", + "website": "https://github.com/actions/runner", + "repository": "https://github.com/actions/runner", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/github.webp", + "description": "GitHub Actions Runner is the agent that executes self-hosted jobs. One Debian container registers several runner processes per repository, so a personal account can run concurrent jobs without sharing one registration across repos.", + "install_methods": [ + { + "type": "default", + "script": "ct/github-actions-runner.sh", + "config_path": "/opt/actions-runners", + "resources": { + "cpu": 4, + "ram": 12288, + "hdd": 40, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "app_vars": [ + { + "name": "var_gh_owner", + "label": "GitHub owner", + "type": "text", + "required": true, + "help": "User or organization that owns the repositories. A repository in var_gh_repos may also be written as owner/repo." + }, + { + "name": "var_gh_repos", + "label": "Repositories", + "type": "text", + "required": true, + "help": "Comma-separated repository names, or owner/repo when a repo belongs to another account." + }, + { + "name": "var_gh_token", + "label": "GitHub token", + "type": "password", + "secret": true, + "required": true, + "help": "Classic PAT with the repo scope, or a fine-grained token with Administration read and write on each repository. Used to mint registration tokens and then discarded." + }, + { + "name": "var_runner_count", + "label": "Runners per repository", + "type": "number", + "default": "2", + "help": "How many runner processes to register for each repository. A runner executes one job at a time." + }, + { + "name": "var_runner_name", + "label": "Runner name prefix", + "type": "text", + "default": "github-runner", + "help": "GitHub shows each process as -1, -2, and so on." + } + ], + "notes": [ + { + "text": "Debian 13 only. Defaults are 4 cores, 12 GB RAM, and 40 GB disk because a single job such as govulncheck can use several gigabytes.", + "type": "info" + }, + { + "text": "Docker is installed so workflow jobs can run containers. The runner itself is installed from the upstream tarball. Nested virtualization has to stay enabled.", + "type": "info" + }, + { + "text": "The service runs as root with RUNNER_ALLOW_RUNASROOT=1. Workflow code from the registered repositories has root inside this container.", + "type": "info" + }, + { + "text": "Every job on this container shares one network namespace. Two jobs that publish the same host port, such as Postgres on 5432, will attach to each other's services.", + "type": "info" + }, + { + "text": "The GitHub token is not written to disk. Updates replace the binaries under /opt/actions-runner and copy them onto the existing registrations. They do not ask for the token again.", + "type": "info" + } + ] +}