amorfo77/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2026-08-10 21:03:18 +00:00
Code Issues Projects Releases Wiki Activity

Chore(beta): Update suggested broker to Valkey + Redis agnostic documentation (#13032)

Browse Source 
Co-authored-by: upmcplanetracker <219436948+upmcplanetracker@users.noreply.github.com>
This commit is contained in:
Trenton H
2026-06-18 19:54:15 +00:00
committed by GitHub
co-authored by upmcplanetracker
parent 0cdf718d9f
commit a009ea1f04
13 changed files with 49 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/faq.md
+9 -5
View File
@@ -118,10 +118,14 @@ able to run paperless, you're a bit on your own. If you can't run the
docker image, the documentation has instructions for bare metal
installs.
## _What about the Redis licensing change and using one of the open source forks_?
## _Which message broker should I use_?
Currently (October 2024), forks of Redis such as Valkey or Redirect are not officially supported by our upstream
libraries, so using one of these to replace Redis is not officially supported.
Paperless-ngx talks to a Redis-compatible message broker, so any broker that
implements the Redis protocol will work. The bundled Docker Compose files
default to [Valkey](https://valkey.io/), the open-source fork created after
Redis' licensing change, but Redis itself and other wire-compatible brokers
(such as Microsoft's Garnet) are equally fine.
However, they do claim to be compatible with the Redis protocol and will likely work, but we will
not be updating from using Redis as the broker officially just yet.
Existing installs can switch broker implementations in place: point
[`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) at the new instance and
reuse the same data volume.