# 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.

## Package Installation¶

Note

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.

In config/app.php you have to add the following code in your aliases:

'aliases' => [
...
'LSCache'   => Litespeed\LSCache\LSCache::class,
],


In app/Http/Kernel.php you have to add the two middlewares under middleware and routeMiddleware:

protected $middleware = [ ... \Litespeed\LSCache\LSCacheMiddleware::class, \Litespeed\LSCache\LSTagsMiddleware::class, ]; protected$routeMiddleware = [
...
'lscache' => \Litespeed\LSCache\LSCacheMiddleware::class,
'lstags' => \Litespeed\LSCache\LSTagsMiddleware::class,
];


Copy lscache.php to config/:

Copy the package config/lscache.php file to your config/ directory.

Important

Do not add the ServiceProvider under providers in config/app.php.

### Steps for Laravel 5.5 and above¶

You should publish the package configuration, which allows you to set the defaults for the X-LiteSpeed-Cache-Control header:

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¶

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

1. From a non-logged-in browser, open the 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. For example, if your page is http://example.com/webapp/, your first resource should either be something like example.com/webapp/ or webapp/.
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 LSCache and is configured correctly.
6. If you don't see X-LiteSpeed-Cache: hit or X-LiteSpeed-Cache: miss, then there is a problem with the LSCache configuration.

Last update: August 29, 2020