index.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  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>DevOps tooling box &#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="utils/searxng.sh" href="searxng.sh.html" />
  17. <link rel="prev" title="searxng_extra/standalone_searx.py" href="../dev/searxng_extra/standalone_searx.py.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="searxng.sh.html" title="utils/searxng.sh"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="../dev/searxng_extra/standalone_searx.py.html" title="searxng_extra/standalone_searx.py"
  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-this"><a href="">DevOps tooling box</a></li>
  36. </ul>
  37. </div>
  38. <div class="document">
  39. <div class="documentwrapper">
  40. <div class="bodywrapper">
  41. <div class="body" role="main">
  42. <section id="devops-tooling-box">
  43. <span id="toolboxing"></span><span id="searx-utils"></span><h1>DevOps tooling box<a class="headerlink" href="#devops-tooling-box" title="Link to this heading">¶</a></h1>
  44. <p>In the folder <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/utils/">git://utils/</a> we maintain some tools useful for administrators
  45. and developers.</p>
  46. <div class="toctree-wrapper compound">
  47. <ul>
  48. <li class="toctree-l1"><a class="reference internal" href="searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a><ul>
  49. <li class="toctree-l2"><a class="reference internal" href="searxng.sh.html#install">Install</a></li>
  50. <li class="toctree-l2"><a class="reference internal" href="searxng.sh.html#command-help">Command Help</a></li>
  51. </ul>
  52. </li>
  53. <li class="toctree-l1"><a class="reference internal" href="lxc.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span></code></a><ul>
  54. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#install-lxd">Install LXD</a></li>
  55. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#searxng-lxc-suite">SearXNG LXC suite</a></li>
  56. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#setup-searxng-buildhost">Setup SearXNG buildhost</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#command-help">Command Help</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#searxng-suite-config">SearXNG suite config</a></li>
  59. </ul>
  60. </li>
  61. </ul>
  62. </div>
  63. <section id="common-command-environments">
  64. <h2>Common command environments<a class="headerlink" href="#common-command-environments" title="Link to this heading">¶</a></h2>
  65. <p>The scripts in our tooling box often dispose of common environments:</p>
  66. <dl id="force-timeout">
  67. <dt><code class="docutils literal notranslate"><span class="pre">FORCE_TIMEOUT</span></code><span class="classifier">environment</span></dt><dd><p>Sets timeout for interactive prompts. If you want to run a script in batch
  68. job, with defaults choices, set <code class="docutils literal notranslate"><span class="pre">FORCE_TIMEOUT=0</span></code>. By example; to install a
  69. SearXNG server and nginx proxy on all containers of the <a class="reference internal" href="lxc.sh.html#lxc-searxng-env"><span class="std std-ref">SearXNG suite</span></a> use:</p>
  70. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">-</span><span class="n">H</span> <span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">lxc</span><span class="o">.</span><span class="n">sh</span> <span class="n">cmd</span> <span class="o">--</span> <span class="n">FORCE_TIMEOUT</span><span class="o">=</span><span class="mi">0</span> <span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">searxng</span><span class="o">.</span><span class="n">sh</span> <span class="n">install</span> <span class="nb">all</span>
  71. <span class="n">sudo</span> <span class="o">-</span><span class="n">H</span> <span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">lxc</span><span class="o">.</span><span class="n">sh</span> <span class="n">cmd</span> <span class="o">--</span> <span class="n">FORCE_TIMEOUT</span><span class="o">=</span><span class="mi">0</span> <span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">searxng</span><span class="o">.</span><span class="n">sh</span> <span class="n">install</span> <span class="n">nginx</span>
  72. </pre></div>
  73. </div>
  74. </dd>
  75. </dl>
  76. </section>
  77. </section>
  78. <div class="clearer"></div>
  79. </div>
  80. </div>
  81. </div>
  82. <span id="sidebar-top"></span>
  83. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  84. <div class="sphinxsidebarwrapper">
  85. <p class="logo"><a href="../index.html">
  86. <img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  87. </a></p>
  88. <h3><a href="../index.html">Table of Contents</a></h3>
  89. <ul class="current">
  90. <li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li>
  92. <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator documentation</a></li>
  93. <li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer documentation</a></li>
  94. <li class="toctree-l1 current"><a class="current reference internal" href="#">DevOps tooling box</a><ul>
  95. <li class="toctree-l2"><a class="reference internal" href="searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
  96. <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>
  97. <li class="toctree-l2"><a class="reference internal" href="#common-command-environments">Common command environments</a></li>
  98. </ul>
  99. </li>
  100. <li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li>
  101. </ul>
  102. <h3>Project Links</h3>
  103. <ul>
  104. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  105. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  106. <li><a href="https://searx.space">Public instances</a>
  107. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  108. </ul><h3>Navigation</h3>
  109. <ul>
  110. <li><a href="../index.html">Overview</a>
  111. <ul>
  112. <li>Previous: <a href="../dev/searxng_extra/standalone_searx.py.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">searxng_extra/standalone_searx.py</span></code></a>
  113. <li>Next: <a href="searxng.sh.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a>
  114. </ul>
  115. </li>
  116. </ul>
  117. <search id="searchbox" style="display: none" role="search">
  118. <h3 id="searchlabel">Quick search</h3>
  119. <div class="searchformwrapper">
  120. <form class="search" action="../search.html" method="get">
  121. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  122. <input type="submit" value="Go" />
  123. </form>
  124. </div>
  125. </search>
  126. <script>document.getElementById('searchbox').style.display = "block"</script>
  127. <div role="note" aria-label="source link">
  128. <h3>This Page</h3>
  129. <ul class="this-page-menu">
  130. <li><a href="../_sources/utils/index.rst.txt"
  131. rel="nofollow">Show Source</a></li>
  132. </ul>
  133. </div>
  134. </div>
  135. </div>
  136. <div class="clearer"></div>
  137. </div>
  138. <div class="footer" role="contentinfo">
  139. &#169; Copyright SearXNG team.
  140. </div>
  141. </body>
  142. </html>