This commit is contained in:
Markus Heiser 2024-03-08 10:53:43 -08:00 committed by GitHub
commit 63efeb16dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 111 additions and 1504 deletions

View file

@ -11,8 +11,9 @@
port: 8888
bind_address: "127.0.0.1"
secret_key: "ultrasecretkey" # change this!
limiter: false
public_instance: false
limiter: false
pass_searxng_org: false
image_proxy: false
default_http_headers:
X-Content-Type-Options : nosniff
@ -31,10 +32,6 @@
``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.
.. _public_instance:
``public_instance`` :
@ -43,7 +40,21 @@
needed for local usage). By set to ``true`` the following features are
activated:
- :py:obj:`searx.botdetection.link_token` in the :ref:`limiter`
- ``server: limiter`` option :ref:`see below <activate limiter>`
- ``server: pass_searxng_org`` option :ref:`see below <pass_searxng_org>`
- :py:obj:`botdetection.link_token` in the :ref:`limiter`
.. _activate limiter:
``limiter`` :
Rate limit the number of request on the instance, block some bots. The
:ref:`limiter` requires a :ref:`settings redis` database.
.. _pass_searxng_org:
``pass_searxng_org`` :
In the limiter activates the passlist of (hardcoded) IPs of the SearXNG
organization, e.g. ``check.searx.space``.
.. _image_proxy:

View file

@ -150,6 +150,7 @@ intersphinx_mapping = {
"linuxdoc" : ("https://return42.github.io/linuxdoc/", None),
"sphinx" : ("https://www.sphinx-doc.org/en/master/", None),
"redis": ('https://redis.readthedocs.io/en/stable/', None),
"botdetection" : ("https://searxng.org/botdetection/", None),
}
issues_github_path = "searxng/searxng"

View file

@ -1,62 +0,0 @@
.. _botdetection:
=============
Bot Detection
=============
.. contents::
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.botdetection
:members:
.. _botdetection ip_lists:
IP lists
========
.. automodule:: searx.botdetection.ip_lists
:members:
.. _botdetection rate limit:
Rate limit
==========
.. automodule:: searx.botdetection.ip_limit
:members:
.. automodule:: searx.botdetection.link_token
:members:
.. _botdetection probe headers:
Probe HTTP headers
==================
.. automodule:: searx.botdetection.http_accept
:members:
.. automodule:: searx.botdetection.http_accept_encoding
:members:
.. automodule:: searx.botdetection.http_accept_language
:members:
.. automodule:: searx.botdetection.http_connection
:members:
.. automodule:: searx.botdetection.http_user_agent
:members:
.. _botdetection config:
Config
======
.. automodule:: searx.botdetection.config
:members: