You are here

Home » API reference » Automated Logout 8

README.txt in Automated Logout 8

Same filename and directory in other branches
  1. 5 README.txt
  2. 6.4 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
  5. 7.5 README.txt
  6. 7.2 README.txt
  7. 7.4 README.txt
CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Recommended Modules
 * Installation
 * Configuration

INTRODUCTION
------------
After a given timeout has passed, users are given a configurable session
expiration prompt. They can reset the timeout, logout, or ignore it, in which
case they'll be logged out after the padding time is elapsed. This is all backed
up by a server side logout if JS is disabled or bypassed.

REQUIREMENTS
------------
None.

RECOMMENDED MODULES
-------------------
 * Session Limit (https://www.drupal.org/project/session_limit)
 * Password Policy (https://www.drupal.org/project/password_policy)

INSTALLATION
------------
 * Install as usual:
 See https://www.drupal.org/documentation/install/modules-themes/modules-8
 for further information.

CONFIGURATION
-------------
* Configure permissions : Home >> Administration >> People
  (/admin/people/permissions)
* Configure Automated logout : Home >> Administration >> Configuration >> People
  (/admin/config/people/autologout)
* Configurable "Global timeout" and "Timeout padding".
  The latter determines how much time a user has to respond to the prompt
  and when the server side timeout will occur.
* Configurable messaging.
* Configurable "Redirect URL" with the destination automatically appended.
* Configure which roles will be automatically logged out.
* Configure if a logout will occur on admin pages.
* Integration with ui.dialog if available.
  This makes for attractive and more functional dialogs.
* Configurable timeout based on user.
* Configurable maximum timeout.
  Primarily used when a user has permission to change their timeout value,
  this will be a cap or maximum value they can use.
* Order of precedence is : user timeout -> lowest role timeout -> global
  timeout.
* So if a user has a user timeout set, that is their timeout threshold,
  if none is set the lowest timeout value based on all the roles the user
  belongs to is used, if none is set the global timeout is used.
* Make sure the timeout value in seconds is smaller than the value for
  session.gc_maxlifetime. Otherwise your session will be destroyed before
  autologout kicks in.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Requirements

  5.  * Recommended Modules

  6.  * Installation

  7.  * Configuration

  8. 

  9. INTRODUCTION

  10. ------------

  11. After a given timeout has passed, users are given a configurable session

  12. expiration prompt. They can reset the timeout, logout, or ignore it, in which

  13. case they'll be logged out after the padding time is elapsed. This is all backed

  14. up by a server side logout if JS is disabled or bypassed.

  15. 

  16. REQUIREMENTS

  17. ------------

  18. None.

  19. 

  20. RECOMMENDED MODULES

  21. -------------------

  22.  * Session Limit (https://www.drupal.org/project/session_limit)

  23.  * Password Policy (https://www.drupal.org/project/password_policy)

  24. 

  25. INSTALLATION

  26. ------------

  27.  * Install as usual:

  28.  See https://www.drupal.org/documentation/install/modules-themes/modules-8

  29.  for further information.

  30. 

  31. CONFIGURATION

  32. -------------

  33. * Configure permissions : Home >> Administration >> People

  34.   (/admin/people/permissions)

  35. * Configure Automated logout : Home >> Administration >> Configuration >> People

  36.   (/admin/config/people/autologout)

  37. * Configurable "Global timeout" and "Timeout padding".

  38.   The latter determines how much time a user has to respond to the prompt

  39.   and when the server side timeout will occur.

  40. * Configurable messaging.

  41. * Configurable "Redirect URL" with the destination automatically appended.

  42. * Configure which roles will be automatically logged out.

  43. * Configure if a logout will occur on admin pages.

  44. * Integration with ui.dialog if available.

  45.   This makes for attractive and more functional dialogs.

  46. * Configurable timeout based on user.

  47. * Configurable maximum timeout.

  48.   Primarily used when a user has permission to change their timeout value,

  49.   this will be a cap or maximum value they can use.

  50. * Order of precedence is : user timeout -> lowest role timeout -> global

  51.   timeout.

  52. * So if a user has a user timeout set, that is their timeout threshold,

  53.   if none is set the lowest timeout value based on all the roles the user

  54.   belongs to is used, if none is set the global timeout is used.

  55. * Make sure the timeout value in seconds is smaller than the value for

  56.   session.gc_maxlifetime. Otherwise your session will be destroyed before

  57.   autologout kicks in.