Hopiu/django-axes
1
0
Fork 0
mirror of https://github.com/jazzband/django-axes.git synced 2026-05-18 12:31:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance configuration docs with detailed credentials description

Browse source
This commit is contained in:
Benedikt Bauer 2018-12-20 16:47:29 +01:00
parent a17c7f4706
commit efc02327f3
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/configuration.rst
View file

@ -124,8 +124,12 @@ These should be defined in your ``settings.py`` file.
Default: ``True``
* ``AXES_USERNAME_FORM_FIELD``: the name of the form field that contains your
users usernames. Default: ``username``
* ``AXES_USERNAME_CALLABLE``: A callable function that takes a request object and a credentials dictionary
and returns the username. If empty, axes just fetches it from the credentials or requst.POST fields
* ``AXES_USERNAME_CALLABLE``: A callable function that takes two arguments:
The request object and A dictionary of keyword arguments containing the user credentials
that were passed to authenticate() or your own custom authentication backend.
Credentials matching a set of ‘sensitive’ patterns, (including password) are not contained.
The function must return the username.
If no function is supplied, axes just fetches the username from the credentials or requst.POST fields
based on ``AXES_USERNAME_FORM_FIELD``. Default: ``None``
* ``AXES_PASSWORD_FORM_FIELD``: the name of the form or credentials field that contains your
users password. Default: ``password``