Here you will learn how to correctly install the Magento 2 Layered Navigation 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 our Improved Navigation for Magento 2. 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 Information:
If you are planning to use the Magento 2 Layered Navigation Pro extension on the Hyvä theme, please be aware that only the Composer installation method is compatible. Please follow the installation guide below.
Extension Installation via Composer
In order to install your Magento 2 Layered Navigation extension via Composer, open the console (SSH terminal) and follow the steps:
Step 1. Switch to your Magento 2 root directory in the terminal
cd /FULL_PATH_TO_YOUR_MAGENTO2
where “FULL_PATH_TO_YOUR_MAGENTO2” is the path to your Magento 2 folder on your server.
Step 2. Add the Plumrocket repository to your Composer configurations
composer config repositories.plumrocket composer https://plumrocket.com/repo/
Step 3. Download Plumrocket extension files
composer require plumrocket/module-productfilter
After running this command, you will be required to enter the username and password (see the How to Get Plumrocket Composer Repository Keys user guide).
Step 4. 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:deploy
After 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 “Layered Navigation Pro” tab in the list, it means that the extension has been successfully installed.
- Navigate to the “Layered Navigation Pro” -> 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.
Step 6. Hyvä Compatibility Extension Installation
If you are planning to use the Magento 2 Layered Navigation Pro extension on the Hyvä theme, it is required to install the additional Hyvä Compatibility extension, which is available for free on Hyvä GitLab. It ensures seamless integration of the Layered Navigation Pro extension with Hyvä and helps you avoid compatibility issues.
Step-by-step guide:
- Log in to the gitlab.hyva.io
- Follow the Hyva Compatibility extension installation guide for Magento 2 Layered Navigation Pro extension. You can choose between two installation methods: via Packagist.com or GitLab.
Next Step > Magento Layered Navigation Pro v4.x Configuration
Extension Installation via FTP
Step 1. Download and Unzip the Extension Files
Step-by-step guide:
- Log into your account at https://plumrocket.com.
- Go to “My Account” in the menu.
- Navigate to “My Downloads”.
- Click the “Download” link to download the latest version of your Plumrocket Magento 2 extension.
- Unzip the Magento 2 Layered Navigation Pro extension files and proceed to the next step.
Step 2. Upload files to the Server
Use any FTP client to upload files to the server using any FTP client. We used the FileZilla FTP client in this guide to show you how it works.
Step-by-step guide:
- This is your client side. You will see the unpacked catalog containing the Layered Navigation Pro 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 right-click.
- Select the “Upload” option for these files.
Step 3. Install the Extension Using SSH Terminal
At this point, SSH access to your webserver is required.
Note: In case you do not have SSH access, you can install the Plumrocket extension using Web installation method.
- In the terminal, switch to your Magento 2 root directory using the following command:
cd /FULL_PATH_TO_YOUR_MAGENTO2
where “FULL_PATH_TO_YOUR_MAGENTO2” is the path to your Magento 2 folder on your server.
- Run the next five Magento 2 commands:
php bin/magento cache:flush
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex pr_productfilter_custom_option catalogsearch_fulltext
After running these commands, the extension should be installed successfully. A similar message should be displayed in your console as displayed below:
Step 4. Set a Serial Key
Step-by-step guide:
- Navigate to your Magento 2 Admin Panel and click on the “Plumrocket” tab.
- If there is the “Layered Navigation Pro” tab in the list, it means that the extension has been successfully installed.
- Navigate to the “Layered Navigation Pro” -> 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 Layered Navigation Pro v4.x Configuration