LiteSpeed Cache for Flarum

rafaucau

LiteSpeed Cache for Flarum

Integrates LSCache with your forum. Requires a LiteSpeed Web Server.

A public cache is currently available. A cache for logged in is planned, but it will be difficult.

This extension has just been created and still needs a lot of work. Feel free to contribute.

Installation

Install with composer:

composer require acpl/flarum-lscache:"*"

You need to include this code in your `.htaccess` file:

<IfModule LiteSpeed>
    CacheLookup on
    RewriteEngine On
    RewriteCond %{REQUEST_METHOD} ^HEAD|GET$
    # Detection of logged-in user.
    RewriteRule .* - [E="Cache-Vary:flarum_remember,flarum_lscache_vary"]
    # If you have a non-default path to the admin panel, change "admin" to match.
    RewriteCond %{ORG_REQ_URI} !/admin
    # Enable private cache for admin panel. If it causes problems replace "private" with "no-cache".
    RewriteRule .* - [E=Cache-Control:private]
</IfModule>

You can also add your own rules. For more information see here: https://docs.litespeedtech.com/lscache/noplugin/settings/#rewrite-rules

Updating

composer update acpl/flarum-lscache:"*"

php flarum migrate

php flarum cache:clear

You can clear the LSCache in the admin panel. The option is available under the standard Flarum cache clearing option.
There is also the php flarum lscache:clear --userId [adminId] command, but you must know the admin id to use it. Eg. php flarum lscache:clear --userId 9. The admin id is needed to authorize the request. This command will probably be replaced by a better solution soon.

Links

DursunCan

rafaucau Flarum only supported apache and nginx?

luceos

rafaucau instead of adding a new command, it might be wise to create a listener that listens for the ClearingCache event so that cache is also cleared when extensions are enabled or disabled.

DursunCan

rafaucau How can I tell if it is working correctly?

# php flarum lscache:clear
Sending a request to purge all LSCache entries...
Something went wrong while sending the request. Check if the user with ID 1 is an administrator. Use the `--userId [id]` option.

Darkle

rafaucau This is awesome! congratulations, thanks for releasing this as open source, I wish I could help with the development but unfortunately it's out of my capabilities.

A few months ago I was testing OLS, but finally I didn't switch as the performance of OLS compared to Nginx was exactly the same, this extension definitely makes the OLS+Flarum combination much more interesting, I hope to test it soon.

rafaucau

DursunCan What do you mean? My forum is running on a LiteSpeed server.

DursunCan

rafaucau I edited my previous answer. Can Flarum get faster with LiteSpeed? Can you share your site?

rafaucau

DursunCan http://forum.android.com.pl/
I will install this extension on my forum tonight. After testing on the dev environment - Flarum is very fast with LSCache
Rather, without LSCache, it works the same as it does on other servers (Apache, Nginx, etc.).

rafaucau

luceos I've been thinking about this, but I haven't been able to do it. To clear the cache I have to return the header X-LiteSpeed-Purge in response. That is, I have to send a request to the API, and the API has to return this header in the response. Then LiteSpeed server clears the cache if it detects this header.
This path in the API is secured so that normal users cannot clear the cache for the entire forum. Therefore, this command creates a temporary API key, sends the request as admin and removes the key.
https://docs.litespeedtech.com/lscache/devguide/controls/#x-litespeed-purge
https://github.com/android-com-pl/flarum-lscache/blob/main/src/Command/LSCacheClearCommand.php

I don't have a better idea at the moment.

Jishnu

rafaucau wow , theme looks great. Will you share it ?

Fealist

rafaucau Waiting for you to upload the plugin to your forum. I have done the necessary tests. I will compare.

luceos

rafaucau oh yeah I now understand the complexity of your problem.

What on ClearingCache you set a flag in the cache store, then you add a middleware to the forum frontend that adds the header and unsets the flag. Maybe that works, not sure how this would clear the cache of everything, or does this only work with one specific endpoint?

rafaucau

DursunCan Ask your hosting support about enabling the LSCache module. I just had a similar problem on production site and it turned out that the module was disabled.

Fealist I have installed it.
When you test it, keep in mind that there is a lot going on in this forum and every time someone makes a post it clears the cache for the home page and the discussion that the post appeared in. If you arrive at a page that is not cached, that means you are the first guest visitor to the page since the last cache was cleared. In that case, refresh the page again.

I also plan to add a "Serve Stale" option.

rafaucau

DursunCan I will try to use Luceos idea soon and then there will be no problem with this command. Currently you have to use the --userId adminId option if the administrator does not have an ID of 1.

DursunCan How can I tell if it is working correctly?

Check it out: https://docs.litespeedtech.com/lscache/start/#verify-your-site-is-being-cached

DursunCan

rafaucau https://www.hizliresim.com/2walsll ?

rafaucau

DursunCan Did you add the code that is in the first post to the .htaccess file? This is required for the cache to work.

BTW. currently LSCache is working for non-logged in users. Check as a guest. I am planning to add cache for logged in users, but it will be difficult and time consuming.

JohnP

Excellent, we are running Flarum on Litespeed and I can't wait to try this out later on today.

rafaucau I am planning to add cache for logged in users, but it will be difficult and time consuming.

Really excited about this, thanks for all of the effort.

DursunCan

rafaucau

BTW. currently LSCache is working for non-logged in users. Check as a guest. I am planning to add cache for logged in users, but it will be difficult and time consuming.

Is LSCache important for logged in users?

DursunCan

rafaucau

I tested without logging in. same value as your site.

alt-svc: h3=":443"; ma=86400, h3-29=":443"; ma=86400, h3-28=":443"; ma=86400, h3-27=":443"; ma=86400
cache-control: public, max-age=0
cf-cache-status: DYNAMIC
cf-ray: 6af676207e4e4c5c-AMS
content-encoding: br
content-type: text/html; charset=utf-8
date: Wed, 17 Nov 2021 05:11:58 GMT
expect-ct: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
expires: Wed, 17 Nov 2021 05:11:45 GMT
nel: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
referrer-policy: same-origin
report-to: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=rDTd4iaPyYYYQnJ1STz2mYJq9s4hvRVpKjweqtKnvFlcoxs%2BD44kY%2BxdhvfHOEY8tKvoP3VdM0YXemyQLXo9t3jwUh%2Btcr%2F5P5NaR5x6cMkcNAB6F%2BQT4FDD3lO8"}],"group":"cf-nel","max_age":604800}
server: cloudflare
vary: Accept-Encoding
x-content-type-options: nosniff
x-csrf-token: KisFOl6y7cZdfYFU3KrGWoWy5TiXLKgm0Irjah8v
x-litespeed-cache: hit
x-powered-by: Flarum
x-turbo-charged-by: LiteSpeed

Fealist

For PC View:

Pre-cache: https://gtmetrix.com/reports/forum.android.com.pl/cmbLchgP/
Post Cache: https://gtmetrix.com/reports/forum.android.com.pl/lRQu8K3p/

rafaucau

Fealist What a big TTFB 🙀 When accessing the site from the same country where we have servers it's 32ms.

askvortsov

rafaucau That is absolutely incredible results, congratulations and thank you so much for making this available to the Flarum community!

ihhddis

Are you noticing any speed improvement now that you have activated the extension? It would be nice if you can share something from your side (if you had data from before), gtmetrix is sometimes a bit random.

rafaucau

ihhddis I cleared the LSCache and checked TTFB. Without cache on my forum it is 907ms

Fealist

ihhddis You can read the previous data by translating it into English below.

https://flarumtr.com/d/2896/2

ihhddis

rafaucau Wow that's fantastic, do you think there would be a problem with OpenLiteSpeed? for some reason there are some LSCache plugins like PrestaShop's that don't work with the Open version only with Enterprise (https://www.litespeedtech.com/products/litespeed-web-server/editions).

If it works, it would be great if someone could make a guide on how to install Flarum with OpenLiteSpeed, I've never managed to get it working but this gives me a lot of motivation.