settings_search.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>search: &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
  8. <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../_static/documentation_options.js?v=b12b0e12"></script>
  11. <script src="../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../genindex.html" />
  15. <link rel="search" title="Search" href="../../search.html" />
  16. <link rel="next" title="server:" href="settings_server.html" />
  17. <link rel="prev" title="general:" href="settings_general.html" />
  18. </head><body>
  19. <div class="related" role="navigation" aria-label="Related">
  20. <h3>Navigation</h3>
  21. <ul>
  22. <li class="right" style="margin-right: 10px">
  23. <a href="../../genindex.html" title="General Index"
  24. accesskey="I">index</a></li>
  25. <li class="right" >
  26. <a href="../../py-modindex.html" title="Python Module Index"
  27. >modules</a> |</li>
  28. <li class="right" >
  29. <a href="settings_server.html" title="server:"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="settings_general.html" title="general:"
  33. accesskey="P">previous</a> |</li>
  34. <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
  35. <li class="nav-item nav-item-1"><a href="../index.html" >Administrator documentation</a> &#187;</li>
  36. <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Settings</a> &#187;</li>
  37. <li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
  38. </ul>
  39. </div>
  40. <div class="document">
  41. <div class="documentwrapper">
  42. <div class="bodywrapper">
  43. <div class="body" role="main">
  44. <section id="search">
  45. <span id="settings-search"></span><h1><code class="docutils literal notranslate"><span class="pre">search:</span></code><a class="headerlink" href="#search" title="Link to this heading">¶</a></h1>
  46. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">search</span><span class="p">:</span>
  47. <span class="w"> </span><span class="nt">safe_search</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
  48. <span class="w"> </span><span class="nt">autocomplete</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
  49. <span class="w"> </span><span class="nt">favicon_resolver</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
  50. <span class="w"> </span><span class="nt">default_lang</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
  51. <span class="w"> </span><span class="nt">ban_time_on_fail</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span>
  52. <span class="w"> </span><span class="nt">max_page</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
  53. <span class="w"> </span><span class="nt">max_ban_time_on_fail</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">120</span>
  54. <span class="w"> </span><span class="nt">suspended_times</span><span class="p">:</span>
  55. <span class="w"> </span><span class="nt">SearxEngineAccessDenied</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">86400</span>
  56. <span class="w"> </span><span class="nt">SearxEngineCaptcha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">86400</span>
  57. <span class="w"> </span><span class="nt">SearxEngineTooManyRequests</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3600</span>
  58. <span class="w"> </span><span class="nt">cf_SearxEngineCaptcha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1296000</span>
  59. <span class="w"> </span><span class="nt">cf_SearxEngineAccessDenied</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">86400</span>
  60. <span class="w"> </span><span class="nt">recaptcha_SearxEngineCaptcha</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">604800</span>
  61. <span class="w"> </span><span class="nt">formats</span><span class="p">:</span>
  62. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">html</span>
  63. </pre></div>
  64. </div>
  65. <dl>
  66. <dt><code class="docutils literal notranslate"><span class="pre">safe_search</span></code>:</dt><dd><p>Filter results.</p>
  67. <ul class="simple">
  68. <li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>: None</p></li>
  69. <li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>: Moderate</p></li>
  70. <li><p><code class="docutils literal notranslate"><span class="pre">2</span></code>: Strict</p></li>
  71. </ul>
  72. </dd>
  73. <dt><code class="docutils literal notranslate"><span class="pre">autocomplete</span></code>:</dt><dd><p>Existing autocomplete backends, leave blank to turn it off.</p>
  74. <ul class="simple">
  75. <li><p><code class="docutils literal notranslate"><span class="pre">360search</span></code></p></li>
  76. <li><p><code class="docutils literal notranslate"><span class="pre">baidu</span></code></p></li>
  77. <li><p><code class="docutils literal notranslate"><span class="pre">brave</span></code></p></li>
  78. <li><p><code class="docutils literal notranslate"><span class="pre">dbpedia</span></code></p></li>
  79. <li><p><code class="docutils literal notranslate"><span class="pre">duckduckgo</span></code></p></li>
  80. <li><p><code class="docutils literal notranslate"><span class="pre">google</span></code></p></li>
  81. <li><p><code class="docutils literal notranslate"><span class="pre">mwmbl</span></code></p></li>
  82. <li><p><code class="docutils literal notranslate"><span class="pre">quark</span></code></p></li>
  83. <li><p><code class="docutils literal notranslate"><span class="pre">qwant</span></code></p></li>
  84. <li><p><code class="docutils literal notranslate"><span class="pre">seznam</span></code></p></li>
  85. <li><p><code class="docutils literal notranslate"><span class="pre">sogou</span></code></p></li>
  86. <li><p><code class="docutils literal notranslate"><span class="pre">stract</span></code></p></li>
  87. <li><p><code class="docutils literal notranslate"><span class="pre">swisscows</span></code></p></li>
  88. <li><p><code class="docutils literal notranslate"><span class="pre">wikipedia</span></code></p></li>
  89. <li><p><code class="docutils literal notranslate"><span class="pre">yandex</span></code></p></li>
  90. </ul>
  91. </dd>
  92. <dt><code class="docutils literal notranslate"><span class="pre">favicon_resolver</span></code>:</dt><dd><p>To activate favicons in SearXNG’s result list select a default
  93. favicon-resolver, leave blank to turn off the feature. Don’t activate the
  94. favicons before reading the <a class="reference internal" href="../searx.favicons.html#favicons"><span class="std std-ref">Favicons documentation</span></a>.</p>
  95. </dd>
  96. <dt><code class="docutils literal notranslate"><span class="pre">default_lang</span></code>:</dt><dd><p>Default search language - leave blank to detect from browser information or
  97. use codes from <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/languages.py">git://searx/languages.py</a>.</p>
  98. </dd>
  99. <dt><code class="docutils literal notranslate"><span class="pre">languages</span></code>:</dt><dd><p>List of available languages - leave unset to use all codes from
  100. <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/languages.py">git://searx/languages.py</a>. Otherwise list codes of available languages.
  101. The <code class="docutils literal notranslate"><span class="pre">all</span></code> value is shown as the <code class="docutils literal notranslate"><span class="pre">Default</span> <span class="pre">language</span></code> in the user interface
  102. (in most cases, it is meant to send the query without a language parameter ;
  103. in some cases, it means the English language) Example:</p>
  104. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">languages</span><span class="p">:</span>
  105. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">all</span>
  106. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en</span>
  107. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en-US</span>
  108. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">de</span>
  109. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">it-IT</span>
  110. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fr</span>
  111. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fr-BE</span>
  112. </pre></div>
  113. </div>
  114. </dd>
  115. <dt><code class="docutils literal notranslate"><span class="pre">max_page</span></code>:</dt><dd><p>If engine supports paging, 0 means unlimited numbers of pages. The value
  116. is only applied if the engine itself does not have a max value that is
  117. lower than this one.</p>
  118. </dd>
  119. <dt><code class="docutils literal notranslate"><span class="pre">ban_time_on_fail</span></code>:</dt><dd><p>Ban time in seconds after engine errors.</p>
  120. </dd>
  121. <dt><code class="docutils literal notranslate"><span class="pre">max_ban_time_on_fail</span></code>:</dt><dd><p>Max ban time in seconds after engine errors.</p>
  122. </dd>
  123. <dt><code class="docutils literal notranslate"><span class="pre">suspended_times</span></code>:</dt><dd><p>Engine suspension time after error (in seconds; set to 0 to disable)</p>
  124. <dl class="simple">
  125. <dt><code class="docutils literal notranslate"><span class="pre">SearxEngineAccessDenied</span></code>: 86400</dt><dd><p>For error “Access denied” and “HTTP error [402, 403]”</p>
  126. </dd>
  127. <dt><code class="docutils literal notranslate"><span class="pre">SearxEngineCaptcha</span></code>: 86400</dt><dd><p>For error “CAPTCHA”</p>
  128. </dd>
  129. <dt><code class="docutils literal notranslate"><span class="pre">SearxEngineTooManyRequests</span></code>: 3600</dt><dd><p>For error “Too many request” and “HTTP error 429”</p>
  130. </dd>
  131. <dt>Cloudflare CAPTCHA:</dt><dd><ul class="simple">
  132. <li><p><code class="docutils literal notranslate"><span class="pre">cf_SearxEngineCaptcha</span></code>: 1296000</p></li>
  133. <li><p><code class="docutils literal notranslate"><span class="pre">cf_SearxEngineAccessDenied</span></code>: 86400</p></li>
  134. </ul>
  135. </dd>
  136. <dt>Google CAPTCHA:</dt><dd><ul class="simple">
  137. <li><p><code class="docutils literal notranslate"><span class="pre">recaptcha_SearxEngineCaptcha</span></code>: 604800</p></li>
  138. </ul>
  139. </dd>
  140. </dl>
  141. </dd>
  142. <dt><code class="docutils literal notranslate"><span class="pre">formats</span></code>:</dt><dd><p>Result formats available from web, remove format to deny access (use lower
  143. case).</p>
  144. <ul class="simple">
  145. <li><p><code class="docutils literal notranslate"><span class="pre">html</span></code></p></li>
  146. <li><p><code class="docutils literal notranslate"><span class="pre">csv</span></code></p></li>
  147. <li><p><code class="docutils literal notranslate"><span class="pre">json</span></code></p></li>
  148. <li><p><code class="docutils literal notranslate"><span class="pre">rss</span></code></p></li>
  149. </ul>
  150. </dd>
  151. </dl>
  152. </section>
  153. <div class="clearer"></div>
  154. </div>
  155. </div>
  156. </div>
  157. <span id="sidebar-top"></span>
  158. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  159. <div class="sphinxsidebarwrapper">
  160. <p class="logo"><a href="../../index.html">
  161. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  162. </a></p>
  163. <h3><a href="../../index.html">Table of Contents</a></h3>
  164. <ul class="current">
  165. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  166. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  167. <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator documentation</a><ul class="current">
  168. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Settings</a><ul class="current">
  169. <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
  170. <li class="toctree-l3"><a class="reference internal" href="settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
  171. <li class="toctree-l3"><a class="reference internal" href="settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
  172. <li class="toctree-l3"><a class="reference internal" href="settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
  173. <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
  174. <li class="toctree-l3"><a class="reference internal" href="settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
  175. <li class="toctree-l3"><a class="reference internal" href="settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
  176. <li class="toctree-l3"><a class="reference internal" href="settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
  177. <li class="toctree-l3"><a class="reference internal" href="settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
  178. <li class="toctree-l3"><a class="reference internal" href="settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
  179. <li class="toctree-l3"><a class="reference internal" href="settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li>
  180. </ul>
  181. </li>
  182. <li class="toctree-l2"><a class="reference internal" href="../installation.html">Installation</a></li>
  183. <li class="toctree-l2"><a class="reference internal" href="../installation-docker.html">Docker Container</a></li>
  184. <li class="toctree-l2"><a class="reference internal" href="../installation-scripts.html">Installation Script</a></li>
  185. <li class="toctree-l2"><a class="reference internal" href="../installation-searxng.html">Step by step installation</a></li>
  186. <li class="toctree-l2"><a class="reference internal" href="../installation-uwsgi.html">uWSGI</a></li>
  187. <li class="toctree-l2"><a class="reference internal" href="../installation-nginx.html">NGINX</a></li>
  188. <li class="toctree-l2"><a class="reference internal" href="../installation-apache.html">Apache</a></li>
  189. <li class="toctree-l2"><a class="reference internal" href="../update-searxng.html">SearXNG maintenance</a></li>
  190. <li class="toctree-l2"><a class="reference internal" href="../answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
  191. <li class="toctree-l2"><a class="reference internal" href="../searx.favicons.html">Favicons</a></li>
  192. <li class="toctree-l2"><a class="reference internal" href="../searx.limiter.html">Limiter</a></li>
  193. <li class="toctree-l2"><a class="reference internal" href="../api.html">Administration API</a></li>
  194. <li class="toctree-l2"><a class="reference internal" href="../architecture.html">Architecture</a></li>
  195. <li class="toctree-l2"><a class="reference internal" href="../plugins.html">List of plugins</a></li>
  196. <li class="toctree-l2"><a class="reference internal" href="../buildhosts.html">Buildhosts</a></li>
  197. </ul>
  198. </li>
  199. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
  200. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  201. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  202. </ul>
  203. <h3>Project Links</h3>
  204. <ul>
  205. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  206. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  207. <li><a href="https://searx.space">Public instances</a>
  208. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  209. </ul><h3>Navigation</h3>
  210. <ul>
  211. <li><a href="../../index.html">Overview</a>
  212. <ul>
  213. <li><a href="../index.html">Administrator documentation</a>
  214. <ul>
  215. <li><a href="index.html">Settings</a>
  216. <ul>
  217. <li>Previous: <a href="settings_general.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a>
  218. <li>Next: <a href="settings_server.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></ul>
  219. </li></ul>
  220. </li>
  221. </ul>
  222. </li>
  223. </ul>
  224. <search id="searchbox" style="display: none" role="search">
  225. <h3 id="searchlabel">Quick search</h3>
  226. <div class="searchformwrapper">
  227. <form class="search" action="../../search.html" method="get">
  228. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  229. <input type="submit" value="Go" />
  230. </form>
  231. </div>
  232. </search>
  233. <script>document.getElementById('searchbox').style.display = "block"</script>
  234. <div role="note" aria-label="source link">
  235. <h3>This Page</h3>
  236. <ul class="this-page-menu">
  237. <li><a href="../../_sources/admin/settings/settings_search.rst.txt"
  238. rel="nofollow">Show Source</a></li>
  239. </ul>
  240. </div>
  241. </div>
  242. </div>
  243. <div class="clearer"></div>
  244. </div>
  245. <div class="footer" role="contentinfo">
  246. &#169; Copyright SearXNG team.
  247. </div>
  248. </body>
  249. </html>