settings.yml

settings.yml

`settings.yml`

This page describe the options possibilities of the file.

settings.yml location

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

the full path specified in the SEARXNG_SETTINGS_PATH environment variable.
/etc/searxng/settings.yml

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

use_default_settings

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

use_default_settings: true

server: : In the following example, the actual settings are the default settings defined in with the exception of the secret_key and the bind_address:

```
use_default_settings: true
server:
    secret_key: "ultrasecretkey"   # change this!
    bind_address: "[::]"
```

engines: : 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
server:
  secret_key: "ultrasecretkey"   # change this!
engines:
  - 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:

```
use_default_settings:
  engines:
    remove:
      - google
server:
  secret_key: "ultrasecretkey"   # change this!
engines:
  - 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:

```
use_default_settings:
  engines:
    keep_only:
      - google
      - duckduckgo
server:
  secret_key: "ultrasecretkey"   # change this!
engines:
  - name: google
    tokens: ['$ecretValue']
  - name: duckduckgo
    tokens: ['$ecretValue']
```

Made with Furo

💾 🌐