Mirrors/mash-playbook
2
0
Fork 0
mirror of https://github.com/mother-of-all-self-hosting/mash-playbook synced 2024-11-12 23:27:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

Put devture_woodpecker_ci_server_path_prefix in the default example in woodpecker-ci.md

Browse source 
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.
This commit is contained in:
Slavi Pantaleev 2024-02-23 08:38:29 +02:00 committed by GitHub
parent 9d87049c68
commit 0c033f8ac3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/services/woodpecker-ci.md
View file

@ -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.