`AXES_COOLOFF_TIME` is undocumented

[carstenfuchs]

Looking at the current Axes 8.1.0 documentation at https://django-axes.readthedocs.io, it is briefly mentioned in a few places that something like a cool off period exists, but the setting itself is nowhere explained.

I would have expected the documentation of the AXES_COOLOFF_TIME setting at Configuring project settings, which indeed starts promising:

The following settings.py options are available for customizing Axes behaviour.

but after that, I'm completely lost (also regarding the rest of this section).

• What unit is AXES_COOLOFF_TIME given in (seconds, hours, ...)?
• How does it work? When is a locked IP cool again? (For example after no failed login attempts at all during the cool off period, or after number of failures within the specified limits, …?)

---

That brings me to the next setting, yet unknown to me:
Is there somewhere a setting where I can set the "number of failed login attempts per xx minutes" before an IP is locked? Somewhere I read something about AXES_FAILURE_LIMIT, but that seems to be undocumented as well.

[aleksihakli]

Hey @carstenfuchs, thanks for reporting!

Would you be interested in adding the appropriate documentation for these items? We warmly welcome contributions to the project.

[rodrigobnogueira]

I'll submit a PR for this one ok? I'm already working on another PR for django-axes