searxng/docs/admin/searx.limiter.rst

.. _limiter:

=======
Limiter
=======

.. sidebar:: info

   The limiter requires a :ref:`Redis <settings redis>` database.

.. contents::
   :depth: 2
   :local:
   :backlinks: entry

.. automodule:: searx.limiter
   :members:
[mod] isolation of botdetection from the limiter This patch was inspired by the discussion around PR-2882 [2]. The goals of this patch are: 1. Convert plugin searx.plugin.limiter to normal code [1] 2. isolation of botdetection from the limiter [2] 3. searx/{tools => botdetection}/config.py and drop searx.tools 4. in URL /config, 'limiter.enabled' is true only if the limiter is really enabled (Redis is available). This patch moves all the code that belongs to botdetection into namespace searx.botdetection and code that belongs to limiter is placed in namespace searx.limiter. Tthe limiter used to be a plugin at some point botdetection was added, it was not a plugin. The modularization of these two components was long overdue. With the clear modularization, the documentation could then also be organized according to the architecture. [1] https://github.com/searxng/searxng/pull/2882 [2] https://github.com/searxng/searxng/pull/2882#issuecomment-1741716891 To test: - check the app works without the limiter, check `/config` - check the app works with the limiter and with the token, check `/config` - make docs.live .. and read - http://0.0.0.0:8000/admin/searx.limiter.html - http://0.0.0.0:8000/src/searx.botdetection.html#botdetection Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2023-10-02 14:36:07 +00:00			`.. _limiter:`

			`=======`
			`Limiter`
			`=======`

			`.. sidebar:: info`

			The limiter requires a :ref:`Redis <settings redis>` database.

			`.. contents::`
			`:depth: 2`
			`:local:`
			`:backlinks: entry`

			`.. automodule:: searx.limiter`
			`:members:`