settings_ui.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  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>ui: &#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="redis:" href="settings_redis.html" />
  17. <link rel="prev" title="server:" href="settings_server.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_redis.html" title="redis:"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="settings_server.html" title="server:"
  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">ui:</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="ui">
  45. <span id="settings-ui"></span><h1><code class="docutils literal notranslate"><span class="pre">ui:</span></code><a class="headerlink" href="#ui" title="Link to this heading">¶</a></h1>
  46. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ui</span><span class="p">:</span>
  47. <span class="w"> </span><span class="nt">static_use_hash</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  48. <span class="w"> </span><span class="nt">default_locale</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
  49. <span class="w"> </span><span class="nt">query_in_title</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  50. <span class="w"> </span><span class="nt">infinite_scroll</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  51. <span class="w"> </span><span class="nt">center_alignment</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  52. <span class="w"> </span><span class="nt">cache_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://web.archive.org/web/</span>
  53. <span class="w"> </span><span class="nt">default_theme</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">simple</span>
  54. <span class="w"> </span><span class="nt">theme_args</span><span class="p">:</span>
  55. <span class="w"> </span><span class="nt">simple_style</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">auto</span>
  56. <span class="w"> </span><span class="nt">search_on_category_select</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  57. <span class="w"> </span><span class="nt">hotkeys</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
  58. <span class="w"> </span><span class="nt">url_formatting</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pretty</span>
  59. </pre></div>
  60. </div>
  61. <dl id="static-use-hash">
  62. <dt><code class="docutils literal notranslate"><span class="pre">static_use_hash</span></code><span class="classifier"><code class="docutils literal notranslate"><span class="pre">$SEARXNG_STATIC_USE_HASH</span></code></span></dt><dd><p>Enables <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#caching_static_assets_with_cache_busting">cache busting</a> of static files.</p>
  63. </dd>
  64. <dt><code class="docutils literal notranslate"><span class="pre">default_locale</span></code> :</dt><dd><p>SearXNG interface language. If blank, the locale is detected by using the
  65. browser language. If it doesn’t work, or you are deploying a language
  66. specific instance of searx, a locale can be defined using an ISO language
  67. code, like <code class="docutils literal notranslate"><span class="pre">fr</span></code>, <code class="docutils literal notranslate"><span class="pre">en</span></code>, <code class="docutils literal notranslate"><span class="pre">de</span></code>.</p>
  68. </dd>
  69. <dt><code class="docutils literal notranslate"><span class="pre">query_in_title</span></code> :</dt><dd><p>When true, the result page’s titles contains the query it decreases the
  70. privacy, since the browser can records the page titles.</p>
  71. </dd>
  72. <dt><code class="docutils literal notranslate"><span class="pre">infinite_scroll</span></code>:</dt><dd><p>When true, automatically loads the next page when scrolling to bottom of the current page.</p>
  73. </dd>
  74. <dt><code class="docutils literal notranslate"><span class="pre">center_alignment</span></code><span class="classifier">default <code class="docutils literal notranslate"><span class="pre">false</span></code></span></dt><dd><p>When enabled, the results are centered instead of being in the left (or RTL)
  75. side of the screen. This setting only affects the <em>desktop layout</em>
  76. (<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/client/simple/src/less/definitions.less">min-width: &#64;tablet</a>)</p>
  77. </dd>
  78. </dl>
  79. <dl>
  80. <dt><code class="docutils literal notranslate"><span class="pre">cache_url</span></code><span class="classifier"><code class="docutils literal notranslate"><span class="pre">https://web.archive.org/web/</span></code></span></dt><dd><p>URL prefix of the internet archive or cache, don’t forget trailing slash (if
  81. needed). The default is <a class="reference external" href="https://web.archive.org/web/">https://web.archive.org/web/</a> alternatives are:</p>
  82. <ul class="simple">
  83. <li><p><a class="reference external" href="https://webcache.googleusercontent.com/search?q=cache">https://webcache.googleusercontent.com/search?q=cache</a>:</p></li>
  84. <li><p><a class="reference external" href="https://archive.today/">https://archive.today/</a></p></li>
  85. </ul>
  86. </dd>
  87. <dt><code class="docutils literal notranslate"><span class="pre">default_theme</span></code> :</dt><dd><p>Name of the theme you want to use by default on your SearXNG instance.</p>
  88. </dd>
  89. <dt><code class="docutils literal notranslate"><span class="pre">theme_args.simple_style</span></code>:</dt><dd><p>Style of simple theme: <code class="docutils literal notranslate"><span class="pre">auto</span></code>, <code class="docutils literal notranslate"><span class="pre">light</span></code>, <code class="docutils literal notranslate"><span class="pre">dark</span></code>, <code class="docutils literal notranslate"><span class="pre">black</span></code></p>
  90. </dd>
  91. <dt><code class="docutils literal notranslate"><span class="pre">results_on_new_tab</span></code>:</dt><dd><p>Open result links in a new tab by default.</p>
  92. </dd>
  93. <dt><code class="docutils literal notranslate"><span class="pre">search_on_category_select</span></code>:</dt><dd><p>Perform search immediately if a category selected. Disable to select multiple categories.</p>
  94. </dd>
  95. <dt><code class="docutils literal notranslate"><span class="pre">hotkeys</span></code>:</dt><dd><p>Hotkeys to use in the search interface: <code class="docutils literal notranslate"><span class="pre">default</span></code>, <code class="docutils literal notranslate"><span class="pre">vim</span></code> (Vim-like).</p>
  96. </dd>
  97. <dt><code class="docutils literal notranslate"><span class="pre">url_formatting</span></code>:</dt><dd><p>Formatting type to use for result URLs: <code class="docutils literal notranslate"><span class="pre">pretty</span></code>, <code class="docutils literal notranslate"><span class="pre">full</span></code> or <code class="docutils literal notranslate"><span class="pre">host</span></code>.</p>
  98. </dd>
  99. </dl>
  100. </section>
  101. <div class="clearer"></div>
  102. </div>
  103. </div>
  104. </div>
  105. <span id="sidebar-top"></span>
  106. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  107. <div class="sphinxsidebarwrapper">
  108. <p class="logo"><a href="../../index.html">
  109. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  110. </a></p>
  111. <h3><a href="../../index.html">Table of Contents</a></h3>
  112. <ul class="current">
  113. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  114. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  115. <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator documentation</a><ul class="current">
  116. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Settings</a><ul class="current">
  117. <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>
  118. <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>
  119. <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>
  120. <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>
  121. <li class="toctree-l3"><a class="reference internal" href="settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
  122. <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>
  123. <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
  124. <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>
  125. <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>
  126. <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>
  127. <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>
  128. </ul>
  129. </li>
  130. <li class="toctree-l2"><a class="reference internal" href="../installation.html">Installation</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="../installation-docker.html">Docker Container</a></li>
  132. <li class="toctree-l2"><a class="reference internal" href="../installation-scripts.html">Installation Script</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="../installation-searxng.html">Step by step installation</a></li>
  134. <li class="toctree-l2"><a class="reference internal" href="../installation-uwsgi.html">uWSGI</a></li>
  135. <li class="toctree-l2"><a class="reference internal" href="../installation-nginx.html">NGINX</a></li>
  136. <li class="toctree-l2"><a class="reference internal" href="../installation-apache.html">Apache</a></li>
  137. <li class="toctree-l2"><a class="reference internal" href="../update-searxng.html">SearXNG maintenance</a></li>
  138. <li class="toctree-l2"><a class="reference internal" href="../answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
  139. <li class="toctree-l2"><a class="reference internal" href="../searx.favicons.html">Favicons</a></li>
  140. <li class="toctree-l2"><a class="reference internal" href="../searx.limiter.html">Limiter</a></li>
  141. <li class="toctree-l2"><a class="reference internal" href="../api.html">Administration API</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="../architecture.html">Architecture</a></li>
  143. <li class="toctree-l2"><a class="reference internal" href="../plugins.html">List of plugins</a></li>
  144. <li class="toctree-l2"><a class="reference internal" href="../buildhosts.html">Buildhosts</a></li>
  145. </ul>
  146. </li>
  147. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
  148. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  149. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  150. </ul>
  151. <h3>Project Links</h3>
  152. <ul>
  153. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  154. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  155. <li><a href="https://searx.space">Public instances</a>
  156. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  157. </ul><h3>Navigation</h3>
  158. <ul>
  159. <li><a href="../../index.html">Overview</a>
  160. <ul>
  161. <li><a href="../index.html">Administrator documentation</a>
  162. <ul>
  163. <li><a href="index.html">Settings</a>
  164. <ul>
  165. <li>Previous: <a href="settings_server.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a>
  166. <li>Next: <a href="settings_redis.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></ul>
  167. </li></ul>
  168. </li>
  169. </ul>
  170. </li>
  171. </ul>
  172. <search id="searchbox" style="display: none" role="search">
  173. <h3 id="searchlabel">Quick search</h3>
  174. <div class="searchformwrapper">
  175. <form class="search" action="../../search.html" method="get">
  176. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  177. <input type="submit" value="Go" />
  178. </form>
  179. </div>
  180. </search>
  181. <script>document.getElementById('searchbox').style.display = "block"</script>
  182. <div role="note" aria-label="source link">
  183. <h3>This Page</h3>
  184. <ul class="this-page-menu">
  185. <li><a href="../../_sources/admin/settings/settings_ui.rst.txt"
  186. rel="nofollow">Show Source</a></li>
  187. </ul>
  188. </div>
  189. </div>
  190. </div>
  191. <div class="clearer"></div>
  192. </div>
  193. <div class="footer" role="contentinfo">
  194. &#169; Copyright SearXNG team.
  195. </div>
  196. </body>
  197. </html>