settings_search.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. .. _settings search:
  2. ===========
  3. ``search:``
  4. ===========
  5. .. code:: yaml
  6. search:
  7. safe_search: 0
  8. autocomplete: ""
  9. favicon_resolver: ""
  10. default_lang: ""
  11. ban_time_on_fail: 5
  12. max_ban_time_on_fail: 120
  13. suspended_times:
  14. SearxEngineAccessDenied: 86400
  15. SearxEngineCaptcha: 86400
  16. SearxEngineTooManyRequests: 3600
  17. cf_SearxEngineCaptcha: 1296000
  18. cf_SearxEngineAccessDenied: 86400
  19. recaptcha_SearxEngineCaptcha: 604800
  20. formats:
  21. - html
  22. ``safe_search``:
  23. Filter results.
  24. - ``0``: None
  25. - ``1``: Moderate
  26. - ``2``: Strict
  27. ``autocomplete``:
  28. Existing autocomplete backends, leave blank to turn it off.
  29. - ``dbpedia``
  30. - ``duckduckgo``
  31. - ``google``
  32. - ``mwmbl``
  33. - ``startpage``
  34. - ``swisscows``
  35. - ``qwant``
  36. - ``wikipedia``
  37. ``favicon_resolver``:
  38. To activate favicons in SearXNG's result list select a default
  39. favicon-resolver, leave blank to turn off the feature. Don't activate the
  40. favicons before reading the :ref:`Favicons documentation <favicons>`.
  41. ``default_lang``:
  42. Default search language - leave blank to detect from browser information or
  43. use codes from :origin:`searx/languages.py`.
  44. ``languages``:
  45. List of available languages - leave unset to use all codes from
  46. :origin:`searx/languages.py`. Otherwise list codes of available languages.
  47. The ``all`` value is shown as the ``Default language`` in the user interface
  48. (in most cases, it is meant to send the query without a language parameter ;
  49. in some cases, it means the English language) Example:
  50. .. code:: yaml
  51. languages:
  52. - all
  53. - en
  54. - en-US
  55. - de
  56. - it-IT
  57. - fr
  58. - fr-BE
  59. ``ban_time_on_fail``:
  60. Ban time in seconds after engine errors.
  61. ``max_ban_time_on_fail``:
  62. Max ban time in seconds after engine errors.
  63. ``suspended_times``:
  64. Engine suspension time after error (in seconds; set to 0 to disable)
  65. ``SearxEngineAccessDenied``: 86400
  66. For error "Access denied" and "HTTP error [402, 403]"
  67. ``SearxEngineCaptcha``: 86400
  68. For error "CAPTCHA"
  69. ``SearxEngineTooManyRequests``: 3600
  70. For error "Too many request" and "HTTP error 429"
  71. Cloudflare CAPTCHA:
  72. - ``cf_SearxEngineCaptcha``: 1296000
  73. - ``cf_SearxEngineAccessDenied``: 86400
  74. Google CAPTCHA:
  75. - ``recaptcha_SearxEngineCaptcha``: 604800
  76. ``formats``:
  77. Result formats available from web, remove format to deny access (use lower
  78. case).
  79. - ``html``
  80. - ``csv``
  81. - ``json``
  82. - ``rss``