[doc] improve documentation WOODPECKER_SESSION_EXPIRES (#2603)

woodpecker-ci · Oct 18, 2023 · 3f185d5 · 3f185d5
1 parent cbf052c
commit 3f185d5
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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)