From c28356267d8c70d53143fa24e9f45658e6eae88c Mon Sep 17 00:00:00 2001 From: Gitea Bot Date: Wed, 30 Sep 2026 11:31:16 +0000 Subject: [PATCH] Update the runner reference pages (#563) Automated update of the generated runner reference pages from gitea/runner (main for the develop docs, the newest stable tag for every documented series), opened by the "update runner reference" scheduled workflow. Preview: https://pr-563.docs-gitea-com.pages.dev --------- Co-authored-by: Lunny Xiao Reviewed-on: https://gitea.com/gitea/docs/pulls/563 Reviewed-by: Lunny Xiao Co-authored-by: Gitea Bot --- runner-docs/reference/config-example.md | 36 ++++++++++++++----------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/runner-docs/reference/config-example.md b/runner-docs/reference/config-example.md index f1c07be2..46809ba2 100644 --- a/runner-docs/reference/config-example.md +++ b/runner-docs/reference/config-example.md @@ -163,19 +163,12 @@ cache: #dir: "" # Outbound IP or hostname that job containers use to reach this runner's cache server. # Leave empty to detect automatically. 0.0.0.0 is not valid here. - # If the runner itself runs in Docker, automatic detection can choose an - # address on the runner container's network that job containers cannot reach - # when the runner creates a separate per-job network. In that case, set this - # to a hostname/IP reachable from job containers, and set port to a fixed - # published port or put the job containers on a shared Docker network. - # Ignored when external_server is set. + # A runner container on the jobs' Docker daemon attaches to each job network automatically. #host: "" # Port for the built-in cache server. 0 picks a random free port. - # Ignored when external_server is set. #port: 0 - # URL of a shared `gitea-runner cache-server` to use instead of starting a local one. + # URL of a shared `gitea-runner cache-server` to forward cache calls to. # Set on every runner that should share a cache pool. A trailing slash is optional. - # Jobs reach the server at this URL too, so set it to the reverse proxy when one fronts the server. # Example: "http://cache-host:8088/" # Requires external_secret (below) to match the value on the cache-server. #external_server: "" @@ -188,6 +181,19 @@ cache: # Surrounding whitespace is trimmed, so a trailing newline in the file is fine. # Setting both external_secret and external_secret_file is an error. #external_secret_file: "" + # Store the cache in an S3-compatible bucket such as AWS S3, MinIO or RustFS. Runners with + # the same settings use the same cache. Cannot be combined with external_server. Add lifecycle + # rules to the bucket that expire old caches and abort incomplete multipart uploads. + # region defaults to us-east-1, and path_style to false for AWS and true otherwise. + # access_key and secret_key can also be set directly instead of read from files. + #s3: + # endpoint: "http://minio:9000" + # region: "us-east-1" + # bucket: "runner-cache" + # prefix: "gitea-runner-cache" + # path_style: true + # access_key_file: "/run/secrets/cache-s3-access-key" + # secret_key_file: "/run/secrets/cache-s3-secret-key" # When true, reuse a cached action instead of fetching from the remote on every job. # A moved tag (e.g. a re-tagged "v6") or an updated branch stays at the cached commit # until its cache entry expires or is manually removed. @@ -196,10 +202,10 @@ cache: # they do not take for GitHub, so reaching it means editing that check out of their own bundle, # put back after the copy into the job. That edit is made either way, this only governs the API # advertised. A bundle that does not match is left alone. With v2, artifact uploads go via the - # cache server unless container jobs cannot reach its Docker network. + # cache server. #v2: true - # How the cache server discards entries, ignored when external_server is set since that - # server applies its own. Leave a setting out for its default; 0s or 0 turns the three + # How the cache server discards entries, ignored when external_server or s3 is set since + # those apply their own. Leave a setting out for its default; 0s or 0 turns the three # limits off. Sizes accept 10GB, 512mb, 1TiB or a plain byte count, binary either way. # Whatever these allow, the cache still sheds entries to keep free space on its volume # above health_check.min_free_disk_space_mb when health checks are enabled. @@ -216,9 +222,8 @@ cache: container: # Specifies the network to which the container will connect. # Could be host, bridge or the name of a custom network. + # A runner container outside bridge cannot join it, so jobs on bridge cannot reach its cache. # If it's empty, runner will create a network automatically. - # For dockerized runners using the built-in cache server, a custom shared - # network can be required so job containers can reach cache.host/cache.port. # Deprecated: `network_mode` is still accepted for old configs; use `network` instead. #network: "" # network_create_options only apply when `network` is left empty and the runner @@ -247,7 +252,8 @@ container: # If it's empty, /workspace will be used. # Purely numeric subdirectories under this path are reserved for task workspaces and may be removed by idle cleanup. #workdir_parent: - # Volumes (including bind mounts) can be mounted to containers. Glob syntax is supported, see https://github.com/gobwas/glob + # Volumes (including bind mounts) can be mounted to containers. Glob syntax is supported, see https://github.com/bmatcuk/doublestar#patterns + # `*` matches within a single path segment, `**` also matches across path separators. # 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: