ÃÛ¶¹ÊÓƵ

DocumentationCommerceInstallation Guide

System requirements

Last update: Wed Apr 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin
  • Developer

The following summarizes software dependencies and services tested for ÃÛ¶¹ÊÓƵ Commerce.

There are some differences in the dependencies for Commerce on Cloud infrastructure. Service version and compatibility support for ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure is determined by services tested and deployed to the hosted cloud environments, and sometimes differ from versions supported by ÃÛ¶¹ÊÓƵ Commerce on-premises deployments. For example, Elasticsearch 7.17 is supported for Commerce 2.4.4 for on-premise deployments, but OpenSearch 1.2 is supported for Commerce 2.4.4 on Cloud infrastructure.

The following tables show versions of third-party software dependencies that ÃÛ¶¹ÊÓƵ has tested with specific ÃÛ¶¹ÊÓƵ Commerce releases.

ÃÛ¶¹ÊÓƵ only supports the combination of system requirements described in the following tables. For example, 2.4.5 is fully tested with MariaDB 10.4. ÃÛ¶¹ÊÓƵ recommends that you upgrade to MariaDB 10.4 before upgrading to 2.4.5.

Commerce on Cloud

The provides a default configuration for services compatible with a specific Commerce version.

table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 6-row-5 7-row-5 layout-auto
Software dependencies 2.4.7-p3 2.4.7-p2 2.4.7-p1 2.4.7
Composer 2.7 2.7 2.7 2.7
Elasticsearch -- -- -- --
OpenSearch 2.12 2.12 2.12 2.12
MariaDB 10.6 10.6 10.6 10.6
PHP 8.3, 8.2 8.3, 8.2 8.3, 8.2 8.3, 8.2
RabbitMQ 3.13 3.13 3.12 3.12
Redis 7.2 7.2 7.2 7.2
table 0-row-10 1-row-10 2-row-10 3-row-10 4-row-10 5-row-10 6-row-10 7-row-10 layout-auto
Software dependencies 2.4.6-p8 2.4.6-p7 2.4.6-p6 2.4.6-p5 2.4.6-p4 2.4.6-p3 2.4.6-p2 2.4.6-p1 2.4.6
Composer 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2
Elasticsearch -- -- -- -- -- -- -- -- --
OpenSearch 2.12 2.12 2.12 2.12 2.5 2.5 2.5 2.5 2.5
MariaDB 10.6 10.6 10.6 10.6 10.6 10.6 10.6 10.6 10.6
PHP 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1
RabbitMQ 3.13 3.13 3.12 3.12, 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9
Redis 7.2 7.0 7.0 7.0 7.0 7.0 7.0 7.0 7.0
table 0-row-12 1-row-12 2-row-12 3-row-12 4-row-12 5-row-12 6-row-12 7-row-12 layout-auto
Software dependencies 2.4.5-p10 2.4.5-p9 2.4.5-p8 2.4.5-p7 2.4.5-p6 2.4.5-p5 2.4.5-p4 2.4.5-p3 2.4.5-p2 2.4.5-p1 2.4.5
Composer 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2
Elasticsearch -- -- -- -- -- -- -- -- -- -- --
OpenSearch 1.3 1.3 1.3 1.3 1.2 1.2 1.2 1.2 1.2 1.2 1.2
MariaDB 10.5 10.5 10.5, 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4
PHP 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1
RabbitMQ 3.13 3.13 3.12, 3.11 3.12, 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.9 3.9 3.9
Redis 7.2 7.0 7.0 7.0 6.2 6.2 6.2 6.2 6.2 6.2 6.2
table 0-row-13 1-row-13 2-row-13 3-row-13 4-row-13 5-row-13 6-row-13 7-row-13 layout-auto
Software dependencies 2.4.4-p11 2.4.4-p10 2.4.4-p9 2.4.4-p8 2.4.4-p7 2.4.4-p6 2.4.4-p5 2.4.4-p4 2.4.4-p3 2.4.4-p2 2.4.4-p1 2.4.4
Composer 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.1 2.1 2.1
Elasticsearch -- -- -- -- -- -- -- -- -- -- -- --
OpenSearch 1.3 1.3 1.3 1.3 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2
MariaDB 10.5 10.5 10.5, 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4
PHP 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1
RabbitMQ 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9
Redis 7.2 7.0 7.0 7.0 6.2 6.2 6.2 6.2 6.2 6.2 6.2 6.2
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto
Software dependencies 2.4.3-p3
Composer 1
Elasticsearch --
OpenSearch 1.2
MariaDB 10.4
PHP 7.4
RabbitMQ 3.8
Redis 6.0
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto
Software dependencies 2.4.2-p2
Composer 1
Elasticsearch 7.9
OpenSearch --
MariaDB 10.4
PHP 7.4
RabbitMQ 3.8
Redis 6.0

The services and versions are defined in . The following is the default service configuration for Commerce 2.4.6 on Cloud infrastructure:

code language-yaml 
mysql:
    type: mysql:10.6
    disk: 5120

redis:
    type: redis:7.0

opensearch:
    type: opensearch:2
    disk: 1024

See Configure services in the Commerce on Cloud Infrastructure guide.

Commerce on-premises
note note
NOTE
Versions 2.4.4 and 2.4.5 support MySQL 8.0.0 through 8.0.28 only.
table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 6-row-5 7-row-5 8-row-5 9-row-5 10-row-5 11-row-5 12-row-5 13-row-5 14-row-5 15-row-5 16-row-5 17-row-5 layout-auto
Software dependencies 2.4.7-p3 2.4.7-p2 2.4.7-p1 2.4.7
Composer 2.7 2.7 2.7 2.7
Elasticsearch 8.11 8.11 8.11 8.11
OpenSearch 2.12 2.12 2.12 2.12
MariaDB 10.6 10.6 10.6 10.6
MySQL 8.0 8.0 8.0 8.0
PHP 8.3, 8.2 8.3, 8.2 8.3, 8.2 8.3, 8.2
RabbitMQ 3.13 3.13 3.13 3.13
Redis 7.2 7.2 7.2 7.2
Varnish 7.5 7.5 7.5 7.5
Apache 2.4 2.4 2.4 2.4
nginx 1.24 1.24 1.24 1.24
AWS Aurora (MySQL) 8.0 8.0 8.0 8.0
AWS S3 âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸
AWS MQ 3.11.20 3.11.20 3.11.20 3.11.20
AWS ElastiCache Redis 7.0 Redis 7.0 Redis 7.0 Redis 7.0
AWS Elasticsearch -- -- -- --
AWS OpenSearch 2.11 2.11 2.11 2.11
table 0-row-10 1-row-10 2-row-10 3-row-10 4-row-10 5-row-10 6-row-10 7-row-10 8-row-10 9-row-10 10-row-10 11-row-10 12-row-10 13-row-10 14-row-10 15-row-10 16-row-10 17-row-10 layout-auto
Software dependencies 2.4.6-p8 2.4.6-p7 2.4.6-p6 2.4.6-p5 2.4.6-p4 2.4.6-p3 2.4.6-p2 2.4.6-p1 2.4.6
Composer 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2
Elasticsearch 8.11, 7.17 8.11, 7.17 8.11, 7.17 8.11, 7.17 8.11, 7.17 8.5, 7.17 8.5, 7.17 8.5, 7.17 8.4, 7.17
OpenSearch 2.12 2.12 2.12 2.12 2.5 2.5 2.5 2.5 2.5
MariaDB 10.6 10.6 10.6 10.6 10.6 10.6 10.6 10.6 10.6
MySQL 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0
PHP 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1 8.2, 8.1
RabbitMQ 3.13 3.13 3.12 3.12, 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9
Redis 7.2, 7.0 7.0 7.0 7.0 7.0 7.0 7.0 7.0 7.0
Varnish 7.5 7.5 7.5 7.5 7.3 7.3 7.3 7.3 7.1
Apache 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4
nginx 1.24 1.24 1.24 1.24 1.24 1.24 1.22 1.22 1.22
AWS Aurora (MySQL) 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0
AWS S3 âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸
AWS MQ 3.9.16 3.9.16 3.9.16 3.9.16 3.9.16 3.9.16 3.9.16 3.9.16 3.9.16
AWS ElastiCache Redis 6.2 Redis 6.2 Redis 6.2 Redis 6.2 Redis 6.2 Redis 6.2 Redis 6.2 Redis 6.2 Redis 6.2
AWS Elasticsearch -- -- -- -- -- -- -- -- --
AWS OpenSearch 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2
table 0-row-12 1-row-12 2-row-12 3-row-12 4-row-12 5-row-12 6-row-12 7-row-12 8-row-12 9-row-12 10-row-12 11-row-12 12-row-12 13-row-12 14-row-12 15-row-12 16-row-12 17-row-12 layout-auto
Software dependencies 2.4.5-p10 2.4.5-p9 2.4.5-p8 2.4.5-p7 2.4.5-p6 2.4.5-p5 2.4.5-p4 2.4.5-p3 2.4.5-p2 2.4.5-p1 2.4.5
Composer 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2
Elasticsearch 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.17
OpenSearch 1.3 1.3 1.3 1.3 1.2 1.2 1.2 1.2 1.2 1.2 1.2
MariaDB 10.5, 10.4 10.5, 10.4 10.5, 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4
MySQL 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0
PHP 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1
RabbitMQ 3.13 3.13 3.12, 3.11 3.12, 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.11, 3.9 3.9 3.9 3.9
Redis 7.2, 7.0 7.0 7.0 7.0 6.2 6.2 6.2 6.2 6.2 6.2 6.2
Varnish 7.5 7.5 7.5 7.5 7.3 7.3 7.3 7.3 7.1 7.0 7.0
Apache 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4
nginx 1.24 1.24 1.24 1.24 1.24 1.24 1.22 1.22 1.22 1.22 1.22
AWS Aurora (MySQL) 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0
AWS S3 âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸
AWS MQ 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13
AWS ElastiCache Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6
AWS Elasticsearch -- -- -- -- -- -- -- -- -- 7.9 7.9
AWS OpenSearch 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2
table 0-row-13 1-row-13 2-row-13 3-row-13 4-row-13 5-row-13 6-row-13 7-row-13 8-row-13 9-row-13 10-row-13 11-row-13 12-row-13 13-row-13 14-row-13 15-row-13 16-row-13 17-row-13 layout-auto
Software dependencies 2.4.4-p11 2.4.4-p10 2.4.4-p9 2.4.4-p8 2.4.4-p7 2.4.4-p6 2.4.4-p5 2.4.4-p4 2.4.4-p3 2.4.4-p2 2.4.4-p1 2.4.4
Composer 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.2 2.1 2.1 2.1
Elasticsearch 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.17 7.16 7.16 7.16
OpenSearch 1.3 1.3 1.3 1.3 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2
MariaDB 10.5, 10.4 10.5, 10.4 10.5, 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4 10.4
MySQL 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0
PHP 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1 8.1
RabbitMQ 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9 3.9
Redis 7.2, 7.0 7.0 7.0 7.0 6.2 6.2 6.2 6.2 6.2 6.2 6.2 6.2
Varnish 7.5 7.5 7.5 7.5 7.3 7.3 7.3 7.3 7.1 7.0 7.0 7.0
Apache 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4 2.4
nginx 1.24 1.24 1.24 1.24 1.24 1.24 1.22 1.22 1.22 1.22 1.22 1.22
AWS Aurora (MySQL) 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 8.0 5.7 5.7 5.7
AWS S3 âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸ âœ”ï¸
AWS MQ 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.9.13 3.8.11 3.8.11 3.8.11
AWS ElastiCache Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6 Redis 6
AWS Elasticsearch -- -- -- -- -- -- -- -- -- 7.9 7.9 7.9
AWS OpenSearch 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2 1.2 -- -- --
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 layout-auto
Software dependencies 2.4.3-p3
Composer 1
Elasticsearch 7.16
OpenSearch 1.2
MariaDB 10.4
MySQL 8.0
PHP 7.4
RabbitMQ 3.8
Redis 6.0
Varnish 6.5
Apache 2.4
nginx 1.18
AWS Aurora (MySQL) 5.7
AWS S3 ✔ï¸
AWS MQ 3.8.11
AWS ElastiCache Redis 6
AWS Elasticsearch 7.9
AWS OpenSearch --
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 layout-auto
Software dependencies 2.4.2-p2
Composer 1
Elasticsearch 7.9
OpenSearch --
MariaDB 10.4
MySQL 8.0
PHP 7.4
RabbitMQ 3.8
Redis 6.0
Varnish 6.4
Apache 2.4
nginx 1.18
AWS Aurora (MySQL) --
AWS S3 ✔ï¸
AWS MQ --
AWS ElastiCache --
AWS Elasticsearch --
AWS OpenSearch --

PHP settings

There are particular PHP configuration settings, such as the memory_limit setting, which can help you to avoid common problems when using ÃÛ¶¹ÊÓƵ Commerce. See Required PHP settings.

For Cloud configuration guidance, see PHP settings in the Commerce on Cloud Infrastructure guide.

PHP OPcache

It is recommended that you verify that is enabled for performance reasons. The OPcache is enabled in many PHP distributions. The opcache extension is installed by default in the Commerce on Cloud infrastructure.

For on-premesis, verify that PHP OPcache it is installed, see PHP settings. Or for specific guidance on performance settings, see the software recommendations for PHP settings in the Performance Best Practices guide.

If you must install OPcache separately, see the .

PHP Process Control

Before you can run indexers in parallel mode, you must enable Process Control support (pcntl) in PHP. See in the PHP documentation.

PHPUnit

PHPUnit v9 (as a command-line tool).

PHP extensions

The PHP installation instructions include a step for installing these extensions.

TIP
For PHP extensions in the Cloud infrastructure, see Enable PHP extensions in the Commerce on Cloud Infrastructure guide.
Commerce on Cloud

The following table shows the supported PHP extensions when deploying ÃÛ¶¹ÊÓƵ Commerce on the Cloud platform.

table 0-row-3 1-row-3 layout-auto
Default extensions Installed extensions that cannot be uninstalled Extensions that can be installed and uninstalled as needed
bcmath
bz2
calendar
exif
gd
gettext
intl
libxml
mysqli
opcache
pcntl
pdo_mysql
Reflection
soap
sockets
SPL
standard
swoole
sysvmsg
sysvsem
sysvshm
zip
zlib		 ctype
curl
date
dba
dom
fileinfo
filter
ftp
hash
iconv
json
mbstring
mysqlnd
openssl
pcre
pdo
pdo_sqlite
phar
posix
readline
session
sqlite3
tokenizer
xml
xmlreader
xmlwriter		 geoip
gmp
igbinary
imagick
imap
ldap
mailparse
mcrypt
msgpack
mysqli
oauth
pdo_mysql
propro
pspell
raphf
recode
redis
shmop sockets
sodium
ssh2
tidy
xdebug
xmlrpc
xsl
yaml
Commerce on-premises

ÃÛ¶¹ÊÓƵ Commerce requires:

  • ext-bcmath
  • ext-ctype
  • ext-curl
  • ext-dom
  • ext-fileinfo
  • ext-filter
  • ext-gd
  • ext-hash
  • ext-iconv
  • ext-intl
  • ext-json
  • ext-libxml
  • ext-mbstring
  • ext-openssl
  • ext-pcre
  • ext-pdo_mysql
  • ext-simplexml
  • ext-soap
  • ext-sockets
  • ext-sodium
  • ext-spl
  • ext-tokenizer
  • ext-xmlwriter
  • ext-xsl
  • ext-zip
  • ext-zlib
  • lib-libxml

Magento Open Source requires:

  • ext-bcmath
  • ext-ctype
  • ext-curl
  • ext-dom
  • ext-fileinfo
  • ext-filter
  • ext-gd
  • ext-hash
  • ext-iconv
  • ext-intl
  • ext-json
  • ext-libxml
  • ext-mbstring
  • ext-openssl
  • ext-pcre
  • ext-pdo_mysql
  • ext-simplexml
  • ext-soap
  • ext-sockets
  • ext-sodium
  • ext-tokenizer
  • ext-xmlwriter
  • ext-xsl
  • ext-zip
  • ext-zlib
  • lib-libxml

Refer to for installation details.

Miscellaneous

This section describes support and compatibility for all other types of required and optional software.

NOTE
The following requirements apply to the latest 2.4.x patch release of ÃÛ¶¹ÊÓƵ Commerce. When relevant, Commerce on Cloud infrastructure guidance is provided.

Browsers

Storefront and Admin:

  • Microsoft Edge (latest and previous major version)
  • Firefox (latest and previous major version; any operating system)
  • Chrome (latest and previous major version; any operating system)
  • Safari (latest and previous major version; macOS only)
  • Safari for iOS (latest and previous major version, for storefront)
  • Chrome for Android (latest and previous major version, for storefront)

Mail server

Mail Transfer Agent (MTA) or an SMTP server. Commerce on Cloud infrastructure uses the SendGrid email service.

Memory

Upgrading the applications and extensions you obtain from the Commerce Marketplace and other sources can require up to 2 GB of RAM. If you are using a system with less than 2 GB of RAM, create a ; otherwise, your upgrade might fail.

Operating systems (Linux x86-64)

Linux distributions, such as RedHat Enterprise Linux (RHEL), CentOS, Ubuntu, Debian, and similar. Microsoft Windows and macOS are not supported.

ÃÛ¶¹ÊÓƵ Commerce requires the following system tools for some operations:

SSL

  • A valid security certificate is required for HTTPS.
  • Self-signed SSL certificates are not supported.
  • Transport Layer Security (TLS) requirement - PayPal and repo.magento.com both require TLS 1.2 or later.

For Commerce on Cloud infrastructure, see Fastly configuration in the Commerce on Cloud Infrastructure guide.

Xdebug

For ÃÛ¶¹ÊÓƵ Commerce, use or later (development environments only; can have an adverse effect on performance).

For ÃÛ¶¹ÊÓƵ Commerce on Cloud, see Configure Xdebug in the Commerce on Cloud Infrastructure guide.

NOTE
There is a known issue with xdebug that can affect ÃÛ¶¹ÊÓƵ Commerce installations or access to the storefront or Admin after installation. See Known issue that affects xdebug installation in the Commerce Support Knowledge Base.
recommendation-more-help
0f8e7db5-0e9c-4002-a5b8-a0088077d995