Skip to content
  • Documentation >
  • Getting started >
  • Requirements

Requirements

This document covers all supported versions of the product. To review the requirements, select the specific version of Ibexa DXP you are interested in.

The following server requirements cover both running the software on-premise and on third-party PaaS providers.

Ibexa Cloud

For running on Ibexa Cloud, where recommended configuration and support is provided out of the box, see separate Ibexa Cloud section for further reading on its requirements.

The minimal setup requires PHP, MySQL/MariaDB, Apache/Nginx, Node.js and yarn. Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached, NFS/EFS/S3 and Solr/Elasticsearch in a clustered setup.

Recommended versions

Review all the recommended versions carefully. If you see a "+" next to the product version, it means that we recommend this version or higher within the same major release. For example, "1.18+" means any 1.x version higher or equal to 1.18, but not 2.x.

Using the latest listed version of each product or component is recommended. Always use a version that receives security updates, either by the vendor themselves or by a trusted third party, such as the distribution vendor.

Operating system

Name Version
Debian 10 "Buster" 10.0-10.13+
Debian 11 "Bullseye" 11.0-11.7+
Ubuntu "Focal Fossa" 20.04
Ubuntu "Jammy Jellyfish" 22.04
RHEL / CentOS 8.1-8.5+

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

Name Version
Debian 10 "Buster" 10.0-10.13+
Debian 11 "Bullseye" 11.0-11.7+
Ubuntu "Focal Fossa" 20.04
Ubuntu "Jammy Jellyfish" 22.04
RHEL / CentOS 8.1-8.5+

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

Name Version
Debian 10 "Buster" 10.0-10.13+
Ubuntu "Bionic" 18.04 LTS
RHEL / CentOS 8.0-8.5+

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

Web server

  • Nginx 1.18-1.25+
  • Apache 2.4 (with required modules mod_rewrite, mod_env and recommended: mod_setenvif, mod_expires; event MPM is recommended, if you need to use prefork you also need the mod_php module)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • Nginx 1.18
  • Apache 2.4 (with required modules mod_rewrite, mod_env and recommended: mod_setenvif, mod_expires; event MPM is recommended, if you need to use prefork you also need the mod_php module)
  • Nginx 1.12, 1.14, 1.16
  • Apache 2.4 (with required modules mod_rewrite, mod_env and recommended: mod_setenvif, mod_expires; event MPM is recommended, if you need to use prefork you also need the mod_php module)

DBMS

  • MariaDB 10.3-10.11+
  • MySQL 8.0
  • PostgreSQL 14

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • MariaDB 10.3, 10.4 (optionally 10.2 - deprecated)
  • MySQL 8.0 (optionally 5.7 - deprecated)
  • PostgreSQL 10+ (PostgreSQL 10 has reached its End of Life. We highly recommend using PostgreSQL 14 for optimal performance and security)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • MariaDB 10.3, 10.4 (optionally 10.2 - deprecated)
  • MySQL 8.0 (optionally 5.7 - deprecated)
  • PostgreSQL 10+ (PostgreSQL 10 has reached its End of Life. We highly recommend using PostgreSQL 14 for optimal performance and security)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

PHP

  • 8.3
  • 8.2
  • 8.1
  • 8.0 (PHP 8.0 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
  • 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
  • 8.2 (see note below)
  • 8.1
  • 8.0 (PHP 8.0 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
  • 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
  • 7.3 (PHP 7.3 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)

Quiet PHP 8.2 deprecation notices from 3rd parties

To avoid PHP 8.2 deprecation notices appearing in outputs (and, for example, breaking REST answers), add the following to your composer.json after installation:

1
2
3
"runtime": {
    "error_handler": "\\Ibexa\\Contracts\\Core\\MVC\\Symfony\\ErrorHandler\\Php82HideDeprecationsErrorHandler"
}

Then run the following command:

1
composer dump-autoload
  • 7.1 (PHP 7.1 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to Ibexa DXP v3.3 or v4.x)
  • 7.2 (PHP 7.2 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to Ibexa DXP v3.3 or v4.x)
  • 7.3 (PHP 7.3 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to Ibexa DXP v3.3 or v4.x)
  • 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to Ibexa DXP v3.3 or v4.x)

PHP extensions

  • php-cli
  • php-fpm
  • php-mysql (php-mysqlnd) or php-pgsql
  • php-xml
  • php-mbstring
  • php-json
  • php-process (on RHEL/CentOS)
  • php-intl
  • php-curl
  • php-pear (optional, provides pecl)
  • php-gd or php-imagick (via pecl on RHEL/CentOS)
  • php-sodium
  • php-bcmath
  • php-cli
  • php-fpm
  • php-mysql (php-mysqlnd) or php-pgsql
  • php-xml
  • php-mbstring
  • php-json
  • php-process (on RHEL/CentOS)
  • php-intl
  • php-curl
  • php-pear (optional, provides pecl)
  • php-gd or php-imagick (via pecl on RHEL/CentOS)
  • php-sodium
  • php-cli
  • php-fpm
  • php-mysql (php-mysqlnd) or php-pgsql
  • php-xml
  • php-mbstring
  • php-json
  • php-process (on RHEL/CentOS)
  • php-intl
  • php-curl
  • php-pear (optional, provides pecl)
  • php-gd or php-imagick (via pecl on RHEL/CentOS)

Cluster PHP extensions

  • php-redis or php-memcached
  • php-redis or php-memcached
  • php-redis 3.1.3+ or php-memcached 3.x+*

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher. Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
  • The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions are not supported.
  • For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher. Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
  • For BinaryFile Field indexing, Apache Tika 1.20 or higher 1.x version, recommended 1.28.1 or higher.
  • The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions are not supported.
  • For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher. Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
  • For BinaryFile Field indexing, Apache Tika 1.20 or higher 1.x version, recommended 1.28.1 or higher.
  • The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions are not supported.

Graphic Handler

  • GraphicsMagick
  • ImageMagick
  • GD

Optionally if you intend to edit PNG, SVG, GIF or WEBP files in the Image Editor, or use it with image variations:

  • JpegOptim
  • Optipng
  • Pngquant 2
  • SVGO 1
  • Gifsicle
  • cwebp
  • GraphicsMagick
  • ImageMagick
  • GD

Optionally if you intend to edit PNG, SVG, GIF or WEBP files in the Image Editor, or use it with image variations:

  • JpegOptim
  • Optipng
  • Pngquant 2
  • SVGO 1
  • Gifsicle
  • cwebp
  • GraphicsMagick
  • ImageMagick
  • GD

Clustering

  • Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
  • Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a volatile-* eviction policy, session instance configured for persistence) or Memcached 1.5 or higher
  • Varnish 6.0LTS or 7.1 with varnish-modules or Fastly using the provided bundle (for HTTP Cache)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
  • Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a volatile-* eviction policy, session instance configured for persistence) or Memcached 1.5 or higher
  • Varnish 6.0LTS with varnish-modules or Fastly using the provided bundle (for HTTP Cache)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
  • Redis 3.2+ (separate instances for session and cache, both using a volatile-* eviction policy, session instance configured for persistence) or Memcached 1.5 or higher
  • Varnish 5.1 or 6.0LTS with varnish-modules or Fastly using the provided bundle (for HTTP Cache)

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

Filesystem

  • Linux ext4 / XFS
  • Linux ext4 / XFS
  • Linux ext4 / XFS

Package manager

  • Composer: recent 2.7 version
  • Composer: recent 2.1 version
  • Composer: recent 2.1 version

Asset manager

  • Node.js 18+
  • yarn 1.15.2+

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • Node.js 14+, 16+, 18+ (Node.js 14+ has reached its End of Life. We strongly recommend using a newer version to ensure you receive security updates.)
  • yarn 1.15.2+

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

  • Node.js 10, 12 or 14
  • yarn 1.15.2+

If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.

Browser

Ibexa DXP is developed to work with any web browser that supports modern standards, on any screen resolution suitable for web, running on any device. However for the Editorial and Administration User Interfaces you'll need; a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.

  • Mozilla® Firefox® most recent stable version (recommended)
  • Google Chrome™ most recent stable version (recommended)
  • Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop and tablet
  • Apple® Safari® most recent stable version, desktop and tablet

Ibexa DXP is developed to work with any web browser that supports modern standards, on any screen resolution suitable for web, running on any device. However for the Editorial and Administration User Interfaces you'll need; a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.

  • Mozilla® Firefox® most recent stable version (recommended)
  • Google Chrome™ most recent stable version (recommended)
  • Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop and tablet
  • Apple® Safari® most recent stable version, desktop and tablet

eZ Platform is developed to work with any web browser that supports modern standards, on any screen resolution suitable for web, running on any device. However for the Editorial and Administration User Interfaces you'll need; a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.

  • Mozilla® Firefox® most recent stable version (recommended)
  • Google Chrome™ most recent stable version (recommended)
  • Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop and tablet
  • Apple® Safari® most recent stable version, desktop and tablet

Ibexa Cloud requirements and setup

Cloud hosting with Ibexa Cloud and Platform.sh

In general, Ibexa Cloud supports all features and services of Platform.sh that are compatible and supported by the Ibexa DXP version you use.

For example:

  • Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. Ibexa DXP supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on Ibexa Cloud in versions 4.0 and 5.0, but 5.0 is recommended.

Features or services supported by Ibexa DXP but not covered by Platform.sh may be possible by means of a custom integration.

Ibexa Cloud Setup support matrix

All Ibexa DXP features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on Ibexa Cloud either.

Note

As Platform.sh does not support a configuration with multiple PostgreSQL databases, for Ibexa Cloud / Platform.sh it is impossible to have a DFS table in a separate database.

For more details on recommended setup configuration see bundled .platform.app.yaml and .platform/ configuration files.

These files are kept up-to-date with latest recommendations and can be improved through contributions.

Supported Ibexa Cloud setup

Because of the large range of possible configurations of Ibexa DXP, there are many possibilities beyond what is provided in the default recommended configuration.

Make sure to set aside time and budget for:

  • Verifying your requirements and ensuring they are supported by Platform.sh
  • Additional time for adaptation and configuration work, and testing by your development team
  • Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with Ibexa DXP

The cost and effort of this is not included in Ibexa Cloud subscription and will vary depending on the project.

Custom integrations

Features supported by Ibexa DXP, but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services.

For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of Ibexa DXP. We recommend giving the development team working on the project access to the bucket to ensure work is done in a DevOps way without depending on external teams when changes are needed.

Cloud hosting with Ibexa Cloud and Platform.sh

In general, Ibexa Cloud supports all features and services of Platform.sh that are compatible and supported by the Ibexa DXP version you use.

For example:

  • Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. Ibexa DXP supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on Ibexa Cloud in versions 4.0 and 5.0, but 5.0 is recommended.

Features or services supported by Ibexa DXP but not covered by Platform.sh may be possible by means of a custom integration.

Ibexa Cloud Setup support matrix

All Ibexa DXP features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on Ibexa Cloud either.

Note

As Platform.sh does not support a configuration with multiple PostgreSQL databases, for Ibexa Cloud / Platform.sh it is impossible to have a DFS table in a separate database.

For more details on recommended setup configuration see bundled .platform.app.yaml and .platform/ configuration files.

These files are kept up-to-date with latest recommendations and can be improved through contributions.

Supported Ibexa Cloud setup

Because of the large range of possible configurations of Ibexa DXP, there are many possibilities beyond what is provided in the default recommended configuration.

Make sure to set aside time and budget for:

  • Verifying your requirements and ensuring they are supported by Platform.sh
  • Additional time for adaptation and configuration work, and testing by your development team
  • Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with Ibexa DXP

The cost and effort of this is not included in Ibexa Cloud subscription and will vary depending on the project.

Custom integrations

Features supported by Ibexa DXP, but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services.

For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of Ibexa DXP. We recommend giving the development team working on the project access to the bucket to ensure work is done in a DevOps way without depending on external teams when changes are needed.

Cloud hosting with eZ Platform Cloud and Platform.sh

In general, eZ Platform Cloud supports all features and services of Platform.sh that are compatible and supported by the eZ Platform version you use.

For example:

  • Platform.sh provides Redis support for versions 2.8, 3.0 and 3.2. eZ Platform supports Redis version 3.2 or higher. As a result, Redis is supported by eZ Platform Cloud versions 3.2.
  • Platform.sh provides Elastic Search service (different versions supported). Elastic Search is not supported for use as search engine for eZ Platform.

Features or services supported by eZ Platform but not covered by Platform.sh may be possible by means of a custom integration.

For more details on recommended setup configuration see bundled .platform.app.yaml and .platform/ configuration files.

These files are kept up-to-date with latest recommendations and can be improved through contributions.

Supported eZ Platform Cloud setup

Because of the large range of possible configurations of eZ Publish legacy, there is no ready-made recommended setup. Make sure to set aside time and budget for:

  • Verifying your legacy configuration and ensuring it is supported by Platform.sh
  • Additional time for adaptation and configuration work, and testing by your own team
  • Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with eZ Publish legacy

The cost and effort of this is not included in eZ Platform Cloud subscription and will vary depending on the project.

Experimental/custom Platform.sh setups

Any use of experimental versions or setups is not eligible for use with eZ Platform Cloud. However, it is possible to use an eZ Enterprise subscription in combination with a Platform.sh contract, where you or a partner take ownership of the configuration to set up the project.

Such projects are possible by means of custom integrations/configuration, but they may generate issues that won't be covered by eZ Enterprise subscription bug fix guarantee.

Use a partner with prior experience on legacy and Platform.sh

If you are in need of setting up your legacy project on Platform.sh for a transitional period, eZ can put you in contact with a partner experienced in setting up older projects on Platform.sh. This will save you a lot of time and effort.

Note

As Platform.sh does not support a configuration with multiple PostgreSQL databases, for eZ Platform Cloud / Platform.sh it is impossible to have a DFS table in a separate database.

Custom integrations

Features supported by eZ Platform, but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services.

For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of eZ Platform. We recommend giving the development team working on the project access to the bucket to ensure work is done in a DevOps way without depending on external teams when changes are needed.