This is an old revision of the document!

LSCache Plugin for XenForo 2

This guide is intended for XenForo 2.x users. For XenForo 1.x installation instructions click here.

  1. Disable any other page caches as these will interfere with LSCXF2.
  2. Access the server hosting your XenForo installation, either directly or using ssh/sftp.
  3. From the unzipped LSCXF2 folder, copy all files under upload to the root directory of your XenForo 2 installation.
  4. In the XenForo control panel, navigate to the Add-ons section to complete the installation.

Once you have downloaded and installed the plugin package, edit the .htaccess file in the XenForo root directory and add the code shown below to the top, making the following changes where appropriate:

  • The default cookie prefix set for XenForo is xf_, so all cookies set by xenForo will begin with this prefix (xf_user, xf_session_admin, etc). If you have changed the cookie prefix in the XenForo configuration file, please make sure to update all xf_COOKIE_NAME cookies in the rewrite rules below to use the correct prefix. For example, if your set cookie prefix is myXF_ you would update xf_user to myXF_user and so on.
  • If you want to cache for more or less than 360 seconds, change 360 to the number of seconds you wish. (Recommended < 10 minutes):
  • Note: Ensure that this code is added before any rewrite rules containing the [L] flag which could stop .htaccess processing and prevent the code from being executed.
# LiteSpeed XenForo cache
<IfModule litespeed>
    CacheLookup public on
    RewriteEngine On
    # cache
    RewriteCond %{HTTP_COOKIE} !(xf_lscxf_logged_in|xf_user|xf_session_admin) [NC]
    RewriteCond %{REQUEST_URI} !/install/ [NC]
    RewriteRule .* - [E=Cache-Control:max-age=360]
    # no cache
    RewriteCond %{HTTP_COOKIE} (xf_lscxf_logged_in|xf_user|xf_session_admin) [NC]
    RewriteRule .* - [E=Cache-Control:vary=loggedin,E=Cache-Control:no-cache]
  • TTL in LSCXF2 is currently controlled by rewrite rules. There is currently no tag-based purge available (though, we are working on it for the future). 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.
  • Only non-logged-in users are served from cache.
  • LSCXF2 is developed specifically for XenForo 2.x. If you are running a XenForo 1.x forum, please use LSCache for XenForo 1.
  • Admin
  • Last modified: 2020/02/17 20:03
  • by Michael Alegre