Initial commit

.gitignore

@@ -0,0 +1,2 @@
+runner-data/
+

README.md

@@ -0,0 +1,53 @@
+# Forgejo runner guide
+
+This guide shows how to set up a runner with Docker Compose, since the instructions in the official documentation/repo example are confusing and error-prone.
+
+## Generate config and register runner
+
+Clone this repo and access it with your shell. Then run:
+
+```sh
+mkdir runner-data
+chmod -R a+rw runner-data/
+docker run --rm -ti -v $(pwd)/runner-data:/data:z code.forgejo.org/forgejo/runner:3.5.1 sh
+```
+
+This will create a container that already places us on the mounted volume (you can `cd /data` to make sure). Now we'll generate a default `config.yml` and a `.runner`, respectively.
+
+```sh
+forgejo-runner generate-config > config.yml
+forgejo-runner register
+```
+
+The second command will start an interactive setup. Enter the fields as prompted:
+
+1. The first prompt will be your repo's URL.
+2. The second prompt will be a secret to authenticate your worker (in my case, I got it from `/admin/actions/runners` > Create new runner > Registration token).
+3. The third will be the name of your runner (just `runner` is fine).
+4. The fourth will be the labels to use. Simply copy the ones shown below.
+
+In my installation, the inputs I entered looked something like this:
+
+```sh
+https://git.badmanners.xyz
+A...z
+runner
+docker:docker://code.forgejo.org/oci/node:20-bookworm,ubuntu-22.04:docker://catthehacker/ubuntu:act-22.04
+```
+
+Then, once we make sure that we have both files in the directory, we can exit the shell with Ctrl+D.
+
+## Edit config.yml fields
+
+We need to change some default fields in `config.yml`. Just run `./edit_config.sh`, and it will automatically take care of it for you.
+
+## Start daemon
+
+Finally, we can start our worker:
+
+```sh
+docker compose up -d
+```
+
+Enjoy! 🍻
+

compose.yaml

@@ -0,0 +1,44 @@
+volumes:
+  docker_certs: {}
+  docker_data: {}
+
+networks:
+  dind:
+    external: false
+
+services:
+  docker-in-docker:
+    # image: code.forgejo.org/oci/docker:dind
+    image: code.forgejo.org/oci/docker@sha256:bb26df3a28c1613fb0c554e911bf9c54f26afe134b07e049f28ec0d8f06fb4da
+    container_name: forgejo_runner_dind
+    restart: unless-stopped
+    hostname: docker # Must set hostname as TLS certificates are only valid for docker or localhost
+    privileged: true
+    networks:
+      - dind
+    environment:
+      DOCKER_TLS_CERTDIR: /certs
+      DOCKER_HOST: docker-in-docker
+    volumes:
+      - docker_certs:/certs
+      - docker_data:/var/lib/docker
+
+  runner:
+    # image: code.forgejo.org/forgejo/runner:3.5.1
+    image: code.forgejo.org/forgejo/runner@sha256:c6b28f34f0c23a44468e5f3284e0c9be144878de57f1a55d39014a7b3f8dfffe
+    container_name: forgejo_runner
+    restart: unless-stopped
+    networks:
+      - dind
+    depends_on:
+      - docker-in-docker
+    environment:
+      DOCKER_HOST: tcp://docker:2376
+      DOCKER_CERT_PATH: /certs/client
+      DOCKER_TLS_VERIFY: "1"
+    volumes:
+      - ./runner-data:/data
+      - docker_certs:/certs
+    command: >-
+      bash -c ' while : ; do test -w .runner && forgejo-runner --config config.yml daemon ; sleep 1 ; done '
+

config.yml

@@ -0,0 +1,100 @@
+# Example configuration file, it's safe to copy this as the default config file without any modification.
+
+# You don't have to copy this file to your instance,
+# just run `./act_runner generate-config > config.yaml` to generate a config file.
+
+log:
+  # The level of logging, can be trace, debug, info, warn, error, fatal
+  level: info
+
+runner:
+  # Where to store the registration result.
+  file: .runner
+  # Execute how many tasks concurrently at the same time.
+  capacity: 1
+  # Extra environment variables to run jobs.
+  envs:
+    A_TEST_ENV_NAME_1: a_test_env_value_1
+    A_TEST_ENV_NAME_2: a_test_env_value_2
+  # Extra environment variables to run jobs from a file.
+  # It will be ignored if it's empty or the file doesn't exist.
+  env_file: .env
+  # The timeout for a job to be finished.
+  # Please note that the Forgejo instance also has a timeout (3h by default) for the job.
+  # So the job could be stopped by the Forgejo instance if it's timeout is shorter than this.
+  timeout: 3h
+  # The timeout for the runner to wait for running jobs to finish when
+  # shutting down because a TERM or INT signal has been received.  Any
+  # running jobs that haven't finished after this timeout will be
+  # cancelled.
+  # If unset or zero the jobs will be cancelled immediately.
+  shutdown_timeout: 3h
+  # Whether skip verifying the TLS certificate of the instance.
+  insecure: false
+  # The timeout for fetching the job from the Forgejo instance.
+  fetch_timeout: 5s
+  # The interval for fetching the job from the Forgejo instance.
+  fetch_interval: 2s
+  # The interval for reporting the job status and logs to the Forgejo instance.
+  report_interval: 1s
+  # The labels of a runner are used to determine which jobs the runner can run, and how to run them.
+  # Like: ["macos-arm64:host", "ubuntu-latest:docker://node:20-bookworm", "ubuntu-22.04:docker://node:20-bookworm"]
+  # If it's empty when registering, it will ask for inputting labels.
+  # If it's empty when execute `deamon`, will use labels in `.runner` file.
+  labels: []
+
+cache:
+  # Enable cache server to use actions/cache.
+  enabled: true
+  # The directory to store the cache data.
+  # If it's empty, the cache data will be stored in $HOME/.cache/actcache.
+  dir: ""
+  # The host of the cache server.
+  # It's not for the address to listen, but the address to connect from job containers.
+  # So 0.0.0.0 is a bad choice, leave it empty to detect automatically.
+  host: ""
+  # The port of the cache server.
+  # 0 means to use a random available port.
+  port: 0
+  # The external cache server URL. Valid only when enable is true.
+  # If it's specified, act_runner will use this URL as the ACTIONS_CACHE_URL rather than start a server by itself.
+  # The URL should generally end with "/".
+  external_server: ""
+
+container:
+  # Specifies the network to which the container will connect.
+  # Could be host, bridge or the name of a custom network.
+  # If it's empty, create a network automatically.
+  network: ""
+  # Whether to create networks with IPv6 enabled. Requires the Docker daemon to be set up accordingly.
+  # Only takes effect if "network" is set to "".
+  enable_ipv6: false
+  # Whether to use privileged mode or not when launching task containers (privileged mode is required for Docker-in-Docker).
+  privileged: false
+  # And other options to be used when the container is started (eg, --add-host=my.forgejo.url:host-gateway).
+  options:
+  # The parent directory of a job's working directory.
+  # If it's empty, /workspace will be used.
+  workdir_parent:
+  # Volumes (including bind mounts) can be mounted to containers. Glob syntax is supported, see https://github.com/gobwas/glob
+  # You can specify multiple volumes. If the sequence is empty, no volumes can be mounted.
+  # For example, if you only allow containers to mount the `data` volume and all the json files in `/src`, you should change the config to:
+  # valid_volumes:
+  #   - data
+  #   - /src/*.json
+  # If you want to allow any volume, please use the following configuration:
+  # valid_volumes:
+  #   - '**'
+  valid_volumes: []
+  # overrides the docker client host with the specified one.
+  # If it's empty, act_runner will find an available docker host automatically.
+  # If it's "-", act_runner will find an available docker host automatically, but the docker host won't be mounted to the job containers and service containers.
+  # If it's not empty or "-", the specified docker host will be used. An error will be returned if it doesn't work.
+  docker_host: ""
+  # Pull docker image(s) even if already present
+  force_pull: false
+
+host:
+  # The parent directory of a job's working directory.
+  # If it's empty, $HOME/.cache/act/ will be used.
+  workdir_parent:

edit_config.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+grep -Fq 'network: ""' runner-data/config.yml ; 
+if [[ $? -ne 0 ]] ; then
+  echo "Already modified config file!"
+  set -e
+  exit 1
+fi
+
+sed -i -e "s|network: .*|network: host|" runner-data/config.yml ;
+sed -i -e "s|^  envs:\$|  envs:\n    DOCKER_HOST: tcp://docker:2376\n    DOCKER_TLS_VERIFY: 1\n    DOCKER_CERT_PATH: /certs/client|" runner-data/config.yml ;
+sed -i -e "s|^  options:|  options: -v /certs/client:/certs/client|" runner-data/config.yml ;
+sed -i -e "s|  valid_volumes: \[\]\$|  valid_volumes:\n    - /certs/client|" runner-data/config.yml ;
+
+echo "Updated config file."
+