Extension Manager

If your Magento installation is hosted on Adobe Commerce Cloud or requires installation from the command line of the server, see Install, manage, and upgrade extensions.

Installing an extension from the Admin 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.

As a best practice, an extension should be installed and tested in a development environment before it is pushed to production. For technical information, see Run the Extension Manager in the developer documentation.

Install an extension

  1. Log in to your Magento account and go to Marketplace > My Products > Access Keys.

    Keep this browser tab open so you can easily retrieve your access key.

  2. In a new browser tab, 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 Setup Wizard

  4. Click Extension Manager.

  5. Copy and paste your Public Key and Private Key from your Magento account.

  6. Click Submit.

    Extension Manager Public and Private Keys

    It might take a few minutes to list all available updates, recently purchased extensions, and currently installed extensions and sample data.

    Marketplace - Account Summary Summary of Marketplace Account

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

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

    • In the Action column, click Install.

    Extension Manager - Extensions ready to install Extensions Ready to Install

  8. Follow the onscreen instructions and progress indicator to complete the installation.

Step 1: Readiness check

Before the installation begins, your store environment is checked for compatibility.

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

Your store is put in Maintenance Mode while the backup is created. By default, the backup includes the code, media, and database.

  1. Clear the checkbox of any item that you do not want to include in the backup.

    Backup Options

  2. Click Create Backup.

    The backup takes a few minutes to complete. A summary report provides information about each step of the process, and lists the path to the backup file at the end of the report.

    Backup Complete

  3. When the backup is complete, click Next.

Step 3: Component install

During this part of the process, your store is taken offline to prevent the installation from interferring with the shopping experience.

  1. When you are ready to begin, click Install.

    Depending on your cron settings, it might take some time for the installation to complete. The page shows the current status, and you can track the detailed progress in the console log. The Success page appears when the process is complete.

    Extension install - installation complete Installation Complete

  2. When the installation is complete, click Back to Setup Tool.

  3. Do one of the following to exit the Setup Wizard and return to the Admin.

    • If you have synchronized your store and want to maintain the synchronization, enter the URL of the Admin in the address bar of the browser. Then, log in to the Admin.

    • If you want to clear the access key, click System Configuration. Then in the upper-right corner, click the Reset link to clear the access key and log out.

    Web Setup Wizard - Tools Setup Wizard

Step 4: Flush the cache

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

  1. If necessary, log in to the Admin of your store.

  2. Do one of the following:

    • Click Cache Management in the message above the workspace.

    • On the Admin sidebar, go to System > Tools > Cache Management.

  3. Click Flush Magento Cache.

    Flush Magento Cache

Step 5: Configure the extension for your store

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

  2. In the left panel, find the new configuration section for the extension you installed.

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

  4. In the Admin, look for any new commands the extension has added to the menus.

    For example, a slider extension might add new commands to the Content menu.