Skip to main content

Installing the extension

Follow these steps to install the extension on your store. You can proceed in two ways: via composer or by uploading the files directly.

warning

Please note that these instructions are valid for Magento 2.4 only. For installing the extension on an earlier version of Magento, please follow:

Prepare for installation​

  1. Back up your store's database and web directory.

  2. Log in to the SSH console of your server and navigate to the root directory of the Magento 2 store.

  3. Take the installation instructions:

    1. To install extension via composer copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.

    2. To manually install the module in the app/code/ directory, download the archive from My Downloadable Products, extract it, and copy the contents to the Magento root directory. Next, access your server via SSH, navigate to the Magento 2 root directory, and follow the installation steps.

    3. If you bought the extension in the Magento Marketplace, run the command in your store's root folder:

      composer require mirasvit/module-search-ultimate

Execute the following set of commands to install​

We recommend this installation method because the composer automatically checks and installs the necessary dependencies, and it is also much easier to keep the extension up-to-date.

  1. Run the following command to enable the extension:

    php -f bin/magento module:enable Mirasvit_Core Mirasvit_Search Mirasvit_SearchGraphQl Mirasvit_SearchUltimate Mirasvit_SearchMysql Mirasvit_SearchElastic Mirasvit_SearchSphinx Mirasvit_SearchAutocomplete Mirasvit_Misspell Mirasvit_SearchLanding Mirasvit_Report Mirasvit_SearchReport

  2. Run the following command to install the extension:

    php -f bin/magento setup:upgrade

  3. Clear the cache:

    php -f bin/magento cache:clean

  4. Deploy static view files:

    rm -rf pub/static/*
    rm -rf var/view_preprocessed/*
    php -f bin/magento setup:static-content:deploy

  5. Reindex the search index and the spell-correction index

    php -f bin/magento indexer:reindex catalogsearch_fulltext mst_misspell

After the installation is complete, perform the basic configuration of the extension.

If you are using the Hyvä theme, install the compatibility module​

  1. Install the Hyvä compatibility module with the command:

    composer require mirasvit/module-search-ultimate-hyva

  2. Enable the installed Hyvä modules:

    php -f bin/magento module:enable Hyva_MirasvitSearch Hyva_MirasvitSearchAutocomplete Hyva_MirasvitMisspell

  3. Update the Magento database schema and data:

    php -f bin/magento setup:upgrade

  4. Compile the code for the installed extension:

    php -f bin/magento setup:di:compile

  5. Check the file app/etc/hyva-themes.json. If there are no entries for the mirasvit/module-search-ultimate-hyva package, run the following command:

    php -f bin/magento hyva:config:generate

  6. Generate the styles for the installed extension:

    cd /path/to/theme/web/tailwind/;
    npm run build-prod

  7. Deploy the static view files:

    cd /path/to/project/;
    rm -rf pub/static/*; rm -rf var/view_preprocessed/*;
    php -f bin/magento setup:static-content:deploy

  8. Clear the cache:

    php -f bin/magento cache:clean

If you want to upgrade the extension, please refer to the How to upgrade extension section. To temporarily disable or remove it, use the commands from the How to disabling extension section.