summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/administration/session_limits.rst
diff options
context:
space:
mode:
authorDon Naro <dnaro@redhat.com>2023-09-01 17:24:03 +0200
committerGitHub <noreply@github.com>2023-09-01 17:24:03 +0200
commitdc81aa46d088df0e045b55be4a2d70d8a204cc8e (patch)
treef44a9e7831b817913d3fa174d85eba770fc06401 /docs/docsite/rst/administration/session_limits.rst
parentRemove extra scheduler state save that does nothing (#14396) (diff)
downloadawx-dc81aa46d088df0e045b55be4a2d70d8a204cc8e.tar.xz
awx-dc81aa46d088df0e045b55be4a2d70d8a204cc8e.zip
Create AWX docsite with RST content (#14328)
Co-authored-by: Thanhnguyet Vo <tvo@ansible.com> Co-authored-by: TVo <thavo@redhat.com>
Diffstat (limited to 'docs/docsite/rst/administration/session_limits.rst')
-rw-r--r--docs/docsite/rst/administration/session_limits.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/docsite/rst/administration/session_limits.rst b/docs/docsite/rst/administration/session_limits.rst
new file mode 100644
index 0000000000..4eac4a4f4c
--- /dev/null
+++ b/docs/docsite/rst/administration/session_limits.rst
@@ -0,0 +1,26 @@
+.. _ag_session_limits:
+
+Working with Session Limits
+=================================
+.. index::
+ single: session limits
+ single: session.py
+ pair: SESSIONS_PER_USER; session limits
+ pair: AUTH_BASIC_ENABLED; session limits
+
+Setting a session limit allows administrators to limit the number of simultaneous sessions per user or per IP address.
+
+A session is created for each browser that a user uses to log in, which forces the user to log out any extra sessions after they exceed the administrator-defined maximum.
+
+Session limits may be important, depending on your particular setup. For example, perhaps you only want a single user on your system with a single login per device (where the user could log in on his work laptop, phone, or home computer). In such a case, you would want to create a session limit equal to 1 (one). If the user logs in on his laptop, for example, then logs in using his phone, his laptop session expires (times out) and only the login on the phone persists. Proactive session limits will kick the user out when the session is idle. The default value is **-1**, which disables the maximum sessions allowed altogether, meaning you can have as many sessions without an imposed limit.
+
+While session counts can be very limited, they can also be expanded to cover as many session logins as are needed by your organization.
+
+When a user logs in and their login results in other users being logged out, the session limit has been reached and those users who are logged out are notified as to why the logout occurred.
+
+To make changes to your session limits, navigate to the **Miscellaneous System settings** of the Settings menu and edit the **Maximum Number Of Simultaneous Logged In Sessions** setting or use the :ref:`api_browsable_api` if you are comfortable with making REST requests.
+
+.. note::
+ To make the best use of session limits, disable ``AUTH_BASIC_ENABLED`` by changing the value to ``False``, as it falls outside of the scope of session limit enforcement. Alternatively, in the System Settings of the AWX UI, toggle the **Enable HTTP Basic Auth** to off.
+
+.. image:: ../common/images/configure-awx-session-limits.png