searxng/docs/admin/settings/settings_server.rst
Markus Heiser a2ee107dd7 [mod] botdetection - outsourcing to an external project
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-02-26 17:24:54 +01:00

2.1 KiB

server:

server:
    base_url: http://example.org/location  # change this!
    port: 8888
    bind_address: "127.0.0.1"
    secret_key: "ultrasecretkey"           # change this!
    public_instance: false
    limiter: false
    pass_searxng_org: false
    image_proxy: false
    default_http_headers:
      X-Content-Type-Options : nosniff
      X-Download-Options : noopen
      X-Robots-Tag : noindex, nofollow
      Referrer-Policy : no-referrer
base_url : $SEARXNG_URL

The base URL where SearXNG is deployed. Used to create correct inbound links.

port & bind_address: $SEARXNG_PORT & $SEARXNG_BIND_ADDRESS

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.

secret_key : $SEARXNG_SECRET

Used for cryptography purpose.

public_instance :

Setting that allows to enable features specifically for public instances (not needed for local usage). By set to true the following features are activated:

  • server: limiter option see below <activate limiter>
  • server: pass_searxng_org option see below <pass_searxng_org>
  • :pybotdetection.link_token in the limiter
limiter :

Rate limit the number of request on the instance, block some bots. The limiter requires a settings redis database.

pass_searxng_org :

In the limiter activates the passlist of (hardcoded) IPs of the SearXNG organization, e.g. check.searx.space.

image_proxy :

Allow your instance of SearXNG of being able to proxy images. Uses memory space.

default_http_headers :

Set additional HTTP headers, see #755