ispasov / docker-github-runner

Run GitHub Actions on self-hosted runner using Docker.

GitHub Runner

---

GitHub allows developpers to run GitHub Actions workflows on your own runners. This Docker image allows you to create your own runner on Docker.

This Docker Image is still under development: the linking process works but as it uses the Debian Buster image as a base, some actions may not work. My goal with this image is to be able to build Docker images (probably using Docker siblings or Docker in Docker).

For now, there is only a Debian Buster image, but I may add more variants in the future.

Important notes

As stated in the documentation :

"GitHub Actions is currently in limited public beta and is subject to change. We strongly recommend that you do not use this feature for high-value workflows and content during the beta period".

Also, GitHub recommends that you do NOT use self-hosted runners with public repositories, for security reasons.

Usage

Use the following command to start listening for jobs:

docker run -it --name my-runner \
    -e RUNNER_NAME=my-runner \
    -e RUNNER_TOKEN=token \
    -e RUNNER_REPOSITORY_URL=https://github.com/... \
    tcardonne/github-runner

Environment variables

The following environment variables allows you to control the configuration parameters.

Name	Description	Default value
RUNNER_REPOSITORY_URL	The runner will be linked to this repository URL	Required
RUNNER_TOKEN	Personal Access Token provided by GitHub	Required
RUNNER_WORK_DIRECTORY	Runner's work directory	"_work"
RUNNER_NAME	Name of the runner displayed in the GitHub UI	Hostname of the container

Using docker-compose.yml

In docker-compose.yml :

version: "3.6"

services:
    runner:
      image: tcardonne/github-runner:latest
      environment:
        RUNNER_NAME: "my-runner"
        RUNNER_REPOSITORY_URL: ${RUNNER_REPOSITORY_URL}
        RUNNER_TOKEN: ${RUNNER_TOKEN}

You can create a .env to provide environment variables when using docker-compose :

RUNNER_REPOSITORY_URL=https://github.com/your_url/your_repo
RUNNER_TOKEN=the_runner_token