Hopiu/django-axes
1
0
Fork 0
mirror of https://github.com/jazzband/django-axes.git synced 2026-03-16 22:30:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update docs

Browse source 
Add new management commands and reorder sections logically.
This commit is contained in:
Aleksi Häkli 2019-07-09 14:44:46 +02:00
parent 0f3b3527be
commit eedf528767
No known key found for this signature in database
GPG key ID: 3E7146964D726BBE
2 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/3_usage.rst
View file

@ -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

8
docs/4_configuration.rst
View file

@ -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