How to install Hyva compatibility modules

Hyvä Theme is a popular frontend solution for Magento 2, designed to enhance the performance and user experience of Magento stores. It relies on compatibility modules to integrate seamlessly with existing Magento 2 extensions.

Follow a detailed instruction guide below to ensure the proper integration of Hyvä with Magento modules you want to install in your store.

1. Prerequisites

  • Magento 2 Installation: Ensure you have a Magento 2 installation compatible with Hyvä Themes. You should have Magento 2.4.x and above, but it's always recommended to use the latest version for security and performance reasons.
  • Access to Server: You should have SSH access to your server and user rights to execute commands.
  • Composer: Magento 2 and Hyvä use Composer for dependency management. Ensure Composer is installed and accessible on your Magento installation. Additionally, check if the PHP version is 7.4, 8.1 or 8.2.

Note: Backup your Magento installation

Before making any changes to your Magento 2 installation, it's crucial to create a backup of your system, including the database and files. This ensures you can easily revert to a stable state if anything goes wrong during the installation process.

Read on how to do a Magento backup.

2. Navigate to Magento root directory

Connect to your Magento server via an SSH and change your current directory to the root of your Magento 2 installation with the following :

cd /path/to/your/magento2

Activate Maintenance Mode:

php bin/magento maintenance:enable

This command will put your Magento store into maintenance mode, displaying a maintenance page to visitors.

After completing compatibility module installation verify that everything is working correctly, and disable maintenance mode to allow users back onto the store:

php bin/magento maintenance:disable

3. Check your Hyvä Theme

Before installing compatibility modules, you must have Hyvä Theme installed and have a valid licence. Follow these steps:

  • Check the Hyvä licence key is present in the auth.json file in your Magento folder. If necessary, add the licence key to auth.json with the following commands. Replace yourLicenseAuthentificationKey and yourProjectName with the key you have obtained and your project name respectively:

    composer config --auth token yourLicenseAuthentificationKey
    composer config repositories.private-packagist composer
    • Add Hyvä repository. Use Composer to add the Hyvä Theme repository to your Magento project:
    composer config repositories.private-packagist composer

3. Identify required compatibility modules

Refer to the documentation of third-party extensions you are using to know which of them require compatibility modules.

Hyvä Themes provide compatibility for various popular extensions, but you need to check for each extension specifically.

Mirasvit modules compatibility with Hyvä

Magento Module Composer name for Hyvä compatibility module Hyvä compatibility module install reference
Advanced SEO Suite for Magento 2 composer require hyva-themes/magento2-mirasvit-seo Advanced SEO Suite Hyvä installation manual
Affiliate for Magento 2 composer require hyva-themes/magento2-mirasvit-affiliate Affiliate Hyvä installation manual
Automatic Related Products for Magento 2 composer require hyva-themes/magento2-mirasvit-related:* Automatic Related Products Hyvä installation manual
Blog MX for Magento 2 composer require mirasvit/module-blog-mx-hyva:* Blog MX Hyvä installation manual
Custom Form Builder for Magento 2 composer require mirasvit/module-form-builder-hyva:* Custom Form Builder Hyvä installation manual
Full Page Cache Warmer for Magento 2 composer require mirasvit/module-cache-warmer-hyva:* Full Page Cache Warmer Hyvä installation manual
GDPR for Magento 2 composer require mirasvit/module-gdpr-hyva GDPR Hyvä installation manual
Google Tag Manager for Magento 2 composer require mirasvit/module-gtm-hyva:* Google Tag Manager Hyvä installation manual
Help Desk MX for Magento 2 composer require hyva-themes/magento2-mirasvit-helpdesk Help Desk MX Hyvä installation manual
Layered Navigation for Magento 2 composer require mirasvit/module-navigation-hyva:* Layered Navigation Hyvä installation manual
Product Attachments for Magento 2 composer require hyva-themes/magento2-mirasvit-attachment Product Attachments Hyvä installation manual
Product Labels for Magento 2 composer require hyva-themes/magento2-mirasvit-catalog-label Product Labels Hyvä installation manual
Promo Banners for Magento 2 composer require hyva-themes/magento2-mirasvit-banner Promo Banners Hyvä installation manual
Reward Points + Referral program for Magento 2 composer require mirasvit/module-rewards-hyva:* Reward Points + Referral program Hyvä installation manual
RMA for Magento 2 composer require mirasvit/module-rma-hyva:* RMA Hyvä installation manual
Search Ultimate for Magento 2 composer require hyva-themes/magento2-mirasvit-search-autocomplete Search Ultimate Hyvä installation manual
Store Credit & Refund for Magento 2 composer require mirasvit/module-credit-hyva:* Store Credit & Refund Hyvä installation manual
FAQ Module & Knowledge Base Extension composer require mirasvit/module-kb-hyva:* FAQ Module & Knowledge Base Hyvä installation manual

4. Install compatibility module

Once you've identified the required compatibility modules, you can install them. Depending on how the compatibility module is distributed, you can use Composer or manually upload the files.

Using Composer

Most Hyvä compatibility modules can be installed via Composer. For each module, follow these steps:

Use Composer to require the compatibility module. The command might look like this:

composer require hyva-themes/hyva-compatibility-magento2-module-name

Replace hyva-compatibility-magento2-module-name with the actual name of the compatibility module you're installing.

Installing compatibility module manually

If the module is not available via Composer, you may need to download its files manually from the source (for example, a GitHub repository). Upload the module files to the appropriate directories in your Magento installation.

5. Enable the Module

After installation, enable the module and run the setup upgrade process:

bin/magento module:enable VendorName_ModuleName 

bin/magento setup:upgrade

bin/magento cache:clean

Replace VendorName and ModuleName with the actual vendor and module name.

Execute the php bin/magento module:status to get the list of all modules installed in your store. In the Disabled section locate newly installed module with its name formatted as VendorName_ModuleName.

6. Test for problems

After installing the compatibility module, thoroughly test your site, focusing on the functionality related to the compatibility module of the Magento extension. Ensure that there are no conflicts and that performance meets your expectations.

If you encounter issues during installation or after installing a compatibility module, consult the documentation for the module, seek support from module developer or Hyvä Theme developer.