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

[docs] Document new maxSessions config option #151268

Merged
merged 5 commits into from
Feb 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
6 changes: 6 additions & 0 deletions docs/settings/security-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,12 @@ Sets the interval at which {kib} tries to remove expired and invalid sessions fr
+
TIP: Use a string of `<count>[ms\|s\|m\|h\|d\|w\|M\|Y]` (e.g. '20m', '24h', '7d', '1w').

xpack.security.session.сoncurrentSessions.maxSessions::
Set the maximum number of users (sessions) who are allowed to be logged into {kib} at the same time.
watson marked this conversation as resolved.
Show resolved Hide resolved
By default, no limit is applied.
If set, the value of this option should be an integer between `1` and `1000`.
When the limit is exceeded, the oldest session is automatically invalidated.

[[security-encrypted-saved-objects-settings]]
==== Encrypted saved objects settings

Expand Down
15 changes: 15 additions & 0 deletions docs/user/security/session-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,18 @@ You can configure the interval at which {kib} tries to remove expired and invali
xpack.security.session.cleanupInterval: "1d"
--------------------------------------------------------------------------------
--

[[session-max-sessions]]
==== Maximum number of concurrent sessions
By default, there are no limit to the maximum number of concurrent sessions in {kib}.
watson marked this conversation as resolved.
Show resolved Hide resolved
To add a limit use the `xpack.security.session.сoncurrentSessions.maxSessions` configuration option.
watson marked this conversation as resolved.
Show resolved Hide resolved
If set, the value of this option should be an integer between `1` and `1000`.
When the limit is exceeded, the oldest session is automatically invalidated.

--
[source,yaml]
--------------------------------------------------------------------------------
xpack.security.session.сoncurrentSessions:
maxSessions: 3
--------------------------------------------------------------------------------
--