Skip to main content

Installing the extension

Use these steps to install the extension on your store.

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 your Magento 2 store.
  3. Copy the installation instructions from the My Downloadable Products page and paste them into the SSH console. Press ENTER to proceed.

Execute the following commands to install the extension​

  1. Run the following command to enable the extension:

    php -f bin/magento module:enable Mirasvit_Core Mirasvit_Kb

  2. Run the following command to install the extension:

    php -f bin/magento setup:upgrade

  3. Compile the code for the installed extensions:

    php -f bin/magento setup:di:compile

  4. Clear the cache:

    php -f bin/magento cache:clean

  5. Deploy static view files:

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

GraphQl​

The Mirasvit_KbGraphQl module ships with the extension and is enabled by the command above, so there is nothing extra to install. It provides the knowledgeBaseArticles, knowledgeBaseCategories, and knowledgeBaseComments queries used by headless and PWA storefronts.

Note

Until version 1.3.0 this was a separate package, mirasvit/module-kb-graph-ql. If it is still installed on your store, remove it before upgrading. See How to upgrade the extension.

If you are using the Hyvä theme​

Hyvä support ships with the extension, so there is no compatibility module to install. On a Luma store the Hyvä part stays dormant. The extension carries its own Tailwind styles, so the theme has to be rebuilt once after installation.

  1. Register the extension with the Hyvä build:

    bin/magento hyva:config:generate

  2. Rebuild the theme assets:

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

  3. Deploy static view files:

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

  4. Flush the cache:

    bin/magento cache:flush
warning

Skipping the Tailwind rebuild leaves the Knowledge Base pages unstyled. The theme keeps serving the styles.css it was built with, and that file knows nothing about the classes this extension adds.

Note

Until version 1.3.0 Hyvä support was a separate package, mirasvit/module-kb-hyva, providing the Hyva_MirasvitKb module. Both are gone. If the package is still installed on your store, remove it before upgrading. See How to upgrade the extension.

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