From e5999aff35daeec9d854c3027f389a15e464dccb Mon Sep 17 00:00:00 2001 From: Yi Ming Yung Date: Fri, 16 Dec 2016 11:42:51 +0100 Subject: [PATCH] Updated configuration docs to include AXES_IP_WHITELIST --- docs/configuration.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index cebb438..a3414a1 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -56,9 +56,9 @@ These should be defined in your ``settings.py`` file. * ``AXES_ONLY_USER_FAILURES`` : If ``True`` only locks based on user id and never locks by IP if attempts limit exceed, otherwise utilize the existing IP and user locking logic Default: ``False`` -* ``AXES_NEVER_LOCKOUT_WHITELIST``: If ``True``, users can always login from - whitelisted IP addresses. +* ``AXES_NEVER_LOCKOUT_WHITELIST``: If ``True``, users can always login from whitelisted IP addresses. Default: ``False`` +* ``AXES_IP_WHITELIST``: A list of IP's to be whitelisted. For example: AXES_IP_WHITELIST=['0.0.0.0']. Default: [] * ``AXES_BEHIND_REVERSE_PROXY``: If ``True``, it will look for the IP address from the header defined at ``AXES_REVERSE_PROXY_HEADER``. Please make sure if you enable this setting to configure your proxy to set the correct value for the header, otherwise you could be attacked by setting this header directly in every request. Default: ``False`` * ``AXES_REVERSE_PROXY_HEADER``: If ``AXES_BEHIND_REVERSE_PROXY`` is ``True``, it will look for the IP address from this header.