settings_search.rst 2.8 KB

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