Skip to content

Commit 65d8034

Browse files
committed
minor #17562 Symfony CLI: document the .symfony.local.yaml config file (jmsche)
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- Symfony CLI: document the .symfony.local.yaml config file It seems there are some other options available for the `.symfony.local.yaml` configuration file: https://github.com/symfony-cli/symfony-cli/blob/862b631e07adc07a534ef5349cbffa6006b76f41/local/project/config.go#L34-L61 I think this PR documents all of them :) Commits ------- 4f17fcb Symfony CLI: document the .symfony.local.yaml config file
2 parents 71b11c3 + 4f17fcb commit 65d8034

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

setup/symfony_server.rst

+33-3
Original file line numberDiff line numberDiff line change
@@ -292,16 +292,46 @@ server provides a ``run`` command to wrap them as follows:
292292
# stop the web server (and all the associated commands) when you are finished
293293
$ symfony server:stop
294294
295-
Configuring Workers
296-
-------------------
295+
Configuration file
296+
------------------
297297

298298
.. caution::
299299

300300
This feature is experimental and could change or be removed at any time
301301
without prior notice.
302302

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

306336
.. code-block:: yaml
307337

0 commit comments

Comments
 (0)