README.md

Docker github runner

A docker image optimized for running shivammathur/setup-php actions in a docker self-hosted runner, but not limited to it. Custom docker images and services can be handled in the workflow as well

docker image

https://hub.docker.com/r/defstudio/github-runner

Setup

• create a new docker-compose.yml file

version: '3.5'

services:
  runner:
    image: defstudio/github-runner:latest
    restart: unless-stopped
    environment:
      ACCESS_TOKEN: "${ACCESS_TOKEN}"
      RUNNER_NAME_PREFIX: "${RUNNER_NAME_PREFIX}"
      ORG: "${ORG_NAME}"
      LABELS: "${LABELS}"
    security_opt:
      - label:disable
    volumes:
      - '/var/run/docker.sock:/var/run/docker.sock'

• add an .env file to store settings

ACCESS_TOKEN=<TOKEN>
RUNNER_NAME_PREFIX=runner
ORG_NAME=def-studio
LABELS=linux,self-hosted

Starting new runners

Single runner

docker-compose up -d

Multiple runners

docker-compose up -d --scale runner=5

Credits

• Fabio Ivona
• myoung34/docker-github-actions-runner
• https://github.com/shivammathur/setup-php
• All Contributors

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.