Support for Valkey (instead of Redis)

Feature Discussion
1

Since Redis is not Open Source instead SSPLv1 and RSALv2 is not usable anymore, perhaps not technically but at least ethical with open source in mind.

But as always, the community created already a solution to it: Valkey
It’s pretty much a drop-in replacement. So should just work as if Redis is installed.
Though, vikunja probably looks for a service named redis.service. This could be adopted to look for a Redis service or Valkey service — or just only for a valkey.service.

The change should not be too big also for those which had already had a running installation. Okay, the configuration needs then probably a small change in the valkey section, but this would be pretty much a copy and paste from the redis section.

Also, it got a lot of commits since the fork for different things like performance or security, which makes it even better than or at least just as good. And this probably is not true because is still open source, which always wins, not true? :man_shrugging::wink:

Anyway, this needs to be decided by you (@kolaente) or together with the community if staying for both or only for one.

Documentation about Valkey can be found here:

Note:
SSPLv1: Server-Side Public License
RSALv2: Redis Source Available License

Sources:
Official Announcing
Ars Technica Article

Note:
Sorry for pining you directly, if this prohibits or so, just say it. I’m sorry for any inconveniences which may appeared.

2

Vikunja does not look for something called redis, it will use whatever is passed to the configuration. If that’s redis or valkey does not matter.

Because of that, I don’t see why this should be changed - it’s only a name thing. Removing the redis setting from the config and calling it valkey instead would be a breaking change, which I’d like to avoid.

We could change the docs though, to favour valkey over redis (PRs welcome!). If valkey does redis-incompatible changes at some point, we could reconsider adding explicit support for valkey.

2 Likes
3

Oh, if this is the case then I do have a configuration error, I guess. :thinking:
Because the Redis integration/configuration does not work on my side…:man_shrugging:… So I thought this could be that the service is named differently.

With this knowledge, I agree with you that this does not need any changes. :handshake:

Does a user and password needed to be configured for Redis/Valkey?

My configuration:

redis:
  # Whether to enable redis or not
  enabled: true
  # The host of the redis server including its port.
  host: 'localhost:6379'
  # The password used to authenticate against the redis server
  password: ''
  # 0 means default database
  db: 0
4

You’ll only need a username and password if you have configured one in
redis/valkey.

What does not work when you say it does not work? Do you have an error
message?

5

Okay, I did not set up any password or user.
I don’t see any error messages.

I believe it does not work because if I monitor Redis/Valkey I don’t see any keys in the database.

Monitoring Redis/Valkey:

valkey-cli -s /run/valkey/valkey.sock

Then you’re in the valkey shell and you can type in MONITOR:

valkey /run/valkey/valkey.sock> MONITOR

Then you should see any data or keys which are getting cached. At least so far, my understanding…:man_shrugging:…

6

Update:

I was just not patient enough. I see the keys and their values, it works without any problems.

Then the only thing to consider maybe is to update the documentation. If I have time, I will look into it if not anyone else is faster than I.

Thanks for helping! :handshake::blush:

1 Like