diff --git a/docs/admin/settings/settings_engines.rst b/docs/admin/settings/settings_engines.rst index c614d8b59..ac85947c3 100644 --- a/docs/admin/settings/settings_engines.rst +++ b/docs/admin/settings/settings_engines.rst @@ -124,14 +124,17 @@ engine is shown. Most of the options have a default value or even are optional. ``api_key`` : optional 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 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*). + 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 If you want to use another language for a specific engine, you can define it diff --git a/searx/settings.yml b/searx/settings.yml index 26baa9e2f..73f8a8242 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -480,14 +480,14 @@ engines: shortcut: ask disabled: true - # - name: azure - # engine: azure - # shortcut: az - # categories: [it, cloud] - # azure_tenant_id: "your_tenant_id" - # azure_client_id: "your_client_id" - # azure_client_secret: "your_client_secret" - # disabled: true + - name: azure + engine: azure + shortcut: az + categories: [it, cloud] + # azure_tenant_id: "your_tenant_id" + # azure_client_id: "your_client_id" + # azure_client_secret: "your_client_secret" + inactive: true # tmp suspended: dh key too small # - name: base @@ -649,7 +649,7 @@ engines: # cf_ai_model_assistant: 'prompts_for_assistant_role' # cf_ai_model_system: 'prompts_for_system_role' timeout: 30 - disabled: true + inactive: true - name: core.ac.uk engine: core @@ -783,20 +783,20 @@ engines: require_api_key: false results: HTML - # - name: elasticsearch - # shortcut: els - # engine: elasticsearch - # base_url: http://localhost:9200 - # username: elastic - # password: changeme - # index: my-index - # enable_http: true - # # available options: match, simple_query_string, term, terms, custom - # query_type: match - # # if query_type is set to custom, provide your query here - # # custom_query_json: {"query":{"match_all": {}}} - # # show_metadata: false - # disabled: true + - name: elasticsearch + shortcut: els + engine: elasticsearch + # base_url: http://localhost:9200 + # username: elastic + # password: changeme + # index: my-index + # enable_http: true + # available options: match, simple_query_string, term, terms, custom + query_type: match + # if query_type is set to custom, provide your query here + # custom_query_json: {"query":{"match_all": {}}} + # show_metadata: false + inactive: true - name: wikidata engine: wikidata @@ -874,12 +874,12 @@ engines: require_api_key: false results: HTML - # - name: ebay - # engine: ebay - # shortcut: eb - # base_url: 'https://www.ebay.com' - # disabled: true - # timeout: 5 + - name: ebay + engine: ebay + shortcut: eb + base_url: 'https://www.ebay.com' + inactive: true + timeout: 5 - name: 1x engine: www1x @@ -900,12 +900,16 @@ engines: - name: flickr categories: images shortcut: fl + engine: flickr_noapi + + - name: flickr_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/ - # engine: flickr + engine: flickr + categories: images + shortcut: fla # api_key: 'apikey' # required! - # Or you can use the html non-stable engine, activated by default - engine: flickr_noapi + inactive: true - name: free software directory engine: mediawiki @@ -919,13 +923,13 @@ engines: website: https://directory.fsf.org/ wikidata_id: Q2470288 - # - name: freesound - # engine: freesound - # shortcut: fnd - # disabled: true - # timeout: 15.0 - # API key required, see: https://freesound.org/docs/api/overview.html - # api_key: MyAPIkey + - name: freesound + engine: freesound + shortcut: fnd + timeout: 15.0 + # API key required, see: https://freesound.org/docs/api/overview.html + # api_key: MyAPIkey + inactive: true - name: frinkiac engine: frinkiac @@ -980,7 +984,7 @@ engines: - name: github code engine: github_code shortcut: ghc - disabled: true + inactive: true ghc_auth: # type is one of: # * none @@ -1267,9 +1271,9 @@ engines: # https://github.com/LibreTranslate/LibreTranslate?tab=readme-ov-file#mirrors base_url: - https://libretranslate.com/translate - # api_key: abc123 + # api_key: '' shortcut: lt - disabled: true + inactive: true - name: lingva engine: lingva @@ -1306,7 +1310,7 @@ engines: shortcut: mar # To get an API key, please follow the instructions at # - https://about.marginalia-search.com/article/api/ - # api_key: ... + # api_key: '' disabled: true inactive: true @@ -2087,19 +2091,19 @@ engines: # engine in combination with Jackett opens the possibility to query a lot of # public and private indexers directly from SearXNG. More details at: # https://docs.searxng.org/dev/engines/online/torznab.html - # - # - name: Torznab EZTV - # engine: torznab - # shortcut: eztv - # base_url: http://localhost:9117/api/v2.0/indexers/eztv/results/torznab - # enable_http: true # if using localhost - # api_key: xxxxxxxxxxxxxxx - # show_magnet_links: true - # show_torrent_files: false - # # https://github.com/Jackett/Jackett/wiki/Jackett-Categories - # torznab_categories: # optional - # - 2000 - # - 5000 + - name: Torznab EZTV + engine: torznab + shortcut: eztv + # base_url: http://localhost:9117/api/v2.0/indexers/eztv/results/torznab + # enable_http: true # if using localhost + # api_key: xxxxxxxxxxxxxxx + show_magnet_links: true + show_torrent_files: false + # https://github.com/Jackett/Jackett/wiki/Jackett-Categories + torznab_categories: # optional + - 2000 + - 5000 + inactive: true # tmp suspended - too slow, too many errors # - name: urbandictionary @@ -2147,14 +2151,15 @@ engines: - name: youtube shortcut: yt + engine: youtube_noapi + + - name: youtube_api # You can use the engine using the official stable API, but you need an API # key See: https://console.developers.google.com/project - # - # engine: youtube_api - # api_key: 'apikey' # required! - # - # Or you can use the html non-stable engine, activated by default - engine: youtube_noapi + engine: youtube_api + # api_key: '' # required! + shortcut: yta + inactive: true - name: dailymotion engine: dailymotion @@ -2307,18 +2312,21 @@ engines: - name: wolframalpha 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 timeout: 6.0 categories: general 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 engine: dictzone shortcut: dc @@ -2366,14 +2374,14 @@ engines: engine: seznam disabled: true - # - name: deepl - # engine: deepl - # shortcut: dpl - # # 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 - # api_key: '' # required! - # timeout: 5.0 - # disabled: true + - name: deepl + engine: deepl + shortcut: dpl + # 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 + # api_key: '' # required! + timeout: 5.0 + inactive: true - name: mojeek shortcut: mjk @@ -2588,7 +2596,7 @@ engines: engine: wallhaven # api_key: abcdefghijklmnopqrstuvwxyz shortcut: wh - disabled: true + inactive: true # wikimini: online encyclopedia for children # The fulltext and title parameter is necessary for Wikimini because