From 122becaa74992800c8c372d20c978fb04d34ab79 Mon Sep 17 00:00:00 2001 From: micash Date: Sun, 26 Nov 2023 18:54:51 +0100 Subject: [PATCH 1/4] move filenames to code block title --- docs/docs/10-intro.md | 12 ++++------- docs/docs/20-usage/20-workflow-syntax.md | 3 +-- docs/docs/20-usage/25-workflows.md | 14 ++++--------- .../00-deployment/10-docker-compose.md | 21 +++++++------------ .../30-administration/10-server-config.md | 21 +++++++------------ .../30-administration/11-forges/30-gitea.md | 6 ++---- .../30-administration/11-forges/40-gitlab.md | 3 +-- .../11-forges/50-bitbucket.md | 3 +-- .../docs/30-administration/15-agent-config.md | 6 ++---- .../30-administration/22-backends/20-local.md | 9 +++----- docs/docs/30-administration/30-database.md | 9 +++----- docs/docs/30-administration/60-ssl.md | 15 +++++-------- 12 files changed, 40 insertions(+), 82 deletions(-) diff --git a/docs/docs/10-intro.md b/docs/docs/10-intro.md index cc28b1f86d3..7b1d8dab3e5 100644 --- a/docs/docs/10-intro.md +++ b/docs/docs/10-intro.md @@ -11,8 +11,7 @@ If you are already using containers in your daily workflow, you'll for sure love - Pipeline steps can be named as you like - Run any command in the commands section -```yaml -# .woodpecker.yml +```yaml title=".woodpecker.yml" steps: build: image: debian @@ -45,8 +44,7 @@ steps: - Woodpecker clones the source code in the beginning - File changes are persisted throughout individual steps as the same volume is being mounted in all steps -```yaml -# .woodpecker.yml +```yaml title=".woodpecker.yml" steps: build: image: debian @@ -65,8 +63,7 @@ steps: - And make the yaml declarative - Plugins are Docker images with your script as an entrypoint -```Dockerfile -# Dockerfile +```yaml title="Dockerfile" FROM laszlocloud/kubectl COPY deploy /usr/local/deploy ENTRYPOINT ["/usr/local/deploy"] @@ -77,8 +74,7 @@ ENTRYPOINT ["/usr/local/deploy"] kubectl apply -f $PLUGIN_TEMPLATE ``` -```yaml -# .woodpecker.yml +```yaml title=".woodpecker.yml" steps: deploy-to-k8s: image: laszlocloud/my-k8s-plugin diff --git a/docs/docs/20-usage/20-workflow-syntax.md b/docs/docs/20-usage/20-workflow-syntax.md index f1f94479a36..3fbabfe0010 100644 --- a/docs/docs/20-usage/20-workflow-syntax.md +++ b/docs/docs/20-usage/20-workflow-syntax.md @@ -67,8 +67,7 @@ The associated commit is checked out with git to a workspace which is mounted to - Woodpecker clones the source code in the beginning of the workflow - Changes to files are persisted through steps as the same volume is mounted to all steps -```yaml -# .woodpecker.yml +```yaml title=".woodpecker.yml" steps: build: image: debian diff --git a/docs/docs/20-usage/25-workflows.md b/docs/docs/20-usage/25-workflows.md index 0d1523109e5..7aa13542e24 100644 --- a/docs/docs/20-usage/25-workflows.md +++ b/docs/docs/20-usage/25-workflows.md @@ -33,9 +33,8 @@ If you still need to pass artifacts between the workflows you need use some stor └── .test.yml ``` -.woodpecker/.build.yml -```yaml +```yaml title=".woodpecker/.build.yml" steps: build: image: debian:stable-slim @@ -44,9 +43,8 @@ steps: - sleep 5 ``` -.woodpecker/.deploy.yml -```yaml +```yaml title=".woodpecker/.deploy.yml" steps: deploy: image: debian:stable-slim @@ -59,9 +57,7 @@ depends_on: - test ``` -.woodpecker/.test.yml - -```yaml +```yaml title=".woodpecker/.test.yml" steps: test: image: debian:stable-slim @@ -73,9 +69,7 @@ depends_on: - build ``` -.woodpecker/.lint.yml - -```yaml +```yaml title=".woodpecker/.lint.yml" steps: lint: image: debian:stable-slim diff --git a/docs/docs/30-administration/00-deployment/10-docker-compose.md b/docs/docs/30-administration/00-deployment/10-docker-compose.md index e649301f2a1..dd466628d55 100644 --- a/docs/docs/30-administration/00-deployment/10-docker-compose.md +++ b/docs/docs/30-administration/00-deployment/10-docker-compose.md @@ -4,8 +4,7 @@ The below [docker-compose](https://docs.docker.com/compose/) configuration can b It relies on a number of environment variables that you must set before running `docker-compose up`. The variables are described below. -```yaml -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -43,8 +42,7 @@ volumes: Woodpecker needs to know its own address. You must therefore provide the public address of it in `://` format. Please omit trailing slashes: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -58,8 +56,7 @@ services: Woodpecker can also have its port's configured. It uses a separate port for gRPC and for HTTP. The agent performs gRPC calls and connects to the gRPC port. They can be configured with ADDR variables: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: woodpecker-server: @@ -72,8 +69,7 @@ services: Reverse proxying can also be [configured for gRPC](../proxy#caddy). If the agents are connecting over the internet, it should also be SSL encrypted. The agent then needs to be configured to be secure: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: woodpecker-server: @@ -86,8 +82,7 @@ services: As agents run pipeline steps as docker containers they require access to the host machine's Docker daemon: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -100,8 +95,7 @@ services: Agents require the server address for agent-to-server communication. The agent connects to the server's gRPC port: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -113,8 +107,7 @@ services: The server and agents use a shared secret to authenticate communication. This should be a random string of your choosing and should be kept private. You can generate such string with `openssl rand -hex 32`: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 47704f089f3..0c74364f786 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -8,8 +8,7 @@ Registration is closed by default (`WOODPECKER_OPEN=false`). If registration is To open registration: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -27,8 +26,7 @@ by open registration and **filter by organization** membership through the `WOOD ### To close registration, but allow specific admin users -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -42,8 +40,7 @@ services: ### To only allow registration of users, who are members of approved organizations -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -59,8 +56,7 @@ services: Administrators should also be enumerated in your configuration. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -77,8 +73,7 @@ Woodpecker operates with the user's OAuth permission. Due to the coarse permissi Use the `WOODPECKER_REPO_OWNERS` variable to filter which GitHub user's repos should be synced only. You typically want to put here your company's GitHub name. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -94,8 +89,7 @@ services: If you want to make available a specific private registry to all pipelines, use the `WOODPECKER_DOCKER_CONFIG` server configuration. Point it to your server's docker config. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -117,8 +111,7 @@ For docker-compose you can use a .env file next to your compose configuration to Alternatively use docker-secrets. As it may be difficult to use docker secrets for environment variables woodpecker allows to read sensible data from files by providing a `*_FILE` option of all sensible configuration variables. Woodpecker will try to read the value directly from this file. Keep in mind that when the original environment variable gets specified at the same time it will override the value read from the file. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/11-forges/30-gitea.md b/docs/docs/30-administration/11-forges/30-gitea.md index b4d7f4e0339..9ce282d6e2f 100644 --- a/docs/docs/30-administration/11-forges/30-gitea.md +++ b/docs/docs/30-administration/11-forges/30-gitea.md @@ -2,8 +2,7 @@ Woodpecker comes with built-in support for Gitea and the "soft" fork Forgejo. To enable Gitea you should configure the Woodpecker container using the following environment variables: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -28,8 +27,7 @@ Otherwise, the communication should go via the `docker0` gateway (usually 172.17 To configure the Docker network if the network's name is `gitea`, configure it like this: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/11-forges/40-gitlab.md b/docs/docs/30-administration/11-forges/40-gitlab.md index bda58699df1..b72957ac670 100644 --- a/docs/docs/30-administration/11-forges/40-gitlab.md +++ b/docs/docs/30-administration/11-forges/40-gitlab.md @@ -2,8 +2,7 @@ Woodpecker comes with built-in support for the GitLab version 8.2 and higher. To enable GitLab you should configure the Woodpecker container using the following environment variables: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/11-forges/50-bitbucket.md b/docs/docs/30-administration/11-forges/50-bitbucket.md index 157d74acd06..593ce2a51fa 100644 --- a/docs/docs/30-administration/11-forges/50-bitbucket.md +++ b/docs/docs/30-administration/11-forges/50-bitbucket.md @@ -2,8 +2,7 @@ Woodpecker comes with built-in support for Bitbucket Cloud. To enable Bitbucket Cloud you should configure the Woodpecker container using the following environment variables: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/15-agent-config.md b/docs/docs/30-administration/15-agent-config.md index e34348b0434..6065aa16df5 100644 --- a/docs/docs/30-administration/15-agent-config.md +++ b/docs/docs/30-administration/15-agent-config.md @@ -2,8 +2,7 @@ Agents are configured by the command line or environment variables. At the minimum you need the following information: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -25,8 +24,7 @@ The following are automatically set and can be overridden: By default, the maximum workflows that are executed in parallel on an agent is 1. If required, you can add `WOODPECKER_MAX_WORKFLOWS` to increase your parallel processing for an agent. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/22-backends/20-local.md b/docs/docs/30-administration/22-backends/20-local.md index 1882a1aeba0..f5388d45610 100644 --- a/docs/docs/30-administration/22-backends/20-local.md +++ b/docs/docs/30-administration/22-backends/20-local.md @@ -32,8 +32,7 @@ agent, configure it and run it on the host machine. Enable connection to the server from the outside of the docker environment by exposing the port 9000: -```yaml -# docker-compose.yml for the server +```yaml title="docker-compose.yml" for the server version: '3' services: @@ -77,8 +76,7 @@ manual clone step. The `image` entry is used to specify the shell, such as Bash or Fish, that is used to run the commands. -```yaml -# .woodpecker.yml +```yaml title=".woodpecker.yml" steps: build: @@ -114,8 +112,7 @@ WOODPECKER_FILTER_LABELS=type=exec Then, use this `label` `type` with value `exec` in the pipeline definition, to only run on this agent: -```yaml -# .woodpecker.yml +```yaml title=".woodpecker.yml" labels: type: exec diff --git a/docs/docs/30-administration/30-database.md b/docs/docs/30-administration/30-database.md index 775e5a1b0b6..6746977e1ec 100644 --- a/docs/docs/30-administration/30-database.md +++ b/docs/docs/30-administration/30-database.md @@ -6,8 +6,7 @@ The default database engine of Woodpecker is an embedded SQLite database which r By default Woodpecker uses a SQLite database stored under `/var/lib/woodpecker/`. You can mount a [data volume](https://docs.docker.com/storage/volumes/#create-and-manage-volumes) to persist the SQLite database. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -22,8 +21,7 @@ services: The below example demonstrates MySQL database configuration. See the official driver [documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for configuration options and examples. The minimum version of MySQL/MariaDB required is determined by the `go-sql-driver/mysql` - see [it's README](https://github.com/go-sql-driver/mysql#requirements) for more information. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -39,8 +37,7 @@ services: The below example demonstrates Postgres database configuration. See the official driver [documentation](https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING) for configuration options and examples. Please use Postgres versions equal or higher than **11**. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/60-ssl.md b/docs/docs/30-administration/60-ssl.md index 7174d6e412c..41fd07fecfc 100644 --- a/docs/docs/30-administration/60-ssl.md +++ b/docs/docs/30-administration/60-ssl.md @@ -9,8 +9,7 @@ Woodpecker supports automated SSL configuration and updates using Let's Encrypt. You can enable Let's Encrypt by making the following modifications to your server configuration: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -44,8 +43,7 @@ Woodpecker uses the official Go acme library which will handle certificate upgra Woodpecker supports SSL configuration by mounting certificates into your container. -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -66,8 +64,7 @@ services: Update your configuration to expose the following ports: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -81,8 +78,7 @@ services: Update your configuration to mount your certificate and key: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: @@ -99,8 +95,7 @@ services: Update your configuration to provide the paths of your certificate and key: -```diff -# docker-compose.yml +```yaml title="docker-compose.yml" version: '3' services: From e015797c43f603a89aa27164aa68c1421a75eea2 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 26 Nov 2023 17:56:22 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks [CI SKIP] for more information, see https://pre-commit.ci --- docs/docs/20-usage/25-workflows.md | 2 -- docs/docs/30-administration/22-backends/20-local.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/docs/docs/20-usage/25-workflows.md b/docs/docs/20-usage/25-workflows.md index 7aa13542e24..76d33f429e3 100644 --- a/docs/docs/20-usage/25-workflows.md +++ b/docs/docs/20-usage/25-workflows.md @@ -33,7 +33,6 @@ If you still need to pass artifacts between the workflows you need use some stor └── .test.yml ``` - ```yaml title=".woodpecker/.build.yml" steps: build: @@ -43,7 +42,6 @@ steps: - sleep 5 ``` - ```yaml title=".woodpecker/.deploy.yml" steps: deploy: diff --git a/docs/docs/30-administration/22-backends/20-local.md b/docs/docs/30-administration/22-backends/20-local.md index f5388d45610..c3f1d9424d7 100644 --- a/docs/docs/30-administration/22-backends/20-local.md +++ b/docs/docs/30-administration/22-backends/20-local.md @@ -77,7 +77,6 @@ The `image` entry is used to specify the shell, such as Bash or Fish, that is used to run the commands. ```yaml title=".woodpecker.yml" - steps: build: image: bash @@ -113,7 +112,6 @@ Then, use this `label` `type` with value `exec` in the pipeline definition, to only run on this agent: ```yaml title=".woodpecker.yml" - labels: type: exec From 6a678622a5bb2d7a25e3e121671a5a46008addae Mon Sep 17 00:00:00 2001 From: micash Date: Sun, 26 Nov 2023 18:58:47 +0100 Subject: [PATCH 3/4] add missing prism languages --- docs/docusaurus.config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 8d740ff6615..e3474ef9d12 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -138,7 +138,7 @@ const config: Config = { prism: { theme: themes.github, darkTheme: themes.dracula, - additionalLanguages: ['diff', 'json', 'docker', 'javascript', 'css', 'bash', 'nginx', 'apacheconf'], + additionalLanguages: ['diff', 'json', 'docker', 'javascript', 'css', 'bash', 'nginx', 'apacheconf', 'ini', 'nix'], }, announcementBar: { id: 'github-star', From ee863d55a9d9c1ac5bdbbde2c10d0dc98f027832 Mon Sep 17 00:00:00 2001 From: micash Date: Sun, 26 Nov 2023 19:13:23 +0100 Subject: [PATCH 4/4] return diff code blocks --- .../00-deployment/10-docker-compose.md | 12 ++++++------ docs/docs/30-administration/10-server-config.md | 14 +++++++------- docs/docs/30-administration/11-forges/30-gitea.md | 4 ++-- docs/docs/30-administration/11-forges/40-gitlab.md | 2 +- .../30-administration/11-forges/50-bitbucket.md | 2 +- docs/docs/30-administration/15-agent-config.md | 4 ++-- docs/docs/30-administration/30-database.md | 6 +++--- docs/docs/30-administration/60-ssl.md | 8 ++++---- 8 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/docs/30-administration/00-deployment/10-docker-compose.md b/docs/docs/30-administration/00-deployment/10-docker-compose.md index dd466628d55..ea78f1ca111 100644 --- a/docs/docs/30-administration/00-deployment/10-docker-compose.md +++ b/docs/docs/30-administration/00-deployment/10-docker-compose.md @@ -42,7 +42,7 @@ volumes: Woodpecker needs to know its own address. You must therefore provide the public address of it in `://` format. Please omit trailing slashes: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -56,7 +56,7 @@ services: Woodpecker can also have its port's configured. It uses a separate port for gRPC and for HTTP. The agent performs gRPC calls and connects to the gRPC port. They can be configured with ADDR variables: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: woodpecker-server: @@ -69,7 +69,7 @@ services: Reverse proxying can also be [configured for gRPC](../proxy#caddy). If the agents are connecting over the internet, it should also be SSL encrypted. The agent then needs to be configured to be secure: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: woodpecker-server: @@ -82,7 +82,7 @@ services: As agents run pipeline steps as docker containers they require access to the host machine's Docker daemon: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -95,7 +95,7 @@ services: Agents require the server address for agent-to-server communication. The agent connects to the server's gRPC port: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -107,7 +107,7 @@ services: The server and agents use a shared secret to authenticate communication. This should be a random string of your choosing and should be kept private. You can generate such string with `openssl rand -hex 32`: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 0c74364f786..bbc5ffa4b59 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -8,7 +8,7 @@ Registration is closed by default (`WOODPECKER_OPEN=false`). If registration is To open registration: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -26,7 +26,7 @@ by open registration and **filter by organization** membership through the `WOOD ### To close registration, but allow specific admin users -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -40,7 +40,7 @@ services: ### To only allow registration of users, who are members of approved organizations -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -56,7 +56,7 @@ services: Administrators should also be enumerated in your configuration. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -73,7 +73,7 @@ Woodpecker operates with the user's OAuth permission. Due to the coarse permissi Use the `WOODPECKER_REPO_OWNERS` variable to filter which GitHub user's repos should be synced only. You typically want to put here your company's GitHub name. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -89,7 +89,7 @@ services: If you want to make available a specific private registry to all pipelines, use the `WOODPECKER_DOCKER_CONFIG` server configuration. Point it to your server's docker config. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -111,7 +111,7 @@ For docker-compose you can use a .env file next to your compose configuration to Alternatively use docker-secrets. As it may be difficult to use docker secrets for environment variables woodpecker allows to read sensible data from files by providing a `*_FILE` option of all sensible configuration variables. Woodpecker will try to read the value directly from this file. Keep in mind that when the original environment variable gets specified at the same time it will override the value read from the file. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/11-forges/30-gitea.md b/docs/docs/30-administration/11-forges/30-gitea.md index 9ce282d6e2f..a9b91838d59 100644 --- a/docs/docs/30-administration/11-forges/30-gitea.md +++ b/docs/docs/30-administration/11-forges/30-gitea.md @@ -2,7 +2,7 @@ Woodpecker comes with built-in support for Gitea and the "soft" fork Forgejo. To enable Gitea you should configure the Woodpecker container using the following environment variables: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -27,7 +27,7 @@ Otherwise, the communication should go via the `docker0` gateway (usually 172.17 To configure the Docker network if the network's name is `gitea`, configure it like this: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/11-forges/40-gitlab.md b/docs/docs/30-administration/11-forges/40-gitlab.md index b72957ac670..a3934489daf 100644 --- a/docs/docs/30-administration/11-forges/40-gitlab.md +++ b/docs/docs/30-administration/11-forges/40-gitlab.md @@ -2,7 +2,7 @@ Woodpecker comes with built-in support for the GitLab version 8.2 and higher. To enable GitLab you should configure the Woodpecker container using the following environment variables: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/11-forges/50-bitbucket.md b/docs/docs/30-administration/11-forges/50-bitbucket.md index 593ce2a51fa..05912c1ce5f 100644 --- a/docs/docs/30-administration/11-forges/50-bitbucket.md +++ b/docs/docs/30-administration/11-forges/50-bitbucket.md @@ -2,7 +2,7 @@ Woodpecker comes with built-in support for Bitbucket Cloud. To enable Bitbucket Cloud you should configure the Woodpecker container using the following environment variables: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/15-agent-config.md b/docs/docs/30-administration/15-agent-config.md index 6065aa16df5..e897cea761e 100644 --- a/docs/docs/30-administration/15-agent-config.md +++ b/docs/docs/30-administration/15-agent-config.md @@ -2,7 +2,7 @@ Agents are configured by the command line or environment variables. At the minimum you need the following information: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -24,7 +24,7 @@ The following are automatically set and can be overridden: By default, the maximum workflows that are executed in parallel on an agent is 1. If required, you can add `WOODPECKER_MAX_WORKFLOWS` to increase your parallel processing for an agent. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/30-database.md b/docs/docs/30-administration/30-database.md index 6746977e1ec..1da4bc1854e 100644 --- a/docs/docs/30-administration/30-database.md +++ b/docs/docs/30-administration/30-database.md @@ -6,7 +6,7 @@ The default database engine of Woodpecker is an embedded SQLite database which r By default Woodpecker uses a SQLite database stored under `/var/lib/woodpecker/`. You can mount a [data volume](https://docs.docker.com/storage/volumes/#create-and-manage-volumes) to persist the SQLite database. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -21,7 +21,7 @@ services: The below example demonstrates MySQL database configuration. See the official driver [documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for configuration options and examples. The minimum version of MySQL/MariaDB required is determined by the `go-sql-driver/mysql` - see [it's README](https://github.com/go-sql-driver/mysql#requirements) for more information. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -37,7 +37,7 @@ services: The below example demonstrates Postgres database configuration. See the official driver [documentation](https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING) for configuration options and examples. Please use Postgres versions equal or higher than **11**. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: diff --git a/docs/docs/30-administration/60-ssl.md b/docs/docs/30-administration/60-ssl.md index 41fd07fecfc..8b6a3315e31 100644 --- a/docs/docs/30-administration/60-ssl.md +++ b/docs/docs/30-administration/60-ssl.md @@ -9,7 +9,7 @@ Woodpecker supports automated SSL configuration and updates using Let's Encrypt. You can enable Let's Encrypt by making the following modifications to your server configuration: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -43,7 +43,7 @@ Woodpecker uses the official Go acme library which will handle certificate upgra Woodpecker supports SSL configuration by mounting certificates into your container. -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -64,7 +64,7 @@ services: Update your configuration to expose the following ports: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: @@ -78,7 +78,7 @@ services: Update your configuration to mount your certificate and key: -```yaml title="docker-compose.yml" +```diff title="docker-compose.yml" version: '3' services: