Skip to content

Commit c387352

Browse files
committed
Symfony CLI: document the .symfony.local.yaml config file
1 parent c4de976 commit c387352

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

setup/symfony_server.rst

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,16 +284,45 @@ server provides a ``run`` command to wrap them as follows:
284284
# stop the web server (and all the associated commands) when you are finished
285285
$ symfony server:stop
286286
287-
Configuring Workers
288-
-------------------
287+
Configuration file
288+
------------------
289289

290290
.. caution::
291291

292292
This feature is experimental and could change or be removed at any time
293293
without prior notice.
294294

295+
There are several options that you can set using a ``.symfony.local.yaml`` config file:
296+
297+
.. code-block:: yaml
298+
299+
# Sets domain1.wip and domain2.wip for the current project
300+
domains:
301+
- domain1
302+
- domain2
303+
304+
http:
305+
document_root: public/ # Path to the project document root
306+
passthru: index.php # Project passthru index
307+
port: 8000 # Force the port that will be used to run the server
308+
preferred_port: 8001 # Preferred HTTP port [default: 8000]
309+
p12: path/to/p12_cert # Name of the file containing the TLS certificate to use in p12 format
310+
allow_http: true # Prevent auto-redirection from HTTP to HTTPS
311+
no_tls: true # Use HTTP instead of HTTPS
312+
daemon: true # Run the server in the background
313+
use_gzip: true # Toggle GZUP compression
314+
315+
.. caution::
316+
317+
Setting domains in this configuration file will override any domains you set
318+
using the ``proxy:domain:attach`` command for the current project when you start
319+
the server.
320+
321+
Configuring Workers
322+
~~~~~~~~~~~~~~~~~~~
323+
295324
If you like some processes to start automatically, along with the webserver
296-
(``symfony server:start``), add a configuration file to your project:
325+
(``symfony server:start``), you can set them in the YAML configuration file:
297326

298327
.. code-block:: yaml
299328

0 commit comments

Comments
 (0)