This page describe the options possibilities of the git://searx/settings.yml file.

settings.yml location

The initial settings.yml we be load from these locations:

  1. the full path specified in the SEARXNG_SETTINGS_PATH environment variable.

  2. /etc/searxng/settings.yml

If these files don’t exist (or are empty or can’t be read), SearXNG uses the git://searx/settings.yml file. Read use_default_settings to see how you can simplify your user defined settings.yml.

Global Settings


issue_url :

If you host your own issue tracker change this URL.

docs_url :

If you host your own documentation change this URL.

public_instances :

If you host your own change this URL.

wiki_url :

Link to your wiki (or false)


  debug: false
  instance_name:  "SearXNG"
  privacypolicy_url: false
  contact_url: false
  enable_metrics: true

Allow a more detailed log if you run SearXNG directly. Display detailed error messages in the browser too, so this must be deactivated in production.

donation_url :

At default the donation link points to the SearXNG project. Set value to true to use your own donation page written in the searx/info/en/ and use false to disable the donation link altogether.


Link to privacy policy.


Contact mailto: address or WEB form.


Enabled by default. Record various anonymous metrics availabled at /stats, /stats/errors and /preferences.


    base_url:  # change this!
    port: 8888
    bind_address: ""
    secret_key: "ultrasecretkey"           # change this!
    limiter: false
    image_proxy: false
      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 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 (utils/brand.env)

port & bind_address: $SEARXNG_PORT & $SEARXNG_BIND_ADDRESS buildenv

Port number and bind address of the SearXNG web application if you run it directly using python searx/ 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 (utils/brand.env)


Used for cryptography purpose.

limiter :

Rate limit the number of request on the instance, block some bots. The Limiter Plugin requires a redis: database.

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


  static_use_hash: false
  default_locale: ""
  query_in_title: false
  infinite_scroll: false
  center_alignment: false
  default_theme: simple
    simple_style: auto
static_use_hash :

Enables cache busting of static files.

default_locale :

SearXNG interface language. If blank, the locale is detected by using the browser language. If it doesn’t work, or you are deploying a language specific instance of searx, a locale can be defined using an ISO language code, like fr, en, de.

query_in_title :

When true, the result page’s titles contains the query it decreases the privacy, since the browser can records the page titles.


When true, automatically loads the next page when scrolling to bottom of the current page.

center_alignmentdefault false

When enabled, the results are centered instead of being in the left (or RTL) side of the screen. This setting only affects the desktop layout (min-width: @tablet)


URL prefix of the internet archive or cache, don’t forgett trailing slash (if needed). The default is alternatives are:

default_theme :

Name of the theme you want to use by default on your SearXNG instance.


Style of simple theme: auto, light, dark


Open result links in a new tab by default.


A redis DB can be connected by an URL, in searx.redisdb you will find a description to test your redis connection in SerXNG. When using sockets, don’t forget to check the access rights on the socket:

ls -la /usr/local/searxng-redis/run/redis.sock
srwxrwx--- 1 searxng-redis searxng-redis ... /usr/local/searxng-redis/run/redis.sock

In this example read/write access is given to the searxng-redis group. To get access rights to redis instance (the socket), your SearXNG (or even your developer) account needs to be added to the searxng-redis group.


URL to connect redis database, see Redis.from_url(url) & Redis DB:


Tip for developers

To set up a local redis instance, first set the socket path of the Redis DB in your YAML setting:

  url: unix:///usr/local/searxng-redis/run/redis.sock?db=0

Then use the following commands to install the redis instance

$ ./manage
$ sudo -H ./manage redis.install
$ sudo -H ./manage redis.addgrp "${USER}"
# don't forget to logout & login to get member of group


Communication with search engines.

  request_timeout: 2.0       # default timeout in seconds, can be override by engine
  max_request_timeout: 10.0  # the maximum timeout in seconds
  useragent_suffix: ""       # information like an email address to the administrator
  pool_connections: 100      # Maximum number of allowable connections, or null
                             # for no limits. The default is 100.
  pool_maxsize: 10           # Number of allowable keep-alive connections, or null
                             # to always allow. The default is 10.
  enable_http2: true         # See
  # uncomment below section if you want to use a custom server certificate
  # see
  # and
  #  verify: ~/.mitmproxy/mitmproxy-ca-cert.cer
  # uncomment below section if you want to use a proxyq see: SOCKS proxies
  # are also supported: see
  #  proxies:
  #    all://:
  #      - http://proxy1:8080
  #      - http://proxy2:8080
  #  using_tor_proxy: true
  # Extra seconds to add in order to account for the time taken by the proxy
  #  extra_proxy_timeout: 10.0
request_timeout :

Global timeout of the requests made to others engines in seconds. A bigger timeout will allow to wait for answers from slow engines, but in consequence will slow SearXNG reactivity (the result page may take the time specified in the timeout to load). Can be override by Engine settings

useragent_suffix :

Suffix to the user-agent SearXNG uses to send requests to others engines. If an engine wish to block you, a contact info here may be useful to avoid that.

keepalive_expiry :

Number of seconds to keep a connection in the pool. By default 5.0 seconds.

proxies :

Define one or more proxies you wish to use, see httpx proxies. If there are more than one proxy for one protocol (http, https), requests to the engines are distributed in a round-robin fashion.

source_ips :

If you use multiple network interfaces, define from which IP the requests must be made. Example:

  • any local IPv4 address.

  • :: any local IPv6 address.


  • [, ] these two specific IP addresses

  • fe80::60a2:1691:e5a2:ee1f

  • fe80::60a2:1691:e5a2:ee1f/126 all IP addresses in this network.

  • [, fe80::/126 ]

retries :

Number of retry in case of an HTTP error. On each retry, SearXNG uses an different proxy and source ip.

retry_on_http_error :

Retry request on some HTTP status code.


  • true : on HTTP status code between 400 and 599.

  • 403 : on HTTP status code 403.

  • [403, 429]: on HTTP status code 403 and 429.

enable_http2 :

Enable by default. Set to false to disable HTTP/2.


Allow to specify a path to certificate. see httpx verification defaults.

In addition to verify, SearXNG supports the $SSL_CERT_FILE (for a file) and $SSL_CERT_DIR (for a directory) OpenSSL variables. see httpx ssl configuration.

max_redirects :

30 by default. Maximum redirect before it is an error.


A list of the categories that are displayed as tabs in the user interface. Categories not listed here can still be searched with the Search syntax.

  social media:

Engine settings

In the code example below a full fledged example of a YAML setup from a dummy engine is shown. Most of the options have a default value or even are optional.

- name: example engine
  engine: example
  shortcut: demo
  base_url: 'https://{language}'
  send_accept_language_header: false
  categories: general
  timeout: 3.0
  api_key: 'apikey'
  disabled: false
  language: en_US
  tokens: [ 'my-secret-token' ]
  weigth: 1
  display_error_messages: true
     wikidata_id: Q306656
     use_official_api: true
     require_api_key: true
     results: HTML
  enable_http: false
  enable_http2: false
  retries: 1
  retry_on_http_error: true # or 403 or [404, 429]
  max_connections: 100
  max_keepalive_connections: 10
  keepalive_expiry: 5.0
      - http://proxy1:8080
      - http://proxy2:8080
      - http://proxy1:8080
      - http://proxy2:8080
      - socks5://user:password@proxy3:1080
      - socks5h://user:password@proxy4:1080
name :

Name that will be used across SearXNG to define this engine. In settings, on the result page…

engine :

Name of the python file used to handle requests and responses to and from this search engine.

shortcut :

Code used to execute bang requests (in this case using !bi)


Part of the URL that should be stable across every request. Can be useful to use multiple sites using only one engine, or updating the site URL without touching at the code.

send_accept_language_header :

Several engines that support languages (or regions) deal with the HTTP header Accept-Language to build a response that fits to the locale. When this option is activated, the language (locale) that is selected by the user is used to build and send a Accept-Language header in the request to the origin search engine.


Define in which categories this engine will be active. Most of the time, it is defined in the code of the engine, but in a few cases it is useful, like when describing multiple search engine using the same code.


Timeout of the search with the current search engine. Be careful, it will modify the global timeout of SearXNG.


In a few cases, using an API needs the use of a secret key. How to obtain them is described in the file.


To disable by default the engine, but not deleting it. It will allow the user to manually activate it in the settings.

inactive: optional

Remove the engine from the settings (disabled & removed).


If you want to use another language for a specific engine, you can define it by using the ISO code of language (and region), like fr, en-US, de-DE.


A list of secret tokens to make this engine private, more details see Private Engines (tokens).

weigthdefault 1

Weighting of the results of this engine.

display_error_messagesdefault true

When an engine returns an error, the message is displayed on the user interface.


Use the network configuration from another engine. In addition, there are two default networks:

  • ipv4 set local_addresses to (use only IPv4 local addresses)

  • ipv6 set local_addresses to :: (use only IPv6 local addresses)


A few more options are possible, but they are pretty specific to some engines, and so won’t be described here.


The user defined settings.yml is loaded from the settings.yml location and can relied on the default configuration git://searx/settings.yml using:

use_default_settings: true


In the following example, the actual settings are the default settings defined in git://searx/settings.yml with the exception of the secret_key and the bind_address:

use_default_settings: true
    secret_key: "ultrasecretkey"   # change this!
    bind_address: ""

With use_default_settings: true, each settings can be override in a similar way, the engines section is merged according to the engine name. In this example, SearXNG will load all the default engines, will enable the bing engine and define a token for the arch linux engine:

use_default_settings: true
  secret_key: "ultrasecretkey"   # change this!
  - name: arch linux wiki
    tokens: ['$ecretValue']
  - name: bing
    disabled: false
engines: / remove:

It is possible to remove some engines from the default settings. The following example is similar to the above one, but SearXNG doesn’t load the the google engine:

      - google
  secret_key: "ultrasecretkey"   # change this!
  - name: arch linux wiki
    tokens: ['$ecretValue']
engines: / keep_only:

As an alternative, it is possible to specify the engines to keep. In the following example, SearXNG has only two engines:

      - google
      - duckduckgo
  secret_key: "ultrasecretkey"   # change this!
  - name: google
    tokens: ['$ecretValue']
  - name: duckduckgo
    tokens: ['$ecretValue']