Here you will learn how to correctly install the Newsletter Popup Extension for Magento 2 using two methods – Installation via Composer or FTP.
Important Information:
- First of all, make sure your system meets all the requirements necessary for the correct functioning of your Newsletter Popup Extension for Magento.
- For more details on system requirements, please read Magento 2 system requirements.
You can choose one of the following two methods to install the extension on your Magento 2 store:
Important Note for Hyvä Theme Users:
If you are planning to use the Magento 2 Newsletter Popup extension on the Hyvä theme, please be aware that only the Composer installation method is compatible. Please follow our Hyvä Theme Compatibility Module Installation guide .
Extension Installation via Composer
This section describes the recommended way to install the extension via Composer using your Plumrocket account. The installation credentials and commands are generated individually for your account and must be copied directly from the Plumrocket dashboard.
Step 1. Obtain Composer Credentials and Commands
Step-by-step guide:
- Log in to your Plumrocket Account.
- Navigate to My Account → My Downloads.
- Find the Magento 2 Newsletter Popup extension in the list.
- Click Install via Composer next to the extension.
After clicking Install via Composer, a popup window will appear containing:
Step-by-step guide:
- Composer repository configuration command.
- Composer require command.
- Authentication credentials (username and password).
- Magento CLI commands to complete the installation.
Important Information:
- The credentials shown in the popup are generated for your account.
- Do not reuse credentials from documentation examples.
- Always copy commands directly from the popup to avoid authentication issues.
After you copied the commands and credentials, connect to your server via SSH and follow the steps:
Step 2. Switch to your Magento 2 root directory in the terminal
cd /FULL_PATH_TO_YOUR_MAGENTO2where “FULL_PATH_TO_YOUR_MAGENTO2” is the path to your Magento 2 folder on your server.
Step 3. Add the Plumrocket repository to your Composer configurations
composer config repositories.plumrocket-module-prnewsletterpopup composer https://USERNAME:PASSWORD@plumrocket.com/repo/where “USERNAME” and “PASSWORD” are your unique Authentication Credentials.
Step 4. Download Plumrocket extension files
composer require plumrocket/module-prnewsletterpopupAfter running this command, you may be prompted to enter the username and password. Use the Authentication Credentials copied from the popup before.
Step 5. Install database and static resources
php bin/magento cache:flush
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deployAfter running these commands, the extension should be installed successfully. A similar message should be displayed in your console as shown below:
Step 5. Set the serial key
Step-by-step guide:
- Navigate to your Magento 2 Admin Panel and click on the “Plumrocket” tab.
- If there is the “Newsletter Popup” tab in the list, it means that the extension has been successfully installed.
- Navigate to the “Newsletter Popup” -> select the “Configuration” option.
- Your Serial Key field should be auto-filled with the green checkmark displayed. This means that the Serial Key has been successfully activated and the extension can be enabled. However, if the green checkmark is not there – you will need to enter your product Serial Key manually. Please follow the License Installation for Magento 2 instructions for more information.
Next Step > Magento 2 Newsletter Popup v4.x Configuration
Extension Installation via FTP
Step 1. Download and unzip the extension files
Detailed description:
- Log into your account at https://plumrocket.com.
- Select “My Account” in the menu. (To open this page, you have to log in first)
- Navigate to “My Downloads” in the menu.
- Press on the “Download” link to download the latest version of your Plumrocket Magento 2 extension.
Unzip the Magento 2 Newsletter Popup extension’s files and proceed to the next step.
Step 2. Upload files to the server
To upload files to the server, you may use any FTP-client. To show you how it works we used the FileZilla FTP-client.
Step-by-step guide:
- This is your client side. You will see the unpacked catalog containing the Newsletter Popup Extension.
- This is your root directory on the server side. This is where the files should be uploaded.
- All the files have to be uploaded to the server. Select the files and press the right mouse button.
- Select the “Upload” option for these files.
Step 3. SSH Installation
1. In the terminal, switch to your Magento 2 root directory:
cd /FULL_PATH_TO_YOUR_MAGENTO2where “FULL_PATH_TO_YOUR_MAGENTO2” is the path to your Magento 2 folder on your server.
2. Update database and static resources:
php bin/magento cache:flush
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deployAfter running these commands, the extension should be installed successfully. A similar message should be displayed in your console as displayed below:
Step 4. Set the serial key
Step-by-step guide:
- Navigate to your Magento 2 Admin Panel and click on the “Plumrocket” tab.
- If there is the “Newsletter Popup” tab in the list, it means that the extension has been successfully installed.
- Navigate to the “Newsletter Popup” -> select the “Configuration” option.
- Your Serial Key field should be auto-filled with the green checkmark displayed. This means that the Serial Key has been successfully activated and the extension can be enabled. However, if the green checkmark is not there – you will need to enter your product Serial Key manually. Please follow the License Installation for Magento 2 instructions for more information.
Next Step > Magento 2 Newsletter Popup v4.x Configuration