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.

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

Session Timeout feature in Chef Automate #5627

Merged
merged 6 commits into from
Sep 2, 2021
Merged
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions components/docs-chef-io/content/automate/session_timeout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
+++
title = "Session Timeout"

weight = 70
draft = false

gh_repo = "automate"
[menu]
[menu.automate]
title = "Session Timeout"
parent = "automate/configuring_automate"
identifier = "automate/configuring_automate/session_timeout.md Session Timeout"
weight = 70
+++

Chef Automate has an optional session timeout configuration for signing out idle workstations. Chef Automate measure session activity as any interaction from a workstation, from a mouse, keyboard, or touchpad. With session timeout enabled, Chef Automate signs out idle workstations after a set number of minutes.

To enable session_timeout in Chef Automate:

- Set the value of `enable_idle_timeout` property to **true** in *config.toml* file.
- Set the value of `idle_timeout_minutes` property to your desired time in minutes(for example **30**). (Setting the value of this property to **30** will set the session timeout time to 30 minutes).

{{< note >}}
The minimum value of `idle_timeout_minutes` can be 5 minutes.
{{< /note >}}

This example sets the session timeout to 30 minutes, which means that Chef Automate signs out any connected workstation after 30 minutes of inactivity:

```toml
[global.v1]
[global.v1.session_settings]
enable_idle_timeout = true
idle_timeout_minutes = 30
```