searxng.sh.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  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>utils/searxng.sh &#8212; SearXNG Documentation (2025.7.10+4b9644eb2)</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=8a7063c2"></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.10+4b9644eb2" 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="utils/lxc.sh" href="lxc.sh.html" />
  17. <link rel="prev" title="DevOps tooling box" href="index.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="lxc.sh.html" title="utils/lxc.sh"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="index.html" title="DevOps tooling box"
  33. accesskey="P">previous</a> |</li>
  34. <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.7.10+4b9644eb2)</a> &#187;</li>
  35. <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">DevOps tooling box</a> &#187;</li>
  36. <li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
  37. </ul>
  38. </div>
  39. <div class="document">
  40. <div class="documentwrapper">
  41. <div class="bodywrapper">
  42. <div class="body" role="main">
  43. <section id="utils-searxng-sh">
  44. <span id="searxng-sh"></span><h1><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code><a class="headerlink" href="#utils-searxng-sh" title="Link to this heading">¶</a></h1>
  45. <p>To simplify the installation and maintenance of a SearXNG instance you can use the
  46. script <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/utils/searxng.sh">git://utils/searxng.sh</a>.</p>
  47. <aside class="sidebar">
  48. <p class="sidebar-title">further reading</p>
  49. <ul class="simple">
  50. <li><p><a class="reference internal" href="../admin/architecture.html#architecture"><span class="std std-ref">Architecture</span></a></p></li>
  51. <li><p><a class="reference internal" href="../admin/installation.html#installation"><span class="std std-ref">Installation</span></a></p></li>
  52. <li><p><a class="reference internal" href="../admin/installation-nginx.html#installation-nginx"><span class="std std-ref">NGINX</span></a></p></li>
  53. <li><p><a class="reference internal" href="../admin/installation-apache.html#installation-apache"><span class="std std-ref">Apache</span></a></p></li>
  54. </ul>
  55. </aside>
  56. <nav class="contents local" id="contents">
  57. <ul class="simple">
  58. <li><p><a class="reference internal" href="#install" id="id1">Install</a></p></li>
  59. <li><p><a class="reference internal" href="#command-help" id="id2">Command Help</a></p></li>
  60. </ul>
  61. </nav>
  62. <section id="install">
  63. <h2><a class="toc-backref" href="#id1" role="doc-backlink">Install</a><a class="headerlink" href="#install" title="Link to this heading">¶</a></h2>
  64. <p>In most cases you will install SearXNG simply by running the command:</p>
  65. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>-H<span class="w"> </span>./utils/searxng.sh<span class="w"> </span>install<span class="w"> </span>all
  66. </pre></div>
  67. </div>
  68. <p>The installation is described in chapter <a class="reference internal" href="../admin/installation-searxng.html#installation-basic"><span class="std std-ref">Step by step installation</span></a>.</p>
  69. </section>
  70. <section id="command-help">
  71. <span id="searxng-sh-overview"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Command Help</a><a class="headerlink" href="#command-help" title="Link to this heading">¶</a></h2>
  72. <p>The <code class="docutils literal notranslate"><span class="pre">--help</span></code> output of the script is largely self-explanatory:</p>
  73. <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage:
  74. searxng.sh install [all|user|pyenv|settings|uwsgi|valkey|nginx|apache|searxng-src|packages|buildhost]
  75. searxng.sh remove [all|user|pyenv|settings|uwsgi|valkey|nginx|apache]
  76. searxng.sh instance [cmd|update|check|localtest|inspect]
  77. install|remove:
  78. all : complete (de-) installation of the SearXNG service
  79. user : service user &#39;searxng&#39; (/usr/local/searxng)
  80. pyenv : virtualenv (python) in /usr/local/searxng/searx-pyenv
  81. settings : settings from /etc/searxng/settings.yml
  82. uwsgi : SearXNG&#39;s uWSGI app searxng.ini
  83. nginx : HTTP site /searxng.conf
  84. apache : HTTP site /searxng.conf
  85. install:
  86. valkey : install a local valkey server
  87. remove:
  88. redis : remove a local redis server /run/redis.sock
  89. install:
  90. searxng-src : clone https://github.com/searxng/searxng into /usr/local/searxng/searxng-src
  91. packages : installs packages from OS package manager required by SearXNG
  92. buildhost : installs packages from OS package manager required by a SearXNG buildhost
  93. instance:
  94. update : update SearXNG instance (git fetch + reset &amp; update settings.yml)
  95. check : run checks from utils/searxng_check.py in the active installation
  96. inspect : run some small tests and inspect SearXNG&#39;s server status and log
  97. get_setting : get settings value from running SearXNG instance
  98. cmd : run command in SearXNG instance&#39;s environment (e.g. bash)
  99. uWSGI:
  100. SEARXNG_UWSGI_SOCKET : /usr/local/searxng/run/socket
  101. environment:
  102. GIT_URL : https://github.com/searxng/searxng
  103. GIT_BRANCH : master
  104. SEARXNG_URL : http://fv-az2301-114/searxng
  105. SEARXNG_PORT : 8888
  106. SEARXNG_BIND_ADDRESS : 127.0.0.1
  107. </pre></div>
  108. </div>
  109. </section>
  110. </section>
  111. <div class="clearer"></div>
  112. </div>
  113. </div>
  114. </div>
  115. <span id="sidebar-top"></span>
  116. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  117. <div class="sphinxsidebarwrapper">
  118. <p class="logo"><a href="../index.html">
  119. <img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  120. </a></p>
  121. <h3><a href="../index.html">Table of Contents</a></h3>
  122. <ul class="current">
  123. <li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li>
  124. <li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li>
  125. <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator documentation</a></li>
  126. <li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer documentation</a></li>
  127. <li class="toctree-l1 current"><a class="reference internal" href="index.html">DevOps tooling box</a><ul class="current">
  128. <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a><ul>
  129. <li class="toctree-l3"><a class="reference internal" href="#install">Install</a></li>
  130. <li class="toctree-l3"><a class="reference internal" href="#command-help">Command Help</a></li>
  131. </ul>
  132. </li>
  133. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span></code></a></li>
  134. <li class="toctree-l2"><a class="reference internal" href="index.html#common-command-environments">Common command environments</a></li>
  135. </ul>
  136. </li>
  137. <li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li>
  138. </ul>
  139. <h3>Project Links</h3>
  140. <ul>
  141. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  142. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  143. <li><a href="https://searx.space">Public instances</a>
  144. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  145. </ul><h3>Navigation</h3>
  146. <ul>
  147. <li><a href="../index.html">Overview</a>
  148. <ul>
  149. <li><a href="index.html">DevOps tooling box</a>
  150. <ul>
  151. <li>Previous: <a href="index.html" title="previous chapter">DevOps tooling box</a>
  152. <li>Next: <a href="lxc.sh.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span></code></a></ul>
  153. </li>
  154. </ul>
  155. </li>
  156. </ul>
  157. <search id="searchbox" style="display: none" role="search">
  158. <h3 id="searchlabel">Quick search</h3>
  159. <div class="searchformwrapper">
  160. <form class="search" action="../search.html" method="get">
  161. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  162. <input type="submit" value="Go" />
  163. </form>
  164. </div>
  165. </search>
  166. <script>document.getElementById('searchbox').style.display = "block"</script>
  167. <div role="note" aria-label="source link">
  168. <h3>This Page</h3>
  169. <ul class="this-page-menu">
  170. <li><a href="../_sources/utils/searxng.sh.rst.txt"
  171. rel="nofollow">Show Source</a></li>
  172. </ul>
  173. </div>
  174. </div>
  175. </div>
  176. <div class="clearer"></div>
  177. </div>
  178. <div class="footer" role="contentinfo">
  179. &#169; Copyright SearXNG team.
  180. </div>
  181. </body>
  182. </html>