From eedf5287678d8582dd755f02e5970e06397011ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksi=20Ha=CC=88kli?= Date: Tue, 9 Jul 2019 14:44:46 +0200 Subject: [PATCH] Update docs Add new management commands and reorder sections logically. --- docs/3_usage.rst | 3 +++ docs/4_configuration.rst | 8 ++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/3_usage.rst b/docs/3_usage.rst index c459ee4..1f5562c 100644 --- a/docs/3_usage.rst +++ b/docs/3_usage.rst @@ -89,6 +89,9 @@ management commands with the Django ``manage.py`` or ``django-admin`` command he will clear lockouts and records for the given IP addresses. - ``python manage.py axes_reset_username [username ...]`` will clear lockouts and records for the given usernames. +- ``python manage.py axes_reset_logs (age)`` + will reset (i.e. delete) AccessLog records that are older + than the given age where the default is 30 days. Resetting attempts programmatically by APIs diff --git a/docs/4_configuration.rst b/docs/4_configuration.rst index 23eb191..fef08c8 100644 --- a/docs/4_configuration.rst +++ b/docs/4_configuration.rst @@ -30,15 +30,15 @@ The following ``settings.py`` options are available for customizing Axes behavio old failed login attempts will be cleared. Can be set to a Python timedelta object or an integer. If an integer, will be interpreted as a number of hours. Default: ``None`` -* ``AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``: If ``True``, prevent login - from IP under a particular username if the attempt limit has been exceeded, - otherwise lock out based on IP. +* ``AXES_ONLY_ADMIN_SITE`` : If ``True``, lock is only enable for admin site, Default: ``False`` * ``AXES_ONLY_USER_FAILURES`` : If ``True``, only lock based on username, and never lock based on IP if attempts exceed the limit. Otherwise utilize the existing IP and user locking logic. Default: ``False`` -* ``AXES_ONLY_ADMIN_SITE`` : If ``True``, lock is only enable for admin site, +* ``AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP``: If ``True``, prevent login + from IP under a particular username if the attempt limit has been exceeded, + otherwise lock out based on IP. Default: ``False`` * ``AXES_USE_USER_AGENT``: If ``True``, lock out and log based on the IP address and the user agent. This means requests from different user agents but from