Configuration

General documentation on how to configure Symfony. More details are available in the official documentation.

Symfony#

The src/api/config folder contains Symfony's configuration.

There are two main parts:

src/api/config/services.yaml: YAML configuration file for your application.
src/api/config/packages folder: YAML configuration files of the bundles (Symfony packages).

The packages folder root files are the default configurations of the bundles.

According to the APP_ENV value of the api service, files from the following folders:

src/api/config/packages/dev
src/api/config/packages/test
src/api/config/packages/prod

will extend/override the default configurations.

You often don't want to extend/override a configuration directly but instead create a variable. For instance, the DATABASE_URL value contains secrets (the database hostname, password, etc.) you should not commit. Also, you might use APP_ENV=prod for different environments (like staging and production), which do not use the same database.

That's why Symfony allows doing the following:

src/api/config/doctrine.yaml

doctrine:
    dbal:
        url: '%env(resolve:DATABASE_URL)%'

This instruction will fetch the value of the given environment variable. See the official documentation for more details.

note

📣 In your development environment, do not put these environment variables in the .env file from the src/api folder, but instead, put them under the environment key from the api service of your docker-compose.yml file.

Parameters#

If you need the value of an environment variable in your code, use the Symfony parameters.

For instance:

src/api/config/services.yaml

parameters:
    app.foo: '%env(FOO)%'
    
services:
    Your\Class\Foo:
        arguments:
            $foo: '%app.foo%'

# A class.
private string $foo;

public function __construct(
    string $foo
) {
    $this->foo = foo;
}