Skip to content

Commit b04efdf

Browse files
committed
Improve the docs about the Symfony server proxy
1 parent e68834e commit b04efdf

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

setup/symfony_server.rst

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ Enabling PHP-FPM
6363
When the server starts it will check for common patterns like ``web/app.php``,
6464
``web/app_dev.php`` or ``public/index.php``. If a file like this is found the
6565
server will automatically start with PHP-FPM enabled. Otherwise the server will
66-
start without PHP-FPM and will show a ``Page not found`` page when trying to
66+
start without PHP-FPM and will show a ``Page not found`` page when trying to
6767
access a ``.php`` file in the browser.
6868

6969
.. tip::
7070

7171
When an ``index.html`` and a front controller like e.g. ``index.php`` are
72-
both present the server will still start with PHP-FPM enabled but the
72+
both present the server will still start with PHP-FPM enabled but the
7373
``index.html`` will take precedence over the front controller. This means
7474
when an ``index.html`` file is present in ``public`` or ``web``, it will be
7575
displayed instead of the ``index.php`` which would show e.g. the Symfony
@@ -181,19 +181,28 @@ local IP. However, sometimes it is preferable to associate a domain name to them
181181
Setting up the Local Proxy
182182
~~~~~~~~~~~~~~~~~~~~~~~~~~
183183

184-
Local domains are possible thanks to a local proxy provided by the Symfony
185-
server. First, start the proxy:
184+
Local domains are possible thanks to a local proxy provided by the Symfony server.
185+
If this is the first time you run the proxy, you must configure it as follows:
186+
187+
#. Open the **proxy settings** of your operating system:
188+
189+
* `Proxy settings in Windows`_;
190+
* `Proxy settings in macOS`_;
191+
* `Proxy settings in Ubuntu`_.
192+
193+
#. Set the following URL as the value of the **Automatic Proxy Configuration**:
194+
``http://127.0.0.1:7080/proxy.pac``
195+
196+
Now run this command to start the proxy:
186197

187198
.. code-block:: terminal
188199
189200
$ symfony proxy:start
190201
191-
If this is the first time you run the proxy, you must configure it as follows:
202+
.. note::
192203

193-
* Open the **proxy settings** of your operating system (`proxy settings in Windows`_,
194-
`proxy settings in macOS`_, `proxy settings in Ubuntu`_);
195-
* Set the following URL as the value of the **Automatic Proxy Configuration**:
196-
``http://127.0.0.1:7080/proxy.pac``
204+
Some browsers (e.g. Chrome) require a full restart after starting the proxy.
205+
Otherwise, you'll see a *"This webpage is not available"* error (``ERR_NAME_NOT_RESOLVED``).
197206

198207
Defining the Local Domain
199208
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -407,6 +416,6 @@ that Composer will also set the stability to ``dev`` for all root dependencies):
407416
.. _`Docker`: https://en.wikipedia.org/wiki/Docker_(software)
408417
.. _`SymfonyCloud`: https://symfony.com/cloud/
409418
.. _`Read SymfonyCloud technical docs`: https://symfony.com/doc/master/cloud/intro.html
410-
.. _`proxy settings in Windows`: https://www.dummies.com/computers/operating-systems/windows-10/how-to-set-up-a-proxy-in-windows-10/
411-
.. _`proxy settings in macOS`: https://support.apple.com/guide/mac-help/enter-proxy-server-settings-on-mac-mchlp2591/mac
412-
.. _`proxy settings in Ubuntu`: https://help.ubuntu.com/stable/ubuntu-help/net-proxy.html.en
419+
.. _`Proxy settings in Windows`: https://www.dummies.com/computers/operating-systems/windows-10/how-to-set-up-a-proxy-in-windows-10/
420+
.. _`Proxy settings in macOS`: https://support.apple.com/guide/mac-help/enter-proxy-server-settings-on-mac-mchlp2591/mac
421+
.. _`Proxy settings in Ubuntu`: https://help.ubuntu.com/stable/ubuntu-help/net-proxy.html.en

0 commit comments

Comments
 (0)