Magento 2 mirasvit/module-seo-report

Welcome to the SEO Monitoring & Reports Guide!

Here you will find everything you need to set up the extension.

First, Please find your extension in My account / My Downloadable Products / View & Download. Then, start with the section titled: Installation. It is best to follow our guide step-by-step to configure the extension.

Go ahead, dive in!

Learn about Initial extension's setup:

Welcome to the SEO Monitoring & Reports Guide!

Here you will find everything you need to set up the extension.

First, Please find your extension in My account / My Downloadable Products / View & Download. Then, start with the section titled: Installation. It is best to follow our guide step-by-step to configure the extension.

Go ahead, dive in!

Learn about Initial extension's setup:

Installation

In this article you will find two possible ways of our extension's installation.

Installation via composer (preferably)

We recommend this installation method because Composer doesn't allow to overwrite files.

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products / View & Download to the SSH console.
  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_SeoReport Mirasvit_Dashboard to enable the extension.
  5. Run command php -f bin/magento setup:upgrade to install the extension.
  6. Run command php -f bin/magento cache:clean to clean the cache.
  7. Deploy static view files
    rm -rf pub/static/*
    rm -rf var/view_preprocessed/*
    php -f bin/magento setup:static-content:deploy

Installation via direct file upload

You can also install the extension via direct files uploading.

  1. Go to My Downloadable Products / View & Download
  2. Unpack .zip package and copy contents to magento root directory
  3. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_SeoReport Mirasvit_Core Mirasvit_Dashboard to enable the extension.
  4. Run command php -f bin/magento setup:upgrade to install the extension.
  5. Run command php -f bin/magento cache:clean to clean the cache.
  6. Deploy static view files
    rm -rf pub/static/*
    rm -rf var/view_preprocessed/*
    php -f bin/magento setup:static-content:deploy

Learn about the initial setup:

Quick Start

As you've successfully completed installation of SEO Monitoring, we will guide you through the main steps required to start efficiently using our extension.

  1. Add own store

    • Go to Marketing / SEO Monitoring / Domains
    • Press Add New Domain and fill all required fields
    • Save new domain
  2. Add keywords

    • After successfully adding webmaster keyfile the keywords
      will be fetched from the Google Search Console automatically.

To initiate fetching process manually after adding the webmaster keyfile just execute commands below:
bin/magento cron:run --group=mst_seo_report_history_update
bin/magento cron:run --group=mst_seo_report_summarize

Extension Upgrading

To upgrade the extension follow these steps:

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
    If extension was installed via:
    • Composer: run command `composer require mirasvit/module-seo-report:* --update-with-dependencies to update current extension with all dependencies.

      Note

      In some cases the command above is not applicable, it's not possible to update just current module, or you just need to upgrade all Mirasvit modules in a bundle. In this case command above will have no effect.

      Run instead composer update mirasvit/* command. It will update all Mirasvit modules, installed on your store.

    • Direct file upload: download new extension package from our store and copy contents to root Magento directory
  3. Run command php -f bin/magento setup:upgrade to install updates.
  4. Deploy static view files rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy
  5. Run command php -f bin/magento cache:clean to clean the cache.

Extension Disabling

Temporarily Disable

To temporarily disable the extension please follow these steps:

  1. Login to the SSH console of your server and navigate the to root directory of the Magento 2 store.
  2. Run the command php -f bin/magento module:disable Mirasvit_Core Mirasvit_SeoReport Mirasvit_Core Mirasvit_Dashboard to disabled the extension.

Remove the Extension

To uninstall the extension please follow these steps:

  1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  2. Disable extension.
  3. Run command composer remove mirasvit/module-seo-report to remove the extension.

Webmaster Key File

To add webmaster key file you need:

  1. Login to your google account.
  2. Visit page https://console.developers.google.com/apis/credentials
  3. Create project
  4. Create creditionals->Service account key
    service_account_key
  5. Save "Service account ID". It will be needed in step 14.
  6. Push "Create"
    creted_key
    Save creted key. It will be needed in step 15.
  7. Enable Search Console API
    search_console_api_0
    search_console_api_0
    search_console_api_0
  8. Add site in webmaster https://www.google.com/webmasters/tools/user-admin
    site_in_webmaster.png
    Change http://www.exaple.com/ at your store.
  9. If site is not verified you'll need verify it.
    verification.png
  10. Visit https://www.google.com/webmasters/tools/user-admin
  11. Push "Add property new"
  12. Chose from "Properties" your store.
  13. Push "Add an owner"
    You can get owner here
    service_account_key
    For our example owner is "Service account ID" ( test-800@active-gasket-172608.iam.gserviceaccount.com )
  14. Push "Continue"
    create_owner
  15. Add downloaded in step 6 "Webmaster Key File" in magento admin panel Stores->Configuration->Seo Reports

Troubleshoot

This section describes the most common problems, that customers report, and how they can be resolved:

Minute, Hourly or Daily updates limit was reached

The SEO Monitoring and Reports extension has a few types of limits. So if you see the notification about reached limits just try to update keyword later.