settings_search.rst 2.8 KB

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