settings_search.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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. :ref:`Favicon resolver <favicons>`, leave blank to turn off the feature by
  39. default.
  40. - ``allesedv``
  41. - ``duckduckgo``
  42. - ``google``
  43. - ``yandex``
  44. ``default_lang``:
  45. Default search language - leave blank to detect from browser information or
  46. use codes from :origin:`searx/languages.py`.
  47. ``languages``:
  48. List of available languages - leave unset to use all codes from
  49. :origin:`searx/languages.py`. Otherwise list codes of available languages.
  50. The ``all`` value is shown as the ``Default language`` in the user interface
  51. (in most cases, it is meant to send the query without a language parameter ;
  52. in some cases, it means the English language) Example:
  53. .. code:: yaml
  54. languages:
  55. - all
  56. - en
  57. - en-US
  58. - de
  59. - it-IT
  60. - fr
  61. - fr-BE
  62. ``ban_time_on_fail``:
  63. Ban time in seconds after engine errors.
  64. ``max_ban_time_on_fail``:
  65. Max ban time in seconds after engine errors.
  66. ``suspended_times``:
  67. Engine suspension time after error (in seconds; set to 0 to disable)
  68. ``SearxEngineAccessDenied``: 86400
  69. For error "Access denied" and "HTTP error [402, 403]"
  70. ``SearxEngineCaptcha``: 86400
  71. For error "CAPTCHA"
  72. ``SearxEngineTooManyRequests``: 3600
  73. For error "Too many request" and "HTTP error 429"
  74. Cloudflare CAPTCHA:
  75. - ``cf_SearxEngineCaptcha``: 1296000
  76. - ``cf_SearxEngineAccessDenied``: 86400
  77. Google CAPTCHA:
  78. - ``recaptcha_SearxEngineCaptcha``: 604800
  79. ``formats``:
  80. Result formats available from web, remove format to deny access (use lower
  81. case).
  82. - ``html``
  83. - ``csv``
  84. - ``json``
  85. - ``rss``