LiteMage Cache for Magento

Tip

This documentation is for LiteMage 2, for use only with Magento 2. For LiteMage 1 and Magento 1, please visit our wiki.

What is LSCache?

LiteSpeed Cache (LSCache) is a built-in, high-performance dynamic content acceleration feature of LiteSpeed server products.

LSCache accelerates dynamic content (not just PHP pages), with features very similar to those in Apache mod_cache, using an efficient, highly customizable, native implementation within the LiteSpeed server, which greatly reduces page load time and server load.

LSCache eliminates the extra reverse-proxy layer(s) required by add-on cache packages (such as Varnish), providing faster, more efficient handling of static content in addition to its stellar handling of dynamic content.

Why Use a Plugin?

The LiteSpeed Cache Engine can be controlled through rewrite rules in the .htaccess of a web app's document root. So what do you gain by using an LSCache plugin?

An LSCache plugin bridges the knowledge gap between a web app and the Cache Engine.

Put another way: web apps have rules about what content may be cached, for how long it may be cached, and what events would cause a cache object to become stale. LSCache plugins are a way of communicating these web app rules to the Cache Engine. LSCache plugins allow you to manage the cache in such a way that more objects may be stored for a longer period, and with unparallelled accuracy.

LiteMage Cache is the world's fastest full-page caching solution 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 best performance around.

Obtain a LiteSpeed Web Server

You will need a LiteSpeed Enterprise license with the LiteMage Module, which you can obtain in one of the following ways:

Configure the Server

LSCache must be set up at the server level before it can be made available to any sites on the server.

Tip

If you are a site owner and you don't have access to your server's admin functions, chances are your hosting provider has already done this setup for you, or can help you to complete it.

See Configure Cache Root and Cache Policy for instructions

Understanding LiteMage Tiers

The LiteMage module is available as a purchasable add-on to new and existing LiteSpeed Licenses, and comes in three tiers: Starter, Standard, and Unlimited, based on the number of cached objects you need. The LiteMage Cache extension for Magento is free to download but requires the LiteMage module to work.

A trial license will allow you to experience the ultra-fast LiteMage full page cache for fifteen days. See for yourself how LiteSpeed + LiteMage can save considerable hardware costs while greatly boosting your Magento store's performance.

Please check our LiteMage pricing page for more information.

Counting Public Cache Objects

If your store is not yet up and running, it may be difficult to know how many public cache objects you will need. If you know the following, you can estimate:

  • Number of items for sale, and how many configuration options are available for each
  • Number of languages or currencies supported
  • Whether the store has separate desktop and mobile themes, or a single responsive theme

Example

  • You have 300 items for sale, each with 2 configuration options. That's 300 x 2 = 600.
  • You support 10 languages. 600 x 10 = 6000.
  • You have a responsive theme. 6000 x 1 = 6000.
  • With 6000 cached objects, the Standard Tier would be appropriate for your store.

You will also want to consider that public cache objects are stored based on URL. If your site uses a layered navigation menu for example, each combination of selections from the layered menu will be its own publicly cached object.

Limits and Exceeding Them

The LiteMage Tiers are as follows:

  • Starter, 1500 public cache objects
  • Standard, 25000 public cache objects
  • Unlimited, ∞ public cache objects

For Starter and Standard, once the limits are reached, further public cache objects will not be stored. Your site will still work without any problems, but it will only be partially cached.

Uncached pages will be served by Magento directly. These pages will load more slowly than those that were cached. Overall, your site being partially cached is still much better than having no cache.

For shared hosting servers, limits on LiteMage objects are applied to each domain instead of the whole server. When one domain reaches the limit, the other domains may be still served from cache without issue, unless they reach their own limit.

Install, Configure and Use the Plugin

Once you've set up your web server and configured the cache root and cache policies, you're ready to install the plugin. The plugin will allow you to configure and manage your LiteSpeed server's cache simply and easily, through your site's own familiar admin interface.

Start with Installation and follow the documentation menu to configure and use the plugin.

Additional Support

If you still have a question after reading through the documentation, you have a few options:

Feedback

Do you have some thoughts about our new documentation site? Join our GoLiteSpeed Slack, drop by the #documentation channel, and let us know what you think!


Last update: November 5, 2020