Skip to content

Commit 6c9b8f2

Browse files
committed
Add Debug config chapter
1 parent 7e07a2d commit 6c9b8f2

File tree

2 files changed

+34
-31
lines changed

2 files changed

+34
-31
lines changed

Resources/doc/reference/configuration.rst

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,9 @@ Configuration
55
:maxdepth: 2
66

77
configuration/proxy-client
8-
configuration/rules
98
configuration/headers
109
configuration/invalidation
1110
configuration/tags
1211
configuration/user-context
13-
configuration/default
14-
15-
16-
17-
18-
19-
Debug Header
20-
------------
21-
22-
Enable the ``debug`` parameter to set a ``X-Cache-Debug`` header on each
23-
response. You can then :ref:`configure your caching proxy <foshttpcache:varnish_debugging>`
24-
to add debug information when that header is present:
25-
26-
.. code-block:: yaml
27-
28-
# app/config/config.yml
29-
fos_http_cache:
30-
debug: true
31-
32-
The default value is ``%kernel.debug%``, triggering the header when you are in
33-
dev mode but not in prod mode. You can change the header with the
34-
``debug_header`` option:
35-
36-
.. code-block:: yaml
37-
38-
# app/config/config.yml
39-
fos_http_cache:
40-
debug_header: Please-Send-Debug-Infos
41-
42-
12+
configuration/flash-message
13+
configuration/debug
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Debug Header
2+
============
3+
4+
Enable the ``debug`` parameter to set a custom header (``X-Cache-Debug``)
5+
header on each response. You can then
6+
:ref:`configure your caching proxy <foshttpcache:varnish_debugging>` to add
7+
debug information when that header is present:
8+
9+
10+
.. code-block:: yaml
11+
12+
# app/config/config.yml
13+
fos_http_cache:
14+
debug:
15+
enabled: true
16+
header: Please-Send-Debug-Infos
17+
18+
enabled
19+
-------
20+
21+
**type**: ``enum`` **default**: ``auto`` **options**: ``true``, ``false``, ``auto``
22+
23+
The default value is ``%kernel.debug%``, triggering the header when you are in
24+
dev mode but not in prod mode.
25+
26+
header
27+
------
28+
29+
**type**: ``string`` **default**: ``X-Cache-Debug**
30+
31+
Custom HTTP header that triggers the caching proxy to set debugging information
32+
on the response.

0 commit comments

Comments
 (0)