Permalink
Browse files

Improved formatting

  • Loading branch information...
1 parent 03c8282 commit 19182a4b43edb62d6dc83f3294b71945af501c99 @camilonova camilonova committed Nov 8, 2013
Showing with 29 additions and 27 deletions.
  1. +29 −27 README.rst
View
@@ -9,11 +9,12 @@ Django Axes
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:
- * "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
+* "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!
+
Requirements
============
@@ -95,28 +96,29 @@ Customizing Axes
You have a couple options available to you to customize ``django-axes`` a bit.
These should be defined in your ``settings.py`` file.
- * ``AXES_LOGIN_FAILURE_LIMIT``: The number of login attempts allowed before a
- record is created for the failed logins. Default: ``3``
- * ``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. Default: ``None``
- * ``AXES_LOGGER``: If set, specifies a logging mechanism for axes to use.
- Default: ``'axes.watch_login'``
- * ``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. Default: ``None``
- * ``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. Default: ``None``
- * ``AXES_VERBOSE``: If ``True``, you'll see slightly more logging for Axes.
- Default: ``True``
+* ``AXES_LOGIN_FAILURE_LIMIT``: The number of login attempts allowed before a
+ record is created for the failed logins. Default: ``3``
+* ``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. Default: ``None``
+* ``AXES_LOGGER``: If set, specifies a logging mechanism for axes to use.
+ Default: ``'axes.watch_login'``
+* ``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. Default: ``None``
+* ``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. Default: ``None``
+* ``AXES_VERBOSE``: If ``True``, you'll see slightly more logging for Axes.
+ Default: ``True``
+
Usage
=====

0 comments on commit 19182a4

Please sign in to comment.