MagePlugins

The Best Extensions Backed By The Best Support Team

Installation Procedure

You should never install an extension directly onto your production website. Please install this extension onto a staging version of your website and verify it's compatibility.

When adding modules (or extensions) to Magento, you should add the code to a Git branch, test in Integration, deploy and test in Staging, before finally pushing and using in Production.

Taking Backups

Take a Backup Of Your Database

Most extensions will modify your database and some complex extensions will modify Magento's Db Tables. It's important that you take a backup of your website database before attempting an install.

This command enables you to back up:

  • The Magento file system (excluding var and pub/static directories)
  • The pub/media directory
  • The Magento 2 database

Database backup files are compressed using the .gz format. The .tgz format is used for system, database, and media backups. Backup files are stored in the var/backups directory in your Magento file system.

After backing up, you can roll back at a later time.

To Create a Single Backup

1. Log in to the Magento server as, or switch to, a user who has permissions to write to the Magento file system. One way to do this is to switch to the Magento file system owner.

If you use the bash shell, you can also use the following syntax to switch to the Magento file system owner and enter the command at the same time:

su -s /bin/bash -c

If the Magento file system owner does not allow logins you can do the following:

sudo -u

2. To run Magento commands from any directory, add /bin to your system PATH.

Because shells have differing syntax, consult a reference like unix.stackexchange.com.

bash shell example for CentOS:

export PATH=$PATH:/var/www/html/magento2/bin

You may visit the official Magento DevDocs to learn more about backups.

Disable Magento Cache

Magento 2 cache is designed to store database and configuration values in memory to create a faster website. Installing extensions when the cache is enabled will cause havoc during the installation process. It's important to disable the Magento Cache items before you install any extensions.

1. Log in to your Magento 2 dashboard.

2. Select System > Cache Management (Figure 1).

Figure 1. Magento 2 dashboard; System > Cache Management


3. The Cache Management page will appear. From the Actions drop-down list, select Disable, click the top check box to select all, then click Submit (Figure 2).

Figure 2. Actions >Disable.

4. To make sure the cache has completely cleared, click Flush Magento Cache (Figure 3).

Figure 3. FlushMagentoCache button.

You may also reference the Magento 2 DevDocs.

Download Your Purchased Extension

Immediately after your purchase you were provided with a download link of your new software. This download will contain one to many extension folders and documentation for each of the extensions.

If you did not download your software at the time of purchase you can log into your account with us and download copy. Your download will be available for 12 months following your purchase. If it has been 12 months since your last purchase you will need to purchase the software again to reactivate your download.

Log into your Mage Plugins customer account here, https://mageplugins.net/customer/account/.

In the left menu of your customer account choose My Downloadable Products. This will display a complete list of the products which you've purchased in the last twelve months. Click on the extension which you would like to install and your download will start.

Install The Extension

1. Copy The Extension Files. In the compressed archive which you downloaded you will see one to many extension folders. Within each of these folders is an exact replica of the Github Repository that we use for developing the extension.

You may delete/ignore any files that are UPPERCASE and/or end with .md. These files are relevant to development only.

The documentation files that you're reading right now exist under the /docs folder within each extension directory. You will receive this exact documentation when you purchase and download the extension. You may read these docs offline.

All other files and folders within each extension directory are important to the successful installation of your new software. Copy and paste, or drag these files into the WEBROOT of your magento installation.


Your extension files are now installed and your extension is ready to be installed into your database.

2. Access your Store by SSH to complete the database installation procedure for your extension.

3. Run the following commands:
   php bin/magento module:enable MP_OneStepCheckout
   php bin/magento setup:upgrade
   php bin/magento setup:static-content:deploy - Add -f if the environment is developer
   php bin/magento setup:di:compile

3. To confirm that your extension has installed, go to Stores > Configuration > MagePlugins > One Step Checkout. The modules that you just copied the files for will be listed here if Magento is recognizing them.

4. Log Out and Log Back In Now that your extension has been installed, log out of your admin area and log back into it. Once you've completed this action you may re-enable your magento cache and any other cache mechanisms that you had disabled.

Your installation is now complete.

Uninstallation Procedures

Prepare for Uninstallation

1. Disable Magento's Cache

2. Disable any caching mechanisms that are running on your server

Disable The Extension

1. Run the command php bin/magento module:disable MP_OneStepCheckout in a UNIX terminal.

2. Deploy static display files using the following command php bin/magento setup:static-content:deploy
* Add -f if the environment is developer

3. Compile the code using the following command php bin/magento setup:di:compile

4. Delete the cache directory var/cache and this will disable the extension completely.

5. Verify that your webstore is operating properly without the extension by creating a sales order. You should not longer be able to see the admin offline payment option when creating an order.

6. If everything is operating properly you may delete the extension files which are outlined in the file structure above.

The Best Extensions Backed By The Best Support Team