Add documentation for WOODPECKER_EXPERT env vars (#4972)

This commit is contained in:
Robert Kaussow 2025-03-18 13:15:00 +01:00 committed by GitHub
parent 0ef31d27a2
commit af68be196b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 28 additions and 4 deletions

View file

@ -410,7 +410,7 @@ var flags = append([]cli.Flag{
&cli.StringFlag{
Sources: cli.EnvVars("WOODPECKER_EXPERT_FORGE_OAUTH_HOST"),
Name: "forge-oauth-host",
Usage: "!!!for experts!!! fully qualified public forge url. Use it if your forge url WOODPECKER_FORGE_URL or WOODPECKER_GITEA_URL, ... isn't a public url. Format: <scheme>://<host>[/<prefix path>]",
Usage: "fully qualified public forge url, used if forge url is not a public url. Format: <scheme>://<host>[/<prefix path>]",
},
//
// Addon
@ -515,7 +515,7 @@ var flags = append([]cli.Flag{
&cli.StringFlag{
Sources: cli.EnvVars("WOODPECKER_EXPERT_WEBHOOK_HOST"),
Name: "server-webhook-host",
Usage: "!!!for experts!!! fully qualified woodpecker server url called by forge's webhooks. Format: <scheme>://<host>[/<prefix path>]",
Usage: "fully qualified woodpecker server url, called by the webhooks of the forge. Format: <scheme>://<host>[/<prefix path>]",
},
//
// secrets encryption in DB

View file

@ -1053,8 +1053,6 @@ Supported variables:
---
---
### CONFIG_SERVICE_ENDPOINT
- Name: `WOODPECKER_CONFIG_SERVICE_ENDPOINT`
@ -1118,6 +1116,32 @@ Directory to store logs in if [`WOODPECKER_LOG_STORE`](#log_store) is `file`.
---
### EXPERT_WEBHOOK_HOST
- Name: `WOODPECKER_EXPERT_WEBHOOK_HOST`
- Default: none
:::warning
This option is not required in most cases and should only be used if you know what you're doing.
:::
Fully qualified Woodpecker server URL, called by the webhooks of the forge. Format: `<scheme>://<host>[/<prefix path>]`.
---
### EXPERT_FORGE_OAUTH_HOST
- Name: `WOODPECKER_EXPERT_FORGE_OAUTH_HOST`
- Default: none
:::warning
This option is not required in most cases and should only be used if you know what you're doing.
:::
Fully qualified public forge URL, used if forge url is not a public URL. Format: `<scheme>://<host>[/<prefix path>]`.
---
### GITHUB\_\*
See [GitHub configuration](./12-forges/20-github.md#configuration)