searxng/docs/admin
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
..
answer-captcha [doc] answer CAPTCHA from server's IP 2023-05-22 10:46:10 +02:00
settings [mod] isolation of botdetection from the limiter 2023-11-01 06:44:56 +01:00
answer-captcha.rst [doc] answer CAPTCHA from server's IP 2023-05-22 10:46:10 +02:00
api.rst [mod] settings.yml: remove plugin settings for plugins that don't exist anymore 2023-09-29 11:26:49 +02:00
arch_public.dot [doc] update documentation of the installation procedures 2022-07-30 13:39:35 +02:00
architecture.rst [docs] corrections from @tiekoetter's review 2022-07-30 13:39:35 +02:00
buildhosts.rst [fix] typos in documentation & messages 2023-08-13 08:50:29 +02:00
index.rst [mod] isolation of botdetection from the limiter 2023-11-01 06:44:56 +01:00
installation-apache.rst [fix] spelling 2023-09-18 16:20:27 +02:00
installation-docker.rst [fix] typos in documentation & messages 2023-08-13 08:50:29 +02:00
installation-nginx.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
installation-scripts.rst [fix] typos/grammar in docs 2023-04-21 06:51:44 +02:00
installation-searxng.rst [fix] typos in documentation & messages 2023-08-13 08:50:29 +02:00
installation-uwsgi.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
installation.rst [fix] typos/grammar in docs 2023-04-21 06:51:44 +02:00
plugins.rst [mod] documentation: change the jinja context doesn't depend on searx.webapp 2020-12-27 10:00:35 +01:00
searx.limiter.rst [mod] isolation of botdetection from the limiter 2023-11-01 06:44:56 +01:00
update-searxng.rst [fix] typos in documentation & messages 2023-08-13 08:50:29 +02:00