Hopiu/django-axes
1
0
Fork 0
mirror of https://github.com/jazzband/django-axes.git synced 2026-05-16 19:41:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve project documentation

Browse source 
Add ipware documentation
This commit is contained in:
Aleksi Häkli 2018-04-11 20:15:35 +03:00 committed by GitHub
parent d08aaa5602
commit d1f1f400b4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/configuration.rst
View file

@ -3,9 +3,7 @@
Configuration
=============
3 Simple Steps!
- add `axes` to your ``INSTALLED_APPS``::
Add `axes` to your ``INSTALLED_APPS``::
INSTALLED_APPS = (
'django.contrib.admin',
@ -13,21 +11,27 @@ Configuration
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
...
# ...
'axes',
...
# ...
)
- add Axes to the top of ``AUTHENTICATION_BACKENDS``::
Add ``axes.backends.AxesModelBackend`` to the top of ``AUTHENTICATION_BACKENDS``::
AUTHENTICATION_BACKENDS = [
'axes.middleware.DjangoAxesAuthBackend',
...
'axes.backends.AxesModelBackend',
# ...
'django.contrib.auth.backends.ModelBackend',
...
# ...
]
- run ``python manage.py migrate`` to sync the database.
Run ``python manage.py migrate`` to sync the database.
Configure `django-ipware <https://github.com/un33k/django-ipware/>`_ to your liking. Pay close attention to the `IPWARE_META_PRECEDENCE_ORDER <https://github.com/un33k/django-ipware#precedence-order>`_ setting. Please note that this configuration is required for functional security in your project. A good starting point for a project running without a reverse proxy could be::
IPWARE_META_PRECEDENCE_ORDER = (
'REMOTE_ADDR',
)
Things to you might need to change in your code, especially if you get a ``AxesModelBackend.RequestParameterRequired``: