vegardit/gitea-act-runner

1. What is it?
2. Usage
3. License

What is it?

debian:stable-slim based Docker image containing Gitea's act_runner

Why not using Alpine Linux?

• musl-libc - Alpine's Greatest Weakness https://www.linkedin.com/pulse/musl-libc-alpines-greatest-weakness-rogan-lynch
• Why I will never use Alpine Linux ever again https://martinheinz.dev/blog/92
• Does Alpine have known DNS issue within Kubernetes? https://stackoverflow.com/questions/65181012/
• Why is the Alpine Docker image over 50% slower than the Ubuntu image? https://superuser.com/questions/1219609/
• Performance issue with alpine musl library https://unix.stackexchange.com/questions/729342/

Usage

The docker image comes in three flavors:

• vegardit/gitea-act-runner:latest: only contains the Gitea act_runner and executes workflows in containers of the docker engine running act_runner itself (DooD / Docker-out-of-Docker approach)
• vegardit/gitea-act-runner:dind-latest: executes workflows using an embedded docker engine (DinD / Docker-in-Docker approach) providing better process isolation
• vegardit/gitea-act-runner:dind-rootless-latest: executes workflows using an embedded docker engine (DinD / Docker-in-Docker approach) running the docker daemon as a non-root user (Rootless mode)

Docker Run

Running from the command line:

• Docker-out-of-Docker approach

    docker run \
      -e GITEA_INSTANCE_URL=https://gitea.example.com \
      -e GITEA_RUNNER_REGISTRATION_TOKEN=<INSERT_TOKEN_HERE> \
      --name gitea_act_runner \
      -v /var/run/docker.sock:/var/run/docker.sock:rw \
      vegardit/gitea-act-runner:latest
  

• Docker-in-Docker approach

    docker run \
      -e GITEA_INSTANCE_URL=https://gitea.example.com \
      -e GITEA_RUNNER_REGISTRATION_TOKEN=<INSERT_TOKEN_HERE> \
      --name gitea_act_runner \
      --privileged
      vegardit/gitea-act-runner:dind-latest
  

• Docker-in-Docker approach with Docker daemon running as a non-root user (Rootless mode)

    docker run \
      -e GITEA_INSTANCE_URL=https://gitea.example.com \
      -e GITEA_RUNNER_REGISTRATION_TOKEN=<INSERT_TOKEN_HERE> \
      --name gitea_act_runner \
      --privileged
      vegardit/gitea-act-runner:dind-rootless-latest
  

Docker Compose

Example docker-compose.yml:

• Docker-out-of-Docker approach

  # https://docs.docker.com/compose/compose-file/
  
  services:
  
    gitea_act_runner:
      image: vegardit/gitea-act-runner:latest
      #image: ghcr.io/vegardit/gitea-act-runner:latest
      restart: always
      volumes:
        - /var/run/docker.sock:/var/run/docker.sock:rw
        - /my/path/to/data/dir:/data:rw # the config file is located at /data/.runner and needs to survive container restarts
      environment:
        TZ: "Europe/Berlin"
        # config parameters for initial runner registration:
        GITEA_INSTANCE_URL: 'https://gitea.example.com' # required
        GITEA_RUNNER_REGISTRATION_TOKEN_FILE: 'path/to/file' # one-time registration token, only required on first container start
        # or: GITEA_RUNNER_REGISTRATION_TOKEN: '<INSERT_TOKEN_HERE>'
  

• Docker-in-Docker approach

  # https://docs.docker.com/compose/compose-file/
  
  services:
  
    gitea_act_runner:
      image: vegardit/gitea-act-runner:dind-latest
      #image: ghcr.io/vegarditgitea-act-runner:dind-latest
      privileged: true
      restart: always
      volumes:
        - /my/path/to/data/dir:/data:rw # the config file is located at /data/.runner and needs to survive container restarts
      environment:
        TZ: "Europe/Berlin"
        # config parameters for initial runner registration:
        GITEA_INSTANCE_URL: 'https://gitea.example.com' # required
        GITEA_RUNNER_REGISTRATION_TOKEN_FILE: 'path/to/file' # one-time registration token, only required on first container start
        # or: GITEA_RUNNER_REGISTRATION_TOKEN: '<INSERT_TOKEN_HERE>'
  

Additional environment variables

The following environment variables can be specified to further configure the service.

Runner registration:

Runner runtime config:

Runner config template variables

The following environment variables are referenced in the /opt/config.template.yaml file.

Embedded cache server:

License

All files in this repository are released under the Apache License 2.0.

Individual files contain the following tag instead of the full license text:

SPDX-License-Identifier: Apache-2.0

This enables machine processing of license information based on the SPDX License Identifiers that are available here: https://spdx.org/licenses/.