Installation¶
Before installing and activating the LSCache plugin, deactivate all other full-page cache plugins.
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.
Extension Installation¶
Note
Please see the Overview for the server-level requirements before attempting to install this extension.
- Download LSCMW like so:
wget https://github.com/litespeedtech/lscache_mediawiki/archive/master.zip
- Unzip the downloaded file:
unzip master.zip
- Find the
.htaccess
file in the MediaWiki root directory, or create one if it doesn't exist. Add the following to the file to enable LSCache at the server level:<IfModule LiteSpeed> CacheLookup on </IfModule>
- Move the
LiteSpeedCache
directory to/extensions
in the MediaWiki directory - Edit
LocalSettings.php
in the MediaWiki root directory, and add the following near the end:wfLoadExtension( 'LiteSpeedCache' );
- Log into MediaWiki and from the administrator panel, navigate to Special pages > Data and Tools > LiteSpeed Cache.
- Set LiteSpeed Public Cache Enabled to
checked
and click the Save Cache Setting button.
Verify Your Site is Being Cached¶
You can verify a page is being served from LSCache through the following steps:
- From a non-logged-in browser, navigate to your site, and open the developer tools (usually, right-click > Inspect). Open the Network tab.
- Refresh the page.
- Click the first resource. This should be an HTML file. For example, if your page is
http://example.com/webapp/
, your first resource should either be something likeexample.com/webapp/
orwebapp/
. - You should see headings similar to these: These headings mean the page had not yet been cached, but that LiteSpeed has now stored it, and it will be served from cache with the next request.
X-LiteSpeed-Cache: miss X-LiteSpeed-Cache-Control:public,max-age=1800 X-LiteSpeed-Tag:B1_F,B1_
- Reload the page and you should see
X-LiteSpeed-Cache: hit
in the response header. This means the page is being served by LSCache and is configured correctly.
Alternative Headers
The X-LiteSpeed-Cache
header is most common, but you may see X-LSADC-Cache
if your site is served by LiteSpeed Web ADC. You may also see X-QC-Cache
if your site was served via QUIC.cloud CDN. These alternate headers are also an indication that LSCache is working properly on your site.
Important
If you don't see X-LiteSpeed-Cache: hit
or X-LiteSpeed-Cache: miss
(or any of the alternative headers), then there is a problem with the LSCache configuration.