Installing the Magento Module

The Limely_MageDrop module is a lightweight companion that adds staging and preview functionality to your Magento 2 admin. It doesn't modify your database schema or alter existing functionality — it simply adds UI elements and communicates with the MageDrop SaaS.

The module source code is available on GitHub: github.com/Limely/MageDrop

Requirements

  • Magento 2.4.x (Open Source or Adobe Commerce)
  • PHP 8.2 or higher
  • Composer
  • Shell access to run Magento CLI commands

Installation

Step 1: Require the module via Composer

composer require limely/module-magedrop

Step 2: Enable the module and run setup

Run the following Magento CLI commands from your Magento root directory:

# Enable the module
php bin/magento module:enable Limely_MageDrop

# Run database setup/upgrade
php bin/magento setup:upgrade

# Compile dependency injection
rm -rf generated/
php bin/magento setup:di:compile

# Deploy static content (production mode only)
php bin/magento setup:static-content:deploy

# Flush the cache
php bin/magento cache:flush

If you're running in developer mode, you can skip the setup:static-content:deploy step.

Step 3: Verify the module is enabled

Confirm the module is registered:

php bin/magento module:status Limely_MageDrop

You should see:

Module is enabled

Configuration

Once the module is installed, configure it in the Magento Admin:

  1. Go to Stores > Configuration > MageDrop > Connection.
  2. Configure the following fields:
FieldDescriptionExample
Enabled Enable or disable the MageDrop module. When disabled, the MageDrop button and preview functionality will be hidden. Yes
Module Token The authentication token used to communicate with MageDrop. Copy this from your store's edit page in the MageDrop dashboard. tok_abc123def456...
  1. Click Save Config.
  2. Flush the cache: go to System > Cache Management and click Flush Magento Cache, or run:
php bin/magento cache:flush

Verifying the connection

After configuring the module, verify that the connection is working:

  1. In the MageDrop dashboard, go to your store's edit page.
  2. Click the Test Module Connection button.
  3. You should see a green success notification confirming the round-trip connection.

If the connection fails, check the following:

  • The Module Token matches the token shown in the MageDrop dashboard.
  • Your server can make outbound HTTPS requests (check firewall rules).
  • Check the Magento log at var/log/system.log for error details.

Updating the module

composer update limely/module-magedrop
rm -rf generated/
php bin/magento setup:di:compile
php bin/magento setup:upgrade
php bin/magento cache:flush

Uninstalling the module

# Disable the module
php bin/magento module:disable Limely_MageDrop

# Remove via Composer
composer remove limely/module-magedrop

# Clean up
rm -rf generated/
php bin/magento setup:di:compile
php bin/magento cache:flush