diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 523b5d414..405d10c56 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -1,3 +1,7 @@ +--- +toc_max_heading_level: 2 +--- + # Server configuration ## User registration diff --git a/docs/docs/30-administration/15-agent-config.md b/docs/docs/30-administration/15-agent-config.md index 504265d36..89bb6f9a8 100644 --- a/docs/docs/30-administration/15-agent-config.md +++ b/docs/docs/30-administration/15-agent-config.md @@ -1,3 +1,7 @@ +--- +toc_max_heading_level: 2 +--- + # Agent configuration Agents are configured by the command line or environment variables. At the minimum you need the following information: diff --git a/docs/docs/30-administration/22-backends/10-docker.md b/docs/docs/30-administration/22-backends/10-docker.md index 57fe7bb91..482d6caa7 100644 --- a/docs/docs/30-administration/22-backends/10-docker.md +++ b/docs/docs/30-administration/22-backends/10-docker.md @@ -1,28 +1,11 @@ +--- +toc_max_heading_level: 2 +--- + # Docker backend This is the original backend used with Woodpecker. The docker backend executes each step inside a separate container started on the agent. -## Configuration - -### `WOODPECKER_BACKEND_DOCKER_NETWORK` - -> Default: empty - -Set to the name of an existing network which will be attached to all your pipeline containers (steps). Please be careful as this allows the containers of different pipelines to access each other! - -### `WOODPECKER_BACKEND_DOCKER_ENABLE_IPV6` - -> Default: `false` - -Enable IPv6 for the networks used by pipeline containers (steps). Make sure you configured your docker daemon to support IPv6. - -### `WOODPECKER_BACKEND_DOCKER_VOLUMES` - -> Default: empty - -List of default volumes separated by comma to be mounted to all pipeline containers (steps). For example to use custom CA -certificates installed on host and host timezone use `/etc/ssl/certs:/etc/ssl/certs:ro,/etc/timezone:/etc/timezone`. - ## Docker credentials Woodpecker supports [Docker credentials](https://github.com/docker/docker-credential-helpers) to securely store registry credentials. Install your corresponding credential helper and configure it in your Docker config file passed via [`WOODPECKER_DOCKER_CONFIG`](../10-server-config.md#woodpecker_docker_config). @@ -60,3 +43,24 @@ docker image rm $(docker images --filter "dangling=true" -q --no-trunc) ```bash docker volume rm $(docker volume ls --filter name=^wp_* --filter dangling=true -q) ``` + +## Configuration + +### `WOODPECKER_BACKEND_DOCKER_NETWORK` + +> Default: empty + +Set to the name of an existing network which will be attached to all your pipeline containers (steps). Please be careful as this allows the containers of different pipelines to access each other! + +### `WOODPECKER_BACKEND_DOCKER_ENABLE_IPV6` + +> Default: `false` + +Enable IPv6 for the networks used by pipeline containers (steps). Make sure you configured your docker daemon to support IPv6. + +### `WOODPECKER_BACKEND_DOCKER_VOLUMES` + +> Default: empty + +List of default volumes separated by comma to be mounted to all pipeline containers (steps). For example to use custom CA +certificates installed on host and host timezone use `/etc/ssl/certs:/etc/ssl/certs:ro,/etc/timezone:/etc/timezone`. diff --git a/docs/docs/30-administration/22-backends/20-local.md b/docs/docs/30-administration/22-backends/20-local.md index 88950f328..70dc57864 100644 --- a/docs/docs/30-administration/22-backends/20-local.md +++ b/docs/docs/30-administration/22-backends/20-local.md @@ -1,3 +1,7 @@ +--- +toc_max_heading_level: 3 +--- + # Local backend :::danger diff --git a/docs/docs/30-administration/22-backends/40-kubernetes.md b/docs/docs/30-administration/22-backends/40-kubernetes.md index abd1b5b28..f4e19a7b1 100644 --- a/docs/docs/30-administration/22-backends/40-kubernetes.md +++ b/docs/docs/30-administration/22-backends/40-kubernetes.md @@ -1,3 +1,7 @@ +--- +toc_max_heading_level: 3 +--- + # Kubernetes backend The kubernetes backend executes steps inside standalone pods. A temporary PVC is created for the lifetime of the pipeline to transfer files between steps.