mirror of
https://github.com/searxng/searxng.git
synced 2024-06-09 16:59:24 +00:00
195 lines
10 KiB
HTML
195 lines
10 KiB
HTML
<!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>utils/searxng.sh — SearXNG Documentation (2024.6.7+f5eb56b63)</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=36e072b1"></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/lxc.sh" href="lxc.sh.html" />
|
|
<link rel="prev" title="DevOps tooling box" href="index.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="lxc.sh.html" title="utils/lxc.sh"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="index.html" title="DevOps tooling box"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2024.6.7+f5eb56b63)</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">DevOps tooling box</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<section id="utils-searxng-sh">
|
|
<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>
|
|
<p>To simplify the installation and maintenance of a SearXNG instance you can use the
|
|
script <a class="reference external" href="https://github.com/searxng/searxng/blob/master/utils/searxng.sh">git://utils/searxng.sh</a>.</p>
|
|
<aside class="sidebar">
|
|
<p class="sidebar-title">further reading</p>
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="../admin/architecture.html#architecture"><span class="std std-ref">Architecture</span></a></p></li>
|
|
<li><p><a class="reference internal" href="../admin/installation.html#installation"><span class="std std-ref">Installation</span></a></p></li>
|
|
<li><p><a class="reference internal" href="../admin/installation-nginx.html#installation-nginx"><span class="std std-ref">NGINX</span></a></p></li>
|
|
<li><p><a class="reference internal" href="../admin/installation-apache.html#installation-apache"><span class="std std-ref">Apache</span></a></p></li>
|
|
</ul>
|
|
</aside>
|
|
<nav class="contents local" id="contents">
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="#install" id="id1">Install</a></p></li>
|
|
<li><p><a class="reference internal" href="#command-help" id="id2">Command Help</a></p></li>
|
|
</ul>
|
|
</nav>
|
|
<section id="install">
|
|
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Install</a><a class="headerlink" href="#install" title="Link to this heading">¶</a></h2>
|
|
<p>In most cases you will install SearXNG simply by running the command:</p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>-H<span class="w"> </span>./utils/searx.sh<span class="w"> </span>install<span class="w"> </span>all
|
|
</pre></div>
|
|
</div>
|
|
<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>
|
|
</section>
|
|
<section id="command-help">
|
|
<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>
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">--help</span></code> output of the script is largely self-explanatory:</p>
|
|
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage:
|
|
searxng.sh install [all|user|pyenv|settings|uwsgi|redis|nginx|apache|searxng-src|packages|buildhost]
|
|
searxng.sh remove [all|user|pyenv|settings|uwsgi|redis|nginx|apache]
|
|
searxng.sh instance [cmd|update|check|localtest|inspect]
|
|
install|remove:
|
|
all : complete (de-) installation of the SearXNG service
|
|
user : service user 'searxng' (/usr/local/searxng)
|
|
pyenv : virtualenv (python) in /usr/local/searxng/searx-pyenv
|
|
settings : settings from /etc/searxng/settings.yml
|
|
uwsgi : SearXNG's uWSGI app searxng.ini
|
|
redis : build & install or remove a local redis server /usr/local/searxng-redis/run/redis.sock
|
|
nginx : HTTP site /etc/nginx/default.apps-available/searxng.conf
|
|
apache : HTTP site /etc/apache2/sites-available/searxng.conf
|
|
install:
|
|
searxng-src : clone https://github.com/searxng/searxng into /usr/local/searxng/searxng-src
|
|
packages : installs packages from OS package manager required by SearXNG
|
|
buildhost : installs packages from OS package manager required by a SearXNG buildhost
|
|
instance:
|
|
update : update SearXNG instance (git fetch + reset & update settings.yml)
|
|
check : run checks from utils/searxng_check.py in the active installation
|
|
inspect : run some small tests and inspect SearXNG's server status and log
|
|
get_setting : get settings value from running SearXNG instance
|
|
cmd : run command in SearXNG instance's environment (e.g. bash)
|
|
uWSGI:
|
|
SEARXNG_UWSGI_SOCKET : /usr/local/searxng/run/socket
|
|
environment:
|
|
GIT_URL : https://github.com/searxng/searxng
|
|
GIT_BRANCH : master
|
|
SEARXNG_URL : http://fv-az1204-833/searxng
|
|
SEARXNG_PORT : 8888
|
|
SEARXNG_BIND_ADDRESS : 127.0.0.1
|
|
</pre></div>
|
|
</div>
|
|
</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="reference internal" href="index.html">DevOps tooling box</a><ul class="current">
|
|
<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>
|
|
<li class="toctree-l3"><a class="reference internal" href="#install">Install</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#command-help">Command Help</a></li>
|
|
</ul>
|
|
</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="index.html#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><a href="index.html">DevOps tooling box</a>
|
|
<ul>
|
|
<li>Previous: <a href="index.html" title="previous chapter">DevOps tooling box</a>
|
|
<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>
|
|
</li>
|
|
</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/searxng.sh.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> |