Permalink
Browse files

feature #4000 [Cookbook] add cookbook article for the server:run comm…

…and (xabbuh)

This PR was merged into the 2.3 branch.

Discussion
----------

[Cookbook] add cookbook article for the server:run command

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes (symfony/symfony#3465)
| Applies to    | all
| Fixed tickets |

Commits
-------

57f467a add cookbook article for the server:run command
  • Loading branch information...
weaverryan committed Aug 19, 2014
2 parents 53b2c2b + 57f467a commit 4f9fef61a96cfda6fa5c3ac228647ccbdbde8ea9
@@ -28,6 +28,7 @@ The Cookbook
templating/index
testing/index
validation/index
web_server/index
web_services/index
workflow/index
@@ -191,6 +191,11 @@
* :doc:`/cookbook/validation/custom_constraint`
* :doc:`/cookbook/web_server/index`
* :doc:`/cookbook/web_server/built_in`
* (configuration) :doc:`/cookbook/configuration/web_server_configuration`
* :doc:`/cookbook/web_services/index`
* :doc:`/cookbook/web_services/php_soap_extension`
@@ -0,0 +1,60 @@
.. index::
single: Web Server; Built-in Web Server
How to Use PHP's built-in Web Server
====================================
Since PHP 5.4 the CLI SAPI comes with a `built-in web server`_. It can be used
to run your PHP applications locally during development, for testing or for
application demonstrations. This way, you don't have to bother configuring
a full-featured web server such as
:doc:`Apache or Nginx </cookbook/configuration/web_server_configuration>`.
.. caution::
The built-in web server is meant to be run in a controlled environment.
It is not designed to be used on public networks.
Starting the Web Server
-----------------------
Running a Symfony application using PHP's built-in web server is as easy as
executing the ``server:run`` command:
.. code-block:: bash
$ php app/console server:run
This starts a server at ``localhost:8000`` that executes your Symfony application.
The command will wait and will respond to incoming HTTP requests until you
terminate it (this is usually done by pressing Ctrl and C).
By default, the web server listens on port 8000 on the loopback device. You
can change the socket passing an ip address and a port as a command-line argument:
.. code-block:: bash
$ php app/console server:run 192.168.0.1:8080
Command Options
---------------
The built-in web server expects a "router" script (read about the "router"
script on `php.net`_) as an argument. Symfony already passes such a router
script when the command is executed in the ``prod`` or in the ``dev`` environment.
Use the ``--router`` option in any other environment or to use another router
script:
.. code-block:: bash
$ php app/console server:run --env=test --router=app/config/router_test.php
If your application's document root differs from the standard directory layout,
you have to pass the correct location using the ``--docroot`` option:
.. code-block:: bash
$ php app/console server:run --docroot=public_html
.. _`built-in web server`: http://www.php.net/manual/en/features.commandline.webserver.php
.. _`php.net`: http://php.net/manual/en/features.commandline.webserver.php#example-401
@@ -0,0 +1,7 @@
Web Server
==========
.. toctree::
:maxdepth: 2
built_in
@@ -57,6 +57,10 @@ to run Symfony:
$ php app/console server:run
.. seealso::
Read more about the internal server :doc:`in the cookbook </cookbook/web_server/built_in>`.
If you get the error `There are no commands defined in the "server" namespace.`,
then you are probably using PHP 5.3. That's ok! But the built-in web server is
only available for PHP 5.4.0 or higher. If you have an older version of PHP or

0 comments on commit 4f9fef6

Please sign in to comment.