From 9d87049c68889937c56a89ab78fd97a74ff2a9fb Mon Sep 17 00:00:00 2001 From: Sergio Durigan Junior Date: Thu, 22 Feb 2024 22:01:35 -0500 Subject: [PATCH] Improve Woodpecker CI docs to mention subpath hosting It should now be possible to host Woodpecker CI under a subpath, so we need to update the documentation to reflect that. Closes #151 Signed-off-by: Sergio Durigan Junior --- docs/services/woodpecker-ci.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/services/woodpecker-ci.md b/docs/services/woodpecker-ci.md index a6b60aa..90b7d8c 100644 --- a/docs/services/woodpecker-ci.md +++ b/docs/services/woodpecker-ci.md @@ -26,8 +26,6 @@ This service requires the following other services: ### Configuration -Until [this Woodpecker CI issue](https://github.com/woodpecker-ci/woodpecker/issues/1636) is solved, Woodpecker CI can only be hosted at its own dedicated domain name, at the root path (`/`). It **cannot** be hosted at a subpath (e.g. `/ci`). - To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: ```yaml @@ -61,6 +59,12 @@ devture_woodpecker_ci_server_config_admins: In the example configuration above, we configure the service to be hosted at `https://woodpecker.example.com`. +If you want to host the service at a subpath (e.g. `/ci`), you should set the following variable: + +``` +devture_woodpecker_ci_server_path_prefix: /ci +``` + #### Gitea Integration The Woodpecker CI server can integrate with [Gitea](gitea.md) using the following **additional** `vars.yml` configuration: