Skip to content

Commit

Permalink
Add docs for web_idle_timeout
Browse files Browse the repository at this point in the history
  • Loading branch information
ravicious committed May 28, 2024
1 parent f28c4aa commit 5599d9d
Showing 1 changed file with 52 additions and 1 deletion.
53 changes: 52 additions & 1 deletion docs/pages/connect-your-client/web-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,55 @@ From the active sessions list, click **Join** and select a participant mode to j

You must have the `join_sessions` allow policy in a role you've been assigned to join sessions in any participant mode.
For information about how to configure the `join_sessions` allow policy and participant modes for a role, see
[Configure an allow policy](../access-controls/guides/moderated-sessions.mdx#configure-an-allow-policy).
[Configure an allow policy](../access-controls/guides/moderated-sessions.mdx#configure-an-allow-policy).

## Idle timeout

After the user logs in, the Teleport Web UI checks every 30 seconds if the session is inactive. If
so, it logs out the user. A session is considered inactive if more than 10 minutes have passed since
the user last interacted with any Web UI browser tab, either through keyboard input or mouse
movement and clicks.

The default idle timeout of 10 minutes can be adjusted in the Auth Service configuration through the
`web_idle_timeout` setting.

<Tabs>
<TabItem scope={["cloud", "team"]} label="Dynamic Resources (All Editions)">

Use `tctl` to edit the `cluster_networking_config` value:

```code
$ tctl edit cluster_networking_config
```

Change the value of `spec.web_idle_timeout` to `saml`:

```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
```

</TabItem>
<TabItem label="Static Config (Self-Hosted)" scope={["oss", "enterprise"]}>

Update `/etc/teleport.yaml` in the `auth_service` section and restart the `teleport` daemon.

```yaml
auth_service:
web_idle_timeout: 10m0s
```

</TabItem>
</Tabs>

0 comments on commit 5599d9d

Please sign in to comment.