README.txt 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Recommended Modules
  6. * Installation
  7. * Configuration
  8. INTRODUCTION
  9. ------------
  10. After a given timeout has passed, users are given a configurable session
  11. expiration prompt. They can reset the timeout, logout, or ignore it, in which
  12. case they'll be logged out after the padding time is elapsed. This is all backed
  13. up by a server side logout if JS is disabled or bypassed.
  14. REQUIREMENTS
  15. ------------
  16. None.
  17. RECOMMENDED MODULES
  18. -------------------
  19. * Session Limit (https://www.drupal.org/project/session_limit)
  20. * Password Policy (https://www.drupal.org/project/password_policy)
  21. INSTALLATION
  22. ------------
  23. * Install as usual:
  24. See https://www.drupal.org/documentation/install/modules-themes/modules-8
  25. for further information.
  26. CONFIGURATION
  27. -------------
  28. * Configure permissions : Home >> Administration >> People
  29. (/admin/people/permissions)
  30. * Configure Automated logout : Home >> Administration >> Configuration >> People
  31. (/admin/config/people/autologout)
  32. * Configurable "Global timeout" and "Timeout padding".
  33. The latter determines how much time a user has to respond to the prompt
  34. and when the server side timeout will occur.
  35. * Configurable messaging.
  36. * Configurable "Redirect URL" with the destination automatically appended.
  37. * Configure which roles will be automatically logged out.
  38. * Configure if a logout will occur on admin pages.
  39. * Integration with ui.dialog if available.
  40. This makes for attractive and more functional dialogs.
  41. * Configurable timeout based on user.
  42. * Configurable maximum timeout.
  43. Primarily used when a user has permission to change their timeout value,
  44. this will be a cap or maximum value they can use.
  45. * Order of precedence is : user timeout -> lowest role timeout -> global
  46. timeout.
  47. * So if a user has a user timeout set, that is their timeout threshold,
  48. if none is set the lowest timeout value based on all the roles the user
  49. belongs to is used, if none is set the global timeout is used.