From 5cda4677b3df1be971000ef27470d3efc308d3be Mon Sep 17 00:00:00 2001 From: Arnaud Limbourg Date: Sat, 2 Apr 2016 13:20:20 +0200 Subject: [PATCH] Fixed #26037 -- Documented precedence of USE_X_FORWARDED_HOST/PORT settings. --- docs/ref/settings.txt | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 010e942e43..a244deed44 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -2519,10 +2519,14 @@ See also :setting:`TIME_ZONE`, :setting:`USE_I18N` and :setting:`USE_L10N`. Default: ``False`` -A boolean that specifies whether to use the X-Forwarded-Host header in -preference to the Host header. This should only be enabled if a proxy +A boolean that specifies whether to use the ``X-Forwarded-Host`` header in +preference to the ``Host`` header. This should only be enabled if a proxy which sets this header is in use. +This setting takes priority over :setting:`USE_X_FORWARDED_PORT`. Per +:rfc:`7239#page-7`, the ``X-Forwarded-Host`` header can include the port +number, in which case you shouldn't use :setting:`USE_X_FORWARDED_PORT`. + .. setting:: USE_X_FORWARDED_PORT ``USE_X_FORWARDED_PORT`` @@ -2532,10 +2536,12 @@ which sets this header is in use. Default: ``False`` -A boolean that specifies whether to use the X-Forwarded-Port header in +A boolean that specifies whether to use the ``X-Forwarded-Port`` header in preference to the ``SERVER_PORT`` ``META`` variable. This should only be enabled if a proxy which sets this header is in use. +:setting:`USE_X_FORWARDED_HOST` takes priority over this setting. + .. setting:: WSGI_APPLICATION ``WSGI_APPLICATION``