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

Improve README and add functionality chapter

Browse source 
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
This commit is contained in:
Aleksi Häkli 2019-03-02 22:34:58 +02:00
parent b55cba78e6
commit 757baeb705
No known key found for this signature in database
GPG key ID: 3E7146964D726BBE
1 changed files with 32 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.rst
View file

@ -30,15 +30,31 @@ Django Axes
:alt: Updates
``django-axes`` is a very simple way for you to keep track of failed login
attempts, both for the Django admin and for the rest of your site. The name is
sort of a geeky pun, since ``axes`` can be read interpreted as:
Axes is a very simple way for you to keep track of failed
login attempts for your login and administration views.
The name is sort of a geeky pun, since it can be interpreted as:
* "access", as in monitoring access attempts
* "axes", as in tools you can use hack (generally on wood). In this case,
however, the "hacking" part of it can be taken a bit further: ``django-axes``
is intended to help you *stop* people from hacking (popular media
definition) your website. Hilarious, right? That's what I thought too!
* ``access``, as in monitoring access attempts, or
* ``axes``, as in tools you can use hack (generally on wood).
In this case, however, the hacking part of it can be taken a bit further:
Axes is intended to help you *stop* people from hacking your website.
Functionality
-------------
Axes records login attempts to your Django powered site and prevents attackers
from brute forcing the site when they exceed the configured attempt limit.
Axes can track the attempts and persist them in the database indefinitely,
or alternatively use a fast and DDoS resistant cache implementation.
Axes can be configured to monitor login attempts by
IP address, username, user agent, or their combinations.
Axes supports cool off periods, IP address whitelisting and blacklisting,
user account whitelisting, and other features for Django access management.
Documentation
@ -57,18 +73,18 @@ If you have questions or have trouble using the app please file a bug report at:
https://github.com/jazzband/django-axes/issues
Contributing
------------
Contributions
-------------
This is a `Jazzband <https://jazzband.co>`_ project.
By contributing you agree to abide by the
`Contributor Code of Conduct <https://jazzband.co/about/conduct>`_
and follow the `guidelines <https://jazzband.co/about/guidelines>`_.
Separate proposed changes and PRs into small, distinct patches by type
so that they can be merged faster into upstream and released quicker:
It is best to separate proposed changes and PRs into small, distinct patches
by type so that they can be merged faster into upstream and released quicker:
* Feature
* Bugfix
* Code style
* Documentation
* features,
* bugfixes,
* code style improvements, and
* documentation improvements.