From 4e03df00fff7353f6c6ab48c8cb85d7ce89c7a1a Mon Sep 17 00:00:00 2001 From: mateuszkamola Date: Tue, 26 May 2026 11:47:46 +0200 Subject: [PATCH] docs: add GitHub OAuth App setup hint to docker-compose page (#6643) --- .../docs/30-administration/05-installation/10-docker-compose.md | 2 ++ .../30-administration/05-installation/10-docker-compose.md | 2 ++ .../30-administration/05-installation/10-docker-compose.md | 2 ++ .../30-administration/05-installation/10-docker-compose.md | 2 ++ 4 files changed, 8 insertions(+) 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 7f8fea552..3567dd9d3 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 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. 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. 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 3ac2400e3..4f157e0a2 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 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. 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. 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 3ac2400e3..3db1569b0 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 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. 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. 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 7f8fea552..3567dd9d3 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 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. 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.