From 4f17fcb9e271c45492d383eb79dfdd28e1a34211 Mon Sep 17 00:00:00 2001 From: jmsche Date: Wed, 14 Dec 2022 15:55:02 +0100 Subject: [PATCH] Symfony CLI: document the .symfony.local.yaml config file --- setup/symfony_server.rst | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/setup/symfony_server.rst b/setup/symfony_server.rst index b9cdb4c2850..37cbc767ccd 100644 --- a/setup/symfony_server.rst +++ b/setup/symfony_server.rst @@ -284,16 +284,46 @@ server provides a ``run`` command to wrap them as follows: # stop the web server (and all the associated commands) when you are finished $ symfony server:stop -Configuring Workers -------------------- +Configuration file +------------------ .. caution:: This feature is experimental and could change or be removed at any time without prior notice. +There are several options that you can set using a ``.symfony.local.yaml`` config file: + +.. code-block:: yaml + + # Sets domain1.wip and domain2.wip for the current project + proxy: + domains: + - domain1 + - domain2 + + http: + document_root: public/ # Path to the project document root + passthru: index.php # Project passthru index + port: 8000 # Force the port that will be used to run the server + preferred_port: 8001 # Preferred HTTP port [default: 8000] + p12: path/to/p12_cert # Name of the file containing the TLS certificate to use in p12 format + allow_http: true # Prevent auto-redirection from HTTP to HTTPS + no_tls: true # Use HTTP instead of HTTPS + daemon: true # Run the server in the background + use_gzip: true # Toggle GZIP compression + +.. caution:: + + Setting domains in this configuration file will override any domains you set + using the ``proxy:domain:attach`` command for the current project when you start + the server. + +Configuring Workers +~~~~~~~~~~~~~~~~~~~ + If you like some processes to start automatically, along with the webserver -(``symfony server:start``), add a configuration file to your project: +(``symfony server:start``), you can set them in the YAML configuration file: .. code-block:: yaml