Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for web_idle_timeout #42058

Merged
merged 3 commits into from
Jun 3, 2024
Merged

Add docs for web_idle_timeout #42058

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5599d9d
Add docs for web_idle_timeout
ravicious May 27, 2024
ec0c61a
Remove leftovers from copying tabs from another page
ravicious May 31, 2024
59fd8db
Rephrase docs to target end users
ravicious May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion docs/pages/connect-your-client/web-ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,54 @@ 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 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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Connect your Client" docs are intended for end users instead of admins. Is it possible to rephrase the change to target end users? E.g., we could tell them to have an admin change web_idle_timeout.

Ideally, there would be a reference we could link to from here that explains the fields of cluster_networking_config for admins, but there doesn't seem to be one. I can open an issue so we can add this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Connect your Client" docs are intended for end users instead of admins. Is it possible to rephrase the change to target end users? E.g., we could tell them to have an admin change web_idle_timeout.

Ah, sure, I wasn't aware of that. AFAIK that's the only page dedicated to Web UI, so I didn't even consider putting this anywhere else. I'll adjust the copy a little bit.

Ideally, there would be a reference we could link to from here that explains the fields of cluster_networking_config for admins, but there doesn't seem to be one. I can open an issue so we can add this.

I'd appreciate that, thanks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added: #42233
I've also approved the PR

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

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