Install, manage, and upgrade extensions

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

When adding 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.

Extensions 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 extension installation purchased from Magento Marketplace. You can use the same procedure to install any extension with the extension’s Composer name. To find it, open the extension’s composer.json file and note the values for "name" and "version".

We also include instructions for updating extensions.

Create a branch for adding or updating the extension

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

  1. Log in to your local development system, or switch to, the Magento file system owner.
  2. Change to a directory to which the Magento file system owner has write access.
  3. Enter the following command in a terminal to log in to your project:

    magento-cloud login
    
  4. List your projects. With the project ID, you can complete additional commands.

    magento-cloud project:list
    
  5. 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>
    
  6. Change to a project directory. For example, cd /var/www/html/magento2
  7. 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.

  8. Fetch origin branches to get the latest code:

    git fetch origin
    
  9. 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>

  10. Pull any updated code to your local for the environment ID (which is the Git branch):

    git pull origin <environment ID>
    
  11. Create a snapshot of the environment as a backup:

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

Install an extension

Extension installation uses the following steps:

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

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

If you already know the extension’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:

  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.

    Access your Marketplace account

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

    Marketplace purchase history

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

    Technical details shows the module's Composer name

  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. This file differs from config.local.php used by Configuration Management.

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 extension deployment failure.

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

Step 3: Verify the extension

To verify the extension 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 extension is installed.
  2. Enter the following command to display a list of enabled modules:

    php bin/magento module:status
    
  3. Verify the extension is listed.

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

Manage extensions

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

Enable and disable extensions

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

For projects using Magento Commerce (Cloud) before 2.1.4, to change settings for your extensions 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 extension or module using sandbox credentials and settings, you make sure to switch those to live settings if in Production.

For projects 2.1.4 and later, you will update configurations according to Configuration Management for config.local.php.

Upgrade an extension

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

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

To update an extension:

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