System Requirements

PHP & MySQL or PostgreSQL

Flow Framework

Everything explained here also applies to the Flow framework (as Neos is based on Flow; and they share the same installation guides).
FlowFramework ReadTheDocs

#Requirements

For the currently supported Neos versions, the basic system requirements are:

  • PHP >= 7.3 (see version matrix below - we recommend the newest released PHP version, as it is generally faster than the version before)
    • PHP modules mbstring, tokenizer, xml and pdo_mysql
    • PHP functions exec(), shell_exec(), escapeshellcmd() and escapeshellarg()
    • It is recommended to install one of the PHP modules VIPS, imagick or gmagick. We also support GD (but it is quite slow, so we do not recommend it for production).
  • Database (MySQL > 5.7.7, MariaDB > 10.2.2 and PostgreSQL > 9.4 are supported.)
  • Web server (Apache or Nginx are supported)
    • For development you can also use the embedded PHP server.
    • For production, you need one of the above two webservers.
  • Git
    • Only for development, not needed for production

↓ Consult the DB compatibility notes and PHP version matrix below for details

 

Ensure your PHP CLI version matches the PHP web server version.

If you run PHP together with Apache or Nginx, you need to ensure that the corresponding PHP CLI (Command Line) version is installed as well, as we require it to precompile classes properly. Neos won't work without this!

DB compatibility notes

  • When running MySQL or MariaDB, be aware that the most recent versions of Neos and Flow require at least MariaDB 10.2.2 or MySQL 5.7.7.
  • If you run into errors like "Specified key was too long" with MySQL or MariaDB even though you have the required version, make sure you are using the DYNAMIC or COMPRESSED row format
  • When running PostgreSQL 10 or higher, you need at least Flow 5.0 (which means Neos 4.0). For older versions, only PostgreSQL 9.4 – 9.6 are supported.

#Develop locally, deploy to live

We suggest that you develop on your local machine, not directly on a remote web server. Then, use Git and some kind of deployment process to deploy your code to a production server.

#PHP version Matrix

Neos versionFlow versioncompatible PHP version
4.35.37.1 - 7.4*
5.x6.x7.2 - 7.4
7.x7.x7.3 - 7.4 / 8.0 - 8.1
8.x8.x8.0 - 8.1

*PHP 7.4 support was introduced with Neos 4.3.16/Flow 5.3.9.

We recommend using the latest PHP version supported by the Neos version. Furthermore, we strongly recommend ensuring that the PHP version is supported by PHP or your distribution.

#Unsupported versions
Neos versionFlow versioncompatible PHP version
1.32.35.3 - 7.0
2.x3.x5.5 - 7.0
3.x4.x7.0 - 7.3
4.0 - 4.25.0 - 5.27.1 - 7.3

For security reasons, unsupported versions should be upgraded at the earliest convenience.

#Supported Graphic Libraries

  • PHP-GD2
  • ImageMagick
  • GraphicsMagick
  • VIPS