Installation

Before installing and activating LSCJoomla, deactivate all other full-page cache plugins, including "System - Page Cache" and "JotCache."

Tip

You can still use other types of cache (like object cache), but only one page cache can be used at a time, so you’ll need to disable any other page caches, if you want to use LSCache.

Tip

To avoid a potential conflict with LiteSpeed Web Server, you may want to keep Joomla!'s gzip function Off. You'll find this setting in System > Global Configuration > Server > Gzip Page Compression.

Requirements

LiteSpeed Cache for Joomla! requires:

  • Joomla! 3.x or later
  • Either LiteSpeed Web Server Enterprise 5.2.3 or later, or OpenLiteSpeed 1.4 or later

Note

Enterprise edition is required in order to use the ESI feature. ESI will be disabled with OpenLiteSpeed.

Server Configuration

Modify the .htaccess file in the Joomla! site directory, and add the following directives:

<IfModule LiteSpeed>
    CacheLookup on
</IfModule>

If your Joomla! site has a separate mobile view, please also add the following:

<IfModule LiteSpeed>
    RewriteEngine On
    RewriteCond %{HTTP_USER_AGENT} Mobile|Android|Silk/|Kindle|BlackBerry|Opera\ Mini|Opera\ Mobi [NC]
    RewriteRule .* - [E=Cache-Control:vary=ismobile]
    RewriteCond %{REQUEST_URI} enquiry [NC]
    RewriteRule .* - [E=Cache-Control:no-cache]
</IfModule>

Plugin Installation

Download the LSCache for Joomla! package from our site.

From the Joomla! Administration menu, navigate to Extensions > Manage > Install.

!

Select the Upload Package File tab, and drag the zip file into the window, or press the button to browse for the file.

!

The plugin will be automatically installed and enabled.

Verify the Plugin is Enabled

Navigate to Extensions > Plugins. If you have a lot of plugins listed, type LiteSpeed into the search box to bring up the LiteSpeed Cache Plugin.

!

Look for the green check mark next to the plugin name. This indicates that the plugin is installed and enabled. If you see a red X instead, click the red X to enable the plugin. Once you’ve done that, the green check mark should appear, and you are good to go.

If you wish to disable the plugin in the future, you may click the green check mark to toggle it back to the red X.

Verify Your Site is Being Cached

You can verify a page is being served from LSCJoomla through the following steps:

  1. Open the browser developer tools and navigate to your site. Open the Network tab.
  2. Refresh the page.
  3. Click the first resource (this should be an HTML file and the resource's headers should appear as in the image below). For example, if your page is http://example.com/joomla/, your first resource should either be something like example.com/joomla/ or joomla/.
    !
  4. If you see headings similar to
    X-LiteSpeed-Cache: miss
    X-LiteSpeed-Cache-Control:public,max-age=1800
    X-LiteSpeed-Tag:B1_F,B1_ 
    
    (for example), this means the page had not yet been cached, but that LiteSpeed has now stored it for future use.
  5. Reload the page and you should see X-LiteSpeed-Cache: hit in the response header. This means the page is being served by the cache and LSCJoomla is configured correctly.

Last update: July 14, 2020