settings_search.rst 2.5 KB

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