README

Description

The LiteMage Cache module provides an improved caching solution alternative to the PageCache module and Varnish Cache. The module will replace the Varnish option to the cache selector in the administrator interface for easy switching.

For most use cases, LiteMage Cache can improve your stores' performance right out of the box. LiteMage Cache also reduces the complexity of your stack; only the LiteMage Extension and LiteSpeed Web Server are required*. There is no need for an NGINX reverse proxy nor a Varnish Cache instance because the server can handle HTTPS and HTTP/2 requests and cache the pages all in one application.

LiteMage Cache operates by taking information from Magento and instructing the LiteSpeed server on how to cache the page. Once the server knows how to cache it, future requests to the same page will be served directly from the server. Requests will never hit the Magento backend until a change occurs.

* For clustered setups, LiteSpeed Load Balancer is needed.

Prerequisites

LiteSpeed Web Server Enterprise Edition with Magento 2 set up and working.

Installation

The following steps assume that the Prerequisites mentioned above are met.

1. Access a terminal as the Magento directory owner (e.g. "user1") and cd to the Magento 2 root directory. If logged in as root, do su user1 first.

2. Set the store to developer mode:

   php bin/magento deploy:mode:set developer
   

3. Download the zip package file from this repository.

4. Unzip the source package. The unzipped directory should be named magento2-LiteSpeed_LiteMage-master.

5. In the Magento 2 root directory, run the following command to create the needed directories:

   mkdir -p app/code/Litespeed/Litemage
   

6. Move the contents from the GitHub directory to the newly created directory:

   mv /path/to/magento2-LiteSpeed_LiteMage-master/* app/code/Litespeed/Litemage/
   

7. Confirm that the contents' owner is consistent with the other magento store files.

8. Enable LiteMage 2 in magento:

   php bin/magento module:enable Litespeed_Litemage
   

9. Upgrade the Magento setup:

   php bin/magento setup:upgrade
   

10. Recompile code

    php bin/magento setup:di:compile
    

11. If desired, switch back to production mode. The previous step may need to be repeated after the mode switch.

Enable LiteMage after installation:

1. In the Magento 2 root directory's .htaccess file, add the following lines:

   <IfModule LiteSpeed>
   LiteMage on
   </IfModule>
   

2. Log into the Magento admin page.

3. In Store -> Configuration -> Advanced -> System, make sure LiteMage is enabled and the Full Page Cache setting has LiteMage selected.

4. In System -> Cache Management, refresh configurations and page cache.

5. Visit and refresh a page that should be cache enabled. Look for the LiteMage related response headers.

   Example:

   X-LiteSpeed-Cache: litemage,hit
   

Configuration

No further changes to your Magento 2 configurations should be necessary as LiteMage honors the same cacheable settings as varnish in the layout xml files.