diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/engines/settings.rst | 25 | ||||
| -rw-r--r-- | docs/admin/filtron.rst | 14 | ||||
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/src/searx.plugins.limiter.rst | 4 |
4 files changed, 37 insertions, 11 deletions
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index a55e2575b..2726674d5 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -226,6 +226,17 @@ Global Settings .. _Redis.from_url(url): https://redis-py.readthedocs.io/en/stable/connections.html#redis.client.Redis.from_url +A redis DB can be connected by an URL, in :py:obj:`searx.shared.redisdb` you +will find a description to test your redis connection in SerXNG. When using +sockets, don't forget to check the access rights on the socket:: + + ls -la /usr/local/searxng-redis/run/redis.sock + srwxrwx--- 1 searxng-redis searxng-redis ... /usr/local/searxng-redis/run/redis.sock + +In this example read/write access is given to the *searxng-redis* group. To get +access rights to redis instance (the socket), your SearXNG (or even your +developer) account needs to be added to the *searxng-redis* group. + ``url`` URL to connect redis database, see `Redis.from_url(url)`_ & :ref:`redis db`:: @@ -235,17 +246,21 @@ Global Settings .. admonition:: Tip for developers - To set up a redis instance simply use:: + To set up a local redis instance using sockets 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 + The YAML setting for such a redis instance is: + + .. code:: yaml + + redis: + url: unix:///usr/local/searxng-redis/run/redis.sock?db=0 + + .. _settings outgoing: ``outgoing:`` diff --git a/docs/admin/filtron.rst b/docs/admin/filtron.rst index f08149ae9..60d7cbeba 100644 --- a/docs/admin/filtron.rst +++ b/docs/admin/filtron.rst @@ -5,17 +5,19 @@ How to protect an instance ========================== +.. tip:: + + To protect your instance a installation of filtron (as described here) is no + longer needed, alternatively activate the :ref:`limiter plugin` in your + ``settings.yml``. Note that the :ref:`limiter plugin` requires a :ref:`Redis + <settings redis>` database. + + .. sidebar:: further reading - :ref:`filtron.sh` - :ref:`nginx searxng site` - -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - .. _filtron: https://github.com/searxng/filtron SearXNG depends on external search services. To avoid the abuse of these services diff --git a/docs/conf.py b/docs/conf.py index 1dd5693ca..5db9e8178 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -123,6 +123,7 @@ extensions = [ 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling. "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs 'myst_parser', # https://www.sphinx-doc.org/en/master/usage/markdown.html + 'notfound.extension', # https://github.com/readthedocs/sphinx-notfound-page ] suppress_warnings = ['myst.domains'] @@ -140,6 +141,10 @@ issues_github_path = "searxng/searxng" # HTML ----------------------------------------------------------------- +# https://searxng.github.io/searxng --> '/searxng/' +# https://docs.searxng.org --> '/' +notfound_urls_prefix = '/' + sys.path.append(os.path.abspath('_themes')) sys.path.insert(0, os.path.abspath("../utils/")) html_theme_path = ['_themes'] diff --git a/docs/src/searx.plugins.limiter.rst b/docs/src/searx.plugins.limiter.rst index 4984cd37a..75d06f5c2 100644 --- a/docs/src/searx.plugins.limiter.rst +++ b/docs/src/searx.plugins.limiter.rst @@ -4,6 +4,10 @@ Limiter Plugin ============== +.. sidebar:: info + + The :ref:`limiter plugin` requires a :ref:`Redis <settings redis>` database. + .. automodule:: searx.plugins.limiter :members: |