Extension Manager

Installing an extension is a three-step process that should take place during off-peak hours. Before the extension is installed, your store is put into maintenance mode, checked for readiness, and backed up. After the extension is installed, it must be configured for your store according to the developer’s instructions.

For technical information, see Run the Extension Manager in the developer documentation.

Important: Always flush the cache after installing or upgrading Magento, or any extensions and modules.

Web setup - Extension Manager Installed Extensions

Install an extension

  1. Retrieve your access keys:

    • Go to Magento Marketplace and log into your account.

    • On the Marketplace tab, go to My Products and click Access Keys.

      If you need to generate a new set of access keys, click Create a New Access Key.

    • Find the set of access keys (public key and private key) in the list and make them available for the next steps.

  2. Log in to the Admin of your Magento store as a user with full administrator rights.

  3. On the Admin sidebar, go to System > Tools > Web Setup Wizard.

    Web Setup Wizard - Tools Web Setup Wizard

  4. Click Extension Manager.

  5. Copy and paste your Public Key and Private Key, then click Submit.

    Extension Manager Extension Manager

    It will take a few minutes to generate the summary and list of all available updates, recently purchased extensions, and currently installed extensions and sample data.

    Marketplace - Account Summary Summary of Your Marketplace Account

  6. Locate Extensions Ready to Install at the top of the page and click Review and Install. Then, do the following:

    • In the list of extensions that are ready to install, select the checkbox of the extension that you want to install.

      Extension Manager - Extensions ready to install Extensions Ready to Install

    • In the Latest version column, choose the version that you want to install.

    • In the Action column, click Install.

  7. Follow the onscreen instructions to complete the following:

    • Step 1: Readiness Check
    • Step 2: Create Backup
    • Step 3: Component Install

Step 1: Readiness Check

  1. Before the installation begins, your store environment must be checked for compatibility. When ready to begin, click Start Readiness Check. The progress indicator shows where you are in the process.

    Extension install - readiness check Readiness Check

  2. When the Readiness Check completes successfully, click Next.

    Extension install - readiness check complete Readiness Check Complete

Step 2: Create Backup

  1. Your store is placed in maintenance mode while the backup is created. When you are ready to begin, click Create Backup. Then, wait a few minutes for the backup to complete.

    Extension install - backup complete Backup Complete

  2. You can see the path to the backup file at the bottom of the report. When the backup is complete, click Next.

Step 3: Component Install

  1. When you are ready to begin, click Install. Then, wait a few moments for the installation to complete.

    Extension install - installation complete Installation Complete

  2. When complete, click Back to Setup Tool. Then, click System Configuration.

  3. In the upper-right corner of Extension Manager, click the Reset link to log out.

  4. Flush the cache after installing and enabling the module.

Configure the extension for your store

  1. Log in to the Admin of your store.

  2. On the Admin sidebar, go to Stores > Settings > Configuration.

  3. In the left panel, find the new tab for the extension you installed.

  4. Follow the instructions from the extension developer to complete the configuration.