Skip to content

Commit 8076c40

Browse files
committed
Simplified the framework configuration reference
1 parent 6584ae7 commit 8076c40

File tree

1 file changed

+16
-148
lines changed

1 file changed

+16
-148
lines changed

reference/configuration/framework.rst

Lines changed: 16 additions & 148 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
.. index::
22
single: Configuration reference; Framework
33

4-
FrameworkBundle Configuration ("framework")
5-
===========================================
4+
FrameworkBundle Configuration
5+
=============================
66

7-
The FrameworkBundle contains most of the "base" framework functionality
8-
and can be configured under the ``framework`` key in your application
9-
configuration. When using XML, you must use the
10-
``http://symfony.com/schema/dic/symfony`` namespace.
7+
The FrameworkBundle includes the main framework configuration, from sessions and
8+
translations to forms, validation, routing and more. All these options are
9+
configured under the ``framework`` key in your application configuration.
1110

12-
This includes settings related to sessions, translation, forms, validation,
13-
routing and more.
11+
.. code-block:: terminal
1412
15-
.. tip::
13+
# displays the default config values defined by Symfony
14+
$ ./bin/console config:dump-reference framework
15+
16+
# displays the actual config values used by your application
17+
$ ./bin/console debug:config framework
1618
17-
The XSD schema is available at
18-
``http://symfony.com/schema/dic/symfony/symfony-1.0.xsd``.
19+
.. note::
20+
21+
When using XML, you must use the ``http://symfony.com/schema/dic/symfony``
22+
namespace and the related XSD schema is available at:
23+
``http://symfony.com/schema/dic/symfony/symfony-1.0.xsd``
1924

2025
Configuration
2126
-------------
@@ -1477,143 +1482,6 @@ If this option is enabled, serialization groups can be defined using annotations
14771482

14781483
For more information, see :ref:`serializer-using-serialization-groups-annotations`.
14791484

1480-
Full Default Configuration
1481-
--------------------------
1482-
1483-
.. configuration-block::
1484-
1485-
.. code-block:: yaml
1486-
1487-
framework:
1488-
secret: ~
1489-
http_method_override: true
1490-
trusted_proxies: []
1491-
ide: ~
1492-
test: ~
1493-
default_locale: en
1494-
1495-
csrf_protection:
1496-
enabled: false
1497-
field_name: _token # Deprecated since 2.4, to be removed in 3.0. Use form.csrf_protection.field_name instead
1498-
1499-
# form configuration
1500-
form:
1501-
enabled: false
1502-
csrf_protection:
1503-
enabled: true
1504-
field_name: ~
1505-
1506-
# esi configuration
1507-
esi:
1508-
enabled: false
1509-
1510-
# fragments configuration
1511-
fragments:
1512-
enabled: false
1513-
path: /_fragment
1514-
1515-
# profiler configuration
1516-
profiler:
1517-
enabled: false
1518-
collect: true
1519-
only_exceptions: false
1520-
only_master_requests: false
1521-
dsn: file:%kernel.cache_dir%/profiler
1522-
username:
1523-
password:
1524-
lifetime: 86400
1525-
matcher:
1526-
ip: ~
1527-
1528-
# use the urldecoded format
1529-
path: ~ # Example: ^/path to resource/
1530-
service: ~
1531-
1532-
# router configuration
1533-
router:
1534-
resource: ~ # Required
1535-
type: ~
1536-
http_port: 80
1537-
https_port: 443
1538-
1539-
# * set to true to throw an exception when a parameter does not
1540-
# match the requirements
1541-
# * set to false to disable exceptions when a parameter does not
1542-
# match the requirements (and return null instead)
1543-
# * set to null to disable parameter checks against requirements
1544-
#
1545-
# 'true' is the preferred configuration in development mode, while
1546-
# 'false' or 'null' might be preferred in production
1547-
strict_requirements: true
1548-
1549-
# session configuration
1550-
session:
1551-
storage_id: session.storage.native
1552-
handler_id: session.handler.native_file
1553-
name: ~
1554-
cookie_lifetime: ~
1555-
cookie_path: ~
1556-
cookie_domain: ~
1557-
cookie_secure: ~
1558-
cookie_httponly: ~
1559-
gc_divisor: ~
1560-
gc_probability: ~
1561-
gc_maxlifetime: ~
1562-
save_path: '%kernel.cache_dir%/sessions'
1563-
1564-
# serializer configuration
1565-
serializer:
1566-
enabled: false
1567-
1568-
# assets configuration
1569-
assets:
1570-
base_path: ~
1571-
base_urls: []
1572-
version: ~
1573-
version_format: '%%s?%%s'
1574-
packages:
1575-
1576-
# Prototype
1577-
name:
1578-
base_path: ~
1579-
base_urls: []
1580-
version: ~
1581-
version_format: '%%s?%%s'
1582-
1583-
# templating configuration
1584-
templating:
1585-
hinclude_default_template: ~
1586-
form:
1587-
resources:
1588-
1589-
# Default:
1590-
- FrameworkBundle:Form
1591-
cache: ~
1592-
engines: # Required
1593-
1594-
# Example:
1595-
- twig
1596-
loaders: []
1597-
1598-
# translator configuration
1599-
translator:
1600-
enabled: false
1601-
fallbacks: [en]
1602-
logging: "%kernel.debug%"
1603-
1604-
# validation configuration
1605-
validation:
1606-
enabled: false
1607-
cache: ~
1608-
enable_annotations: false
1609-
translation_domain: validators
1610-
1611-
# annotation configuration
1612-
annotations:
1613-
cache: file
1614-
file_cache_dir: '%kernel.cache_dir%/annotations'
1615-
debug: '%kernel.debug%'
1616-
16171485
.. _`HTTP Host header attacks`: http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
16181486
.. _`Security Advisory Blog post`: https://symfony.com/blog/security-releases-symfony-2-0-24-2-1-12-2-2-5-and-2-3-3-released#cve-2013-4752-request-gethost-poisoning
16191487
.. _`Doctrine Cache`: http://docs.doctrine-project.org/projects/doctrine-common/en/latest/reference/caching.html

0 commit comments

Comments
 (0)