From df73d2c47519652780cf7489d3aef3ced1c6ef5a Mon Sep 17 00:00:00 2001 From: Patrick Schratz Date: Tue, 26 Dec 2023 11:18:05 +0100 Subject: [PATCH] Document `WOODPECKER_LOG_FILE` (#3022) Missed from #2115 Also rephrased the description a bit. --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> --- cmd/common/logger.go | 2 +- docs/docs/30-administration/10-server-config.md | 7 +++++++ .../version-2.0/30-administration/10-server-config.md | 7 +++++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/cmd/common/logger.go b/cmd/common/logger.go index d9b4e9671..3dad5aac8 100644 --- a/cmd/common/logger.go +++ b/cmd/common/logger.go @@ -34,7 +34,7 @@ var GlobalLoggerFlags = []cli.Flag{ &cli.StringFlag{ EnvVars: []string{"WOODPECKER_LOG_FILE"}, Name: "log-file", - Usage: "where logs are written to. 'stdout' and 'stderr' can be used as special keywords", + Usage: "Output destination for logs. 'stdout' and 'stderr' can be used as special keywords.", Value: "stderr", }, &cli.BoolFlag{ diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 060a29519..fd6b55d59 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -189,6 +189,13 @@ The following list describes all available server configuration options. Configures the logging level. Possible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`, `disabled` and empty. +### `WOODPECKER_LOG_FILE` + +> Default: `stderr` + +Output destination for logs. +'stdout' and 'stderr' can be used as special keywords. + ### `WOODPECKER_LOG_XORM` > Default: `false` diff --git a/docs/versioned_docs/version-2.0/30-administration/10-server-config.md b/docs/versioned_docs/version-2.0/30-administration/10-server-config.md index 26d775f79..45606e43d 100644 --- a/docs/versioned_docs/version-2.0/30-administration/10-server-config.md +++ b/docs/versioned_docs/version-2.0/30-administration/10-server-config.md @@ -196,6 +196,13 @@ The following list describes all available server configuration options. Configures the logging level. Possible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`, `disabled` and empty. +### `WOODPECKER_LOG_FILE` + +> Default: `stderr` + +Output destination for logs. +'stdout' and 'stderr' can be used as special keywords. + ### `WOODPECKER_LOG_XORM` > Default: `false`