From 856f2af826a541de57910486bb0a26dbc23ded43 Mon Sep 17 00:00:00 2001 From: Mateusz Kamola Date: Mon, 25 May 2026 11:18:42 +0200 Subject: [PATCH 1/2] docs: add GitHub OAuth App setup hint to docker-compose page --- .../30-administration/05-installation/10-docker-compose.md | 4 +++- .../30-administration/05-installation/10-docker-compose.md | 4 +++- .../30-administration/05-installation/10-docker-compose.md | 4 +++- .../30-administration/05-installation/10-docker-compose.md | 4 +++- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/docs/30-administration/05-installation/10-docker-compose.md b/docs/docs/30-administration/05-installation/10-docker-compose.md index 7f8fea552ae..a0f63fa852f 100644 --- a/docs/docs/30-administration/05-installation/10-docker-compose.md +++ b/docs/docs/30-administration/05-installation/10-docker-compose.md @@ -2,6 +2,8 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. +Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). + It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. The server uses the default port `8000` and gets exposed to the host here, so WoodpeckerWO can be accessed through this port on the host or by a reverse proxy sitting in front of it. @@ -40,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: diff --git a/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md index 3ac2400e30e..9453a8df4bf 100644 --- a/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md +++ b/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md @@ -2,6 +2,8 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. +Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). + It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. The server uses the default port `8000` and gets exposed to the host here, so WoodpeckerWO can be accessed through this port on the host or by a reverse proxy sitting in front of it. @@ -40,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: diff --git a/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md index 3ac2400e30e..9453a8df4bf 100644 --- a/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md +++ b/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md @@ -2,6 +2,8 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. +Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). + It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. The server uses the default port `8000` and gets exposed to the host here, so WoodpeckerWO can be accessed through this port on the host or by a reverse proxy sitting in front of it. @@ -40,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: diff --git a/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md index 7f8fea552ae..a0f63fa852f 100644 --- a/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md +++ b/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md @@ -2,6 +2,8 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. +Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). + It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. The server uses the default port `8000` and gets exposed to the host here, so WoodpeckerWO can be accessed through this port on the host or by a reverse proxy sitting in front of it. @@ -40,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: From 50c1b47b62b8f6c106b2c1947ef733b21f040d6e Mon Sep 17 00:00:00 2001 From: Mateusz Kamola Date: Tue, 26 May 2026 10:20:04 +0200 Subject: [PATCH 2/2] docs: update wording for more generic hint --- .../30-administration/05-installation/10-docker-compose.md | 4 ++-- .../30-administration/05-installation/10-docker-compose.md | 4 ++-- .../30-administration/05-installation/10-docker-compose.md | 4 ++-- .../30-administration/05-installation/10-docker-compose.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docs/30-administration/05-installation/10-docker-compose.md b/docs/docs/30-administration/05-installation/10-docker-compose.md index a0f63fa852f..3567dd9d315 100644 --- a/docs/docs/30-administration/05-installation/10-docker-compose.md +++ b/docs/docs/30-administration/05-installation/10-docker-compose.md @@ -2,7 +2,7 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. -Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). +Before starting, you will need to register an OAuth App with your forge — see the [forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/overview) for instructions. It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. @@ -42,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: diff --git a/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md index 9453a8df4bf..4f157e0a23e 100644 --- a/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md +++ b/docs/versioned_docs/version-3.12/30-administration/05-installation/10-docker-compose.md @@ -2,7 +2,7 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. -Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). +Before starting, you will need to register an OAuth App with your forge — see the [forge documentation](https://woodpecker-ci.org/docs/3.12/administration/configuration/forges/overview) for instructions. It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. @@ -42,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: diff --git a/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md index 9453a8df4bf..3db1569b01a 100644 --- a/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md +++ b/docs/versioned_docs/version-3.13/30-administration/05-installation/10-docker-compose.md @@ -2,7 +2,7 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. -Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). +Before starting, you will need to register an OAuth App with your forge — see the [forge documentation](https://woodpecker-ci.org/docs/3.13/administration/configuration/forges/overview) for instructions. It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. @@ -42,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: diff --git a/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md b/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md index a0f63fa852f..3567dd9d315 100644 --- a/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md +++ b/docs/versioned_docs/version-3.14/30-administration/05-installation/10-docker-compose.md @@ -2,7 +2,7 @@ This example [docker-compose](https://docs.docker.com/compose/) setup shows the deployment of a Woodpecker instance connected to GitHub (`WOODPECKER_GITHUB=true`). If you are using another forge, please change this including the respective secret settings. -Before starting, you will need to register a GitHub OAuth App — see the [GitHub forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/github) for instructions, including the required callback URL (`/authorize`). +Before starting, you will need to register an OAuth App with your forge — see the [forge documentation](https://woodpecker-ci.org/docs/administration/configuration/forges/overview) for instructions. It creates persistent volumes for the server and agent config directories. The bundled SQLite DB is stored in `/var/lib/woodpecker` and is the most important part to be persisted as it holds all users and repository information. @@ -42,7 +42,7 @@ volumes: woodpecker-agent-config: ``` -Woodpecker must know its own address. You must therefore specify the public address in the format `://`. This address is also used as the base for the OAuth callback URL — i.e., for GitHub, the full callback URL to register in your OAuth App will be `:///authorize`. Please omit any trailing slashes: +Woodpecker must know its own address. You must therefore specify the public address in the format `://`. Please omit any trailing slashes: ```diff title="docker-compose.yaml" services: