diff options
| author | Gaspard d'Hautefeuille <github@dhautefeuille.eu> | 2025-07-09 07:55:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-07-09 07:55:37 +0200 |
| commit | f798ddd4922d793d5e6ccb7c4111810d549ff4f4 (patch) | |
| tree | 223aa9d26deb176d983cd8e1bed51ff2cff71eff /docs/dev/engines/offline | |
| parent | bd593d0bad2189f57657bbcfa2c5e86f795c680e (diff) | |
[mod] migrate from Redis to Valkey (#4795)
This patch migrates from `redis==5.2.1` [1] to `valkey==6.1.0` [2].
The migration to valkey is necessary because the company behind Redis has decided
to abandon the open source license. After experiencing a drop in user numbers,
they now want to run it under a dual license again. But this move demonstrates
once again how unreliable the company is and how it treats open source
developers.
To review first, read the docs::
$ make docs.live
Follow the instructions to remove redis:
- http://0.0.0.0:8000/admin/settings/settings_redis.html
Config and install a local valkey DB:
- http://0.0.0.0:8000/admin/settings/settings_valkey.html
[1] https://pypi.org/project/redis/
[2] https://pypi.org/project/valkey/
Co-authored-by: HLFH <gaspard@dhautefeuille.eu>
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/engines/offline')
| -rw-r--r-- | docs/dev/engines/offline/nosql-engines.rst | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/docs/dev/engines/offline/nosql-engines.rst b/docs/dev/engines/offline/nosql-engines.rst index 76f5cfb61..551600c4e 100644 --- a/docs/dev/engines/offline/nosql-engines.rst +++ b/docs/dev/engines/offline/nosql-engines.rst @@ -7,7 +7,7 @@ NoSQL databases .. sidebar:: further read - `NoSQL databases <https://en.wikipedia.org/wiki/NoSQL>`_ - - `redis.io <https://redis.io/>`_ + - `valkey.io <https://valkey.io/>`_ - `MongoDB <https://www.mongodb.com>`_ .. contents:: @@ -22,7 +22,7 @@ NoSQL databases The following `NoSQL databases`_ are supported: -- :ref:`engine redis_server` +- :ref:`engine valkey_server` - :ref:`engine mongodb` All of the engines above are just commented out in the :origin:`settings.yml @@ -45,7 +45,7 @@ section :ref:`private engines`. Extra Dependencies ================== -For using :ref:`engine redis_server` or :ref:`engine mongodb` you need to +For using :ref:`engine valkey_server` or :ref:`engine mongodb` you need to install additional packages in Python's Virtual Environment of your SearXNG instance. To switch into the environment (:ref:`searxng-src`) you can use :ref:`searxng.sh`:: @@ -61,20 +61,20 @@ Configure the engines their structure. -.. _engine redis_server: +.. _engine valkey_server: -Redis Server ------------- +Valkey Server +------------- -.. _redis: https://github.com/andymccurdy/redis-py#installation +.. _valkey: https://github.com/andymccurdy/valkey-py#installation .. sidebar:: info - - ``pip install`` redis_ - - redis.io_ - - :origin:`redis_server.py <searx/engines/redis_server.py>` + - ``pip install`` valkey_ + - valkey.io_ + - :origin:`valkey_server.py <searx/engines/valkey_server.py>` -.. automodule:: searx.engines.redis_server +.. automodule:: searx.engines.valkey_server :members: @@ -94,4 +94,3 @@ MongoDB .. automodule:: searx.engines.mongodb :members: - |