From a23914b5480b41f15affc700af2569dc79b52912 Mon Sep 17 00:00:00 2001 From: Christoph Heiss Date: Sun, 5 Jan 2025 14:33:14 +0100 Subject: [PATCH] admin: runner-installation: update `container.docker_host` description The behaviour was changed in a non-backwards-compatible manner with 5.0.0 [0], and then further modified with the 5.0.3 release [1]. Mention that fact explicitly as an additional note, so that users know how to configure it as needed based on their version. The description in the example config is taken from upstream [2]. [0] https://code.forgejo.org/forgejo/runner/src/branch/main/RELEASE-NOTES.md#5-0-0 [1] https://code.forgejo.org/forgejo/runner/src/branch/main/RELEASE-NOTES.md#5-0-3 [2] https://code.forgejo.org/forgejo/runner/src/branch/main/internal/pkg/config/config.example.yaml Signed-off-by: Christoph Heiss --- docs/admin/runner-installation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/admin/runner-installation.md b/docs/admin/runner-installation.md index 894089ca..bc90af3a 100644 --- a/docs/admin/runner-installation.md +++ b/docs/admin/runner-installation.md @@ -220,8 +220,8 @@ container: # - '**' valid_volumes: [] # overrides the docker client host with the specified one. - # If "-", an available docker host will automatically be found. - # If empty, an available docker host will automatically be found and mounted in the job container (e.g. /var/run/docker.sock). + # If "-" or "", an available docker host will automatically be found. + # 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. docker_host: "-" # Pull docker image(s) even if already present @@ -233,6 +233,10 @@ host: workdir_parent: ``` +Note: `container.docker_host = "automount"` is only available for +forgejo-runner >= 5.0.3. For forgejo-runner < 5.0.3, it must be explicitly +set to an empty string. + #### Cache configuration Some actions such as https://data.forgejo.org/actions/cache or