settings_search.rst 2.2 KB

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