Merge pull request #21464 from abpframework/idle-session-timeout.md

Add `Idle Session Timeout` document.
abpframework · Nov 28, 2024 · da05b26 · da05b26
2 parents 7ba1dc2 + e89f2e6
commit da05b26
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/docs/en/images/idle-message.png b/docs/en/images/idle-message.png
diff --git a/docs/en/images/idle-setting.png b/docs/en/images/idle-setting.png
diff --git a/docs/en/modules/account-pro.md b/docs/en/modules/account-pro.md
@@ -358,3 +358,4 @@ This module doesn't define any additional distributed event. See the [standard d
 * [Impersonation](./account/impersonation.md)
 * [Linked Accounts](./account/linkedaccounts.md)
 * [Session Management](./account/session-management.md)
+* [Idle Session Timeout](./account/idle-session-timeout.md)]
diff --git a/docs/en/modules/account/idle-session-timeout.md b/docs/en/modules/account/idle-session-timeout.md
@@ -0,0 +1,19 @@
+# Idle Session Timeout
+
+The `Idle Session Timeout` feature allows you to automatically log out users after a certain period of inactivity.
+
+## Configure Idle Session Timeout
+
+You can enable/disable the `Idle Session Timeout` feature in the `Setting > Account > Idle Session Timeout` page.
+
+The default idle session timeout is 1 hour. You can change it by selecting a different value from the dropdown list or entering a custom value(in minutes).
+
+![idle-setting](../../images/idle-setting.png)
+
+Once the idle session timeout is reached, the user will see a warning modal before being logged out. if user does not respond for 60 seconds, the user will be logged out automatically.
+
+![idle-setting](../../images/idle-message.png)
+
+## How it works
+
+There is JavaScript code running in the background to detect user activity. such as mouse movement, key press, click, etc. If there is no activity detected for setting time, The warning modal will be shown to the user.