LiteSpeed Cache for XenForo

Tip

This documentation is for LSCache for XenForo 2, for use only with XenForo 2.x. For XenForo 1.x, 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.

Important

  • LSCXF will only cache and serve pages for non-logged-in users. After a user has logged in, their page requests will always be freshly generated by XenForo.
  • TTL in LSCXF2 is currently controlled by rewrite rules. At this time, there is no tag-based purge available. Because of this, it is recommended that you use a small TTL (less than 10 minutes, or 600 seconds). A small TTL minimizes the chances of serving stale content.

Server-Level Prerequisites

Obtain a LiteSpeed Web Server

You will either need LiteSpeed-powered hosting, or one of the following LiteSpeed server products in order to use LSCache:

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

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: August 22, 2020