summaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2022-01-03 17:43:20 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2022-01-03 20:56:39 +0100
commita6cfab93fa7c1b1f0a04c073df42b50f2834d845 (patch)
tree3ea5eb2b6ede194671f9ef9e8e8c2e7531d77e5e /docs/admin
parent4f1130d6639ca93cd827f8c2bdaed1c3864f1af3 (diff)
downloadsearxng-a6cfab93fa7c1b1f0a04c073df42b50f2834d845.tar.gz
searxng-a6cfab93fa7c1b1f0a04c073df42b50f2834d845.zip
[enh] add redis connector searx/shared/redisdb.py
Add a redis connector, the default DB connector is a socket at:: unix:///usr/local/searxng-redis/run/redis.sock?db=0 To set up a redis instance simply use:: $ ./manage redis.build $ sudo -H ./manage redis.install A hint for developers: To get access rights to this instance, your developer account needs to be added to the *searxng-redis* group:: $ sudo -H ./manage redis.addgrp "${USER}" # don't forget to logout & login to get member of group Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/engines/settings.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index b04de7cb3..9f96a2b68 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -139,6 +139,36 @@ Global Settings
``default_http_headers``:
Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__
+
+.. _settings redis:
+
+``redis:``
+----------
+
+.. _Redis.from_url(url): https://redis-py.readthedocs.io/en/stable/connections.html#redis.client.Redis.from_url
+
+``url``
+ URL to connect redis database, see `Redis.from_url(url)`_ & :ref:`redis db`::
+
+ redis://[[username]:[password]]@localhost:6379/0
+ rediss://[[username]:[password]]@localhost:6379/0
+ unix://[[username]:[password]]@/path/to/socket.sock?db=0
+
+.. admonition:: Tip for developers
+
+ To set up a redis instance simply use::
+
+ $ ./manage redis.build
+ $ sudo -H ./manage redis.install
+
+ To get access rights to this instance, your developer account needs to be
+ added to the *searxng-redis* group::
+
+ $ sudo -H ./manage redis.addgrp "${USER}"
+ # don't forget to logout & login to get member of group
+
+.. _settings outgoing:
+
``outgoing:``
-------------