Clemens/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2026-05-31 06:57:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

[mod] settings.yml: set engines that require an api key to inactive by default

Browse Source
This commit is contained in:
Tommaso Colella
2025-12-29 15:20:43 +01:00
committed by GitHub
parent abae17e6fc
commit 320c317719
2 changed files with 91 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/settings/settings_engines.rst
+5 -2
View File
@@ -124,14 +124,17 @@ engine is shown. Most of the options have a default value or even are optional.
``api_key`` : optional ``api_key`` : optional
In a few cases, using an API needs the use of a secret key. How to obtain them In a few cases, using an API needs the use of a secret key. How to obtain them
is described in the file. is described in the file. Engines that require an API key are set to
``inactive: true`` by default. To enable such an engine, provide the API key
and set ``inactive: false``.
``disabled`` : optional ``disabled`` : optional
To disable by default the engine, but not deleting it. It will allow the user To disable by default the engine, but not deleting it. It will allow the user
to manually activate it in the settings. to manually activate it in the settings.
``inactive``: optional ``inactive``: optional
Remove the engine from the settings (*disabled & removed*). Remove the engine from the settings (*disabled & removed*). This defaults to ``true`` for engines
that require an API key, please see the ``api_key`` section if you want to enable such an engine.
``language`` : optional ``language`` : optional
If you want to use another language for a specific engine, you can define it If you want to use another language for a specific engine, you can define it
searx/settings.yml
+86 -78
View File
@@ -480,14 +480,14 @@ engines:
shortcut: ask shortcut: ask
disabled: true disabled: true
# - name: azure - name: azure
# engine: azure engine: azure
# shortcut: az shortcut: az
# categories: [it, cloud] categories: [it, cloud]
# azure_tenant_id: "your_tenant_id" # azure_tenant_id: "your_tenant_id"
# azure_client_id: "your_client_id" # azure_client_id: "your_client_id"
# azure_client_secret: "your_client_secret" # azure_client_secret: "your_client_secret"
# disabled: true inactive: true
# tmp suspended: dh key too small # tmp suspended: dh key too small
# - name: base # - name: base
@@ -649,7 +649,7 @@ engines:
# cf_ai_model_assistant: 'prompts_for_assistant_role' # cf_ai_model_assistant: 'prompts_for_assistant_role'
# cf_ai_model_system: 'prompts_for_system_role' # cf_ai_model_system: 'prompts_for_system_role'
timeout: 30 timeout: 30
disabled: true inactive: true
- name: core.ac.uk - name: core.ac.uk
engine: core engine: core
@@ -783,20 +783,20 @@ engines:
require_api_key: false require_api_key: false
results: HTML results: HTML
# - name: elasticsearch - name: elasticsearch
# shortcut: els shortcut: els
# engine: elasticsearch engine: elasticsearch
# base_url: http://localhost:9200 # base_url: http://localhost:9200
# username: elastic # username: elastic
# password: changeme # password: changeme
# index: my-index # index: my-index
# enable_http: true # enable_http: true
# # available options: match, simple_query_string, term, terms, custom # available options: match, simple_query_string, term, terms, custom
# query_type: match query_type: match
# # if query_type is set to custom, provide your query here # if query_type is set to custom, provide your query here
# # custom_query_json: {"query":{"match_all": {}}} # custom_query_json: {"query":{"match_all": {}}}
# # show_metadata: false # show_metadata: false
# disabled: true inactive: true
- name: wikidata - name: wikidata
engine: wikidata engine: wikidata
@@ -874,12 +874,12 @@ engines:
require_api_key: false require_api_key: false
results: HTML results: HTML
# - name: ebay - name: ebay
# engine: ebay engine: ebay
# shortcut: eb shortcut: eb
# base_url: 'https://www.ebay.com' base_url: 'https://www.ebay.com'
# disabled: true inactive: true
# timeout: 5 timeout: 5
- name: 1x - name: 1x
engine: www1x engine: www1x
@@ -900,12 +900,16 @@ engines:
- name: flickr - name: flickr
categories: images categories: images
shortcut: fl shortcut: fl
engine: flickr_noapi
- name: flickr_api
# You can use the engine using the official stable API, but you need an API # You can use the engine using the official stable API, but you need an API
# key, see: https://www.flickr.com/services/apps/create/ # key, see: https://www.flickr.com/services/apps/create/
# engine: flickr engine: flickr
categories: images
shortcut: fla
# api_key: 'apikey' # required! # api_key: 'apikey' # required!
# Or you can use the html non-stable engine, activated by default inactive: true
engine: flickr_noapi
- name: free software directory - name: free software directory
engine: mediawiki engine: mediawiki
@@ -919,13 +923,13 @@ engines:
website: https://directory.fsf.org/ website: https://directory.fsf.org/
wikidata_id: Q2470288 wikidata_id: Q2470288
# - name: freesound - name: freesound
# engine: freesound engine: freesound
# shortcut: fnd shortcut: fnd
# disabled: true timeout: 15.0
# timeout: 15.0 # API key required, see: https://freesound.org/docs/api/overview.html
# API key required, see: https://freesound.org/docs/api/overview.html # api_key: MyAPIkey
# api_key: MyAPIkey inactive: true
- name: frinkiac - name: frinkiac
engine: frinkiac engine: frinkiac
@@ -980,7 +984,7 @@ engines:
- name: github code - name: github code
engine: github_code engine: github_code
shortcut: ghc shortcut: ghc
disabled: true inactive: true
ghc_auth: ghc_auth:
# type is one of: # type is one of:
# * none # * none
@@ -1267,9 +1271,9 @@ engines:
# https://github.com/LibreTranslate/LibreTranslate?tab=readme-ov-file#mirrors # https://github.com/LibreTranslate/LibreTranslate?tab=readme-ov-file#mirrors
base_url: base_url:
- https://libretranslate.com/translate - https://libretranslate.com/translate
# api_key: abc123 # api_key: ''
shortcut: lt shortcut: lt
disabled: true inactive: true
- name: lingva - name: lingva
engine: lingva engine: lingva
@@ -1306,7 +1310,7 @@ engines:
shortcut: mar shortcut: mar
# To get an API key, please follow the instructions at # To get an API key, please follow the instructions at
# - https://about.marginalia-search.com/article/api/ # - https://about.marginalia-search.com/article/api/
# api_key: ... # api_key: ''
disabled: true disabled: true
inactive: true inactive: true
@@ -2087,19 +2091,19 @@ engines:
# engine in combination with Jackett opens the possibility to query a lot of # engine in combination with Jackett opens the possibility to query a lot of
# public and private indexers directly from SearXNG. More details at: # public and private indexers directly from SearXNG. More details at:
# https://docs.searxng.org/dev/engines/online/torznab.html # https://docs.searxng.org/dev/engines/online/torznab.html
# - name: Torznab EZTV
# - name: Torznab EZTV engine: torznab
# engine: torznab shortcut: eztv
# shortcut: eztv # base_url: http://localhost:9117/api/v2.0/indexers/eztv/results/torznab
# base_url: http://localhost:9117/api/v2.0/indexers/eztv/results/torznab # enable_http: true # if using localhost
# enable_http: true # if using localhost # api_key: xxxxxxxxxxxxxxx
# api_key: xxxxxxxxxxxxxxx show_magnet_links: true
# show_magnet_links: true show_torrent_files: false
# show_torrent_files: false # https://github.com/Jackett/Jackett/wiki/Jackett-Categories
# # https://github.com/Jackett/Jackett/wiki/Jackett-Categories torznab_categories: # optional
# torznab_categories: # optional - 2000
# - 2000 - 5000
# - 5000 inactive: true
# tmp suspended - too slow, too many errors # tmp suspended - too slow, too many errors
# - name: urbandictionary # - name: urbandictionary
@@ -2147,14 +2151,15 @@ engines:
- name: youtube - name: youtube
shortcut: yt shortcut: yt
engine: youtube_noapi
- name: youtube_api
# You can use the engine using the official stable API, but you need an API # You can use the engine using the official stable API, but you need an API
# key See: https://console.developers.google.com/project # key See: https://console.developers.google.com/project
# engine: youtube_api
# engine: youtube_api # api_key: '' # required!
# api_key: 'apikey' # required! shortcut: yta
# inactive: true
# Or you can use the html non-stable engine, activated by default
engine: youtube_noapi
- name: dailymotion - name: dailymotion
engine: dailymotion engine: dailymotion
@@ -2307,18 +2312,21 @@ engines:
- name: wolframalpha - name: wolframalpha
shortcut: wa shortcut: wa
# You can use the engine using the official stable API, but you need an API
# key. See: https://products.wolframalpha.com/api/
#
# engine: wolframalpha_api
# api_key: ''
#
# Or you can use the html non-stable engine, activated by default
engine: wolframalpha_noapi engine: wolframalpha_noapi
timeout: 6.0 timeout: 6.0
categories: general categories: general
disabled: true disabled: true
- name: wolframalpha_api
# You can use the engine using the official stable API, but you need an API
# key. See: https://products.wolframalpha.com/api/
engine: wolframalpha_api
# api_key: '' # required!
shortcut: waa
timeout: 6.0
categories: general
inactive: true
- name: dictzone - name: dictzone
engine: dictzone engine: dictzone
shortcut: dc shortcut: dc
@@ -2366,14 +2374,14 @@ engines:
engine: seznam engine: seznam
disabled: true disabled: true
# - name: deepl - name: deepl
# engine: deepl engine: deepl
# shortcut: dpl shortcut: dpl
# # You can use the engine using the official stable API, but you need an API key # You can use the engine using the official stable API, but you need an API key
# # See: https://www.deepl.com/pro-api?cta=header-pro-api # See: https://www.deepl.com/pro-api?cta=header-pro-api
# api_key: '' # required! # api_key: '' # required!
# timeout: 5.0 timeout: 5.0
# disabled: true inactive: true
- name: mojeek - name: mojeek
shortcut: mjk shortcut: mjk
@@ -2588,7 +2596,7 @@ engines:
engine: wallhaven engine: wallhaven
# api_key: abcdefghijklmnopqrstuvwxyz # api_key: abcdefghijklmnopqrstuvwxyz
shortcut: wh shortcut: wh
disabled: true inactive: true
# wikimini: online encyclopedia for children # wikimini: online encyclopedia for children
# The fulltext and title parameter is necessary for Wikimini because # The fulltext and title parameter is necessary for Wikimini because