docs: Clarify cool-off mechanisms and document AXES_USE_ATTEMPT_EXPIRATION#1400
Open
rodrigobnogueira wants to merge 5 commits intojazzband:masterfrom
Open
docs: Clarify cool-off mechanisms and document AXES_USE_ATTEMPT_EXPIRATION#1400rodrigobnogueira wants to merge 5 commits intojazzband:masterfrom
rodrigobnogueira wants to merge 5 commits intojazzband:masterfrom
Conversation
added 4 commits
February 21, 2026 13:29
…iptions and add common configuration examples.
3 tasks
aleksihakli
reviewed
Mar 16, 2026
Member
aleksihakli
left a comment
There was a problem hiding this comment.
Commenting on reformatting the table coding.
This kind of reformat is a valid approach, but please note that it requires a complete reread of the documentation and testing at RTD website since our documentation is located there. Just adding the necessary documentation in one PR and suggesting reformatting in another would be more polite considering the maintainers' time in open-source projects.
Author
|
Thanks @aleksihakli . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR addresses issue #1383 where users found the
AXES_COOLOFF_TIMEbehavior confusing and lacked documentation on how to set a "number of failed login attempts per xx minutes" lockout rule.Changes:
list-table: Thesettings.pytable indocs/4_configuration.rstwas a fragile grid table making it hard to maintain. It has been converted to a clean Sphinx.. list-table::.AXES_USE_ATTEMPT_EXPIRATION: This setting, when combined withAXES_COOLOFF_TIME, enables the "rolling window" behavior the reporter was looking for (e.g., 3 attempts per 15 minutes). Added it to the configuration docs.AXES_FAILURE_LIMIT: Clarified it's the limit before the request is considered locked.AXES_COOLOFF_TIME: Explicitly statedNonemeans permanent lockout until manual reset/deletion, and gave type examples (timedeltarecommended).AXES_RESET_COOL_OFF_ON_FAILURE_DURING_LOCKOUT: Emphasized that any new failed attempt while locked resets the timer tonow() + cool_off, meaning repeated brute-force attempts continuously extend the lockout period.Lockout configurationheading: Grouped the configuration table under a clear heading to help users find security policies quickly.Fixes #1383
Before submitting