github-self-hosted-runner-container

Table of Contents

• About
• Getting Started
• Usage

About

Docker image for running a local Github Action Runner in Docker.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Docker

Usage

To add a runner

• Add a runner to your github repo
• Copy the token from the instructions after you add the runner
• You can also copy your repo URI from the instructions

To run

docker run -it -e GITHUB_REG_TOKEN=<your-key> -e GITHUB_URL=https://github.com/<your-repo> densom/self-hosted-runner:latest

Or, copy .env.example into .env and change the variables for your project.

docker run -it --env-file .env densom/self-hosted-runner:latest

# required
GITHUB_REG_TOKEN=<your-key>
GITHUB_URL=https://github.com/<your-repo>

# optional
GITHUB_RUNNER_NAME=my-local-runner
GITHUB_RUNNER_GROUP=Default
GITHUB_RUNNER_WORKDIR=_work