8000 minor #13475 [Setup] Clarify the Symfony binary and show small PHP bu… · symfony/symfony-docs@1a3f107 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1a3f107

Browse files
javiereguiluzjaviereguiluz
committed
minor #13475 [Setup] Clarify the Symfony binary and show small PHP built-in command (wouterj)
This PR was squashed before being merged into the 4.4 branch (closes #13475). Discussion ---------- [Setup] Clarify the Symfony binary and show small PHP built-in command `@MaikB` on Reddit left some very usefull insights in how we documented Symfony CLI ([ref](https://www.reddit.com/r/PHP/comments/foqs7x/symfony_docs_make_it_look_like_you_have_to_use/fm47h1t/?context=8&depth=9)). An excerpt from the comment: > First there is the docs. [...] They just push very hard towards the symfony-cli. That on its own is no big deal. A big deal is that I had to do some digging to even find out that this CLI is closed source. You have to mention that upfront. [... shows the steps it required to find out the source is closed] > > Just give people an page which discusses the usage of the built-in web server (php -S localhost:8000 -t public), with or without a router script. Explain the shortcomings which lead you to develop the now deprecated symfony/web-server-bundle. Then tell the story of how the CLI came about and how it is connected to your cloud business. Tell us that you have to keep the sources closed for now, maybe because it contains details which are important for your business to be keep out of the public. Just give us something. > > I sincerely do believe this is an communication issue. [...] > > Now that I explained myself in more detail, let me say that I am thankful to Fabien and and everyone who has and still is working on Symfony. This is just a problem, not the end of the world. I hope you have a good day, given the pandemic, and stay safe. --- I think this is very usefull information. I personally don't think there is anything wrong with the binary being closed source, but obviously there are people that feel uneasy about it. As we're an inclusive community, I think it makes sense to tell people upfront "hey, this is a closed source tool". This effectively changes nothing, but would solve part of the problem of these people that now feel excluded. It also opens the possibility to point people to a location to report bugs in the binary (previously, we only mentioned it in the Local web server guide). I was against documenting the PHP built-in server in the docs, to not make it more complicated. But as it's used by community members and just a very small one-liner, I think it's nice to have a small note about it. Again, it's a small note, but it potentially solves a huge thing for others. --- @fabpot @nicolas-grekas @javiereguiluz @weaverryan As I'm totally not into all strategy and ideas behind Symfony, I would like your opinions/reviews here. The goal at the very minimal is to not upset people with the changes in this PR. Commits ------- c571179 [Setup] Clarify the Symfony binary and show small PHP built-in command
2 parents 4cc5294 + c571179 commit 1a3f107

File tree

2 files changed

+24
-9
lines changed

2 files changed

+24
-9
lines changed

‎setup.rst

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ requirements. Open your console terminal and run this command:
3333
3434
$ symfony check:requirements
3535
36+
.. note::
37+
38+
The Symfony binary is developped internally at Symfony. If you want to
39+
report a bug or suggest a new feature, please create an issue on
40+
`symfony/cli`_.
41+
3642
.. _creating-symfony-applications:
3743

3844
Creating Symfony Applications
@@ -78,14 +84,16 @@ started. In other words, your new application is ready!
7884
Running Symfony Applications
7985
----------------------------
8086

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

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

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

110+
.. tip::
111+
112+
The web server works with any PHP application, not only Symfony projects,
113+
so it's a very useful generic development tool.
114+
102115
.. _install-existing-app:
103116

104117
Setting up an Existing Symfony Project
@@ -294,6 +307,7 @@ Learn More
294307
.. _`Stellar Development with Symfony`: https://symfonycasts.com/screencast/symfony
295308
.. _`Install Composer`: https://getcomposer.org/download/
296309
.. _`install Symfony CLI`: https://symfony.com/download
310+
.. _`symfony/cli`: https://github.com/symfony/cli
297311
.. _`The Symfony Demo Application`: https://github.com/symfony/demo
298312
.. _`Symfony Flex`: https://github.com/symfony/flex
299313
.. _`PHP security advisories database`: https://github.com/FriendsOfPHP/security-advisories

‎setup/symfony_server.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ The Symfony server is part of the ``symfony`` binary created when you
1919

2020
.. note::
2121

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

2526
Getting Started
2627
---------------

0 commit comments

Comments
 (0)
0