Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
Documented the loadForEnv() method#10626
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -67,6 +67,42 @@ The ``load()`` method never overwrites existing environment variables. Use the | ||||||||||
| .. versionadded:: 4.2 | ||||||||||
| The ``Dotenv::overload()`` method was introduced in Symfony 4.2. | ||||||||||
| Symfony follows and promotes the `app config recommendations`_ made by the | ||||||||||
| Twelve-Factor App methodology. Among other things, it's recommended to not group | ||||||||||
| env vars into environments (``dev``, ``prod``, ``test``, etc.) | ||||||||||
| When deploying apps you should follow that recommendation strictly. However, | ||||||||||
| when developing apps on your local machine, testing multiple apps in different | ||||||||||
| environments with regular env vars is cumbersome. That's why Symfony provides a | ||||||||||
| feature to define env vars per environment using the ``loadForEnv()`` method | ||||||||||
| (but you should only use it on your local machine, not in production servers):: | ||||||||||
| // ... | ||||||||||
| $dotenv->loadForEnv('dev', __DIR__.'/.env'); | ||||||||||
| // Looks for env vars in these files (and in this order): | ||||||||||
| // .env.dev.local | ||||||||||
| // .env.local | ||||||||||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Will be loadedafter Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more.
Hmm. Are you sure? I didn't check the code, but if it's true it's not respecting the same priorities ashttps://github.com/bkeepers/dotenv/blob/master/README.md#what-other-env-files-can-i-use, i.e:
Also, what about using the same presentation as Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Buthttps://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#what-other-env-files-can-be-used does load IMHO, loading | ||||||||||
| // .env.dev | ||||||||||
| // .env | ||||||||||
| // ... | ||||||||||
| $dotenv->loadForEnv('test', __DIR__.'/.env'); | ||||||||||
| // In the 'test' environment, the '.env.local' file is ignored. This example | ||||||||||
| // looks for env vars in these files (and in this order): | ||||||||||
| // .env.test.local | ||||||||||
| // .env.test | ||||||||||
| // .env | ||||||||||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggested change
Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I would add somewhere something similar tohttps://github.com/bkeepers/dotenv/blob/master/README.md#can-i-use-dotenv-in-production last paragraph:
i.e no need to repeat all env vars. Only the ones likely to be specific for the target env. | ||||||||||
| The ``.env`` file should be committed to the shared repository and contains the | ||||||||||
| default env var values for the app. The optional ``.env.local`` file shouldn't | ||||||||||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggested change
| ||||||||||
| be committed to the repository and overrides the values of some env vars to run | ||||||||||
| the app on your local machine. The other two optional files (``.env`` + | ||||||||||
| "environment name" + ``.local`` and ``.env`` + "environment name") work | ||||||||||
| similarly, but they are specific to some environment. | ||||||||||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. May I suggest to add the following: Suggested change
| ||||||||||
| .. versionadded:: 4.2 | ||||||||||
| The ``Dotenv::loadForEnv()`` method was introduced in Symfony 4.2. | ||||||||||
| You should never store a ``.env`` file in your code repository as it might | ||||||||||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This sentence should be remove in favor of the paragraph you introduced, right? | ||||||||||
| contain sensitive information; create a ``.env.dist`` file with sensible | ||||||||||
| defaults instead. | ||||||||||
| @@ -112,3 +148,4 @@ Embed commands via ``$()`` (not supported on Windows): | ||||||||||
| .. _Packagist: https://packagist.org/packages/symfony/dotenv | ||||||||||
| .. _twelve-factor applications: http://www.12factor.net/ | ||||||||||
| .. _`app config recommendations`: https://12factor.net/config | ||||||||||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggested change
| ||||||||||