Installation Guide

Installing a Magento 2 Extension

Download and Extract the Extension#

Download the latest release of the extension from its GitHub repository in the PluginCompany organization (the source code ZIP of the most recent version tag on the releases page) and extract it locally to any folder. The extracted folder contains the module files, with registration.php in its root.

Upload Files to Server#

Connect to your server using SSH, SFTP or FTP.

Create the directory app/code/PluginCompany/ExtensionName in your Magento 2 root directory and copy the extracted files into it, so that app/code/PluginCompany/ExtensionName/registration.php exists.

Enable the Extension#

Enable the extension using the following command:

php bin/magento module:enable PluginCompany_ExtensionName

Update the Database#

Run the following upgrade command:

php bin/magento setup:upgrade

Clean the Magento Cache#

Clean the cache using the following command:

php bin/magento cache:clean

Remove auto-generated classes#

Remove all auto-generated classes using the following command:

rm -Rf ./generated/*

Or in Magento 2.0 and 2.1:

rm -Rf ./var/generation/*

Run the Compiler#

Run the dependency injection compilation command:

php bin/magento setup:di:compile

Deploy Static View Files#

Run the static content generation command:

php bin/magento setup:static-content:deploy