Before installing and activating the LSCache plugin, deactivate all other full-page cache plugins.
You can still use other types of cache (like object cache, or browser cache), but only one full-page cache should be used at a time.
Please see the Overview for the server-level requirements before attempting to install this package.
Require this package using composer.
composer require litespeed/lscache-laravel
Laravel uses Auto-Discovery, so you won't have to make any changes to your application, the two middlewares and facade will be available right from the beginning.
Steps for Laravel >=5.1 and <=5.4¶
The package can be used for Laravel 5.1 to 5.4 as well, however due to lack of Auto-Discovery, a few additional steps have to be performed.
config/app.php you have to add the following code in your
'aliases' => [ ... 'LSCache' => Litespeed\LSCache\LSCache::class, ],
app/Http/Kernel.php you have to add the two middlewares under
protected $middleware = [ ... \Litespeed\LSCache\LSCacheMiddleware::class, \Litespeed\LSCache\LSTagsMiddleware::class, ]; protected $routeMiddleware = [ ... 'lscache' => \Litespeed\LSCache\LSCacheMiddleware::class, 'lstags' => \Litespeed\LSCache\LSTagsMiddleware::class, ];
Copy the package
config/lscache.php file to your
Do not add the ServiceProvider under
Steps for Laravel 5.5 and above¶
You should publish the package configuration, which allows you to set the defaults for the
php artisan vendor:publish --provider="Litespeed\LSCache\LSCacheServiceProvider"
Enable CacheLookup for LiteSpeed Cache¶
To enable CacheLookup for LiteSpeed Cache, you have to include the following code, either on server, vhost or .htaccess level:
<IfModule LiteSpeed> CacheLookup on </IfModule>
Verify Your Site is Being Cached¶
See a video demonstration of this topic here.
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 like
- 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: hitin the response header. This means the page is being served by LSCache and is configured correctly.
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.
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.
Sometimes there are pages which should not be cached. To verify that such pages have indeed been excluded from caching, check the developer tools as described above.
You should see headings similar to these:
X-LiteSpeed-Cache-Control:no-cache, esi=on X-LiteSpeed-Tag:B1_F,B1_
X-LiteSpeed-Cache-Control, when set to
no-cache, indicates that LiteSpeed Server has served your page dynamically, and that it was intentionally not served from cache.
LSCache Check Tool¶
There's a simple way to see if a URL is cached by LiteSpeed: the LSCache Check Tool.
Enter the URL you wish to check, and the tool will respond with an easy-to-read Yes or No result, and a display of the URL's response headers, in case you want to examine the results more closely.
In addition to LSCache support, the tool can detect cache hits, and can detect when sites are using LiteSpeed Web ADC or QUIC.cloud CDN for caching.
Additionally, a Stale Cache Warning will alert you if browser cache is detected on dynamic pages. This is because browser cache may interfere with the delivery of fresh content.