Nov 2018 Changes to .env & How to UpdateEdit this page
Warning: You are browsing the documentation for Symfony 5.1, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (the current stable version).
In November 2018, several changes were made to the core Symfony recipes related
.env file. These changes make working with environment variables easier
and more consistent - especially when writing functional tests.
If your app was started before November 2018, your app does not require any changes to keep working. However, if/when you are ready to take advantage of these improvements, you will need to make a few small updates.
But first, what changed? On a high-level, not much. Here's a summary of the most important changes:
- A) The
.env.distfile no longer exists. Its contents should be moved to your
.envfile (see the next point).
- B) The
.envfile is now committed to your repository. It was previously ignored via the
.gitignorefile (the updated recipe does not ignore this file). Because this file is committed, it should contain non-sensitive, default values. The
.envcan be seen as the previous
- C) A
.env.localfile can now be created to override values in
.envfor your machine. This file is ignored in the new
- D) When testing, your
.envfile is now read, making it consistent with all other environments. You can also create a
.env.testfile for test-environment overrides.
- E) One further change to the recipe in January 2019 means that your
.envfiles are always loaded, even if you set an
APP_ENV=prodenvironment variable. The purpose is for the
.envfiles to define default values that you can override if you want to with real environment values.
There are a few other improvements, but these are the most important. To take advantage of these, you will need to modify a few files in your existing app.
If you created your application after November 15th 2018, you don't need to make any changes! Otherwise, here is the list of changes you'll need to make - these changes can be made to any Symfony 3.4 or higher app:
- Update your
public/index.phpfile to add the code of the public/index.php file provided by Symfony. If you've customized this file, make sure to keep those changes (but add the rest of the changes made by Symfony).
- Update your
bin/consolefile to add the code of the bin/console file provided by Symfony.
1 2 3 4 5 6 7 8 9 10
# .gitignore # ... ###> symfony/framework-bundle ### - /.env + /.env.local + /.env.local.php + /.env.*.local # ...
1 2 3 4 5 6 7
# Unix $ mv .env .env.local $ git mv .env.dist .env # Windows C:\> move .env .env.local C:\> git mv .env.dist .env
You can also update the comment on the top of .env to reflect the new changes.
- If you're using PHPUnit, you will also need to create a new .env.test file
and update your phpunit.xml.dist file so it loads the