From d6c551cc44fd234147920750c8a70bca77aaf1ed Mon Sep 17 00:00:00 2001 From: Igor Shevchenko Date: Thu, 21 May 2020 03:52:54 +0500 Subject: [PATCH] Update docs for AXES_ONLY_ADMIN_SITE --- docs/4_configuration.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/4_configuration.rst b/docs/4_configuration.rst index 1550181..d975dc5 100644 --- a/docs/4_configuration.rst +++ b/docs/4_configuration.rst @@ -32,7 +32,9 @@ The following ``settings.py`` options are available for customizing Axes behavio or a string path to a callable which takes no arguments. If an integer, will be interpreted as a number of hours. Default: ``None`` -* ``AXES_ONLY_ADMIN_SITE`` : If ``True``, lock is only enable for admin site, +* ``AXES_ONLY_ADMIN_SITE``: If ``True``, lock is only enabled for admin site. + Admin site is determined by checking request path against the path of ``"admin:index"`` view. + If admin urls are not registered in current urlconf, all requests will not be locked. Default: ``False`` * ``AXES_ONLY_USER_FAILURES`` : If ``True``, only lock based on username, and never lock based on IP if attempts exceed the limit.