[symfony#2857] Fixing a few minor errors, adding more details, and using the non-deprecated trusted_proxies config in forwarded headers docs

weaverryan · weaverryan · commit bd63f2648a08 · 2013-07-28T19:03:31.000-05:00
diff --git a/cookbook/cache/varnish.rst b/cookbook/cache/varnish.rst
@@ -176,14 +176,20 @@ that will invalidate the cache for a given resource:
             }
         }
 
-Routing
-------------------
+Routing and X-FORWARDED Headers
+-------------------------------
 
 To ensure that the Symfony Router generates urls correctly with Varnish,
-proper ```X-Forwarded``` headers must be added. Headers depend on how you
-have configured hosts and ports for the web server and Varnish but this
-example should work if the web server is using the same IP as Varnish but
-a different port (e.g. 8080).
+proper ```X-Forwarded``` headers must be added so that Symfony is aware of
+the original port number of the request. Exactly how this is done depends
+on your setup. As a simple example, Varnish and your web server are on the
+same machine and that Varnish is listening on one port (e.g. 80) and Apache
+on another (e.g. 8080). In this situation, Varnish should add the ``X-Forwarded-Port``
+header so that the Symfony application knows that the original port number
+is 80 and not 8080.
+
+If this header weren't set properly, Symfony may append ``8080`` when generating
+absolute URLs:
 
 .. code-block:: text
 
@@ -197,8 +203,9 @@ a different port (e.g. 8080).
 
 .. note::
 
-    Remember to set ``framework.trust_proxy_headers: true`` in the Symfony
-    configuration for this to work.
+    Remember to configure :ref:`framework.trusted_proxies<reference-framework-trusted-proxies>`
+    in the Symfony configuration so that Varnish is seen as a trusted proxy
+    and the ``X-Forwarded-`` headers are used.
 
 .. _`Edge Architecture`: http://www.w3.org/TR/edge-arch
 .. _`GZIP and Varnish`: https://www.varnish-cache.org/docs/3.0/phk/gzip.html
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -94,6 +94,8 @@ services related to testing your application (e.g. ``test.client``) are loaded.
 This setting should be present in your ``test`` environment (usually via
 ``app/config/config_test.yml``). For more information, see :doc:`/book/testing`.
 
+.. _reference-framework-trusted-proxies:
+
 trusted_proxies
 ~~~~~~~~~~~~~~~
 
