X hide

Magento 2 Newsletter Popup v3.x Installation

From Plumrocket Documentation

You are viewing:  Newsletter-popup-icon-32.png  Newsletter Popup

Installation Service
Installation Service



Contents

Installation

In this article you will learn how to install Newsletter Popup for Magento 2 properly.


Attention green.png Important Information:
  1. First of all make sure your system meets all the requirements necessary for the correct functioning of ou N ewsletter Popup Extension for Magento 2.
  2. For more details on system requirements, please read Magento system requirements.


Uploading Magento 2 extension files

Download and unpack Magento 2 Newsletter Popup Extension files as it is shown below:


Description.png Detailed description:
  1. An original archive with extension to be unpacked.
  2. The unpacked catalog of files.


1 newsletter popup v3 magento 2.png


In order to upload files to the server, you may use any FTP-client (to show you how it works, we used the FileZilla FTP-client.)


Description.png Detailed description:
  1. This is your client side. You will see the unpacked catalog containing the Newsletter Popup Extension.
  2. This is your root directory on the server side. This is where the files should be uploaded.
  3. All the files have to be uploaded to the server. Select the files and press right mouse button.
  4. Select the "Upload" option for these files.


2 newsletter popup v3 magento 2.jpg


The screenshot below shows possible difficulties that can occur when you upload the files. If there are identical files on the server, they should be overwritten. Please, check below the detailed tips on how to overwrite the files (while using the FileZilla FTP-client):


Information Sign sm.png Step-by-Step action:
  1. In case you receive the "Target file already exists" notification from your FTP-client, check the instructions below.
  2. Select the "Overwrite" radio button to overwrite files.
  3. Tick the "Apply to current queue only" —Āheckbox in order to save these settings for all similar cases of current queue configuration in the future.
  4. Press "OK".


3 newsletter popup v3 magento 2.jpg


After uploading, please select one of the 3 installation methods described below:


SSH Installation (requires SSH access to your webserver)

1. In terminal, switch to your Magento 2 root directory using command:

Command:
  1. cd /FULL_PATH_TO_YOUR_MAGENTO2

where "FULL_PATH_TO_YOUR_MAGENTO2" is the path to your Magento 2 folder on your server.


2. Run the Magento 2 upgrade command:

Command:
  1. php bin/magento setup:upgrade


3. Run the single-tenant compiler command:

Command:
  1. php bin/magento setup:di:compile


4. Deploy static view files command:

Command:
  1. php bin/magento setup:static-content:deploy


Web Installation (using native Magento 2 Component Manager)

Information Sign sm.png Step-by-Step action:
  1. Log into your Magento 2 Admin Panel.
  2. Go to the "System" tab.
  3. Select the "Web Setup Wizard" option.


3b newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. Once you open "Setup Wizard" interface - go to the "Home" tab.
  2. Select the "Component Manager" option.


4 newsletter popup v3 magento 2.jpg


Step 1 - Base extension installation


Before you proceed with Newsletter Popup Extension for Magento 2 installation - please, install Plumrocket Base extension. This is a system extension required for correct functioning of all Plumrocket Inc extensions. Note: You may skip Step "1" and proceed with "Step 2" if you have already installed Base extension by Plumrocket Inc before.


Information Sign sm.png Step-by-Step action:
  1. Please find "Plumrocket_Base" extension in the "Component Manager" tab.
  2. Select the "Enable" option from the drop-down menu.


5 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. Please, press the "Start Readiness Check" button on the next page.


6 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. Please, make sure all the check marks are green. This means that your system is ready to move forward with Magento 2 Base module installation.
  2. If the check was successful - press on the "Next"button.


7 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. It is important to make a backup. You can select at least the "Code" and "Database" backup options.
  2. Press the "Create Backup" button. For your the safety, this process will put your website into "Maintenance" mode until the Base extension is installed.


8 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. Once the backup process is completed, you will see a notifucation.
  2. Press on the "Next" button.


9 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. Press the "Enable" button to activate this Magento 2 Base extension.


10 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. The "Update pending" notification means that the activation of this extension is currently in progress. Please wait until it is completed.


11 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. The "Success" notification means that Plumrocket Base Magento 2 extension has been successfully installed. At this point your website is in "Live" mode again.
  2. You can now get back to setup tool and install the Newsletter Popup Extension for Magento 2.


12 newsletter popup v3 magento 2.jpg


Step 2 - Newsletter Popup Extension for Magento 2 installation

On this step, please navigate back to the "Component Manager" tab, and activate theNewsletter Popup Page Extension in the same way, as you did with the Base Extension:


Information Sign sm.png Step-by-Step action:
  1. Please, find "Magento/module-newsletter" extension in the "Component Manager" tab.
  2. Select the "Enable" option from the drop-down menu.


144 newsletter popup v3 magento 2.jpg


Proceed with the Newsletter Popup Extension activation in the same way as with Base extension above. Once Newsletter Popup Extension is activated - please, follow the final steps below:


Information Sign sm.png Step-by-Step action:
  1. Navigate to your Magento 2 Admin Panel.
  2. Go to the "Plumrocket" tab.
  3. If you see the "Newsletter Popup" tab in the list, this means that Magento 2 Newsletter Popup Extension from Plumrocket Inc. has been successfully installed.


13 newsletter popup v3 magento 2.jpg


License Installation

Attention green.png Important Information:
  1. Go to the "Plumrocket" tab in the main menu.
  2. Navigate to the "Newsletter Popup" -> select the "Configuration"option.
  3. Your Serial Key should be entered automatically in most cases. If you see green check mark - this means that product Magento 2 Serial Key has been successfully activated. Now it is safe to enable the extension. However, if the green check mark is not there - you will need to enter your product Serial Key manually. In order to find and activate your Serial Key - please follow the License Installation for Magento 2 instructions.


14 newsletter popup v3 magento 2.jpg


Newsletter Popup Thumbnail Generation

At some point in order to enable Newsletter Popup thumbnail generation you will need to install the wkhtmltoimage command line tool (which is a part of wkhtmltopdf command line tool). This option is disabled by default as shown below.


Information Sign sm.png Step-by-Step action:
  1. In your Magento 2 Admin Panel go to "Plumrocket" tab.
  2. Select "Newsletter Popup Extension" > "Configuration" section.
  3. As you can see, "Thumbnail Generation" option is disabled by default.


15 newsletter popup v3 magento 2.jpg


This option is used for generating Newsletter Popup thumbnails that display in the "Manage Popups" grid as shown below.


Information Sign sm.png Step-by-Step action:
  1. Go to "Manage Popups" section of Newsletter Popup extension.
  2. Thumbnails of your Newsletter Popups will be available in the grid once this option is enabled.


16 newsletter popup v3 magento 2.jpg


Attention green.png Important Information:

Please note that enabling this option is not obligatory, however it is a useful tool that will help admin to visually distinguish multiple popups at the backend.


In order to enable Newsletter Popup Thumbnail Generation option, follow the step-by-step instructions below.


Information Sign sm.png Step-by-Step action:
  1. Go to wkhtmltopdf official page and click on the "Downloads" link.


Wkhtmltopdf 1 newsletter popup v3 magento 2.jpg


Information Sign sm.png Step-by-Step action:
  1. Choose and download the needed archive from the list.


Wkhtmltopdf 2 newsletter popup v3 magento 2.jpg


Attention green.png Important Information:

Once you've downloaded the archive/file - you need to pass it to your server administrator (or to your hosting support) with a request to install it on your server.


After successful installation of wkhtmltopdf command line tool for Newsletter Popup Thumbnail Generation the according option should become enabled in your Magento backend as shown below.


Information Sign sm.png Step-by-Step action:
  1. In your Magento Admin Panel, go to "Plumrocket tab > "Configuration" section of the Newsletter Popup Extension.
  2. You will be able to see that the "Thumbnail Generation" is now enabled.


17 newsletter popup v3 magento 2.jpg


Next Step > Magento 2 Newsletter Popup v3.x Configuration

Newsletter Popup Extension for Magento 2 Newsletter Popup Extension for Magento 2

Navigation