devol
/
searx
mirror of https://github.com/searx/searx
1
0
Fork 0
Code Issues Releases Wiki Activity
searx/admin/installation.html

171 lines
9.8 KiB
HTML
Raw Normal View History

gh-pages: updated
2019-12-30 18:31:17 +01:00
<!DOCTYPE html>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<html>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<head>
<meta charset="utf-8" />
gh-pages: updated
2020-09-30 10:35:05 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
gh-pages: updated
2019-12-30 18:31:17 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1">
Deploying to gh-pages from @ ae122ea943f77600fd97556503c483dcd92e1e63 🚀
2021-03-27 20:39:04 +01:00
<title>Installation &#8212; Searx Documentation (Searx-1.0.0.tex)</title>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
Deploying to gh-pages from @ fb4e6080ed758e770dd1ef217927d7fde6894755 🚀
2021-01-05 16:45:49 +01:00
<link rel="stylesheet" href="../_static/searx.css" type="text/css" />
Deploying to gh-pages from @ c89e59650b812a532c9bce741055b568920b2b94 🚀
2021-02-17 20:54:37 +01:00
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
gh-pages: updated
2020-02-15 10:08:58 +01:00
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
gh-pages: updated
2020-06-19 11:15:15 +02:00
<link rel="next" title="Step by step installation" href="installation-searx.html" />
gh-pages: updated
2019-12-30 18:31:17 +01:00
<link rel="prev" title="Administrator documentation" href="index.html" />
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../';</script>
</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>
Deploy searx/searx to github.com/searx/searx.git:gh-pages
2020-11-04 14:12:59 +01:00
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<li class="right" >
gh-pages: updated
2020-06-19 11:15:15 +02:00
<a href="installation-searx.html" title="Step by step installation"
gh-pages: updated
2019-12-30 18:31:17 +01:00
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Administrator documentation"
accesskey="P">previous</a> |</li>
Deploying to gh-pages from @ ae122ea943f77600fd97556503c483dcd92e1e63 🚀
2021-03-27 20:39:04 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.0.0.tex)</a> &#187;</li>
gh-pages: updated
2020-09-30 10:35:05 +02:00
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Installation</a></li>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
Deploying to gh-pages from @ 52e08ed777f005679f1ace632cbcf8147d54535f 🚀
2021-04-08 19:47:22 +02:00
<div class="section" id="installation">
gh-pages: updated
2020-06-19 11:15:15 +02:00
<span id="id1"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p><em>You’re spoilt for choice</em>, choose your preferred method of installation.</p>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<ul class="simple">
gh-pages: updated
2020-06-19 11:15:15 +02:00
<li><p><a class="reference internal" href="installation-docker.html#installation-docker"><span class="std std-ref">Docker installation</span></a></p></li>
<li><p><a class="reference internal" href="#installation-scripts"><span class="std std-ref">Installation scripts</span></a></p></li>
<li><p><a class="reference internal" href="installation-searx.html#installation-basic"><span class="std std-ref">Step by step installation</span></a></p></li>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</ul>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p>The <a class="reference internal" href="installation-searx.html#installation-basic"><span class="std std-ref">Step by step installation</span></a> is good enough for intranet usage and it is a
excellent illustration of <em>how a searx instance is build up</em>. If you place your
instance public to the internet you should really consider to install a
<a class="reference internal" href="../utils/filtron.sh.html#filtron-sh"><span class="std std-ref">filtron reverse proxy</span></a> and for privacy a <a class="reference internal" href="../utils/morty.sh.html#morty-sh"><span class="std std-ref">result proxy</span></a> is mandatory.</p>
<p>Therefore, if you do not have any special preferences, its recommend to use the
<a class="reference internal" href="installation-docker.html#installation-docker"><span class="std std-ref">Docker installation</span></a> or the <a class="reference internal" href="#installation-scripts">Installation scripts</a> from our <a class="reference internal" href="../utils/index.html#toolboxing"><span class="std std-ref">tooling
box</span></a> as described below.</p>
Deploying to gh-pages from @ 52e08ed777f005679f1ace632cbcf8147d54535f 🚀
2021-04-08 19:47:22 +02:00
<div class="section" id="installation-scripts">
gh-pages: updated
2020-06-19 11:15:15 +02:00
<span id="id2"></span><h2>Installation scripts<a class="headerlink" href="#installation-scripts" title="Permalink to this headline"></a></h2>
Deploying to gh-pages from @ 52e08ed777f005679f1ace632cbcf8147d54535f 🚀
2021-04-08 19:47:22 +02:00
<div class="sidebar">
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p class="sidebar-title">Update OS first!</p>
<p>To avoid unwanted side effects, update your OS before installing searx.</p>
Deploying to gh-pages from @ 52e08ed777f005679f1ace632cbcf8147d54535f 🚀
2021-04-08 19:47:22 +02:00
</div>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p>The following will install a setup as shown in <a class="reference internal" href="architecture.html#architecture"><span class="std std-ref">Architecture</span></a>. First you
need to get a clone. The clone is only needed for the installation procedure
and some maintenance tasks (alternatively you can create your own fork).</p>
Deploying to gh-pages from @ 78655663380d9d67872b419a872dd40d05ef1ed1 🚀
2020-12-14 18:24:55 +01:00
<p>For the installation procedure, use a <em>sudoer</em> login to run the scripts. If you
install from <code class="docutils literal notranslate"><span class="pre">root</span></code>, take into account that the scripts are creating a
<code class="docutils literal notranslate"><span class="pre">searx</span></code>, a <code class="docutils literal notranslate"><span class="pre">filtron</span></code> and a <code class="docutils literal notranslate"><span class="pre">morty</span></code> user. In the installation procedure
these new created users do need read access to the clone of searx, which is not
the case if you clone into a folder below <code class="docutils literal notranslate"><span class="pre">/root</span></code>.</p>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> ~/Downloads
gh-pages: updated
2020-09-30 10:35:05 +02:00
$ git clone https://github.com/searx/searx searx
gh-pages: updated
2020-06-19 11:15:15 +02:00
$ <span class="nb">cd</span> searx
Revert "gh-pages: updated" (made same mistake twice / I am so sorry) This reverts commit 8162baea2327aaea508c13d8465da3efd3ca89ef.
2020-04-19 12:57:50 +02:00
</pre></div>
</div>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p><strong>Install</strong> <a class="reference internal" href="../utils/searx.sh.html#searx-sh"><span class="std std-ref">searx service</span></a></p>
<p>This installs searx as described in <a class="reference internal" href="installation-searx.html#installation-basic"><span class="std std-ref">Step by step installation</span></a>.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/searx.sh install all
Revert "gh-pages: updated" (made same mistake twice / I am so sorry) This reverts commit 8162baea2327aaea508c13d8465da3efd3ca89ef.
2020-04-19 12:57:50 +02:00
</pre></div>
</div>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p><strong>Install</strong> <a class="reference internal" href="../utils/filtron.sh.html#filtron-sh"><span class="std std-ref">filtron reverse proxy</span></a></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/filtron.sh install all
Revert "gh-pages: updated" (made same mistake twice / I am so sorry) This reverts commit 8162baea2327aaea508c13d8465da3efd3ca89ef.
2020-04-19 12:57:50 +02:00
</pre></div>
</div>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p><strong>Install</strong> <a class="reference internal" href="../utils/morty.sh.html#morty-sh"><span class="std std-ref">result proxy</span></a></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/morty.sh install all
Revert "gh-pages: updated" (made same mistake twice / I am so sorry) This reverts commit 8162baea2327aaea508c13d8465da3efd3ca89ef.
2020-04-19 12:57:50 +02:00
</pre></div>
</div>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<p>If all services are running fine, you can add it to your HTTP server:</p>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<ul class="simple">
gh-pages: updated
2020-06-19 11:15:15 +02:00
<li><p><a class="reference internal" href="installation-apache.html#installation-apache"><span class="std std-ref">Install with apache</span></a></p></li>
<li><p><a class="reference internal" href="installation-nginx.html#installation-nginx"><span class="std std-ref">Install with nginx</span></a></p></li>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</ul>
Deploying to gh-pages from @ 78655663380d9d67872b419a872dd40d05ef1ed1 🚀
2020-12-14 18:24:55 +01:00
<div class="admonition tip">
<p class="admonition-title">Tip</p>
Deploying to gh-pages from @ 9c55d772e98f5e51da4a34389dc240cfb3b14852 🚀
2021-01-12 10:55:12 +01:00
<p>About script’s installation options have a look at chapter <a class="reference internal" href="../utils/index.html#toolboxing-setup"><span class="std std-ref">Tooling box setup</span></a>. How to brand your instance see chapter <a class="reference internal" href="settings.html#settings-global"><span class="std std-ref">Global Settings</span></a>. To
Deploying to gh-pages from @ 78655663380d9d67872b419a872dd40d05ef1ed1 🚀
2020-12-14 18:24:55 +01:00
<em>stash</em> your instance’s setup, <a class="reference external" href="https://git-scm.com/docs/git-stash">git stash</a> your clone’s <a class="reference external" href="https://github.com/searx/searx/blob/master/Makefile">git://Makefile</a>
and <a class="reference external" href="https://github.com/searx/searx/blob/master/.config.sh">git://.config.sh</a> file .</p>
</div>
Deploying to gh-pages from @ 52e08ed777f005679f1ace632cbcf8147d54535f 🚀
2021-04-08 19:47:22 +02:00
</div>
</div>
gh-pages: updated
2019-12-30 18:31:17 +01:00
gh-pages: updated
2020-09-30 10:35:05 +02:00
<div class="clearer"></div>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</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/searx_logo_small.png" alt="Logo"/>
</a></p>
<h3>Project Links</h3>
<ul>
gh-pages: updated
2020-09-30 10:35:05 +02:00
<li><a href="https://github.com/searx/searx">Source</a>
gh-pages: updated
2019-12-30 18:31:17 +01:00
gh-pages: updated
2020-09-30 10:35:05 +02:00
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
gh-pages: updated
2019-12-30 18:31:17 +01:00
Deploying to gh-pages from @ 9c55d772e98f5e51da4a34389dc240cfb3b14852 🚀
2021-01-12 10:55:12 +01:00
<li><a href="https://searx.space">Public instances</a>
gh-pages: updated
2019-12-30 18:31:17 +01:00
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
Deploying to gh-pages from @ 9c55d772e98f5e51da4a34389dc240cfb3b14852 🚀
2021-01-12 10:55:12 +01:00
<li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</ul><h3>Navigation</h3>
<ul>
<li><a href="../index.html">Overview</a>
<ul>
<li><a href="index.html">Administrator documentation</a>
<ul>
<li>Previous: <a href="index.html" title="previous chapter">Administrator documentation</a>
gh-pages: updated
2020-06-19 11:15:15 +02:00
<li>Next: <a href="installation-searx.html" title="next chapter">Step by step installation</a></ul>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</li>
</ul>
</li>
</ul>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
gh-pages: updated
2020-02-15 10:08:58 +01:00
<script>$('#searchbox').show(0);</script>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
gh-pages: updated
2020-02-20 19:32:55 +01:00
&#169; Copyright 2015-2020, Adam Tauber, Noémi Ványi.
Deploying to gh-pages from @ a533fdc2bcb5c5b354848e1a139687bc66c3052d 🚀
2021-04-21 18:14:58 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.3.
gh-pages: updated
2019-12-30 18:31:17 +01:00
</div>
gh-pages: updated
2020-02-15 10:08:58 +01:00
<script src="../_static/version_warning_offset.js"></script>
gh-pages: updated
2019-12-30 18:31:17 +01:00
</body>
</html>