settings_search.rst 2.2 KB

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