mirror of
https://github.com/searxng/searxng.git
synced 2024-09-22 04:50:14 +02:00
fd814aac86
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>
53 lines
1.7 KiB
ReStructuredText
53 lines
1.7 KiB
ReStructuredText
.. _settings server:
|
|
|
|
===========
|
|
``server:``
|
|
===========
|
|
|
|
.. code:: yaml
|
|
|
|
server:
|
|
base_url: http://example.org/location # change this!
|
|
port: 8888
|
|
bind_address: "127.0.0.1"
|
|
secret_key: "ultrasecretkey" # change this!
|
|
limiter: false
|
|
image_proxy: false
|
|
default_http_headers:
|
|
X-Content-Type-Options : nosniff
|
|
X-XSS-Protection : 1; mode=block
|
|
X-Download-Options : noopen
|
|
X-Robots-Tag : noindex, nofollow
|
|
Referrer-Policy : no-referrer
|
|
|
|
|
|
``base_url`` : ``$SEARXNG_URL`` :ref:`buildenv <make buildenv>`
|
|
The base URL where SearXNG is deployed. Used to create correct inbound links.
|
|
If you change the value, don't forget to rebuild instance's environment
|
|
(:ref:`utils/brand.env <make buildenv>`)
|
|
|
|
``port`` & ``bind_address``: ``$SEARXNG_PORT`` & ``$SEARXNG_BIND_ADDRESS`` :ref:`buildenv <make buildenv>`
|
|
Port number and *bind address* of the SearXNG web application if you run it
|
|
directly using ``python searx/webapp.py``. Doesn't apply to a SearXNG
|
|
services running behind a proxy and using socket communications. If you
|
|
change the value, don't forget to rebuild instance's environment
|
|
(:ref:`utils/brand.env <make buildenv>`)
|
|
|
|
``secret_key`` : ``$SEARXNG_SECRET``
|
|
Used for cryptography purpose.
|
|
|
|
``limiter`` :
|
|
Rate limit the number of request on the instance, block some bots. The
|
|
:ref:`limiter` requires a :ref:`settings redis` database.
|
|
|
|
.. _image_proxy:
|
|
|
|
``image_proxy`` :
|
|
Allow your instance of SearXNG of being able to proxy images. Uses memory space.
|
|
|
|
.. _HTTP headers: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
|
|
|
|
``default_http_headers`` :
|
|
Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__
|
|
|