Clarified which setting causes HttpRequest.get_host() to rely on the HTTP_X_FORWARDED_HOST header.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@17172 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Aymeric Augustin 2011-12-07 19:42:50 +00:00
parent 2693aa890e
commit 0519adb2a8
1 changed files with 4 additions and 4 deletions

View File

@ -193,10 +193,10 @@ Methods
.. method:: HttpRequest.get_host()
Returns the originating host of the request using information from
the ``HTTP_X_FORWARDED_HOST`` (if enabled in the settings) and ``HTTP_HOST``
headers (in that order). If they don't provide a value, the method
uses a combination of ``SERVER_NAME`` and ``SERVER_PORT`` as
Returns the originating host of the request using information from the
``HTTP_X_FORWARDED_HOST`` (if :setting:`USE_X_FORWARDED_HOST` is enabled)
and ``HTTP_HOST`` headers, in that order. If they don't provide a value,
the method uses a combination of ``SERVER_NAME`` and ``SERVER_PORT`` as
detailed in :pep:`3333`.
Example: ``"127.0.0.1:8000"``