django-auto-logout
Auto logout a user after specific time in Django.
Works with
- Python
🐍 ≥ 3.7, - Django
🌐 ≥ 3.0.
✔️
Installation
pip install django-auto-logout
Append to settings.py
middlewares:
MIDDLEWARE = [
# append after default middlewares
'django_auto_logout.middleware.auto_logout',
]
NOTE
Make sure that the following middlewares are used before doing this:
django.contrib.sessions.middleware.SessionMiddleware
django.contrib.auth.middleware.AuthenticationMiddleware
django.contrib.messages.middleware.MessageMiddleware
💤
Logout in case of idle
Logout a user if there are no requests for a long time.
Add to settings.py
:
AUTO_LOGOUT = {'IDLE_TIME': 600} # logout after 10 minutes of downtime
or the same, but with datetime.timedelta
(more semantically):
from datetime import timedelta
AUTO_LOGOUT = {'IDLE_TIME': timedelta(minutes=10)}
⌛
Limit session time
Logout a user after 3600 seconds (hour) from the last login.
Add to settings.py
:
AUTO_LOGOUT = {'SESSION_TIME': 3600}
or the same, but with datetime.timedelta
(more semantically):
from datetime import timedelta
AUTO_LOGOUT = {'SESSION_TIME': timedelta(hours=1)}
✉️
Show messages when logging out automatically
Set the message that will be displayed after the user automatically logs out of the system:
AUTO_LOGOUT = {
'SESSION_TIME': 3600,
'MESSAGE': 'The session has expired. Please login again to continue.',
}
It uses django.contrib.messages
. Don't forget to display messages in templates:
{% for message in messages %}
<div class="message {{ message.tags }}">
{{ message }}
</div>
{% endfor %}
NOTE
messages
template variable provides by django.contrib.messages.context_processors.messages
context processor.
See TEMPLATES
→ OPTIONS
→ context_processors
in your settings.py
file.
🌈
Combine configurations
You can combine previous configurations. For example, you may want to logout a user in case of downtime (5 minutes or more) and not allow working within one session for more than half an hour:
from datetime import timedelta
AUTO_LOGOUT = {
'IDLE_TIME': timedelta(minutes=5),
'SESSION_TIME': timedelta(minutes=30),
'MESSAGE': 'The session has expired. Please login again to continue.',
}