wwmoraes/github-runner repository overview

⁠GitHub Runner

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

This is a fork from tcardonne/docker-github-runner⁠, replacing Debian and Ubuntu with Bitnami's minideb.

⁠Important notes

• GitHub recommends⁠ that you do NOT use self-hosted runners with public repositories, for security reasons.
• Organization level self-hosted runners are supported (see environment variables), but be advised that the GitHub API for organization level runners is still in public beta and subject to changes.

⁠Usage

⁠Basic usage

Use the following command to start listening for jobs:

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

⁠Using Docker inside your Actions

If you want to use Docker inside your runner (ie, build images in a workflow), you can enable Docker siblings by binding the host Docker daemon socket. Please keep in mind that doing this gives your actions full control on the Docker daemon.

docker run -it --name my-runner \
    -e RUNNER_NAME=my-runner \
    -e GITHUB_ACCESS_TOKEN=token \
    -e RUNNER_REPOSITORY_URL=https://github.com/... \
    -v /var/run/docker.sock:/var/run/docker.sock \
    wwmoraes/github-runner

⁠Using docker-compose.yml

In docker-compose.yml :

version: "3.7"

services:
    runner:
      image: wwmoraes/github-runner:latest
      environment:
        RUNNER_NAME: "my-runner"
        RUNNER_REPOSITORY_URL: ${RUNNER_REPOSITORY_URL}
        #RUNNER_ORGANIZATION_URL: ${RUNNER_ORGANIZATION_URL}
        GITHUB_ACCESS_TOKEN: ${GITHUB_ACCESS_TOKEN}
      volumes:
      - /var/run/docker.sock:/var/run/docker.sock

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

RUNNER_REPOSITORY_URL=https://github.com/your_url/your_repo
# or RUNNER_ORGANIZATION_URL=https://github.com/your-organization
GITHUB_ACCESS_TOKEN=the_runner_token

⁠Environment variables

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

⁠Runner Token

In order to link your runner to your repository/organization, you need to provide a token. There is two way of passing the token :

• via GITHUB_ACCESS_TOKEN (recommended), containing a Personnal Access Token⁠. This token will be used to dynamically fetch a new runner token, as runner tokens are valid for a short period of time.
  • For a single-repository runner, your PAT should have repo scopes.
  • For an organization runner, your PAT should have admin:org scopes.
• via RUNNER_TOKEN. This token is displayed in the Actions settings page of your organization/repository, when opening the "Add Runner" page.

⁠Runner auto-update behavior

The GitHub runner (the binary) will update itself when receiving a job, if a new release is available. In order to allow the runner to exit and restart by itself, the binary is started by a supervisord process.