Magento User Installation Guide

How to use the SiteSearchApp extension for Magento 2

  1. 1. Go to your SiteSearchApp portal and login with the credentials received. Once logged, you will be redirected to the Magento Dashboard.
  2. 2. Go to Your Project Name > Search App > Configuration, to add certain credentials that are required to connect the app to the site. Insert all the required fields including Host, API Key, and user credentials after.
  3. 3. Adjust CMS Settings to exclude certain pages upon being indexed.
  4. 4. Modify Design Settings to design your search autocomplete container.
  5. 5. Go to Your Project Name > Search App > Indexer to index the site and all the data will be passed on the searchapp, click Manual Index
  6. 6. Cron job is automatically set-up. It will run every 12 midnight.

How to install the SiteSearchApp extension for Magento 2

Installation by copying the code

  1. 1. Download the extension's package from repository https://git.scigsi.com/site-search-app/SearchApp
  2. 2. Use any SSH client to connect to your server. Bear in mind that the user should write permissions to this folder and its subfolders.
  3. 3. Upload all the files and folders from the extension's package to the root Magento folder.
  4. 4. Via SSH, navigate to the root Magento folder and perform the command:
    php bin/magento module:enable SCI_SearchApp
  5. 5. Clear the compiled code and cache:
    php bin/magento setup:upgrade
    php bin/magento cache:flush
    php bin/magento setup:static-content:deploy

Installation Via Composer

  1. 1. Use any SSH client to connect to your server. Navigate to the root Magento folder. Bear in mind that the user should write permissions to this folder and its subfolders.
  2. 2. Perform the command:
    composer require sci5/magento-site-searchapp
  3. 3. Clear the compiled code and the cache:
    php bin/magento setup:upgrade
    php bin/magento cache:flush
    php bin/magento setup:static-content:deploy
  4. 4. To update the extension via composer perform the command:
    composer update sci5/magento-site-searchapp

Installation via Magento Marketplace

Magento 2 provides the possibility to install the extensions via Web Setup Wizard tool in the backend. This is the main method to install the extension purchased on Magento Marketplace website. First of all, please check this article to ensure that all the minimum requirements are met. After that please follow this guide.

  1. 1. Log into your Magento Marketplace account. Click the My Access Keys link on the Developer Portal tab.
  2. 2. Copy both Public Key and Private Key. Note that they are provided on the Magento 2 tab
  3. 3. Log into the Magento backend panel and go to SYSTEM ⟶ Tools ⟶ Web Setup Wizard
  4. 4. Click the Module Manager. Then, click the Sign In link in the upper-right corner. Put the Public Key and Private Key from your Marketplace account.
  5. 5. You need to synchronize your backend with the Marketplace website. For this click the Refresh button. Note that it might take a few minutes. After that you'll be able to observe the number of the purchased extensions close to the Extensions Ready to Install text.
  6. 6. Click the Review and Install button below the Extensions Ready to Install text. In the Extensions Grid, mark the checkbox of the extension you want to install. Please, always use the latest version of the extension (extensions). Click the Install button.
    The installation process has started.
  7. 7. Readiness Check. The store environment is checked for compatibility. When the Readiness Check completes successfully, tap Next button. If you observe some problems here, fix them and click the Try Again button to recheck the compatibility of the Magento installation.
  8. 8. Create Backup. By default, the backup includes the code, media, and database but you can deselect any checkbox of any item that you do not want to include in the backup. Click the Create Backup button. Once this operation has finished, click the Next button.
  9. 9. This page shows the names and the versions of the extensions that are about to be installed. The website will be taken offline to protect your customers during the installations. Click the Install button.
  10. 10. The page shows the current status, and you can track its progress in the Console Log
  11. 11. Log out and in for all the changes to take into effect. Your extension is now ready to use.