doc new features

This commit is contained in:
Mike Blume 2010-09-20 17:14:34 +00:00
parent df61513e71
commit f289dc9f81

3
README
View file

@ -90,6 +90,9 @@ You have a couple options available to you to customize `django-axes` a bit. Th
* `AXES_LOCK_OUT_AT_FAILURE`: After the number of allowed login attempts are exceeded, should we lock out this IP (and optional user agent)? Default: `True`
* `AXES_USE_USER_AGENT`: If True, lock out / log based on an IP address AND a user agent. This means requests from different user agents but from the same IP are treated differently. Default: `False`
* `AXES_COOLOFF_TIME`: If set, defines a period of inactivity after which old failed login attempts will be forgotten. Can be set to a python timedelta object or an integer. If an integer, will be interpreted as a number of hours.
* `AXES_LOGGER`: If set, specifies a logging mechanism for axes to use.
* `AXES_LOCKOUT_TEMPLATE`: If set, specifies a template to render when a user is locked out. Template receives cooloff_time and failure_limit as context variables.
* `AXES_LOCKOUT_URL`: If set, specifies a URL to redirect to on lockout. If both AXES_LOCKOUT_TEMPLATE and AXES_LOCKOUT_URL are set, the template will be used.
==Usage==