thoughtfulweb/lite-speed-cache

Clear the LiteSpeed cache on page save.

CraftCMS LSCache Purge

Destroy LSCache on save, or force destroy., _(*1)

Installation

1. Move the litespeedcache folder into your craft/plugins directory
2. Install the plugin in the Control Panel
3. Set your LS Cache folder path on the settings page, you may need to ask your host where this is
4. Turn on Clear caches per URL? if you need it on the settings page

Markup

Cache records need to have the path set as the key., _(*2)

{% cache globally using key craft.request.path %}
{% cache globally using key craft.request.path ~ '/p' ~ craft.request.getPageNum %}

If you need to add extra data to the key (e.g if you're using a different limit parameter for different browser sizes) then you must seperate this information from the path using %%, _(*3)

{% set cacheKeyType = craft.request.isMobileBrowser() ? 'mobile' : 'desktop' %}
{% cache globally using key craft.request.path ~ '/p' ~ craft.request.getPageNum ~ '%%' ~ cacheKeyType %}

For any parameters that are truly global parameters, like navigation, prefix the key with global%%. This will trigger a global purge instead of purging per URL, as every page will need to be refreshed for navigation changes to take effect., _(*4)

{% cache globally using key 'global%%navigation' %}

On your default document, you must add a header to tell LSCache to not cache the entry if it cannot find a cache record in craft_templatecaches table. If there is no cache record associated with the entry, pressing save will not fire a purge request to the URL., _(*5)

{% if not craft.liteSpeedCache.checkTemplateCache(craft.request.path)|length %}
    {% header "X-LiteSpeed-Cache-Control: no-cache" %}
{% endif %}

Notes

We'd recommend setting globally to reduce the amount of cache records that you get, otherwise you'll end up with hunderds of cache records if there are URL paramaters defined for a page., _(*6)

This plugin does run the LSCache clearances as a batched task, so hopefully it shouldn't be too intensive on the server. If you're noticing massive latency issues, it might be worth selecting the global purging option., _(*7)

If you're running CraftCommerce, the plugin will globally purge for now., _(*8)

You cannot use CloudFlare and still use per-URL purging. Either do not route through CloudFlare, or just enable the global purge., _(*9)