User Manual - Newsletter Popup & Maker
Installing the Magento 2 Newsletter Popup & Maker extension
Command Line Installation
-
Backup your web directory and store database
-
Download the Exit Popup Pro installation package
-
Upload contents of the Exit Popup Pro installation package to your store root directory
-
In SSH console of your server navigate to your store root folder:
cd path_to_the_store_root_folder |
Run the following command:
php bin/magento module:enable Aheadworks_Newsletter |
then:
php bin/magento setup:upgrade |
after:
php bin/magento setup:static-content:deploy -f |
-
Flush store cache; log out from the backend and log in again
|
Make sure the installation is done from the FTP administrator account. Otherwise, set 775 permissions to the store root directory after the extension is deployed. |
Composer Installation
If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:
Login to your ssh console and navigate to your store folder:
cd path_to_the_store_root_folder |
Run the following commands:
composer config repositories.aheadworks composer https://dist.aheadworks.com/ |
After the command was executed successfully, you can use the composer to install the extension.
To install the extension:
Login to your ssh console and navigate to your store folder:
cd path_to_the_store_root_folder |
Run the following command to install the latest version of the extension:
composer require aheadworks/module-newsletter |
if you need to install a specific version, run this command:
composer require aheadworks/module-newsletter<version> |
Specify the version of the extension in <version>
When prompted, enter Public Key (Username) and Private Key (Password):
Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:
To upgrade the extension:
To update or upgrade an extension:
Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.
If a composer package exists for the extension, run one of the following.
Update per module name:
composer update aheadworks/module-newsletter |
Updater per version:
composer require aheadworks/module-newsletter:<version> |
Run the following commands to upgrade, deploy, and clean the cache.
php bin/magento setup:upgrade --keep-generated |
Set up cron
If you have already configured cron jobs for your Magento installation then you can skip this step. Read the following instructions on setting cron job for your Magento store: Magento user guide.-
Generally, it would be enough to run in SSH console of your server:
crontab -e |
And insert the following line:
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento cron:run |
Remember to confirm the Save request when exiting the installation.
Uninstalling the Magento 2 Newsletter Popup & Maker extension
Since Magento introduced declarative Database you need to be very careful when uninstalling or disabling the module.
|
NOTE: Please be very careful when uninstalling/disabling this module. This module uses a declarative DB scheme. Once the module is uninstalled its DB tables will be lost. |
Manual Removal
1. Disable the module by executing the following commands:
php bin/magento module:disable Aheadworks_Newsletter |
2. Remove the extension files from the following folder:
app/code/Aheadworks/Newsletter |
Automatic Removal (via Composer)
1. Disable the module by executing the following commands:
php bin/magento module:uninstall Aheadworks_Newsletter |
Extension Compatibility
|
Module Version |
Magento Version |
|
As of version 1.0.0 |
2.4.6 - 2.4.8 |
The PHP version depends on your current Magento version. Please, refer to your Magento version