From 7667d838f24f60c93ff4a1ba59c15a689f065aba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Cie=C5=9Blak?= Date: Mon, 3 Jun 2024 10:43:01 +0200 Subject: [PATCH] Add docs for web_idle_timeout --- docs/pages/connect-your-client/web-ui.mdx | 49 +++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/docs/pages/connect-your-client/web-ui.mdx b/docs/pages/connect-your-client/web-ui.mdx index 021c95fbaa6de..1969aad214d6d 100644 --- a/docs/pages/connect-your-client/web-ui.mdx +++ b/docs/pages/connect-your-client/web-ui.mdx @@ -29,3 +29,52 @@ If the launch button is missing, then you don't have permission to join in any p For more information about the `join_sessions` allow policy, see [Configure an allow policy](../access-controls/guides/moderated-sessions.mdx#configure-an-allow-policy). +## Idle timeout + +After you log in, the Teleport Web UI checks every 30 seconds if your session is inactive. If so, it +logs you out. A session is considered inactive if more than 10 minutes have passed since you last +interacted with any Web UI browser tab, either through keyboard input or mouse movement and clicks. + +To change the default idle timeout of 10 minutes, ask your cluster admin to adjust the +`web_idle_timeout` setting in the Auth Service configuration. + + + + +Use `tctl` to edit the `cluster_networking_config` value: + +```code +$ tctl edit cluster_networking_config +``` + +Change the value of `spec.web_idle_timeout`: + +```yaml +kind: cluster_networking_config +metadata: + ... +spec: + ... + web_idle_timeout: 10m0s + ... +version: v2 +``` + +After you save and exit the editor, `tctl` will update the resource: + +```text +cluster networking configuration has been updated +``` + + + + +Update `/etc/teleport.yaml` in the `auth_service` section and restart the `teleport` daemon. + +```yaml +auth_service: + web_idle_timeout: 10m0s +``` + + +