Skip to content

Commit fc6b3e0

Browse files
committed
reformatted web cache resolver documentation additions
1 parent 4b35b5e commit fc6b3e0

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

Resources/doc/cache-resolver/web_path.rst

+20-12
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ Web Path Resolver
55
=================
66

77
The ``WebPathResolver`` resolver enabled cache resolution using the
8-
web path of your application.
9-
The resulting web path is computed by taking into account the request context,
10-
notably to decide which scheme to use. If you use a proxy to decrypt incoming
11-
TLS traffic, and need the resolver to generate https urls, you will need to
12-
`list trusted proxies in the configuration of the framework`_. If you also
13-
`embed controllers`_ in your templates, you will need to add the localhost to
14-
that list.
15-
The request context is also used to determine the port to specify, should it
16-
differ from standard HTTP ports like ports 80 or 443.
17-
18-
.. _`list trusted proxies in the configuration of the framework`: https://symfony.com/doc/current/request/load_balancer_reverse_proxy.html
19-
.. _`embed controllers`: https://symfony.com/doc/current/templating/embedding_controllers.html
8+
web path of your application. The resulting web path is computed by
9+
taking a number of factors into account, including the `request context`_
10+
as provided by the Symfony HTTP kernel.
11+
12+
.. tip::
13+
14+
The request context is most notably used to determine the HTTP scheme
15+
prepended to the final URL. If you use a proxy to offload TLS traffic
16+
decryption and need the resolver to generate HTTPS URLS, you will need
17+
to configure Symfony's `trusted proxies`_ appropriately. If you
18+
`embed controllers`_ in your templates, ``localhost`` must be added to
19+
your trusted proxy configuration.
20+
21+
The request context is also used to determine the port to specify,
22+
should it differ from the standard HTTP/HTTPS (80/443) ports.
2023

2124

2225
Configuration
@@ -75,3 +78,8 @@ filter set using the following configuration.
7578
cache: profile_photos
7679
filters:
7780
# the filter list
81+
82+
83+
.. _`request context`: http://symfony.com/doc/current/components/http_foundation.html#request
84+
.. _`trusted proxies`: https://symfony.com/doc/current/request/load_balancer_reverse_proxy.html#solution-trusted-proxies
85+
.. _`embed controllers`: https://symfony.com/doc/current/templating/embedding_controllers.html

0 commit comments

Comments
 (0)