Install, manage, and upgrade modules

This information includes information for adding modules to Magento Commerce (Cloud), managing enabled and disabled modules, and upgrading module code.

When adding modules (or extensions) to Magento Commerce (Cloud), you should add the code to a Git branch, test in Integration, deploy and test in Staging, before finally pushing and using in Production.

Modules include the following:

Modules to extend Magento capabilities, with options through Magento Marketplace and directly through company sites
Themes to change the look and feel of your storefronts
Language packages to localize the storefront and Admin

These instructions walk through module installation purchased from Magento Marketplace. You can use the same procedure to install any module with the module’s Composer name. To find it, open the module’s composer.json file and note the values for "name" and "version".

Create a branch for adding or updating the module

We recommend using a branch for adding or updating, configuring, and testing your module.

Log in to your local development system, or switch to, the Magento file system owner.
Change to a directory to which the Magento file system owner has write access.
Enter the following command in a terminal to log in to your project:
```
magento-cloud login
```
List your projects. With the project ID, you can complete additional commands.
```
magento-cloud project:list
```
If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.
```
magento-cloud project:get <project ID>
```
Change to a project directory. For example, cd /var/www/html/magento2
List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.
```
magento-cloud environment:list
```
magento-cloud environment:list displays environment hierarchies whereas git branch displays does not. If you have any nested environments, use magento-cloud environment:list to see the full list.
Fetch origin branches to get the latest code:
```
git fetch origin
```
Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment.
```
magento-cloud environment:checkout <environment ID>
```
To create a new environment, use magento-cloud environment:branch <environment name> <parent environment ID>
Pull any updated code to your local for the environment ID (which is the Git branch):
```
git pull origin <environment ID>
```

Create a snapshot of the environment as a backup:

magento-cloud snapshot:create -e <environment ID>

Install a module

Module installation uses the following steps:

Purchase a module from Magento Marketplace or another site.
Create a branch to work with the files.
Get the module’s Composer name and version from your purchase history.
In your local Magento Commerce (Cloud) project, update the Magento composer.json file with the name and version of the module and add the code to Git. The code builds, deploys, and is available through the environment.
Verify the module installed properly.

Step 1: Get the module’s Composer name and version

If you already know the module’s Composer name and version, skip this step and continue with Update Magento’s composer.json.

This section discusses how to get a module’s Composer name and its version from Magento Marketplace. Alternatively, you can find the name and version of any module (whether or not you purchased it on Marketplace) in the module’s composer.json file. Open composer.json in a text editor and write down the values of "name" and "version".

To get the module’s Composer name from Magento Marketplace:

Log in to Magento Marketplace with the user name and password you used to purchase the component.
In the upper right corner, click <your user name> > My Account as the following figure shows.
On the My Account page, click My Purchases as the following figure shows.
On the My Purchases page, click Technical Details for the module you purchased as the following figure shows.
Click Copy to copy the component name to the clipboard.
Open a text editor.
Paste the module name in the text editor.
Append a colon character (:) to the component name.
In Technical Details on the My Purchases page, click Copy to copy the version to the clipboard.
Append the version number to the component name after the colon.

A sample follows:
```
pixlee/magento2:1.0.1
```

Step 2: Update Magento’s `composer.json`

When adding the module to composer.json, the file app/etc/config.php will also be updated. This file includes a list of installed modules, themes, and language packages, and shared configuration settings.

To update composer.json:

If you haven’t done so already, change to your environment root directory.

Enter the following commands to update it:

composer require <component-name>:<version> --no-update
composer update

For example:

composer require pixlee/magento2:1.0.1 --no-update
composer update

Wait for project dependencies to update.
Enter the following commands in the order shown to commit your changes, including composer.lock:
```
git add -A
git commit -m "<message>"
git push origin <environment ID>
```

If there are errors, see module deployment failure.

When installing and adding the module, you must add the `composer.lock` to your Git branch for deployment. If the module is not in the file, the module won't load in Magento Commerce (Cloud). This ensures when the `composer install` command is used, the module properly loads. This command uses the `composer.lock` file.

Step 3: Verify the module

To verify the module installed properly, you can check its functionality in the Magento Admin or you can make sure it is enabled as follows:

Open a terminal.
Checkout the branch where the module is installed.
List all enabled modules:
```
php bin/magento module:status
```
Verify the module is listed.

The module name is in the format <VendorName>_<ComponentName>. It will not be in the same format as the Composer name.

Manage modules

To manage your modules, you can enable and disable or change settings per environment.

Enable and disable modules

You can use CLI commands or directly edit app/etc/config.php to enable or disable modules. After updating this file, push your changes from your local to the remote Git and deploy across all environments.

In a terminal, access your local development environment.
List all modules:
```
php bin/magento module:status
```

Enable a module.

php bin/magento module:enable <module name>

Disable a module.

php bin/magento module:disable <module name>

Verify the status of a module:

php bin/magento module:status

Also, you can navigate to, and edit, the app/etc/config.php file to verify the module is disabled.

return array (
 'modules' =>
 array (
   'Magento_Core' => 1,
   'Magento_Store' => 1,
   'Magento_Theme' => 1,
   'Magento_Authorization' => 1,
   'Magento_Directory' => 1,
   'Magento_Backend' => 1,
   'Magento_Backup' => 1,
   'Magento_Eav' => 1,
   'Magento_Customer' => 1,
...
 ),
);

The value 1 or 0 indicates whether a module is enabled or disabled.

Push your updates to the Git branch:

git add -A
git commit -m "<message>"
git push origin <environment ID>

Complete deployment to Integration for testing, then Staging for testing, and finally Production.

Modify configurations

To change settings for your modules and modules, you should make those changes in all environments as needed. We recommend using similar or matching settings between Staging and Production to fully test functionality. If you have an module or module using sandbox credentials and settings, you make sure to switch those to live settings if in Production.

Upgrade an module

You should have a branch to work in when updating your module. These instructions use composer to update the files. Before you continue, you must:

Know the module’s Composer name and version
Know the module is compatible with your project and Magento Commerce (Cloud) version. In particular, check the required PHP version.

To update an module:

If you haven’t done so already, change to your environment root directory.
Open composer.json in a text editor.
Locate your module and update the version.
Save your changes to composer.json and exit the text editor.
Update project dependencies:
```
composer update
```
Enter the following commands in the order to commit the changes and deploy the project, including composer.lock:
```
git add -A
git commit -m "<message>"
git push origin <environment ID>
```
Wait for the project to deploy and verify in your environment.

If there are errors, see Component deployment failure.

Edit this page on GitHub

Give us feedback