GB Redis Setup

glowingblue

open-graph-image

A Flarum extension.

Makes it easy to enable/disable Redis features:

Cache
Queue
Sessions

For this to work, environment variables have to be set on your host:

REDIS_HOST=null # Required
REDIS_PORT=6379 # Optional, else uses default
REDIS_PASSWORD=null # Required, can be an empty string
REDIS_DATABASE_CACHE=1 # Optional, else uses default
REDIS_DATABASE_QUEUE=2 # Optional, else uses default
REDIS_DATABASE_SESSION=3 # Optional, else uses default

📥 Installation

composer require glowingblue/redis-setup

♻ Updating

composer update glowingblue/redis-setup
php flarum cache:clear

🔗 Links

DursunCan

glowingblue Will Redis settings be made from the admin panel?

1Dot

glowingblue So I can leave the code that I should add in extend.php right?? as It's setup

Justman10000

glowingblue

What is the advantage over a normal database? Or what exactly is Redis doing?

iPurpl3x

DursunCan The admin panel only offers switches to enable or disable the features. The configuration itself has to be done with environment variables.

Hari

I'm confused, luceos sir's extension Redis sessions, cache & queues also has the same features?

ReCache is only meant for files right?

but in common all these three performs similarly for the cache option?

so If I am interested in the only cache I can choose between GB redis and luceos redis?

iPurpl3x

Hari Not really. In fact they work together. glowingblue/redis-setup requires blomstra/flarum-redis (which is now a library and not an extension anymore).

glowingblue/redis-setup is just here to make it simple for admins to enable & disables features that are actually only working because blomstra/flarum-redis is installed. Does that make sense ?

In other words, what blomstra/flarum-redis explains as setup in the README is all done by glowingblue/redis-setup. All that is required is to set the correct environment variables on the host.

[deleted]

iPurpl3x I'm trying this extension, but it doesn't seem to work for me. I've added the environment variables into etc/environment but I'm not seeing any activity in redis-cli monitor. In addition, attempting to clear the cache from CLI presents the below

In AbstractConnection.php line 155:
                                                                                                    
  php_network_getaddresses: getaddrinfo failed: Name or service not known [tcp://127.0.0.1 :6379 ]

serdo

plugin cannot be installed

iPurpl3x

serdo Try

composer require blomstra/flarum-redis v0.4.0-beta.2

then

composer require glowingblue/redis-setup

Because blomstra/flarum-redis is still in beta, composer may not want to install it. Therefore change the minimum stability to beta (docs).

EDIT:

Also set "prefer-stable": true else you may get all kind of beta dependencies that you don't want.

luceos

iPurpl3x you can fix this in the composer.json of this extension by setting blomstra/flarum-redis to ^0.4.0@beta.

iPurpl3x

luceos Thanks, done with v1.0.1.

(cc @serdo)

IanM

[deleted] tcp://127.0.0.1 :6379

It's likely to be the space there.. tcp://127.0.0.1:6379 should be the correct value. Did you maybe add a space in your env vars?

[deleted]

IanM No, there's nothing there - these are two variables provided on separate lines - see initial post

IanM

[deleted] Yes I know, I wrote this 😉

What I mean is, perhaps there's some whitespace at the end of your entry for REDIS_HOST? I really should add some validation/trimming to this 🤔

[deleted]

IanM 🙂 Sorry ! No spaces - just checked and double-checked

IanM

[deleted] hmm, ok, thank you for checking 🙂 Let me just finish up what I'm working on, then I'll look to see what's happening here.. It's likely environment related, as we have this running on a few sites as we speak...

[deleted]

@IanM getting a bit closer now

  `AUTH` failed: ERR Client sent AUTH, but no password is set [tcp://127.0.0.1:6379]

However, I don't have auth set in redis - I was previously using it for ReCache.

[deleted]

IanM I've just removed the # and comments, which seems to be the issue (for whatever reason, as the # should be ignored !). Just removed the null value from the password variable and rebooting

IanM

[deleted] Ah, yes the # and after should be ignored.. For standard setups, redis password env var should either be omitted entirerly, or set to null

[deleted]

IanM Working now (not complaining at least when I try to clear the cache), but no output in redis-cli monitor which is odd - I'd expect output here of sorts ?

EDIT - still nothing - is there any way to determine if this is actually working ?

IanM

[deleted] each of the services (cache, queue & session) use a different redis database (1, 2, 3) by default. You may need to select which db to monitor. Personally I tend not to use redis-cli unless I'm dealing with Sentinel Redis.

You might find this useful to monitor what's going into the redis databases https://github.com/ErikDubbelboer/phpRedisAdmin

[deleted]

Ok - seems I have Beta.2 of blomstra/flarum-redis. Updated to Beta.3 and now have this in redis-cli monitor

metabullet@vps:~/public_html$ redis-cli monitor
OK
1624548182.176478 [0 127.0.0.1:45920] "SELECT" "1"
1624548182.176782 [1 127.0.0.1:45920] "GET" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d"
1624548182.177191 [1 127.0.0.1:45920] "EVAL" "return redis.call('exists',KEYS[1])<1 and redis.call('setex',KEYS[1],ARGV[2],ARGV[1])" "1" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d1523" "b:1;" "3600"
1624548182.177309 [1 lua] "exists" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d1523"
1624548182.177328 [1 lua] "setex" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d1523" "3600" "b:1;"
1624548182.177997 [1 127.0.0.1:45920] "EVAL" "return redis.call('exists',KEYS[1])<1 and redis.call('setex',KEYS[1],ARGV[2],ARGV[1])" "1" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d" "b:1;" "86400"
1624548182.178041 [1 lua] "exists" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d"
1624548182.178057 [1 lua] "setex" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d" "86400" "b:1;"
1624548182.382770 [1 127.0.0.1:45920] "DEL" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d"
1624548241.596999 [0 127.0.0.1:45926] "SELECT" "1"
1624548241.597402 [1 127.0.0.1:45926] "GET" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d"
1624548241.598618 [1 127.0.0.1:45926] "EVAL" "return redis.call('exists',KEYS[1])<1 and redis.call('setex',KEYS[1],ARGV[2],ARGV[1])" "1" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d1524" "b:1;" "3600"
1624548241.598733 [1 lua] "exists" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d1524"
1624548241.598762 [1 lua] "setex" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d1524" "3600" "b:1;"
1624548241.600307 [1 127.0.0.1:45926] "EVAL" "return redis.call('exists',KEYS[1])<1 and redis.call('setex',KEYS[1],ARGV[2],ARGV[1])" "1" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d" "b:1;" "86400"
1624548241.600374 [1 lua] "exists" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d"
1624548241.600398 [1 lua] "setex" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d" "86400" "b:1;"
1624548241.824980 [1 127.0.0.1:45926] "DEL" "framework/schedule-09839b5b62939efb03132ab26135aa194bcfda5d"

IanM

[deleted] I've not yet had a look at the changes in beta.3 - give me some time to investigate, please. I'll come back to you in an hour or two