From fcfb1bcf61682d4755d88ec44038277b21e75d9e Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 10 Jul 2017 16:33:49 +0200 Subject: [PATCH 1/4] Simplified the requirements article --- reference/requirements.rst | 64 ++++++++++---------------------------- 1 file changed, 17 insertions(+), 47 deletions(-) diff --git a/reference/requirements.rst b/reference/requirements.rst index 416083318e1..22feb836f57 100644 --- a/reference/requirements.rst +++ b/reference/requirements.rst @@ -6,57 +6,27 @@ Requirements for Running Symfony ================================ -To run Symfony, your system needs to adhere to a list of requirements. You -can easily see if your system passes all requirements by running the -``web/config.php`` in your Symfony distribution. Since the CLI often uses -a different ``php.ini`` configuration file, it's also a good idea to check -your requirements from the command line via: +Symfony 2.7 requires **PHP 5.3.9** or higher to run, in addition to other minor +requirements. To make things simple, Symfony provides a tool to quickly check if +your system meets all those requirements. -.. code-block:: terminal - - $ php app/check.php - -Below is the list of required and optional requirements. - -Required --------- +Beware that PHP can define a different configuration for the command console and +the web server, so you need to check requirements in both. -* PHP needs to be a minimum version of PHP 5.3.9 -* `JSON extension`_ needs to be enabled -* `ctype extension`_ needs to be enabled -* Your ``php.ini`` needs to have the ``date.timezone`` setting +Checking Requirements for the Web Server +---------------------------------------- -.. caution:: +Browse the ``web/config.php`` file in your browser and fix the reported issues. +When using the PHP built-in web server, this file is available at +``http://127.0.0.1:8000/config.php`` - Be aware that PHP 5.3.16 is not suitable to run Symfony, - because of a `major bug in the Reflection subsystem`_. +Checking Requirements for the Command Console +--------------------------------------------- -Optional --------- +Open your console or terminal, enter in your project directory, execute this +command and fix the reported issues: -* You need to have the PHP-XML module installed -* You need to have at least version 2.6.21 of libxml -* PHP tokenizer needs to be enabled -* mbstring functions need to be enabled -* iconv needs to be enabled -* POSIX needs to be enabled (only on \*nix) -* Intl needs to be installed with ICU 4+ -* APC 3.0.17+ (or another opcode cache needs to be installed) -* ``php.ini`` recommended settings - - * ``short_open_tag = Off`` - * ``magic_quotes_gpc = Off`` - * ``register_globals = Off`` - * ``session.auto_start = Off`` - -Doctrine --------- - -If you want to use Doctrine, you will need to have PDO installed. Additionally, -you need to have the PDO driver installed for the database server you want -to use. +.. code-block:: terminal -.. _`Requirements section of the README`: https://github.com/symfony/symfony/blob/2.7/README.md#requirements -.. _`JSON extension`: https://php.net/manual/book.json.php -.. _`ctype extension`: https://php.net/manual/book.ctype.php -.. _`major bug in the Reflection subsystem`: https://bugs.php.net/bug.php?id=62715 + $ cd my-project/ + $ php app/check.php From d82d84231e88de35226d812b5e221022a78d59e0 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 10 Jul 2017 16:39:34 +0200 Subject: [PATCH 2/4] Added a note about removing the config.php file when you no longer need it --- reference/requirements.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/reference/requirements.rst b/reference/requirements.rst index 22feb836f57..3453caa0a3c 100644 --- a/reference/requirements.rst +++ b/reference/requirements.rst @@ -20,6 +20,9 @@ Browse the ``web/config.php`` file in your browser and fix the reported issues. When using the PHP built-in web server, this file is available at ``http://127.0.0.1:8000/config.php`` +Once you've fixed all the reported issues, delete this ``web/config.php`` file +to avoid leaking internal information about your application to visitors. + Checking Requirements for the Command Console --------------------------------------------- From bc3c633505c7094d55a8a300db76251233ff4c56 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Wed, 12 Jul 2017 13:18:09 +0200 Subject: [PATCH 3/4] Minor fixes --- reference/requirements.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/requirements.rst b/reference/requirements.rst index 3453caa0a3c..aeb7c26eb74 100644 --- a/reference/requirements.rst +++ b/reference/requirements.rst @@ -11,7 +11,7 @@ requirements. To make things simple, Symfony provides a tool to quickly check if your system meets all those requirements. Beware that PHP can define a different configuration for the command console and -the web server, so you need to check requirements in both. +the web server, so you need to check requirements in both environments. Checking Requirements for the Web Server ---------------------------------------- @@ -20,7 +20,7 @@ Browse the ``web/config.php`` file in your browser and fix the reported issues. When using the PHP built-in web server, this file is available at ``http://127.0.0.1:8000/config.php`` -Once you've fixed all the reported issues, delete this ``web/config.php`` file +Once you've fixed all the reported issues, delete the ``web/config.php`` file to avoid leaking internal information about your application to visitors. Checking Requirements for the Command Console From 74b63f436555f0835430ddfa31ce58c43af0525e Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Thu, 13 Jul 2017 09:47:37 +0200 Subject: [PATCH 4/4] Reworded some contents --- reference/requirements.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/reference/requirements.rst b/reference/requirements.rst index aeb7c26eb74..ae7707c1057 100644 --- a/reference/requirements.rst +++ b/reference/requirements.rst @@ -16,9 +16,8 @@ the web server, so you need to check requirements in both environments. Checking Requirements for the Web Server ---------------------------------------- -Browse the ``web/config.php`` file in your browser and fix the reported issues. -When using the PHP built-in web server, this file is available at -``http://127.0.0.1:8000/config.php`` +Symfony includes a ``config.php`` file in the ``web/`` directory of your project. +Open that file with your browser to check the requirements. Once you've fixed all the reported issues, delete the ``web/config.php`` file to avoid leaking internal information about your application to visitors.