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_Report Mirasvit_Helpdesk Mirasvit_HelpdeskGraphQl

  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

GraphQl​

The Mirasvit_HelpdeskGraphQl module ships with the extension and is enabled by the command above, so there is nothing extra to install. It provides the mstHelpdeskTickets, mstHelpdeskStatuses, mstHelpdeskPriorities, mstHelpdeskDepartments and mstHelpdeskCustomFields queries and the create-ticket, add-message and close-ticket mutations used by headless and PWA storefronts. See GraphQL API.

Note

Until version 1.7.0 this was a separate package, mirasvit/module-helpdesk-graph-ql. If it is still installed on your store, upgrading the extension removes it by itself. 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: the contact button and popup, the Contact Us form, the customer's tickets and the satisfaction pages are part of the extension itself. On a Luma store the Hyvä part stays dormant. Rebuild the theme once after installation so its styles cover the Help Desk templates:

  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

    On a theme older than Hyvä 1.4, run npm run build-prod instead.

  3. Deploy static view files and flush the cache:

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

Until version 1.7.0 Hyvä support was a separate package, mirasvit/module-helpdesk-hyva, providing the Hyva_MirasvitHelpdesk module. Both are gone. If the package is still installed on your store, upgrading the extension removes it by itself. 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.