Installing the Magento 2 ShipperHQ Extension

Overview

Please follow these steps to install your extension. These installation instructions provide comprehensive installation guidance. If you do not follow these steps as indicated you may well see issues with your install, which may take some time to resolve. So please follow each step carefully and if the install fails re-check the steps.

Presumptions

We assume you understand Magento 2, and have it installed correctly.

It is highly recommended to backup your server files and database before installing this module. No responsibility can be taken for any adverse effects it may cause. It is also recommended you install on a test server initially to carry out your own testing.

Also make sure your [M2instanceRootDirectory]/vendor/ directory is writable or you will get a message stating module-shipper or module-logger “does not exist and could not be created.

Installation Process

Clean Install

  1. Run the following commands from your root Magento installation directory:
    composer require shipperhq/module-shipper
    composer require shipperhq/module-logger
    composer update shipperhq/*
    php bin/magento setup:upgrade
  2. Flush & Re-enable the cache if required
  3. Remove generated file content by deleting contents of:
    var/view_preprocessed
    pub/static/frontend/ 
    pub/static/_requirejs/
    pub/static/adminhtml/
    var/generation
    var/cache
    var/page_cache
  4. If you are in default or production mode, you will need to recompile your code bin/magento setup:di:compile

Updating Existing Installation

Run from your root Magento directory.

  1. Update the extension:
    composer update shipperhq/*
    bin/magento setup:upgrade
  2. Flush the cache
  3. Remove generated file content by deleting contents of:
    var/view_preprocessed
    pub/static/frontend/
    pub/static/adminhtml/
    pub/static/_requirejs/
    var/generation
    var/cache
    var/page_cache
  4. If you are in default or production mode, you will need to recompile your code bin/magento setup:di:compile
  5. This would also be a good time to Synchronize your ShipperHQ with M2 so go ahead and take care of that in Sales > Configuration > Shipping Methods  > Synchronize ShipperHQ near the top of the shipping method.

Specify a Specific Version of ShipperHQ

Run from your root Magento directory.

  1. Specify the version you wish to install or upgrade to using command
    composer require shipperhq/module-shipper:20.0.*
    bin/magento setup:upgrade
  2. Flush the cache
  3. Remove generated file content by deleting contents of:
    var/view_preprocessed
    pub/static/frontend/
    pub/static/adminhtml/
    pub/static/_requirejs/
    var/generation
    var/cache
    var/page_cache
  4. If you are in default or production mode, you will need to recompile your code bin/magento setup:di:compile
  5. This would also be a good time to Synchronize your ShipperHQ with M2 so go ahead and take care of that in Sales > Configuration > Shipping Methods  > Synchronize ShipperHQ near the top of the shipping method.

Manual Installation

Please note that we recommend the use of Composer (as above), as per Magento 2 standards.

  1. Download the ZIP from the ZIP directory of the Github repo: https://github.com/shipperhq/module-shipper
  2. Extract the contents of the ZIP to the root of your Magento directory. This will merge into the app directory.
  3. Enable the modules using: php bin/magento module:enable ShipperHQ_Shipper ShipperHQ_Logger ShipperHQ_Common
  4. Update Magento with: php bin/magento setup:upgrade
  5. Clear cache and re-compile

WebShopApps MatrixRate Installation

Please see the MatrixRate Installation guide.

Post-Installation Steps

In order to successfully connect your Magento eCommerce site to ShipperHQ you’ll need to configure your website in ShipperHQ. The final step is to configure the ShipperHQ Magento extension.