Redis sessions, cache & queues

luceos

Lurker Can Flarum-Redis be run together with Blomstra-Realtime on the same Flarum community?

Yes they co-exist. In fact Realtime works better if a queue extension is enabled/working.

Lurker From my understanding, both of them serve the same purpose, but I could be wrong.

Yes you are wrong. Which I can completely understand. Let me try to narrow it down.

Realtime makes Flarum more realtime by sending updates to the Flarum community html page you have open directly through a two-way continuous communication channel. For instance new posts being rendered inside a discussion, new discussions onto the index and the typing indicator without having to refresh the page; it does not add any backend functionality to move task processing (like sending notifications) to a queue.

Blomstra Redis does not add any realtime updates to Flarum, it enables tasks to be processed in the background. Instead of having to wait for notifications (and other php/backend tasks) to be completed, a user on your community can simply post and see their post on the forum immediately. The more background tasks are scheduled when creating content, the longer the request to submit that content, unless you use a queue. Blomstra Redis enables a queue relying on Redis, Blomstra database queue enables one relying on the database.

Additional resources:

queues: https://laravel.com/docs/9.x/queues#introduction
websockets: https://bettersoftwarewithsid.com/websocket-an-in-depth-beginners-guide

Lurker

I was able to successfully create the flarum-queue.service file and had it started and enabled. This is the status of my flarum-queue.service:

● flarum-queue.service - flarum-queue
     Loaded: loaded (/etc/systemd/system/flarum-queue.service; enabled; vendor>
     Active: active (running) since Wed 2022-10-26 15:07:12 UTC; 10s ago
   Main PID: 8910 (php8.1)
      Tasks: 1 (limit: 1116)
     Memory: 28.0M
        CPU: 218ms
     CGroup: /system.slice/flarum-queue.service
             └─8910 /usr/bin/php8.1 flarum queue:work

However, when I tried to login to my site, I get this message:
Oops! Something went wrong. Please reload the page and try again.

I can't seem to log in to my own site now. I tried resetting my password, but it's saying that "An error occured. Please try again."

Solution: Clear the Flarum cache by typing: php flarum cache:clear

If you get a permission error like this:

Could not clear contents of storage/cache. Please adjust file permissions and try again. This can frequently be fixed by clearing cache via the Tools dropdown on the Administration Dashboard page.

Solution: Run the command as the web user by typing sudo -u www-data php flarum cache:clear

Edited after several readings and droplet restores. Personal issues have now been resolved. Thanks!

llaumgui

Hi, nice extension ! Is there a way to use config.php to enable / disable your extension ? Because I haven't Redis on my local environment.

luceos

llaumgui I'm not sure.

SwaggyMacro your queue runner/worker isn't running.

SwaggyMacro

It makes verification mail cannot send correctly when I use Redis.
That mail was sent correctly When I disabled Redis.
Is there any solution to fix this?

SwaggyMacro

luceos
I ran command:

php flarum info

llaumgui

luceos llaumgui I'm not sure.

I use this trick: https://discuss.flarum.org/d/32585-conditionnal-part-in-extendphp/2

luceos

SwaggyMacro check the section under queue in the OP https://discuss.flarum.org/d/21873-redis-sessions-cache-queues

SwaggyMacro

luceos
Thank you a lot, I saw this, And It works now.

Queue
Make sure to start your queue workers, see the laravel documentation for specifics.

To test the worker can start use php flarum queue:work.

Updating
composer update blomstra/flarum-redis
Make sure to restart your queue workers every time you upgrade flarum, add or remove extensions. So whenever you ran composer commands you have to restart the queue.

Gatsu

I got a Litespeed server web and cache by @rafaucau .
Can I use redis with litespeed cache?
I have a shared hosting.

rafaucau

Gatsu Yes, you can.

CyberGene

Are there any known problems with the Redis queue?

I have been experimenting with a copy of my forum on a DigitalOcean droplet. I installed a Redis server on the Ubuntu and installed this extension, then I put the proper configuration in the extend.php (using the one with three separate databases), I also made the Flarum queue a service.d following the excellent example of @matteocontrini (thank you!) and all seemed good for a while. I then disabled Pusher extension and whole hell broke loose! I couldn't access the forum anymore, I couldn't execute the "clear" command, the MySQL service hijacked the CPU and even after a restart it would still take the CPU and only a restart of the entire droplet fixed the MySQL problem, however the forum was still inaccessible. I had to remove this extension through the composer remove command in order to fix the problem.

Any advices? I was very optimistic about moving my forum from Siteground to a DigitalOcena droplet in order to benefit from a queue and then from the Blomstra Realtime, however the entire experience smashed my enthusiasm into zero and I'm wondering whether I can rely on these advanced extensions. Maybe it's me who is not experienced enough, which is why I'm asking if other members are happy with the Redis queue support and other realtime features?

luceos

xasharma make sure to daemonize the queue worker, otherwise the queue won't do anything at all.

CyberGene I missed this. There are no issues that I know of. In fact the redis queue is in use here on discuss and in many production communities for Blomstra. MySQL impact is usually influenced by one or a combination of extensions.. Make sure to restart the queue daemon when making changes to your enabled extensions (it should do that automatically though).

xasharma

luceos Set up

In your extend.php:

    new Blomstra\Redis\Extend\Redis([
        'host' => '127.0.0.1',
        'password' => null,
        'port' => 6379,
        'database' => 1,
    ])

This enables sessions, cache and queue to run on redis.

When I run this I stop receiving notifications on site about the signups and posts ... Can anyone please tell me the right configuration for Redis sessions, cache & queues

xasharma

luceos Sorry but didn't understand ... I am a cybersecurity worker .... sorry no such knowledge for it

Please give me a code or please tell me which code I use

clarkwinkelmann

xasharma see "Queues" paragraph under "Set up" in the first post/README. It links to the Laravel documentation for more details on the various ways this can be setup. In essence you need to configure your server to continually run the queue worker command, ideally as a "daemon" or "service". This is the process that will connect to Redis to retrieve jobs.

Prcek

xasharma Please give me a code or please tell me which code I use

Deamonize php flarum queue:work --tries=5 or better make a containerized worker:

# docker build -t php8.1-worker-flarum -f ./Dockerfile.php8.1-worker-flarum .

FROM php:8.1-cli

ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/

RUN chmod +x /usr/local/bin/install-php-extensions && \
    install-php-extensions curl dom fileinfo gd json mbstring openssl pdo_mysql tokenizer zip

WORKDIR /data/web

CMD ["php", "flarum", "queue:work", "--tries=5"]

xasharma

clarkwinkelmann

Sorry but i want redis sessions cache and queues all ... i have a VPS having 6 Cores and 12 GB RAM

Please tell me the code .... I have enabled redis on my VPS.

clarkwinkelmann

xasharma there are different ways to make a server run a PHP script as a daemon.

Laravel recommends using Supervisor which should be available on many Linux operating systems. They show an example config file in their documentation https://laravel.com/docs/6.x/queues#supervisor-configuration Just adjust the command= instruction for Flarum (adjust path, executable name and remove queue driver from parameters), something like command=php /home/forge/app.com/flarum queue:work --sleep=3 --tries=3. You can probably drop the --sleep and --tries parameters as well if you don't want to customize them.

Personally I manage my VPSes with Laravel Forge and they have a nice utility where I can just drop the flarum queue:work command and it sets up Supervisor for me.

There are many other Linux service managers that could be used in place of Supervisor. If your hosting is managed it might come with another built-in option. Usually those services ask for parameters like a command to run, a number of processes to run, whether to auto-restart the script if it crashes and how long to wait before restarts or when to kill the process if it takes too long to stop. It's probably fine to run just one process for the queue worker but if your server has a lot of resources you can start more processes.

If you need more help, please describe your exact hosting situation in detail.

xasharma

clarkwinkelmann Thank you for this help ... My support helped me to install redis and I want code that can be used directly and just paste in extend.php and I want to use this extension to fast my site.

« Previous Page Next Page »