Document WOODPECKER_LOG_FILE (#3022)

Missed from #2115 Also rephrased the description a bit. --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
woodpecker-ci · Dec 26, 2023 · df73d2c · df73d2c
1 parent 5671956
commit df73d2c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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`