How to install Magento 2 extension

Our Magento 2 extensions support both Community and Enterprise edition of Magento starting from version 2.1. The current version of the Magento installed on your website can be found in the lower right corner of any backend page.

Magento 2 Version

The extensions have 3 separate ways of installation: via Composer, by copying the code or via Magento Marketplace.

Installation Via Composer

  1. Create a folder anywhere on your server (preferably not in the Magento installation directory). Put the zip archive into this folder.

  2. Use any SSH client to connect to your server. Navigate to the root Magento folder. Bear in mind that the user should write permissions to this folder and its subfolders.

  3. Add the folder with the extension's archive as a repository. For this, run the Composer command:

    composer config repositories.mageworx artifact {/ABSOLUTE/PATH/TO/FOLDER}
    

    like:

    composer config repositories.mageworx artifact /mageworx/extensions/zip
    

    This command will add these lines to your composer.json file:

    "mageworx": {
        "type": "artifact",
        "url": "/mageworx/extensions/zip"
    }
    
  4. Perform the command:

    composer require mageworx/module-modulename
    

    How to identify the name of the module?

    You need to check the composer.json file. Its' structure can be shown as:

        “name”: “mageworx/module-advancedproductoptions”,
        “version”: “2.9.1",
        “type”: “metapackage”,
        “require”: {
            “mageworx/module-optionbase”: “2.4.13”,
            “mageworx/module-optioninventory”: “2.4.11”,
            “mageworx/module-optiontemplates”: “2.4.11”,
            “mageworx/module-optionfeatures”: “2.4.0”,
            “mageworx/module-optiondependency”: “2.0.14”,
            “mageworx/module-optionswatches”: “2.0.7”,
            “mageworx/module-optionlink”: “2.0.2”
            }
        }
    
    The name of the extension can be seen on the “name” string, so, e.g., in this example the name is “mageworx/module-advancedproductoptions”.
    Our extensions have the different structure. Some of them consist of several submodules. The main module is called the metapackage (as shown in this example). You need to put the name of the metapackage of the extension when performing the composer command

  5. Clear the compiled code and the cache:

    php bin/magento setup:upgrade
    
  6. To update the extension via composer perform the command:

    composer update mageworx/module-modulename
    

    Do not forget to change the modulename with the appropriate one as described above.

This chart has the composer names for all our extensions:

The Extension's Name Composer Name
Advanced Product Options mageworx/module-advancedproductoptions
Cross Links mageworx/module-seocrosslinksmeta
Currency Auto Switcher mageworx/module-currencymeta
Customer Group Prices mageworx/module-customergrouppricesmeta
Delivery Date mageworx/module-deliverydate
Donations Suite mageworx/module-donationsmeta
Extended Rich Snippets mageworx/module-seomarkupmeta
Extended Sales-Orders Grid mageworx/module-ordersgridmeta
File Downloads & Product Attachments mageworx/module-downloadsmeta
Geo Lock mageworx/module-geolockmeta
Gift Cards mageworx/module-giftcards
Landing Pages mageworx/module-landingpagesprometa
Multi Fees mageworx/module-multifeesmeta
Order Editor mageworx/module-ordereditormeta
Order Management mageworx/module-ordereditor
Others Also Bought module-alsoboughtmeta
Personal Customer Discount mageworx/module-personalpromotionmeta
Prices per Customer mageworx/module-customerpricesmeta
Reward Points mageworx/module-rewardpointsmeta
Search Suite mageworx/module-searchsuitesphinxmeta
SEO Meta Templates mageworx/module-seoxtemplatesmeta
SEO Suite Ultimate mageworx/module-seosuiteultimate
Shipping Suite mageworx/module-shippingrulesmeta
Sitemap Suite mageworx/module-sitemapsuitemeta
Store and Currency Auto Switcher mageworx/module-storecurrencymeta
WAVES Crypto Payments mageworx/module-waves-payment

Installation by copying the code

  1. Download the extension's package from your customer account, unzip it.

  2. Use any SSH client to connect to your server. Bear in mind that the user should write permissions to this folder and its subfolders.

  3. Upload all the files and folders from the extension's package to the root Magento folder.

  4. Via SSH, navigate to the root Magento folder and perform the command:

    php bin/magento module:enable MageWorx_ModuleName
    

    How to identify the name of the module?

    The names of the extensions can taken from the names of the folders located in /app/code/Mageworx/ in the module's folder. Bear in mind that several folders can be seen there, in this case you need to list all of them without commas, like php bin/magento module:enable MageWorx_SeoAll MageWorx_SeoBase MageWorx_SeoXTemplates...etc. You do not need to include the meta package in this link. The meta package has the ...Meta word in the name like MageWorx_OrderManagementMeta. You do not need to add the extensions that were already installed.

  5. Clear the compiled code and cache:

    php bin/magento setup:upgrade
    php bin/magento cache:flush
    php bin/magento setup:static-content:deploy
    

Installation via Magento Marketplace

Magento 2 provides the possibility to install the extensions via Web Setup Wizard tool in the backend. This is the main method to install the extension purchased on Magento Marketplace website. First of all, please check this article to ensure that all the minimum requitrements are met. After that please follow this guide.

  1. Log into your Magento Marketplace account. Click the My Access Keys link on the Developer Portal tab.

    Magento Marketplace Keys

  2. Copy both Public Key and Private Key. Note that thet are provided on the Magento 2 tab

    Magento Marketplace Keys

  3. Log into the Magento backend panel and go to SYSTEM ⟶ Tools ⟶ Web Setup Wizard

    Magento Web Wizard

  4. Click the Module Manager. Then, click the Sign In link in the upper-right corner. Put the Public Key and Private Key from your Marketplace account.

    Magento Web Wizard

  5. You need to synchronize your backend with the Marketplace website. For this click the Refresh button. Note that it might take a few minutes. After that you'll be able to observe the number of the purchased extensions close to the Extensions Ready to Install text.

    Magento Web Wizard

  6. Click the Review and Install button below the Extensions Ready to Install text. In the Extensions Grid, mark the checkbox of the extension you want to install. Please, always use the latest version of the extenxion (extensions). Click the Install button. !! скрин
    The installation process has started.

  7. Rediness Check. The store environment is checked for compatibility. When the Readiness Check completes successfully, tap Next button. If you observe some problems here, fix them and click the Try Again button to recheck the compatibility of the Magento installation. Magento Web Wizard Rediness Check
  8. Create Backup. By default, the backup includes the code, media, and database but you can deselect any checkbox of any item that you do not want to include in the backup. Click the Create Backup button. Magento Web Wizard Create Backup Once this operation has finished, click the Next button Magento Web Wizard Create Backup
  9. This page shows the names and the versions of the extensions that are about to be installed. The website will be taken offline to protect your customers during the installations. Click the Install button. Magento Web Wizard
  10. The page shows the current status, and you can track its progress in the Console Log Magento Web Wizard The Success page appears when the process is complete.
  11. Log out and in for all the changes to take into effect. Your extension is now ready to use.