Skip to content

Documented the console environment variables #4665

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 22, 2014
Merged

Documented the console environment variables #4665

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7c4cd17
Documented the console environment variables
javiereguiluz Dec 17, 2014
6fc8f4c
Fixed some errors in the explanation
javiereguiluz Dec 17, 2014
8ead4a4
Minor grammar fix
javiereguiluz Dec 17, 2014
a1d88d8
More grammar fixes
javiereguiluz Dec 17, 2014
2fb082d
Rewordings and transformed a list into a definition list
javiereguiluz Dec 17, 2014
dd8157f
More tweaks and grammar fixes
javiereguiluz Dec 17, 2014
df2a0f2
Fixes and tweaks
javiereguiluz Dec 19, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions cookbook/configuration/environments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,37 @@ environment by using this code and changing the environment string.
mode. You'll need to enable that in your front controller by calling
:method:`Symfony\\Component\\Debug\\Debug::enable`.

Selecting the Environment for Console Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default, Symfony commands are executed in the ``dev`` environment and with the
debug mode enabled. Use ``--env`` and ``-no-debug`` options to modify this behavior:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use the [...]


.. code-block:: bash

# 'dev' environment and debug enabled
$ php app/console command_name

# 'prod' environment and debug enabled
$ php app/console command_name --env=prod
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is wrong. The console file has a special handling for the prod env, forcing it to be in no-debug mode: https://github.com/symfony/symfony-standard/blob/20516f547e3282a1b3aeec2a284efd311aa9f5a4/app/console#L19
Use --env=test instead for this case


# 'prod' environment and debug disabled
$ php app/console command_name --env=prod --no-debug

In addition to ``--env`` and ``--debug`` options, Symfony commands behavior can
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...] to the [...]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has to be "[...] Symfony commands' behavior [...] which reads really ugly. So I suggest to change this to "[...] the behavior of Symfony commands can [...]"

also be controlled with environment variables. The Symfony console application
checks the existence and value of these environment variables before executing
any command:

* ``SYMFONY_ENV``, sets the execution environment of the command to the value of
this variable.
* ``SYMFONY_DEBUG``, if ``true``, debug mode is enabled for the command. If
``false``, debug mode is disabled.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disabling debug mode is done with SYMFONY_DEBUG=0 actually (there is no boolean in env variables)


These environment variables are very useful for production servers, because they
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Afaik you can omit the comma.

allow you to ensure that commands are always run on ``prod`` environment without
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[...] run in the [...]

having to add any command option.

.. index::
single: Environments; Creating a new environment

Expand Down