====== AutoLogOff Plugin ======

---- plugin ----
description: Automatically log out users after a defined period of inactivity
author     : Andreas Gohr 
email      : dokuwiki@cosmocode.de
type       : action
lastupdate : 2024-04-15
compatible : Hrun, Greebo, Hogfather, Igor
depends    : 
conflicts  : 
similar    : 
tags       : logout, logoff, security

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-autologoff/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-autologoff/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-autologoff/
donationurl: 

screenshot_img : :plugin:autologoff.png
----

If you want to make sure your users will not leave open sensitive data on the wiki open in a Browser while they are not at their desktop, this plugin might be for you. You can configure inactivity times for groups and single users. After the specified amount of time the user is automatically logged out. Users will be warned about the logout one minute in advance, so they can abort the automatic logout and reset the timer.

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Configuration and Settings =====

Configure groups and users that shall be logged out after inactivity in the admin backend. Times are specified in minutes. Setting it to 0 will disable the logout for a user or group.

===== Development =====

==== Changes ====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-autologoff/commits/master.atom author date}}

==== Added Events ====

This plugin triggers the custom Event ''ACTION_AUTH_AUTOLOGOFF'' when the automatic logout occurs. ''advise_before'' is called immediately before the logout, ''advise_after'' is called immediately afterwards. The event cannot be prevented.


===== FAQ =====

  * Does it require full inactivity (the user left their computer) for the automatic logoff to occur? Or will it occur if the user is still using the computer for something else (another program?, another browser tab?) but not using dokuwiki?