Skip to content

Commit 71d61ab

Browse files
bartvanraaijjaviereguiluz
authored andcommitted
Update requirements.rst
List the minor requirements in the docs and make some small improvements.
1 parent 5fe3acc commit 71d61ab

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

reference/requirements.rst

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,44 @@
33

44
.. _requirements-for-running-symfony2:
55

6-
Requirements for Running Symfony
7-
================================
6+
Requirements for Running Symfony 4
7+
==================================
88

99
Symfony 4 requires **PHP 7.1.3** or higher to run, in addition to other minor
10-
requirements. To make things simple, Symfony provides a tool to quickly check if
11-
your system meets all those requirements. Run this command to install the tool:
10+
requirements:
11+
12+
PHP Extensions
13+
~~~~~~~~~~~~~~
14+
* The `Ctype`_ extension must be available
15+
* The `iconv`_ extension must be available
16+
* The `JSON`_ extension must be available
17+
* The `PCRE`_ extension must be available (minimum version 8.0)
18+
* The `Session`_ extension must be available
19+
* The `SimpleXML`_ extension must be available
20+
* The `Tokenizer`_ extension must be available
21+
22+
Please note that all these extensions are installed and enabled by default
23+
in PHP 7+.
24+
25+
Other Requirements
26+
~~~~~~~~~~~~~~~~~~
27+
* The cache directory must me writable by the web server
28+
* The logs directory must be writable by the web server
29+
30+
Checking Requirements with Symfony Requirements Checker
31+
-------------------------------------------------------
32+
To make things simple, Symfony provides a tool to quickly check if
33+
your system meets these requirements. In addition, the tool will
34+
also provide recommendations if applicable.
35+
36+
Run this command to install the tool:
1237

1338
.. code-block:: terminal
1439
1540
$ cd your-project/
1641
$ composer require symfony/requirements-checker
1742
18-
Beware that PHP can define a different configuration for the command console and
43+
Beware that PHP may use different configurations for the command console and
1944
the web server, so you need to check requirements in both environments.
2045

2146
Checking Requirements for the Web Server
@@ -38,4 +63,12 @@ Checking Requirements for the Command Console
3863

3964
The requirements checker tool adds a script to your Composer configuration to
4065
check the requirements automatically. There's no need to execute any command; if
41-
there is any issue, you'll see them in the console output.
66+
there are any issues, you'll see them in the console output.
67+
68+
.. _iconv: http://php.net/manual/en/book.iconv.php
69+
.. _JSON: http://php.net/manual/en/book.json.php
70+
.. _Session: http://php.net/manual/en/book.session.php
71+
.. _Ctype: http://php.net/manual/en/book.ctype.php
72+
.. _Tokenizer: http://php.net/manual/en/book.tokenizer.php
73+
.. _SimpleXML: http://php.net/manual/en/book.simplexml.php
74+
.. _PCRE: http://php.net/manual/en/book.pcre.php

0 commit comments

Comments
 (0)