searxng/docs/src
Markus Heiser fd814aac86 [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-11-01 06:44:56 +01:00
..
index.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
searx.babel_extract.rst [mod] add i18n infrastructure for SearXNG message files (searxng.msg) 2022-03-16 09:55:53 +01:00
searx.botdetection.rst [mod] isolation of botdetection from the limiter 2023-11-01 06:44:56 +01:00
searx.exceptions.rst [doc] Add doc-strings to searx.exceptions 2023-01-29 19:06:19 +01:00
searx.infopage.rst [mod] replace /help by /info pages and include pages in project docs 2022-03-12 11:36:31 +01:00
searx.locales.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
searx.plugins.tor_check.rst [mod] add tor_check plugin - convenient tor checking trough searxng 2022-07-19 07:34:54 +02:00
searx.redisdb.rst move searx.shared.redisdb to searx.redisdb 2022-12-10 09:26:38 +01:00
searx.redislib.rst [mod] collection of redis functions and lua scripts (initial) 2022-05-30 11:10:30 +02:00
searx.search.processors.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
searx.search.rst [doc] update docs/dev/plugins.rst 2021-09-10 10:58:22 +02:00
searx.utils.rst [mod] add documentation about searx.utils 2022-01-29 22:49:42 +01:00