Install, manage, and upgrade modules

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:

1. Log in to Magento Marketplace with the user name and password you used to purchase the component.

2. In the upper right corner, click <your user name> > My Account as the following figure shows.

   

3. On the My Account page, click My Purchases as the following figure shows.

   

4. On the My Purchases page, click Technical Details for the module you purchased as the following figure shows.

   

5. Click Copy to copy the component name to the clipboard.
6. Open a text editor.
7. Paste the module name in the text editor.
8. Append a colon character (:) to the component name.
9. In Technical Details on the My Purchases page, click Copy to copy the version to the clipboard.

10. 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:

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

2. 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
   

3. Wait for project dependencies to update.

4. 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.

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:

1. SSH to the environment on which the module is installed.

2. Enter the following command to display a list of enabled modules:

   php bin/magento module:status
   

3. 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.

1. In a terminal, access your local development environment.

2. You need a specific name of the extension or module. Use the following command to locate the name:

    php bin/magento module:status
   

3. To enable, use the following command.

    php bin/magento module:enable <module name>
   

4. To disable, use the following command.

    php bin/magento module:disable <module name>
   

5. Use the following command to verify the changed status of the module:

    php bin/magento module:status
   

You can also 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.

1. Push your updates to the Git branch:

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

2. 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:

1. If you haven’t done so already, change to your environment root directory.
2. Open composer.json in a text editor.
3. Locate your module and update the version.
4. Save your changes to composer.json and exit the text editor.

5. Use the following command to update project dependencies:

   composer update
   

6. 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>
   

7. Wait for the project to deploy and verify in your environment.

If there are errors, see Component deployment failure.

Related topics

• Update components
• Install optional sample data
• Merge and delete an environment