diff options
Diffstat (limited to 'utils/index.html')
| -rw-r--r-- | utils/index.html | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/utils/index.html b/utils/index.html new file mode 100644 index 000000000..d361ce5dc --- /dev/null +++ b/utils/index.html @@ -0,0 +1,158 @@ +<!DOCTYPE html> + +<html lang="en" data-content_root="../"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>DevOps tooling box — SearXNG Documentation (2024.5.17+ec41b5358)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" /> + <link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" /> + <link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" /> + <script src="../_static/documentation_options.js?v=619ad1c8"></script> + <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="utils/searxng.sh" href="searxng.sh.html" /> + <link rel="prev" title="searxng_extra/standalone_searx.py" href="../dev/searxng_extra/standalone_searx.py.html" /> + </head><body> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="searxng.sh.html" title="utils/searxng.sh" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="../dev/searxng_extra/standalone_searx.py.html" title="searxng_extra/standalone_searx.py" + accesskey="P">previous</a> |</li> + <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2024.5.17+ec41b5358)</a> »</li> + <li class="nav-item nav-item-this"><a href="">DevOps tooling box</a></li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <section id="devops-tooling-box"> +<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> +<p>In the folder <a class="reference external" href="https://github.com/searxng/searxng/blob/master/utils/">git://utils/</a> we maintain some tools useful for administrators +and developers.</p> +<div class="toctree-wrapper compound"> +<ul> +<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> +<li class="toctree-l2"><a class="reference internal" href="searxng.sh.html#install">Install</a></li> +<li class="toctree-l2"><a class="reference internal" href="searxng.sh.html#command-help">Command Help</a></li> +</ul> +</li> +<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> +<li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#install-lxd">Install LXD</a></li> +<li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#searxng-lxc-suite">SearXNG LXC suite</a></li> +<li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#setup-searxng-buildhost">Setup SearXNG buildhost</a></li> +<li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#command-help">Command Help</a></li> +<li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#searxng-suite-config">SearXNG suite config</a></li> +</ul> +</li> +</ul> +</div> +<section id="common-command-environments"> +<h2>Common command environments<a class="headerlink" href="#common-command-environments" title="Link to this heading">¶</a></h2> +<p>The scripts in our tooling box often dispose of common environments:</p> +<dl id="force-timeout"> +<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 +job, with defaults choices, set <code class="docutils literal notranslate"><span class="pre">FORCE_TIMEOUT=0</span></code>. By example; to install a +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> +<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> +<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> +</pre></div> +</div> +</dd> +</dl> +</section> +</section> + + + <div class="clearer"></div> + </div> + </div> + </div> + <span id="sidebar-top"></span> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + + + <p class="logo"><a href="../index.html"> + <img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo"/> + </a></p> + + +<h3><a href="../index.html">Table of Contents</a></h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li> +<li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li> +<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator documentation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer documentation</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">DevOps tooling box</a><ul> +<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> +<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> +<li class="toctree-l2"><a class="reference internal" href="#common-command-environments">Common command environments</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li> +</ul> + + <h3>Project Links</h3> + <ul> + <li><a href="https://github.com/searxng/searxng/tree/master">Source</a> + + <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a> + + <li><a href="https://searx.space">Public instances</a> + + <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a> + </ul><h3>Navigation</h3> +<ul> + <li><a href="../index.html">Overview</a> + <ul> + <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> + <li>Next: <a href="searxng.sh.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a> + </ul> + </li> +</ul> +<search id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> + <input type="submit" value="Go" /> + </form> + </div> +</search> +<script>document.getElementById('searchbox').style.display = "block"</script> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/utils/index.rst.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> + </div> + </div> + <div class="clearer"></div> + </div> + + <div class="footer" role="contentinfo"> + © Copyright SearXNG team. + </div> + <script src="../_static/version_warning_offset.js"></script> + + </body> +</html>
\ No newline at end of file |