settings_redis.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  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>redis: &#8212; SearXNG Documentation (2025.7.11+d57433985)</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=e2a99f3f"></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.7.11+d57433985" 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="valkey:" href="settings_valkey.html" />
  17. <link rel="prev" title="ui:" href="settings_ui.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_valkey.html" title="valkey:"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="settings_ui.html" title="ui:"
  33. accesskey="P">previous</a> |</li>
  34. <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.11+d57433985)</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">redis:</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="redis">
  45. <span id="settings-redis"></span><h1><code class="docutils literal notranslate"><span class="pre">redis:</span></code><a class="headerlink" href="#redis" title="Link to this heading">¶</a></h1>
  46. <div class="admonition attention">
  47. <p class="admonition-title">Attention</p>
  48. <p>SearXNG is switching from the Redis DB to <a class="reference external" href="https://valkey.io">Valkey</a>. The configuration
  49. description of <a class="reference external" href="https://valkey.io">Valkey</a> in SearXNG can be found here: <a class="reference internal" href="settings_valkey.html#settings-valkey"><span class="std std-ref">settings</span></a>.</p>
  50. </div>
  51. <p>If you have built and installed a local Redis DB for SearXNG, it is recommended
  52. to uninstall it now and replace it with the installation of a <a class="reference external" href="https://valkey.io">Valkey</a> DB.</p>
  53. <section id="redis-developer-notes">
  54. <span id="id1"></span><h2>Redis Developer Notes<a class="headerlink" href="#redis-developer-notes" title="Link to this heading">¶</a></h2>
  55. <p>To uninstall SearXNG’s local Redis DB you can use:</p>
  56. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># stop your SearXNG instance</span>
  57. $<span class="w"> </span>./utils/searxng.sh<span class="w"> </span>remove.redis
  58. </pre></div>
  59. </div>
  60. <p>Remove the Redis DB in your YAML setting:</p>
  61. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">redis</span><span class="p">:</span>
  62. <span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unix:///usr/local/searxng-redis/run/redis.sock?db=0</span>
  63. </pre></div>
  64. </div>
  65. <p>To install <a class="reference external" href="https://valkey.io">Valkey</a> read: <a class="reference internal" href="settings_valkey.html#valkey-developer-notes"><span class="std std-ref">Valkey Developer Notes</span></a></p>
  66. </section>
  67. </section>
  68. <div class="clearer"></div>
  69. </div>
  70. </div>
  71. </div>
  72. <span id="sidebar-top"></span>
  73. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  74. <div class="sphinxsidebarwrapper">
  75. <p class="logo"><a href="../../index.html">
  76. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  77. </a></p>
  78. <h3><a href="../../index.html">Table of Contents</a></h3>
  79. <ul class="current">
  80. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  81. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  82. <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator documentation</a><ul class="current">
  83. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Settings</a><ul class="current">
  84. <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>
  85. <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>
  86. <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>
  87. <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>
  88. <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>
  89. <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>
  90. <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>
  91. <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a><ul>
  92. <li class="toctree-l4"><a class="reference internal" href="#redis-developer-notes">Redis Developer Notes</a></li>
  93. </ul>
  94. </li>
  95. <li class="toctree-l3"><a class="reference internal" href="settings_valkey.html"><code class="docutils literal notranslate"><span class="pre">valkey:</span></code></a></li>
  96. <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>
  97. <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>
  98. <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>
  99. </ul>
  100. </li>
  101. <li class="toctree-l2"><a class="reference internal" href="../installation.html">Installation</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="../installation-docker.html">Installation container</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="../installation-scripts.html">Installation Script</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="../installation-searxng.html">Step by step installation</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="../installation-granian.html">Granian</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="../installation-uwsgi.html">uWSGI</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="../installation-nginx.html">NGINX</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="../installation-apache.html">Apache</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="../update-searxng.html">SearXNG maintenance</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="../answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="../searx.favicons.html">Favicons</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="../searx.limiter.html">Limiter</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="../api.html">Administration API</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="../architecture.html">Architecture</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="../plugins.html">List of plugins</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="../buildhosts.html">Buildhosts</a></li>
  117. </ul>
  118. </li>
  119. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
  120. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  121. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  122. </ul>
  123. <h3>Project Links</h3>
  124. <ul>
  125. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  126. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  127. <li><a href="https://searx.space">Public instances</a>
  128. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  129. </ul><h3>Navigation</h3>
  130. <ul>
  131. <li><a href="../../index.html">Overview</a>
  132. <ul>
  133. <li><a href="../index.html">Administrator documentation</a>
  134. <ul>
  135. <li><a href="index.html">Settings</a>
  136. <ul>
  137. <li>Previous: <a href="settings_ui.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a>
  138. <li>Next: <a href="settings_valkey.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">valkey:</span></code></a></ul>
  139. </li></ul>
  140. </li>
  141. </ul>
  142. </li>
  143. </ul>
  144. <search id="searchbox" style="display: none" role="search">
  145. <h3 id="searchlabel">Quick search</h3>
  146. <div class="searchformwrapper">
  147. <form class="search" action="../../search.html" method="get">
  148. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  149. <input type="submit" value="Go" />
  150. </form>
  151. </div>
  152. </search>
  153. <script>document.getElementById('searchbox').style.display = "block"</script>
  154. <div role="note" aria-label="source link">
  155. <h3>This Page</h3>
  156. <ul class="this-page-menu">
  157. <li><a href="../../_sources/admin/settings/settings_redis.rst.txt"
  158. rel="nofollow">Show Source</a></li>
  159. </ul>
  160. </div>
  161. </div>
  162. </div>
  163. <div class="clearer"></div>
  164. </div>
  165. <div class="footer" role="contentinfo">
  166. &#169; Copyright SearXNG team.
  167. </div>
  168. </body>
  169. </html>