@@ -188,36 +188,36 @@ Then you can use the following command to start a server out-of-the-box:
188188
189189 .. _var-dumper-dump-server-format :
190190
191- Debug any project with the server format
192- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
191+ Configuring the Dump Server with Environment Variables
192+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193193
194- There is a way to force the ``VarDumper `` to dump to a server, without the need to configure anything in your
195- application: by using the ``VAR_DUMPER_FORMAT=server `` environment variable.
196- It is especially useful to debug any project (as soon as the VarDumper component is installed),
197- without altering its code by:
194+ .. versionadded :: 5.2
198195
199- * starting a server:
196+ The `` VAR_DUMPER_FORMAT= server`` feature was introduced in Symfony 5.2.
200197
201- .. code-block :: terminal
198+ If you prefer to not modify the application configuration (e.g. to quickly debug
199+ a project given to you) use the ``VAR_DUMPER_FORMAT `` env var.
202200
203- $ ./vendor/bin/var-dump-server
201+ First, start the server as usual:
204202
205- * running your code with the `` VAR_DUMPER_FORMAT=server `` env variable. For instance, for a CLI command:
203+ .. code-block :: terminal
206204
207- .. code-block :: terminal
205+ $ ./vendor/bin/var-dump-server
208206
209- $ VAR_DUMPER_FORMAT=server [your-cli-command]
207+ Then, run your code with the ``VAR_DUMPER_FORMAT=server `` env var by configuring
208+ this value in the :ref: `.env file of your application <config-env-vars >`. For
209+ console commands, you can also define this env var as follows:
210210
211- .. tip ::
211+ .. code-block :: terminal
212212
213- If your project loads environment variables from a dotenv file, you can set the ``VAR_DUMPER_FORMAT=server ``
214- environment variable in there as well.
213+ $ VAR_DUMPER_FORMAT=server [your-cli-command]
215214
216215 .. note ::
217216
218- The host used to contact the server when using the ``server `` format is the one configured by the
219- ``VAR_DUMPER_SERVER `` var or defaults to ``127.0.0.1:9912 ``.
220- But you can configure the host through the ``VAR_DUMPER_FORMAT=tcp://127.0.0.1:1234 `` environment variable as well.
217+ The host used by the ``server `` format is the one configured in the
218+ ``VAR_DUMPER_SERVER `` env var or ``127.0.0.1:9912 `` if none is defined.
219+ If you prefer, you can also configure the host in the ``VAR_DUMPER_FORMAT ``
220+ env var like this: ``VAR_DUMPER_FORMAT=tcp://127.0.0.1:1234 ``.
221221
222222DebugBundle and Twig Integration
223223--------------------------------
0 commit comments