Skip to content

[Setup] Clarify the Symfony binary and show small PHP built-in command #13475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ requirements. Open your console terminal and run this command:

$ symfony check:requirements

.. note::

The Symfony binary is developped internally at Symfony. If you want to
report a bug or suggest a new feature, please create an issue on
`symfony/cli`_.

.. _creating-symfony-applications:

Creating Symfony Applications
Expand Down Expand Up @@ -78,14 +84,16 @@ started. In other words, your new application is ready!
Running Symfony Applications
----------------------------

On production, you should use a web server like Nginx or Apache (see
:doc:`configuring a web server to run Symfony </setup/web_server_configuration>`).
But for development, it's more convenient to use the
:doc:`local web server </setup/symfony_server>` provided by Symfony.
In production, you should install a webserver like Nginx or Apache and
:doc:`configure it to run Symfony </setup/web_server_configuration>`. This
method can also be used if you're not using the Symfony local web server for
development.

This local server provides support for HTTP/2, TLS/SSL, automatic generation of
security certificates and many other features. It works with any PHP application,
not only Symfony projects, so it's a very useful development tool.
However for local development, the most convenient way of running Symfony is by
using the :doc:`local web server </setup/symfony_server>` provided by the
``symfony`` binary. This local server provides among other things support for
HTTP/2, concurrent requests, TLS/SSL and automatic generation of security
certificates.

Open your console terminal, move into your new project directory and start the
local web server as follows:
Expand All @@ -99,6 +107,11 @@ Open your browser and navigate to ``http://localhost:8000/``. If everything is
working, you'll see a welcome page. Later, when you are finished working, stop
the server by pressing ``Ctrl+C`` from your terminal.

.. tip::

The web server works with any PHP application, not only Symfony projects,
so it's a very useful generic development tool.

.. _install-existing-app:

Setting up an Existing Symfony Project
Expand Down Expand Up @@ -294,6 +307,7 @@ Learn More
.. _`Stellar Development with Symfony`: https://symfonycasts.com/screencast/symfony
.. _`Install Composer`: https://getcomposer.org/download/
.. _`install Symfony CLI`: https://symfony.com/download
.. _`symfony/cli`: https://github.com/symfony/cli
.. _`The Symfony Demo Application`: https://github.com/symfony/demo
.. _`Symfony Flex`: https://github.com/symfony/flex
.. _`PHP security advisories database`: https://github.com/FriendsOfPHP/security-advisories
Expand Down
5 changes: 3 additions & 2 deletions setup/symfony_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ The Symfony server is part of the ``symfony`` binary created when you

.. note::

If you want to report a bug or suggest a new feature, please create an issue
on `symfony/cli`_.
The Symfony binary is developped internally at Symfony. If you want to
report a bug or suggest a new feature, please create an issue on
`symfony/cli`_.

Getting Started
---------------
Expand Down