From e68940619c1194f86f527125f2be1af9aefc5b20 Mon Sep 17 00:00:00 2001 From: Andrew Cassidy Date: Mon, 6 Oct 2025 03:51:19 +0000 Subject: [PATCH] chore(docs): clarify the behavior of `[container].docker_host` (#1059) The description of `container.docker_host` was misleading (and IMO the setting itself does too many things, see forgejo/forgejo-actions-feature-requests#58). I clarified the comments in the example config to clearly explain that it will mount the specified socket inside the job container, and give some example values - other - [PR](https://code.forgejo.org/forgejo/runner/pulls/1059): Clarify the behavior of `container.docker_host` Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/1059 Reviewed-by: earl-warren Co-authored-by: Andrew Cassidy Co-committed-by: Andrew Cassidy --- internal/pkg/config/config.example.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/internal/pkg/config/config.example.yaml b/internal/pkg/config/config.example.yaml index c32526e1..5addac41 100644 --- a/internal/pkg/config/config.example.yaml +++ b/internal/pkg/config/config.example.yaml @@ -176,10 +176,12 @@ container: # valid_volumes: # - '**' valid_volumes: [] - # overrides the docker client host with the specified one. - # If "-" or "", an available docker host will automatically be found. + # Overrides the docker host set by the DOCKER_HOST environment variable, and mounts on the job container. + # If "-" or "", no docker host will be mounted in the job container # If "automount", an available docker host will automatically be found and mounted in the job container (e.g. /var/run/docker.sock). - # Otherwise the specified docker host will be used and an error will be returned if it doesn't work. + # If it's a url, the specified docker host will be mounted in the job container + # Example urls: unix:///run/docker.socket or ssh://user@host + # The specified socket is mounted within the job container at /var/run/docker.sock docker_host: "-" # Pull docker image(s) even if already present force_pull: false