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 <sergiodj@sergiodj.net>
This commit is contained in:
parent
97c8e23136
commit
9d87049c68
1 changed files with 6 additions and 2 deletions
|
@ -26,8 +26,6 @@ This service requires the following other services:
|
||||||
|
|
||||||
### Configuration
|
### 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:
|
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
|
||||||
|
|
||||||
```yaml
|
```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`.
|
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
|
#### Gitea Integration
|
||||||
|
|
||||||
The Woodpecker CI server can integrate with [Gitea](gitea.md) using the following **additional** `vars.yml` configuration:
|
The Woodpecker CI server can integrate with [Gitea](gitea.md) using the following **additional** `vars.yml` configuration:
|
||||||
|
|
Loading…
Reference in a new issue