README.md

binary-braids/github-actions-runner

A self-hosted runner is a system that you deploy and manage to execute jobs from GitHub Actions on GitHub.com

Table of Contents

• Configuration
  • Prerequisites
  • Required Environment Variables
  • Optional Environment Variables
• Available Architecture
• Examples
  • Docker Compose
  • Docker CLI
• Support
  • Issues
  • Feature Requests
  • Updates

Configuration

Prerequisites

You will need to generate a GitHub Personal Access Token to use with the container image. This will allow the runner to register with your specified organization.

To generate a token follow this guide: Managing your personal access tokens

Note

You will need to grant the Read and write permissions under Self-hosted runners for Fine-grained tokens or manage_runners:org permissions for classic tokens

Required Environment Variables

Variable	Description
ORGANIZATION	The GitHub Organization Name
ACCESS_TOKEN	The Access Token to allow the runner to register to the organization.

Optional Environment Variables

Variable	Description
USE_HOSTNAME	If set to TRUE then the container name will be used as the runner name. Defaults to FALSE
CUSTOM_NAME	Use this option to configure a custom name for the runner

Available Architecture

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64-<version tag>

Examples

Docker Compose

services:
  github-actions-runner:
    image: ghcr.io/binary-braids/github-actions-runner:latest
    container_name: github-actions-runner
    environment:
      - ORGANIZATION=<Github Org ID>
      - ACCESS_TOKEN=<GitHub Org Access Token>
    restart: unless-stopped

Docker CLI

docker run -d \
  --name=github-actions-runner \
  --e ORGANIZATION=<Github Org ID> \
  --e ACCESS_TOKEN=<GitHub Org Access Token> \
  ghcr.io/binary-braids/github-actions-runner:latest

Support

This image is provided as is and is a hobby project. With that being said, please see below on details for support.

Issues

• Please submit a new Issue if you encounter any bugs or issues

Feature Requests

• You are welcome to submit a feature request but no timeline or guarantee will be provided regarding implentation thereof

Updates

• The image will be updated from time to time based on fixes or new features