docs: Add missing AXES_IPWARE_PROXY_ORDER setting documentation #1365
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 adds documentation for the
AXES_IPWARE_PROXY_ORDERsetting, which currently exists in thecodebase but is missing from the official configuration documentation.
Problem
The
AXES_IPWARE_PROXY_ORDERsetting is defined inaxes/conf.pywith a default value of"left-most"and is used in
axes/helpers.pyto configure IP detection behavior, but it's not documented indocs/4_configuration.rstalongside otherAXES_IPWARE_*settings likeAXES_IPWARE_PROXY_COUNTandAXES_IPWARE_META_PRECEDENCE_ORDER.This can lead to confusion for users deploying behind reverse proxies who may not be aware this
configuration option exists.
Solution
Added comprehensive documentation for
AXES_IPWARE_PROXY_ORDERincluding:"left-most"or"right-most")Related
axes/conf.py#L153-L157Before submitting