From af68be196b0700eea05d39c19340f8dfe599f34f Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Tue, 18 Mar 2025 13:15:00 +0100 Subject: [PATCH] Add documentation for WOODPECKER_EXPERT env vars (#4972) --- cmd/server/flags.go | 4 +-- .../10-configuration/10-server.md | 28 +++++++++++++++++-- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/cmd/server/flags.go b/cmd/server/flags.go index 8a7839457..e03c9e630 100644 --- a/cmd/server/flags.go +++ b/cmd/server/flags.go @@ -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: ://[/]", + Usage: "fully qualified public forge url, used if forge url is not a public url. Format: ://[/]", }, // // 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: ://[/]", + Usage: "fully qualified woodpecker server url, called by the webhooks of the forge. Format: ://[/]", }, // // secrets encryption in DB diff --git a/docs/docs/30-administration/10-configuration/10-server.md b/docs/docs/30-administration/10-configuration/10-server.md index 18f85e5cf..f47ac222c 100644 --- a/docs/docs/30-administration/10-configuration/10-server.md +++ b/docs/docs/30-administration/10-configuration/10-server.md @@ -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: `://[/]`. + +--- + +### 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: `://[/]`. + +--- + ### GITHUB\_\* See [GitHub configuration](./12-forges/20-github.md#configuration)