diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2022-01-11 19:55:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-11 19:55:14 +0100 |
| commit | 977e9a433085124e17f2f7f26afabbeb71db9470 (patch) | |
| tree | 286c046cdd9eaa069e49c81b6f7f7bb545746b65 /docs | |
| parent | f4004133b605cea8225c720a7f4c593d4c20d13e (diff) | |
| parent | dca83944b588be3ec9e49486daea6cf15ef58f78 (diff) | |
| download | searxng-977e9a433085124e17f2f7f26afabbeb71db9470.tar.gz searxng-977e9a433085124e17f2f7f26afabbeb71db9470.zip | |
Merge pull request #686 from return42/lib_redis
Add redis DB and connector
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/engines/settings.rst | 30 | ||||
| -rw-r--r-- | docs/src/searx.shared.redisdb.rst | 8 |
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index a829b870c..c96dd3329 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -142,6 +142,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:`` ------------- diff --git a/docs/src/searx.shared.redisdb.rst b/docs/src/searx.shared.redisdb.rst new file mode 100644 index 000000000..265d87617 --- /dev/null +++ b/docs/src/searx.shared.redisdb.rst @@ -0,0 +1,8 @@ +.. _redis db: + +======== +Redis DB +======== + +.. automodule:: searx.shared.redisdb + :members: |