How to integrate LiteMage into Magento v2

Knowledgebase Article

How to integrate LiteMage into Magento v2

LiteMage Cache is the world's fastest full page cache for Magento.

Built on top of LSCache and designed specifically for Magento, LiteMage can assemble both public and private blocks from cache by hole-punching through ESI to deliver the fastest full-page caching around.

Prerequisites:

Magento 2 requires PHP 7, memory limit to be set to 756M or more and the LiteMage requires PHP extension ZIP.

You can use the PHP Selector tool and easily make the adjustments:

Before you start, make sure that any full page cache extension/module is disabled.

If you are using Magento Enterprise, you must also disable “Page Cache”.

Note: This guides assumes that you have experience with unix shell (SSH), Magento, since version 2, recommends Composer to install packages.

Please contact support if you need assistance to proceed with the steps below.

Installing LiteMage 2 - the LiteMage extension for Magento 2

This tutorial assume that the Prerequisites mentioned above have been met.

If the current deploy mode is set to “default” instead of “production”, you can install LiteMage 2 without changing it to “production”. If the current deploy mode is set to “production”, you will have to set the deploy mode to “developer” before installation and change it back to “production” once installation is complete.

You can do so with command:

php bin/magento deploy:mode:set developer

The easiest way to install LiteMage 2 is with the use of composer:

composer require litespeed/module-litemage

This will download the LiteMage 2 package from packagist.org and install it into directory: vendor/litespeed.

It will need your username(public key) and password(private key) authentication for repo.magento.com

Step 1) Enable LiteMage 2 in Magento with command:

php bin/magento module:enable Litespeed_Litemage

Step 2) Upgrade Magento's setup with command:

php bin/magento setup:upgrade

Step 3) Recompile using the signal-tenant/multi-tenant compiler.

The single-tenant compiler has some known issues in earlier versions of Magento. If you are running Magento 2.0.6 or later AND have one Magento store, please run:

php bin/magento setup:di:compile

If you are running Magento 2.0.5 or earlier OR have multiple Magento stores, Please run:

php bin/magento setup:di:compile-multi-tenan

If desired, You may now switch your deploy mode back to “production” with the following command:

php bin/magento deploy:mode:set production

You can now disable maintenance mode with the command:

php bin/magento maintenance:disable

Enable LiteMage After Installation

Step 1) Add the following code in the .htaccess file under Magento root folder to enable LiteMage module:

LiteMage on

</IfModule>

Step 2) Log in to the Magento admin page.

In Store >> Configuration >> Advanced >> System, make sure LiteMage is enabled and selected under the “Full Page Cache” setting. If not, select it and Save Config.

Testing!

To ensure that LiteMage is working correctly, visit a page that should be cache enabled and open your browser's inspector by right clicking the page and selecting “inspect”.

Then select the “Network” tab and refresh the page.

Now select the item from the list corresponding to your current HTML page (usually the first item ending in .html).

Under “Headers”, check the response header for the following LiteMage related info.

X-LiteSpeed-Cache: hit,litemage

If you see X-LiteSpeed-Cache: miss,litemage, please refresh the page and check again.

Should you need any further assistance, please do not hesitate to contact us.