- Overview
- System requirements
- Prerequisites
- Quick start installation
- Advanced installation
- Post-installation steps
- Tutorials
- Backup and rollback the file system, media, and database
- Check the database status
- Configure message consumer behavior
- Configure the lock provider
- Configure the store
- Create, edit, or unlock admin accounts
- Create or update the deployment configuration
- Create the database schema
- Display or change the Admin URI
- Enable or disable maintenance mode
- Enable or disable modules
- Install an extension
- Install Commerce
- Modify docroot to improve security
- Uninstall language packages
- Uninstall modules
- Uninstall or reinstall Commerce
- Uninstall themes
- Upgrade the database schema
- Return to Operational Guides
System requirements
The following summarizes software dependencies and services tested for Adobe Commerce and Magento Open Source.
There are some differences in the dependencies for Commerce on Cloud infrastructure. Service version and compatibility support for Adobe Commerce on cloud infrastructure is determined by services tested and deployed to the hosted cloud environments, and sometimes differ from versions supported by Adobe 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 Adobe has tested with specific Adobe Commerce and Magento Open Source releases.
Adobe only supports the combination of system requirements described in the following tables. For example, 2.4.5 is fully tested with MariaDB 10.4. Adobe recommends that you upgrade to MariaDB 10.4 before upgrading to 2.4.5.
The Commerce on Cloud template provides a default configuration for services compatible with a specific Commerce version.
| Software dependencies | 2.4.7-beta1 | 2.4.6-p2 | 2.4.6-p1 | 2.4.6 | 2.4.5-p4 | 2.4.5-p3 | 2.4.5-p2 | 2.4.5-p1 | 2.4.5 | 2.4.4-p5 | 2.4.4-p4 | 2.4.4-p3 | 2.4.4-p2 | 2.4.4-p1 | 2.4.4 | 2.4.3-p3 | 2.4.3-p2 | 2.4.3 | 2.4.2 | 2.4.1 | 2.4.0 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Composer | 2.5 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.1 | 2.1 | 2.1 | 1 | 1 | 1 | 1 | 1 | 1 |
| Elasticsearch | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | -- | 7.10 | 7.9 | 7.7 | 7.6, 7.7 |
| OpenSearch | 2.5 | 2.5 | 2.5 | 2.5 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | -- | -- | -- | -- |
| MariaDB | 10.6 | 10.6 | 10.6 | 10.6 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.2, 10.3, 10.4 |
| PHP | 8.2, 8.1 | 8.2, 8.1 | 8.2, 8.1 | 8.2, 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 7.4 | 7.4 | 7.4 | 7.4 | 7.4 | 7.3, 7.4 |
| RabbitMQ | 3.11 | 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 | 3.9 | 3.9 | 3.9 | 3.9 | 3.9 | 3.9 | 3.8 | 3.8 | 3.8 | 3.8 | 3.8 | 3.8 |
| Redis | 7.0 | 7.0 | 7.0 | 7.0 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.0 | 6.0 | 6.0 | 6.0 | 5.0 | 5.0 |
The services and versions are defined in the services.yaml file. The following is the default service configuration for Commerce 2.4.6 on Cloud infrastructure:
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.
Versions 2.4.4 and 2.4.5 support MySQL 8.0.0 through 8.0.28 only.
| Software dependencies | 2.4.7-beta1 | 2.4.6-p2 | 2.4.6-p1 | 2.4.6 | 2.4.5-p4 | 2.4.5-p3 | 2.4.5-p2 | 2.4.5-p1 | 2.4.5 | 2.4.4-p5 | 2.4.4-p4 | 2.4.4-p3 | 2.4.4-p2 | 2.4.4-p1 | 2.4.4 | 2.4.3-p3 | 2.4.3-p2 | 2.4.3 | 2.4.2 | 2.4.1 | 2.4.0 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Composer | 2.5 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.2 | 2.1 | 2.1 | 2.1 | 1 | 1 | 1 | 1 | 1 | 1 |
| Elasticsearch | 8.5 | 8.5, 7.17 | 8.5, 7.17 | 8.4, 7.17 | 7.17 | 7.17 | 7.17 | 7.17 | 7.17 | 7.17 | 7.17 | 7.17 | 7.16 | 7.16 | 7.16 | 7.16 | 7.16 | 7.10 | 7.9 | 7.7 | 7.6 |
| OpenSearch | 2.5 | 2.5 | 2.5 | 2.5 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | -- | -- | -- | -- |
| MariaDB | 10.6 | 10.6 | 10.6 | 10.6 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.4 | 10.2, 10.3, 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 | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | 8.0 | 5.7, 8.0 |
| PHP | 8.2, 8.1 | 8.2, 8.1 | 8.2, 8.1 | 8.2, 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 8.1 | 7.4 | 7.4 | 7.4 | 7.4 | 7.4 | 7.3, 7.4 |
| RabbitMQ | 3.11 | 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 | 3.9 | 3.9 | 3.9 | 3.9 | 3.9 | 3.9 | 3.8 | 3.8 | 3.8 | 3.8 | 3.8 | 3.8 |
| Redis | 7.0 | 7.0 | 7.0 | 7.0 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.2 | 6.0 | 6.0 | 6.0 | 6.0 | 5.0 | 5.0 |
| Varnish | 7.3 | 7.3 | 7.3 | 7.1 | 7.3 | 7.3 | 7.1 | 7.0 | 7.0 | 7.3 | 7.3 | 7.1 | 7.0 | 7.0 | 7.0 | 6.5 | 6.5 | 6.5 | 6.4 | 6.2 | 6 |
| 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 | 2.4 | 2.4 | 2.4 | 2.4 | 2.4 | 2.4 | 2.4 | 2.4 | 2.4 |
| nginx | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.22 | 1.18 | 1.18 | 1.18 | 1.18 | 1.18 | 1.18 |
| 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 | 8.0 | 5.7 | 5.7 | 5.7 | 5.7 | 5.7 | 5.7 | -- | -- | -- |
| AWS S3 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | -- | -- |
| AWS MQ | 3.10.10 | 3.9.16 | 3.9.16 | 3.9.16 | 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 | 3.8.11 | 3.8.11 | 3.8.11 | -- | -- | -- |
| AWS ElastiCache | Redis 7.0 | Redis 6.2 | Redis 6.2 | Redis 6.2 | Redis 6 | Redis 6 | 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 | 7.9 | 7.9 | 7.9 | 7.9 | 7.9 | -- | -- | -- |
| AWS OpenSearch | 2.3 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | -- | -- | -- | -- | -- | -- | -- | -- | -- |
PHP settings
There are particular PHP configuration settings, such as the memory_limit setting, which can help you to avoid common problems when using Adobe Commerce and Magento Open Source. 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 PHP OPcache 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 OPcache documentation.
PHPUnit
PHPUnit (as a command-line tool) 9.0.0
PHP extensions
The PHP installation instructions include a step for installing these extensions.
For PHP extensions in the Cloud infrastructure, see Enable PHP extensions in the Commerce on Cloud Infrastructure guide.
The following table shows the supported PHP extensions when deploying Adobe Commerce on the Cloud platform.
| Default extensions | Installed extensions that cannot be uninstalled | Extensions that can be installed and uninstalled as needed |
|---|---|---|
|
bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip |
ctype curl date 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 ioncube ldap mailparse mcrypt msgpack mysqli oauth pdo_mysql propro pspell raphf recode redis shmop sockets sodium ssh2 tidy xdebug xmlrpc xsl yaml |
Adobe Commerce requires:
ext-bcmathext-ctypeext-curlext-domext-fileinfoext-filterext-gdext-hashext-iconvext-intlext-jsonext-libxmlext-mbstringext-opensslext-pcreext-pdo_mysqlext-simplexmlext-soapext-socketsext-sodiumext-splext-tokenizerext-xmlwriterext-xslext-zipext-zliblib-libxml
B2B for Adobe Commerce requires:
ext-bcmathext-ctypeext-curlext-domext-fileinfoext-filterext-gdext-hashext-iconvext-intlext-jsonext-libxmlext-mbstringext-opensslext-pcreext-pdo_mysqlext-simplexmlext-soapext-socketsext-sodiumext-splext-tokenizerext-xmlwriterext-xslext-zipext-zliblib-libxml
Magento Open Source requires:
ext-bcmathext-ctypeext-curlext-domext-fileinfoext-filterext-gdext-hashext-iconvext-intlext-jsonext-libxmlext-mbstringext-opensslext-pcreext-pdo_mysqlext-simplexmlext-soapext-socketsext-sodiumext-tokenizerext-xmlwriterext-xslext-zipext-zliblib-libxml
Refer to official PHP documentation for installation details.
Miscellaneous
This section describes support and compatibility for all other types of required and optional software.
The following requirements apply to the latest 2.4.x patch release of Adobe Commerce and Magento Open Source. 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 Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 12 or later), for desktop storefront
- Safari Mobile for iPhone 6 or later; iOS 12 or later, for mobile storefront
- Chrome for mobile (latest and previous major version [Android™ 4 or later] for mobile 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 swap file; 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.
Adobe Commerce and Magento Open Source require 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.comboth require TLS 1.2 or later.
For Commerce on Cloud infrastructure, see Fastly configuration in the Commerce on Cloud Infrastructure guide.
Xdebug
For Adobe Commerce and Magento Open Source, use php_xdebug 2.5.x or later (development environments only; can have an adverse effect on performance).
For Adobe Commerce on Cloud, see Configure Xdebug in the Commerce on Cloud Infrastructure guide.
There is a known issue with xdebug that can affect Adobe Commerce or Magento Open Source installations or access to the storefront or Admin after installation. See Known issue that affects xdebug installation in the Commerce Support Knowledge Base.
Business.Adobe.com resources
Resources
Adobe Account
