Get the metapackage
To get the Adobe Commerce metapackage:
-
Log in to your application server as, or switch to, the file system owner.
-
Change to the web server docroot directory or a directory that you have configured as a virtual host docroot.
-
Create a Composer project using a Commerce metapackage.
Magento Open Source
composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition <install-directory-name>
Adobe Commerce
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition <install-directory-name>
When prompted, enter your authentication keys. Public and private keys are created and configured from Commerce Marketplace - Access Keys. For the
username
, copy and paste the public key value. For thepassword
, copy and paste the private key value.NOTE
If you use a Composer[auth.json](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/develop/authentication-keys)
file or environment variable configured with your Commerce authentication keys, you are not prompted to enter authentication keys.If you encounter errors, such as
Could not find package...
or...no matching package found
, make sure that there are no typos in your command. If you still encounter errors, you may not be authorized to download Adobe Commerce. Contact Adobe Commerce Support for help.See Troubleshooting for help with more errors.
Example - Minor release
Minor releases contain new features, quality fixes, and security fixes. Use Composer to specify a minor release. For example, to specify the Adobe Commerce 2.4.6 metapackage:
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.4.6 <install-directory-name>
Example - Quality patch
Quality patches primarily contain functional and security fixes. However, they can also sometimes contain new, backward-compatible features. Use Composer to download a quality patch. For example, to specify the Adobe Commerce 2.4.6 metapackage:
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.4.6 <install-directory-name>
Example - Security patch
Security patches contain security fixes only. They are designed to make the upgrade process faster and easier.
Security patches use the Composer naming convention 2.4.6-px
. Use Composer to specify a patch. For example, to download the Adobe Commerce 2.4.6-p1 metapackage:
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.4.6-p1 <install-directory-name>
Set file permissions
You must set read-write permissions for the web server group before you install Adobe Commerce. This is necessary so that the command line can write files to the file system.
cd /var/www/html/<magento install directory>
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
chown -R :www-data . # Ubuntu
chmod u+x bin/magento
Install the application
You must use the command line to install Adobe Commerce.
This example assumes that the install directory is named magento2ee
, the db-host
is on the same machine (localhost
), and that the db-name
, db-user
, and db-password
are all magento
:
bin/magento setup:install \
--base-url=http://localhost/magento2ee \
--db-host=localhost \
--db-name=magento \
--db-user=magento \
--db-password=magento \
--admin-firstname=admin \
--admin-lastname=admin \
--admin-email=admin@admin.com \
--admin-user=admin \
--admin-password=admin123 \
--language=en_US \
--currency=USD \
--timezone=America/Chicago \
--use-rewrites=1 \
--search-engine=opensearch \
--opensearch-host=os-host.example.com \
--opensearch-port=9200 \
--opensearch-index-prefix=magento2 \
--opensearch-timeout=15
--backend-frontname
option. However, Adobe recommends omitting this option and allowing the installation command to automatically generate a random URI. A random URI is harder for hackers or malicious software to exploit. The URI displays in your console when installation is complete.Command summary
To display a complete list of commands, enter:
bin/magento list
To get help for a particular command, enter:
bin/magento help <command>
For example:
bin/magento help setup:install
bin/magento help cache:enable
The following table summarizes the available commands. Commands are shown in summary form only. For more information about a command, click the link in the Command column.
Command | Description | Prerequisites |
---|---|---|
magento setup:install | Installs the application | None |
magento setup:uninstall | Removes the application. | Application installed |
magento setup:upgrade | Updates the application. | Deployment configuration |
magento maintenance:{enable/disable} | Enables or disables maintenance mode (in maintenance mode, only exempt IP addresses can access the Admin or storefront). | Application installed |
magento setup:config:set | Creates or updates the deployment configuration. | None |
magento module:{enable/disable} | Enable or disable modules. | None |
magento setup:store-config:set | Sets storefront-related options, such as base URL, language, timezone. | Deployment configuration |
magento setup:db-schema:upgrade | Updates the database schema. | Deployment configuration |
magento setup:db-data:upgrade | Updates the database data. | Deployment configuration |
magento setup:db:status | Checks if the database is up to date with the code. | Deployment configuration |
magento admin:user:create | Creates an administrator user. | You can create users for the following: Deployment configuration Enable at minimum the Magento_User and Magento_Authorization modulesDatabase (simplest way is to use bin/magento setup:upgrade ) |
magento list | Lists all available commands. | None |
magento help | Provides help for the specified command. | None |
Common arguments
The following arguments are common to all commands. These commands can be run either before or after the application is installed:
Long version | Short version | Meaning |
---|---|---|
--help | -h | Get help for any command. For example, ./magento help setup:install or ./magento help setup:config:set . |
--quiet | -q | Quiet mode; no output. |
--no-interaction | -n | No interactive questions. |
--verbose=1,2,3 | -v, -vv, -vvv | Verbosity level. For example, --verbose=3 or -vvv displays debug verbosity, which is the most verbose output. Default is --verbose=1 or -v . |
--version | -V | Display this application version |
--ansi | n/a | Force ANSI output |
--no-ansi | n/a | Disable ANSI output |