type: string default: php_array

This option can be one of the following values:

php_array

Use a PHP array to cache annotations in memory

file

Use the filesystem to cache annotations

none

Disable the caching of annotations

type: boolean default: %kernel.debug%

Whether to enable debug mode for caching. If enabled, the cache will automatically update when the original file is changed (both with code and annotation changes). For performance reasons, it is recommended to disable debug mode in production, which will happen automatically if you use the default value.

type: string default: %kernel.cache_dir%/annotations

The directory to store cache files for annotations, in case annotations.cache is set to 'file'.

type: string

This option allows you to define a base path to be used for assets:

1
2
3
4
5

# config/packages/framework.yaml
framework:
    # ...
    assets:
        base_path: '/images'

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets base-path="/images"/>
    </framework:config>
</container>

1
2
3
4
5
6
7
8

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    // ...
    $framework->assets()
        ->basePath('/images');
};

type: array

This option allows you to define base URLs to be used for assets. If multiple base URLs are provided, Symfony will select one from the collection each time it generates an asset's path:

1
2
3
4
5
6

# config/packages/framework.yaml
framework:
    # ...
    assets:
        base_urls:
            - 'http://cdn.example.com/'

1
2
3
4
5
6
7
8

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    // ...
    $framework->assets()
        ->baseUrls(['http://cdn.example.com/']);
};

type: string default: null

The file path or absolute URL to a manifest.json file containing an associative array of asset names and their respective compiled names. A common cache-busting technique using a "manifest" file works by writing out assets with a "hash" appended to their file names (e.g. main.ae433f1cb.css) during a front-end compilation routine.

This option can be set globally for all assets and individually for each asset package:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# config/packages/framework.yaml
framework:
    assets:
        # this manifest is applied to every asset (including packages)
        json_manifest_path: "%kernel.project_dir%/public/build/manifest.json"
        # you can use absolute URLs too and Symfony will download them automatically
        # json_manifest_path: 'https://cdn.example.com/manifest.json'
        packages:
            foo_package:
                # this package uses its own manifest (the default file is ignored)
                json_manifest_path: "%kernel.project_dir%/public/build/a_different_manifest.json"
                # Throws an exception when an asset is not found in the manifest
                strict_mode: %kernel.debug%
            bar_package:
                # this package uses the global manifest (the default file is used)
                base_path: '/images'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <!-- this manifest is applied to every asset (including packages) -->
        <framework:assets json-manifest-path="%kernel.project_dir%/public/build/manifest.json">
        <!-- you can use absolute URLs too and Symfony will download them automatically -->
        <!-- <framework:assets json-manifest-path="https://cdn.example.com/manifest.json"> -->
            <!-- this package uses its own manifest (the default file is ignored) -->
            <!-- Throws an exception when an asset is not found in the manifest -->
            <framework:package
                name="foo_package"
                json-manifest-path="%kernel.project_dir%/public/build/a_different_manifest.json" strict-mode="%kernel.debug%"/>
            <!-- this package uses the global manifest (the default file is used) -->
            <framework:package
                name="bar_package"
                base-path="/images"/>
        </framework:assets>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    // ...
    $framework->assets()
        // this manifest is applied to every asset (including packages)
        ->jsonManifestPath('%kernel.project_dir%/public/build/manifest.json');

    // you can use absolute URLs too and Symfony will download them automatically
    // 'json_manifest_path' => 'https://cdn.example.com/manifest.json',
    $framework->assets()->package('foo_package')
        // this package uses its own manifest (the default file is ignored)
        ->jsonManifestPath('%kernel.project_dir%/public/build/a_different_manifest.json')
        // Throws an exception when an asset is not found in the manifest
        ->setStrictMode('%kernel.debug%');

    $framework->assets()->package('bar_package')
        // this package uses the global manifest (the default file is used)
        ->basePath('/images');
};

You can group assets into packages, to specify different base URLs for them:

1
2
3
4
5
6
7

# config/packages/framework.yaml
framework:
    # ...
    assets:
        packages:
            avatars:
                base_urls: 'http://static_cdn.example.com/avatars'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets>
            <framework:package
                name="avatars"
                base-url="http://static_cdn.example.com/avatars"/>
        </framework:assets>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    // ...
    $framework->assets()
        ->package('avatars')
            ->baseUrls(['http://static_cdn.example.com/avatars']);
};

Now you can use the avatars package in your templates:

1

<img src="{{ asset('...', 'avatars') }}">

Each package can configure the following options:

• base_path
• base_urls
• version_strategy
• version
• version_format
• json_manifest_path
• strict_mode

type: boolean default: false

When enabled, the strict mode asserts that all requested assets are in the manifest file. This option is useful to detect typos or missing assets, the recommended value is %kernel.debug%.

type: string

This option is used to bust the cache on assets by globally adding a query parameter to all rendered asset paths (e.g. /images/logo.png?v2). This applies only to assets rendered via the Twig asset() function (or PHP equivalent).

For example, suppose you have the following:

1

<img src="{{ asset('images/logo.png') }}" alt="Symfony!"/>

By default, this will render a path to your image such as /images/logo.png. Now, activate the version option:

1
2
3
4
5

# config/packages/framework.yaml
framework:
    # ...
    assets:
        version: 'v2'

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets version="v2"/>
    </framework:config>
</container>

Now, the same asset will be rendered as /images/logo.png?v2 If you use this feature, you must manually increment the version value before each deployment so that the query parameters change.

You can also control how the query string works via the version_format option.

type: string default: %%s?%%s

This specifies a sprintf pattern that will be used with the version option to construct an asset's path. By default, the pattern adds the asset's version as a query string. For example, if version_format is set to %%s?version=%%s and version is set to 5, the asset's path would be /images/logo.png?version=5.

type: string default: null

The service id of the asset version strategy applied to the assets. This option can be set globally for all assets and individually for each asset package:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# config/packages/framework.yaml
framework:
    assets:
        # this strategy is applied to every asset (including packages)
        version_strategy: 'app.asset.my_versioning_strategy'
        packages:
            foo_package:
                # this package removes any versioning (its assets won't be versioned)
                version: ~
            bar_package:
                # this package uses its own strategy (the default strategy is ignored)
                version_strategy: 'app.asset.another_version_strategy'
            baz_package:
                # this package inherits the default strategy
                base_path: '/images'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:assets version-strategy="app.asset.my_versioning_strategy">
            <!-- this package removes any versioning (its assets won't be versioned) -->
            <framework:package
                name="foo_package"
                version="null"/>
            <!-- this package uses its own strategy (the default strategy is ignored) -->
            <framework:package
                name="bar_package"
                version-strategy="app.asset.another_version_strategy"/>
            <!-- this package inherits the default strategy -->
            <framework:package
                name="baz_package"
                base_path="/images"/>
        </framework:assets>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    // ...
    $framework->assets()
        ->versionStrategy('app.asset.my_versioning_strategy');

    $framework->assets()->package('foo_package')
        // this package removes any versioning (its assets won't be versioned)
        ->version(null);

    $framework->assets()->package('bar_package')
        // this package uses its own strategy (the default strategy is ignored)
        ->versionStrategy('app.asset.another_version_strategy');

    $framework->assets()->package('baz_package')
        // this package inherits the default strategy
        ->basePath('/images');
};

type: string default: cache.adapter.filesystem

The cache adapter used by the cache.app service. The FrameworkBundle ships with multiple adapters: cache.adapter.apcu, cache.adapter.system, cache.adapter.filesystem, cache.adapter.psr6, cache.adapter.redis, cache.adapter.memcached, cache.adapter.pdo and cache.adapter.doctrine_dbal.

There's also a special adapter called cache.adapter.array which stores contents in memory using a PHP array and it's used to disable caching (mostly on the dev environment).

type: string

The service name to use as your default Doctrine provider. The provider is available as the cache.default_doctrine_provider service.

type: string default: memcached://localhost

The DSN to use by the Memcached provider. The provider is available as the cache.default_memcached_provider service.

type: string default: doctrine.dbal.default_connection

The service id of the database connection, which should be either a PDO or a Doctrine DBAL instance. The provider is available as the cache.default_pdo_provider service.

type: string

The service name to use as your default PSR-6 provider. It is available as the cache.default_psr6_provider service.

type: string default: redis://localhost

The DSN to use by the Redis provider. The provider is available as the cache.default_redis_provider service.

type: string default: %kernel.cache_dir%/pools

The path to the cache directory used by services inheriting from the cache.adapter.filesystem adapter (including cache.app).

type: array

A list of cache pools to be created by the framework extension.

To configure a Redis cache pool with a default lifetime of 1 hour, do the following:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:cache>
            <framework:pool
                name="cache.mycache"
                adapter="cache.adapter.redis"
                default-lifetime="3600"
            />
        </framework:cache>
        <!-- ... -->
    </framework:config>
</container>

type: string default: _%kernel.project_dir%.%kernel.container_class%

This value is used as part of the "namespace" generated for the cache item keys. A common practice is to use the unique name of the application (e.g. symfony.com) because that prevents naming collisions when deploying multiple applications into the same path (on different servers) that share the same cache backend.

It's also useful when using blue/green deployment strategies and more generally, when you need to abstract out the actual deployment directory (for example, when warming caches offline).

type: string default: cache.adapter.system

The cache adapter used by the cache.system service. It supports the same adapters available for the cache.app service.

type: boolean default: true or false depending on your installation

This option can be used to disable CSRF protection on all forms. But you can also disable CSRF protection on individual forms.

1
2
3
4

# config/packages/framework.yaml
framework:
    # ...
    csrf_protection: true

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
    <framework:config>
        <framework:csrf-protection enabled="true"/>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;
return static function (FrameworkConfig $framework): void {
    $framework->csrfProtection()
        ->enabled(true)
    ;
};

If you're using forms, but want to avoid starting your session (e.g. using forms in an API-only website), csrf_protection will need to be set to false.

type: array default: []

The list of CSRF token ids that will use stateless CSRF protection.

type: integer or bool default: false

Whether to check the CSRF token in an HTTP header in addition to the cookie when using stateless CSRF protection. You can also set this to 2 (the value of the CHECK_ONLY_HEADER constant on the SameOriginCsrfTokenManager class) to check only the header and ignore the cookie.

type: string default: csrf-token

The name of the cookie (and HTTP header) to use for the double-submit when using stateless CSRF protection.

type: array default: [] (empty array = enable all locales)

Symfony applications generate by default the translation files for validation and security messages in all locales. If your application only uses some locales, use this option to restrict the files generated by Symfony and improve performance a bit:

1
2
3

# config/packages/translation.yaml
framework:
    enabled_locales: ['en', 'es']

1
2
3
4
5
6

// config/packages/translation.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->enabledLocales(['en', 'es']);
};

An added bonus of defining the enabled locales is that they are automatically added as a requirement of the special _locale parameter. For example, if you define this value as ['ar', 'he', 'ja', 'zh'], the _locale routing parameter will have an ar|he|ja|zh requirement. If some user makes requests with a locale not included in this option, they'll see a 404 error.

type: boolean default: false

If this option is set to true, the response will have a Content-Language HTTP header set with the Request locale.

type: boolean default: false

If this option is set to true, the Request locale will automatically be set to the value of the Accept-Language HTTP header.

When the _locale request attribute is passed, the Accept-Language header is ignored.

type: boolean default: false

Whether to enable the edge side includes support in the framework.

You can also set esi to true to enable it:

1
2
3

# config/packages/framework.yaml
framework:
    esi: true

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:esi/>
    </framework:config>
</container>

1
2
3
4
5
6

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->esi()->enabled(true);
};

type: boolean default: true or false depending on your installation

Whether to enable the form services or not in the service container. If you don't use forms, setting this to false may increase your application's performance because less services will be loaded into the container.

This option will automatically be set to true when one of the child settings is configured.

type: boolean default: false

Whether to enable the fragment listener or not. The fragment listener is used to render ESI fragments independently of the rest of the page.

This setting is automatically set to true when one of the child settings is configured.

type: string default: null

Sets the content shown during the loading of the fragment or when JavaScript is disabled. This can be either a template name or the content itself.

type: string default: /_fragment

The path prefix for fragments. The fragment listener will only be executed when the request starts with this path.

type: boolean default: false

Specifies whether the client can force a cache reload by including a Cache-Control "no-cache" directive in the request. Set it to true for compliance with RFC 2616.

type: boolean default: false

Specifies whether the client can force a cache revalidate by including a Cache-Control "max-age=0" directive in the request. Set it to true for compliance with RFC 2616.

type: boolean default: %kernel.debug%

If true, exceptions are thrown when things go wrong. Otherwise, the cache will try to carry on and deliver a meaningful response.

type: integer default: 0

The number of seconds that a cache entry should be considered fresh when no explicit freshness information is provided in a response. Explicit Cache-Control or Expires headers override this value.

type: boolean default: false

type: array default: ['Authorization', 'Cookie']

Set of request headers that trigger "private" cache-control behavior on responses that don't explicitly state whether the response is public or private via a Cache-Control directive.

type: array default: Set-Cookie

Set of response headers that will never be cached even when the response is cacheable and public.

type: integer default: 60

Specifies the default number of seconds (the granularity is the second) during which the cache can serve a stale response when an error is encountered. This setting is overridden by the stale-if-error HTTP Cache-Control extension (see RFC 5861).

type: integer default: 2

Specifies the default number of seconds (the granularity is the second as the Response TTL precision is a second) during which the cache can immediately return a stale response while it revalidates it in the background. This setting is overridden by the stale-while-revalidate HTTP Cache-Control extension (see RFC 5861).

type: string default: 'X-Symfony-Cache'

Header name to use for traces.

type: string possible values: 'none', 'short' or 'full'

For 'short', a concise trace of the main request will be added as an HTTP header. 'full' will add traces for all requests (including ESI subrequests). (default: 'full' if in debug; 'none' otherwise)

type: string

The username and password used to create the Authorization HTTP header used in HTTP Basic authentication. The value of this option must follow the format username:password.

type: string

The token used to create the Authorization HTTP header used in HTTP Bearer authentication (also called token authentication).

type: string

The username and password used to create the Authorization HTTP header used in the Microsoft NTLM authentication protocol. The value of this option must follow the format username:password. This authentication mechanism requires using the cURL-based transport.

type: string

URI that is merged into relative URIs, following the rules explained in the RFC 3986 standard. This is useful when all the requests you make share a common prefix (e.g. https://api..com/) so you can avoid adding it to every request.

Here are some common examples of how base_uri merging works in practice:

type: string

A network interface name, IP address, a host name or a UNIX socket to use as the outgoing network interface.

type: boolean | Closure

Buffering the response means that you can access its content multiple times without performing the request again. Buffering is enabled by default when the content type of the response is text/*, application/json or application/xml.

If this option is a boolean value, the response is buffered when the value is true. If this option is a closure, the response is buffered when the returned value is true (the closure receives as argument an array with the response headers).

type: string

The path of the certificate authority file that contains one or more certificates used to verify the other servers' certificates.

type: string

The path to a directory that contains one or more certificate authority files.

type: string

A list of the names of the ciphers allowed for the TLS connections. They can be separated by colons, commas or spaces (e.g. 'RC4-SHA:TLS13-AES-128-GCM-SHA256').

type: integer

The minimum version of TLS to accept. The value must be one of the STREAM_CRYPTO_METHOD_TLSv*_CLIENT constants defined by PHP.

type: integer default: 1000

The initial delay in milliseconds used to compute the waiting time between retries.

type: boolean default: false

Whether to enable the support for retry failed HTTP request or not. This setting is automatically set to true when one of the child settings is configured.

type: array

Arbitrary additional data to pass to the HTTP client for further use. This can be particularly useful when decorating an existing client.

type: array

An associative array of the HTTP headers added before making the request. This value must use the format ['header-name' => 'value0, value1, ...'].

type: array default: DEFAULT_RETRY_STATUS_CODES()

The list of HTTP status codes that triggers a retry of the request.

type: string | null default: null

The HTTP version to use, typically '1.1' or '2.0'. Leave it to null to let Symfony select the best version automatically.

type: float default: 0.1 (must be between 0.0 and 1.0)

This option adds some randomness to the delay. It's useful to avoid sending multiple requests to the server at the exact same time. The randomness is calculated as delay * jitter. For example: if delay is 1000ms and jitter is 0.2, the actual delay will be a number between 800 and 1200 (1000 +/- 20%).

type: string

The path to a file that contains the PEM formatted certificate used by the HTTP client. This is often combined with the local_pk and passphrase options.

type: string

The path of a file that contains the PEM formatted private key of the certificate defined in the local_cert option.

type: integer default: 0

The maximum amount of milliseconds initial to wait between retries. Use 0 to not limit the duration.

type: float default: 0

The maximum execution time, in seconds, that the request and the response are allowed to take. A value lower than or equal to 0 means it is unlimited.

type: integer default: 6

Defines the maximum amount of simultaneously open connections to a single host (considering a "host" the same as a "host name + port number" pair). This limit also applies for proxy connections, where the proxy is considered to be the host for which this limit is applied.

type: integer default: 20

The maximum number of redirects to follow. Use 0 to not follow any redirection.

type: integer default: 3

The maximum number of retries for failing requests. When the maximum is reached, the client returns the last received response.

type: float default: 2

This value is multiplied to the delay each time a retry occurs, to distribute retries in time instead of making all of them sequentially.

type: string | null default: null

A comma separated list of hosts that do not require a proxy to be reached, even if one is configured. Use the '*' wildcard to match all hosts and an empty string to match none (disables the proxy).

type: string

The passphrase used to encrypt the certificate stored in the file defined in the local_cert option.

type: array

When negotiating a TLS connection, the server sends a certificate indicating its identity. A public key is extracted from this certificate and if it does not exactly match any of the public keys provided in this option, the connection is aborted before sending or receiving any data.

The value of this option is an associative array of algorithm => hash (e.g ['pin-sha256' => '...']).

type: string | null

The HTTP proxy to use to make the requests. Leave it to null to detect the proxy automatically based on your system configuration.

type: array

An associative array of the query string values added to the URL before making the request. This value must use the format ['parameter-name' => parameter-value, ...].

type: string

The service ID of the rate limiter used to limit the number of HTTP requests within a certain period. The service must implement the LimiterInterface.

type: array

A list of hostnames and their IP addresses to pre-populate the DNS cache used by the HTTP client in order to avoid a DNS lookup for those hosts. This option is useful to improve security when IPs are checked before the URL is passed to the client and to make your tests easier.

The value of this option is an associative array of domain => IP address (e.g ['symfony.com' => '46.137.106.254', ...]).

type: array

This option configures the behavior of the HTTP client when some request fails, including which types of requests to retry and how many times. The behavior is defined with the following options:

• delay
• http_codes
• jitter
• max_delay
• max_retries
• multiplier

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# config/packages/framework.yaml
framework:
    # ...
    http_client:
        # ...
        default_options:
            retry_failed:
                # retry_strategy: app.custom_strategy
                http_codes:
                    0: ['GET', 'HEAD']   # retry network errors if request method is GET or HEAD
                    429: true            # retry all responses with 429 status code
                    500: ['GET', 'HEAD']
                max_retries: 2
                delay: 1000
                multiplier: 3
                max_delay: 5000
                jitter: 0.3

        scoped_clients:
            my_api.client:
                # ...
                retry_failed:
                    max_retries: 4

type: string

The service is used to decide if a request should be retried and to compute the time to wait between retries. By default, it uses an instance of GenericRetryStrategy configured with http_codes, delay, max_delay, multiplier and jitter options. This class has to implement RetryStrategyInterface.

type: string

For scoped clients only: the regular expression that the URL must match before applying all other non-default options. By default, the scope is derived from base_uri.

type: float default: depends on your PHP config

Time, in seconds, to wait for network activity. If the connection is idle for longer, a TransportException is thrown. Its default value is the same as the value of PHP's default_socket_timeout config option.

type: boolean default: true

If true, the certificate sent by other servers is verified to ensure that their common name matches the host included in the URL. This is usually combined with verify_peer to also verify the certificate authenticity.

type: boolean default: true

If true, the certificate sent by other servers when negotiating a TLS connection is verified for authenticity. Authenticating the certificate is not enough to be sure about the server, so you should combine this with the verify_host option.

type: boolean default: true

Whether to enable the support for lock or not. This setting is automatically set to true when one of the child settings is configured.

type: array

A map of lock stores to be created by the framework extension, with the name as key and DSN or service id as value:

1
2
3

# config/packages/lock.yaml
framework:
    lock: '%env(LOCK_DSN)%'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<!-- config/packages/lock.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:lock>
            <framework:resource name="default">%env(LOCK_DSN)%</framework:resource>
        </framework:lock>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/lock.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->lock()
        ->resource('default', [env('LOCK_DSN')]);
};

type: string default: null

The DSN used by the mailer. When several DSN may be used, use transports option (see below) instead.

type: array

Headers to add to emails. The key (name attribute in xml format) is the header name and value the header value.

type: string default: null or default bus if Messenger component is installed

Service identifier of the message bus to use when using the Messenger component (e.g. messenger.default_bus).

type: array

A list of DSN that can be used by the mailer. A transport name is the key and the dsn is the value.

type: boolean default: true

Whether to enable or not Messenger.

type: boolean, int or array<int, string> default: true

Use the application logger instead of the PHP logger for logging PHP errors. When an integer value is used, it defines a bitmask of PHP errors that will be logged. Those integer values must be the same used in the error_reporting PHP option. The default log levels will be used for each PHP error. When a boolean value is used, true enables logging for all PHP errors while false disables logging entirely.

This option also accepts a map of PHP errors to log levels:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <!-- in XML configuration you cannot use PHP constants as the value of
             the 'type' attribute, which makes this format way less readable.
             Consider using YAML or PHP for this configuration -->
        <framework:log type="8" logLevel="error"/>
        <framework:log type="2" logLevel="error"/>
        <!-- ... -->
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9

// config/packages/framework.php
use Psr\Log\LogLevel;
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->phpErrors()->log(\E_DEPRECATED, LogLevel::ERROR);
    $framework->phpErrors()->log(\E_USER_DEPRECATED, LogLevel::ERROR);
    // ...
};

type: boolean default: %kernel.debug%

Throw PHP errors as \ErrorException instances. The parameter debug.error_handler.throw_at controls the threshold.

type: boolean default: true

This option configures the way the profiler behaves when it is enabled. If set to true, the profiler collects data for all requests. If you want to only collect information on-demand, you can set the collect flag to false and activate the data collectors manually:

1

$profiler->enable();

type: string default: null

This specifies name of a query parameter, a body parameter or a request attribute used to enable or disable collection of data by the profiler for each request. Combine it with the collect option to enable/disable the profiler on demand:

• If the collect option is set to true but this parameter exists in a request and has any value other than true, yes, on or 1, the request data will not be collected;
• If the collect option is set to false, but this parameter exists in a request and has value of true, yes, on or 1, the request data will be collected.

type: boolean default: false

When this option is true, all normalizers and encoders are decorated by traceable implementations that collect profiling information about them.

type: string default: file:%kernel.cache_dir%/profiler

The DSN where to store the profiling information.

type: boolean default: false

The profiler can be enabled by setting this option to true. When you install it using Symfony Flex, the profiler is enabled in the dev and test environments.

type: boolean default: false

When this is set to true, the profiler will only be enabled when an exception is thrown during the handling of the request.

type: boolean default: false

When this is set to true, the profiler will only be enabled on the main requests (and not on the subrequests).

type: boolean default: false

When enabled, the property_accessor service uses PHP's magic __call() method when its getValue() method is called.

type: boolean default: true

When enabled, the property_accessor service uses PHP's magic __get() method when its getValue() method is called.

type: boolean default: true

When enabled, the property_accessor service uses PHP's magic __set() method when its setValue() method is called.

type: boolean default: false

When enabled, the property_accessor service throws an exception when you try to access an invalid index of an array.

type: boolean default: true

When enabled, the property_accessor service throws an exception when you try to access an invalid property path of an object.

type: boolean default: true or false depending on your installation

type: boolean default: false

Configures the property_info service to extract property information from the constructor arguments using the ConstructorExtractor.

type:

Name of the rate limiter you want to create.

type: array default: []

This setting is used to associate additional request formats (e.g. html) to one or more mime types (e.g. text/html), which will allow you to use the format & mime types to call Request::getFormat($mimeType) or Request::getMimeType($format).

In practice, this is important because Symfony uses it to automatically set the Content-Type header on the Response (if you don't explicitly set one). If you pass an array of mime types, the first will be used for the header.

To configure a jsonp format:

1
2
3
4
5

# config/packages/framework.yaml
framework:
    request:
        formats:
            jsonp: 'application/javascript'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>

<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:request>
            <framework:format name="jsonp">
                <framework:mime-type>application/javascript</framework:mime-type>
            </framework:format>
        </framework:request>
    </framework:config>
</container>

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->request()
        ->format('jsonp', 'application/javascript');
};

type: string default: %kernel.cache_dir%

The directory where routing information will be cached. Can be set to ~ (null) to disable route caching.

type: string

The default URI used to generate URLs in a non-HTTP context (see Generating URLs in Commands).

type: integer default: 80

The port for normal http requests (this is used when matching the scheme).

type: integer default: 443

The port for https requests (this is used when matching the scheme).

type: string required

The path the main routing resource (e.g. a YAML file) that contains the routes and imports the router should load.

type: mixed default: true

Determines the routing generator behavior. When generating a route that has specific parameter requirements, the generator can behave differently in case the used parameters do not meet these requirements.

The value can be one of:

true

Throw an exception when the requirements are not met;

false

Disable exceptions when the requirements are not met and return '' instead;

null

Disable checking the requirements (thus, match the route even when the requirements don't match).

true is recommended in the development environment, while false or null might be preferred in production.

type: string

The type of the resource to hint the loaders about the format. This isn't needed when you use the default routers with the expected file extensions (.xml, .yaml, .php).

type: boolean default: true

When this option is set to true, the regular expressions used in the requirements of route parameters will be run using the utf-8 modifier. This will for example match any UTF-8 character when using ., instead of matching only a single byte.

If the charset of your application is UTF-8 (as defined in the getCharset() method of your kernel) it's recommended setting it to true. This will make non-UTF8 URLs to generate 404 errors.

type: string default: base64:default::SYMFONY_DECRYPTION_SECRET

The env var name that contains the vault decryption secret. By default, this value will be decoded from base64.

type: boolean default: true

Whether to enable or not secrets managements.

type: string default: %kernel.project_dir%/.env.%kernel.environment%.local

The path to the local .env file. This file must contain the vault decryption key, given by the decryption_env_var option.

type: string default: %kernel.project_dir%/config/secrets/%kernel.runtime_environment%

The directory to store the secret vault. By default, the path includes the value of the kernel.runtime_environment parameter.

type: boolean default: true

Whether to enable the support for semaphore or not. This setting is automatically set to true when one of the child settings is configured.

type: array

A map of semaphore stores to be created by the framework extension, with the name as key and DSN or service id as value:

1
2
3

# config/packages/semaphore.yaml
framework:
    semaphore: '%env(SEMAPHORE_DSN)%'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<!-- config/packages/semaphore.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:semaphore>
            <framework:resource name="default">%env(SEMAPHORE_DSN)%</framework:resource>
        </framework:semaphore>
    </framework:config>
</container>

type string

The service id that is used as the circular reference handler of the default serializer. The service has to implement the magic __invoke($object) method.

type: array default: []

A map with default context options that will be used with each serialize and deserialize call. This can be used for example to set the json encoding behavior by setting json_encode_options to a json_encode flags bitmask.

You can inspect the serializer context builders to discover the available settings.

type: boolean default: true

Enables support for PHP attributes in the serializer component.

type: boolean default: true or false depending on your installation

Whether to enable the serializer service or not in the service container.

type: string

The name converter to use. The CamelCaseToSnakeCaseNameConverter name converter can enabled by using the serializer.name_converter.camel_case_to_snake_case value.

type: string default: 0

If set to 0, Symfony won't set any particular header related to the cache and it will rely on php.ini's session.cache_limiter directive.

Unlike the other session options, cache_limiter is set as a regular container parameter:

1
2
3
4

# config/services.yaml
parameters:
    session.storage.options:
        cache_limiter: 0

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <parameters>
        <parameter key="session.storage.options" type="collection">
            <parameter key="cache_limiter">0</parameter>
        </parameter>
    </parameters>
</container>

1
2
3
4

// config/services.php
$container->setParameter('session.storage.options', [
    'cache_limiter' => 0,
]);

Be aware that if you configure it, you'll have to set other session-related options as parameters as well.

type: string

This determines the domain to set in the session cookie.

If not set, php.ini's session.cookie_domain directive will be relied on.

type: boolean default: true

This determines whether cookies should only be accessible through the HTTP protocol. This means that the cookie won't be accessible by scripting languages, such as JavaScript. This setting can effectively help to reduce identity theft through XSS attacks.

type: integer

This determines the lifetime of the session - in seconds. Setting this value to 0 means the cookie is valid for the length of the browser session.

If not set, php.ini's session.cookie_lifetime directive will be relied on.

type: string

This determines the path to set in the session cookie.

If not set, php.ini's session.cookie_path directive will be relied on.

type: string or null default: null

It controls the way cookies are sent when the HTTP request did not originate from the same domain that is associated with the cookies. Setting this option is recommended to mitigate CSRF security attacks.

By default, browsers send all cookies related to the domain of the HTTP request. This may be a problem for example when you visit a forum and some malicious comment includes a link like https://some-bank.com/?send_money_to=attacker&amount=1000. If you were previously logged into your bank website, the browser will send all those cookies when making that HTTP request.

The possible values for this option are:

• null, use php.ini's session.cookie_samesite directive.
• 'none' (or the Symfony\Component\HttpFoundation\Cookie::SAMESITE_NONE constant), use it to allow sending of cookies when the HTTP request originated from a different domain (previously this was the default behavior of null, but in newer browsers 'lax' would be applied when the header has not been set)
• 'strict' (or the Cookie::SAMESITE_STRICT constant), use it to never send any cookie when the HTTP request did not originate from the same domain.
• 'lax' (or the Cookie::SAMESITE_LAX constant), use it to allow sending cookies when the request originated from a different domain, but only when the user consciously made the request (by clicking a link or submitting a form with the GET method).

type: boolean or 'auto'

This determines whether cookies should only be sent over secure connections. In addition to true and false, there's a special 'auto' value that means true for HTTPS requests and false for HTTP requests.

If not set, php.ini's session.cookie_secure directive will be relied on.

type: boolean default: true

Whether to enable the session support in the framework.

1
2
3
4

# config/packages/framework.yaml
framework:
    session:
        enabled: true

1
2
3
4
5
6
7

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->session()
        ->enabled(true);
};

type: integer

See gc_probability.

If not set, php.ini's session.gc_divisor directive will be relied on.

type: integer

This determines the number of seconds after which data will be seen as "garbage" and potentially cleaned up. Garbage collection may occur during session start and depends on gc_divisor and gc_probability.

If not set, php.ini's session.gc_maxlifetime directive will be relied on.

type: integer

This defines the probability that the garbage collector (GC) process is started on every session initialization. The probability is calculated by using gc_probability / gc_divisor, e.g. 1/100 means there is a 1% chance that the GC process will start on each request.

If not set, Symfony will use the value of the session.gc_probability directive in the php.ini configuration file.

type: string | null default: null

If framework.session.save_path is not set, the default value of this option is null, which means to use the session handler configured in php.ini. If the framework.session.save_path option is set, then Symfony stores sessions using the native file session handler.

It is possible to store sessions in a database, and also to configure the session handler with a DSN:

1
2
3
4
5
6
7
8

# config/packages/framework.yaml
framework:
    session:
        # a few possible examples
        handler_id: 'redis://localhost'
        handler_id: '%env(REDIS_URL)%'
        handler_id: '%env(DATABASE_URL)%'
        handler_id: 'file://%kernel.project_dir%/var/sessions'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
    <framework:config>
        <!-- a few possible examples -->
        <framework:session enabled="true"
            handler-id="redis://localhost"
            handler-id="%env(REDIS_URL)%"
            handler-id="%env(DATABASE_URL)%"
            handler-id="file://%kernel.project_dir%/var/sessions"/>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;
use function Symfony\Component\DependencyInjection\Loader\Configurator\env;

return static function (FrameworkConfig $framework): void {
    // ...

    $framework->session()
        // a few possible examples
        ->handlerId('redis://localhost')
        ->handlerId(env('REDIS_URL'))
        ->handlerId(env('DATABASE_URL'))
        ->handlerId('file://%kernel.project_dir%/var/sessions');
};

type: integer default: 0

This is how many seconds to wait between updating/writing the session metadata. This can be useful if, for some reason, you want to limit the frequency at which the session persists, instead of doing that on every request.

type: string

This specifies the name of the session cookie.

If not set, php.ini's session.name directive will be relied on.

type: string | null default: %kernel.cache_dir%/sessions

This determines the argument to be passed to the save handler. If you choose the default file handler, this is the path where the session files are created.

If null, php.ini's session.save_path directive will be relied on:

1
2
3
4
5
6
7
8
9
10
11
12
13

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:session save-path="null"/>
    </framework:config>
</container>

type: integer

This determines the number of bits in the encoded session ID character. The possible values are 4 (0-9, a-f), 5 (0-9, a-v), and 6 (0-9, a-z, A-Z, "-", ","). The more bits results in stronger session ID. 5 is recommended value for most environments.

If not set, php.ini's session.sid_bits_per_character directive will be relied on.

type: integer

This determines the length of session ID string, which can be an integer between 22 and 256 (both inclusive), 32 being the recommended value. Longer session IDs are harder to guess.

If not set, php.ini's session.sid_length directive will be relied on.

type: string default: session.storage.factory.native

The service ID used for creating the SessionStorageInterface that stores the session. This service is available in the Symfony application via the session.storage.factory service alias. The class has to implement SessionStorageFactoryInterface. To see a list of all available storages, run:

1

$ php bin/console debug:container session.storage.factory.

type: boolean

This specifies if the session ID is stored on the client side using cookies or not.

If not set, php.ini's session.use_cookies directive will be relied on.

type: boolean default: false

Whether to enable or not SSI support in your application.

type: string | null default: %kernel.cache_dir%/translations

Defines the directory where the translation cache is stored. Use null to disable this cache.

type: string default: %kernel.project_dir%/translations

This option allows to define the path where the application translations files are stored.

type: boolean default: true or false depending on your installation

Whether or not to enable the translator service in the service container.

type: string|array default: value of default_locale

This option is used when the translation key for the current locale wasn't found.

type: string default: translator.formatter.default

The ID of the service used to format translation messages. The service class must implement the MessageFormatterInterface.

default: true when the debug mode is enabled, false otherwise.

When true, a log entry is made whenever the translator cannot find a translation for a given key. The logs are made to the translation channel at the debug level for keys where there is a translation in the fallback locale, and the warning level if there is no translation to use at all.

type: array default: []

This option allows to define an array of paths where the component will look for translation files. The later a path is added, the more priority it has (translations from later paths overwrite earlier ones). Translations from the default_path have more priority than translations from all these paths.

type: array default: []

This option enables and configures translation providers to push and pull your translations to/from third party translation services.

type: array default: []

Defines the Doctrine entities that will be introspected to add automatic validation constraints to them:

1
2
3
4
5
6
7

framework:
    validation:
        auto_mapping:
            # an empty array means that all entities that belong to that
            # namespace will add automatic validation
            'App\Entity\': []
            'Foo\': ['Foo\Some\Entity', 'Foo\Another\Entity']

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <framework:validation>
            <framework:auto-mapping>
                <framework:service namespace="App\Entity\"/>

                <framework:service namespace="Foo\">Foo\Some\Entity</framework:service>
                <framework:service namespace="Foo\">Foo\Another\Entity</framework:service>
            </framework:auto-mapping>
        </framework:validation>
    </framework:config>
</container>

1
2
3
4
5
6
7
8
9
10
11

// config/packages/framework.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework): void {
    $framework->validation()
        ->autoMapping()
            ->paths([
                'App\\Entity\\' => [],
                'Foo\\' => ['Foo\\Some\\Entity', 'Foo\\Another\\Entity'],
            ]);
};

type: boolean default: false

Validation error messages are automatically translated to the current application locale. Set this option to true to disable translation of validation messages. This is useful to avoid "missing translation" errors in applications that use only a single language.

type: string default: html5

Sets the default value for the "mode" option of the Email validator.

type: boolean default: true

If this option is enabled, validation constraints can be defined using PHP attributes.

type: boolean default: true or false depending on your installation

Whether or not to enable validation support.

This option will automatically be set to true when one of the child settings is configured.

The NotCompromisedPassword constraint makes HTTP requests to a public API to check if the given password has been compromised in a data breach.

type: string | array default: ['loadValidatorMetadata']

Defines the name of the static method which is called to load the validation metadata of the class. You can define an array of strings with the names of several methods. In that case, all of them will be called in that order to load the metadata.

type: string | false default: validators

The translation domain that is used when translating validation constraint error messages. Use false to disable translations.

type: boolean default: true or false depending on your installation

Adds a Link HTTP header to the response.

type: boolean default: false

Whether to enable the support for workflows or not. This setting is automatically set to true when one of the child settings is configured.

type:

Name of the workflow you want to create.