From 0c033f8ac39db14542873b1dd3be9d338b7abbe0 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Fri, 23 Feb 2024 08:38:29 +0200 Subject: [PATCH] Put devture_woodpecker_ci_server_path_prefix in the default example in woodpecker-ci.md This is consistent with other services. We demonstarte the subpath approach (where it's feasible) and tell people how to host at the root path if they wish. --- docs/services/woodpecker-ci.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/services/woodpecker-ci.md b/docs/services/woodpecker-ci.md index 90b7d8c..076f607 100644 --- a/docs/services/woodpecker-ci.md +++ b/docs/services/woodpecker-ci.md @@ -37,7 +37,9 @@ To enable this service, add the following configuration to your `vars.yml` file devture_woodpecker_ci_server_enabled: true -devture_woodpecker_ci_server_hostname: woodpecker.example.com +devture_woodpecker_ci_server_hostname: mash.example.com + +devture_woodpecker_ci_server_path_prefix: /ci # Generate this secret with `openssl rand -hex 32` devture_woodpecker_ci_server_config_agent_secret: '' @@ -57,13 +59,9 @@ devture_woodpecker_ci_server_config_admins: ######################################################################## ``` -In the example configuration above, we configure the service to be hosted at `https://woodpecker.example.com`. +In the example configuration above, we configure the service to be hosted at `https://mash.example.com/ci`. -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 -``` +If you want to host the service at the root path, remove the `devture_woodpecker_ci_server_path_prefix` variable override. #### Gitea Integration @@ -84,11 +82,11 @@ devture_woodpecker_ci_server_container_add_host_domain_name: "{{ gitea_hostname devture_woodpecker_ci_server_container_add_host_ip_address: "{{ ansible_host }}" ``` -To integrate with version-control systems other than Gitea, you'll need similar configuration. +To integrate with version-control systems other than Gitea (e.g. [Forgejo](forgejo.md)), you'll need similar configuration. ### Usage -After installation, you should be able to access the Woodpecker CI server instance at `https://woodpecker.DOMAIN` (matching the `devture_woodpecker_ci_server_hostname` value configured in `vars.yml`). +After installation, you should be able to access the Woodpecker CI server instance at `https://mash.DOMAIN/ci` (matching the `devture_woodpecker_ci_server_hostname` and `devture_woodpecker_ci_server_path_prefix` values configured in `vars.yml`). The **Log in** button should take you to Gitea, where you can authorize Woodpecker CI with the OAuth 2 application.