From 3f185d5b364866c4f28564d174e6267db3c0f616 Mon Sep 17 00:00:00 2001 From: "Martin W. Kirst" Date: Wed, 18 Oct 2023 18:26:20 +0200 Subject: [PATCH] [doc] improve documentation WOODPECKER_SESSION_EXPIRES (#2603) --- docs/docs/30-administration/10-server-config.md | 3 +++ .../version-0.15/30-administration/10-server-config.md | 3 +++ .../version-1.0/30-administration/10-server-config.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index 33a010914f..763711e34a 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -355,6 +355,9 @@ The maximum time in minutes you can set in the repo settings before a pipeline g > Default: `72h` Configures the session expiration time. +Context: when someone does log into Woodpecker, a temporary session token is created. +As long as the session is valid (until it expires or log-out), +a user can log into Woodpecker, without re-authentication. ### `WOODPECKER_ESCALATE` > Defaults are defined in [shared/constant/constant.go](https://github.com/woodpecker-ci/woodpecker/blob/main/shared/constant/constant.go) diff --git a/docs/versioned_docs/version-0.15/30-administration/10-server-config.md b/docs/versioned_docs/version-0.15/30-administration/10-server-config.md index f00278993a..f279a7e8d5 100644 --- a/docs/versioned_docs/version-0.15/30-administration/10-server-config.md +++ b/docs/versioned_docs/version-0.15/30-administration/10-server-config.md @@ -173,6 +173,9 @@ The default docker image to be used when cloning the repo > Default: `72h` Configures the session expiration time. +Context: when someone does log into Woodpecker, a temporary session token is created. +As long as the session is valid (until it expires or log-out), +a user can log into Woodpecker, without re-authentication. ### `WOODPECKER_ESCALATE` > Default: `plugins/docker,plugins/gcr,plugins/ecr,woodpeckerci/plugin-docker,woodpeckerci/plugin-docker-buildx` diff --git a/docs/versioned_docs/version-1.0/30-administration/10-server-config.md b/docs/versioned_docs/version-1.0/30-administration/10-server-config.md index 9c111257dc..9f86cb1c0e 100644 --- a/docs/versioned_docs/version-1.0/30-administration/10-server-config.md +++ b/docs/versioned_docs/version-1.0/30-administration/10-server-config.md @@ -352,6 +352,9 @@ The maximum time in minutes you can set in the repo settings before a pipeline g > Default: `72h` Configures the session expiration time. +Context: when someone does log into Woodpecker, a temporary session token is created. +As long as the session is valid (until it expires or log-out), +a user can log into Woodpecker, without re-authentication. ### `WOODPECKER_ESCALATE` > Defaults are defined in [shared/constant/constant.go](https://github.com/woodpecker-ci/woodpecker/blob/master/shared/constant/constant.go)