Skip to content
Snippets Groups Projects

Update README.txt

Files
2
README.md 0 → 100644
+ 91
0
# Automated Logout
## 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.
For a full description of the module, visit the
[Autologout project page](https://www.drupal.org/project/autologout/issues/3315952).
Submit bug reports or feature suggestions in the
[Autologout issue queue](https://www.drupal.org/project/issues/autologout).
## Requirements
This module requires the following module:
- [JS Cookie](https://www.drupal.org/project/js_cookie)
## Recommended modules
- [Session Limit](https://www.drupal.org/project/session_limit)
- [Password Policy](https://www.drupal.org/project/password_policy)
## Installation
Install as you would normally install a contributed Drupal module. For further
information, see [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-modules).
## 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 maximum value they can use.
Order of precedence is: user timeout -> the lowest role timeout -> global
timeout.
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.
## FAQ
**Q: How to upgrade from version 1.3?**
**A:** After the 1.4 version of module is added to the site, updating the
configuration is required, either using **drush updb**, **drush updatedb**
or browser **/update.php**.
Once database update completes, configuration export is required, to save
the newly added fields and its settings.
Configuration export can be done using **drush cex** or in the configuration
UI `admin/config/development/configuration` where **Export** tab is used for full
or single file export.
## Maintainers
- Ajit Shinde - [(AjitS)](https://www.drupal.org/u/ajits)
- Bostjan Kovac - [(boshtian)](https://www.drupal.org/u/boshtian)
- John Ennew - [(johnennew)](https://www.drupal.org/u/johnennew)
- James Glasgow - [(jrglasgow)](https://www.drupal.org/u/jrglasgow)
- Andy Kirkham - [(AjK)](https://www.drupal.org/u/ajk)
- Dan Andrews - [(dandrews)](https://www.drupal.org/u/dandrews)
- Jakob Perry - [(japerry)](https://www.drupal.org/u/japerry)
- Lev Tsypin - [(levelos)](https://www.drupal.org/u/levelos)
- Prabin Giri - [(prabeen.giri)](https://www.drupal.org/u/prabeengiri)
- K M - [(kmasood)](https://www.drupal.org/u/kmasood)
- Martin Fraser - [(darksnow)](https://www.drupal.org/u/darksnow)
- Alexander Shudra - [(str8)](https://www.drupal.org/u/str8)
Loading