mirror of https://github.com/searx/searx
304 lines
16 KiB
HTML
304 lines
16 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<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/filtron.sh — Searx Documentation (Searx-0.17.0.tex)</title>
|
||
<link rel="stylesheet" href="../_static/searx.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/tabs.css" />
|
||
<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>
|
||
<script src="../_static/language_data.js"></script>
|
||
<script src="../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.js"></script>
|
||
<script src="../_static/sphinx_tabs/tabs.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="utils/morty.sh" href="morty.sh.html" />
|
||
<link rel="prev" title="utils/searx.sh" href="searx.sh.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>
|
||
<li class="right" >
|
||
<a href="morty.sh.html" title="utils/morty.sh"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="searx.sh.html" title="utils/searx.sh"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-0.17.0.tex)</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Tooling box <code class="docutils literal notranslate"><span class="pre">utils/*</span></code></a> »</li>
|
||
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">utils/filtron.sh</span></code></a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="utils-filtron-sh">
|
||
<span id="filtron-sh"></span><h1><code class="docutils literal notranslate"><span class="pre">utils/filtron.sh</span></code><a class="headerlink" href="#utils-filtron-sh" title="Permalink to this headline">¶</a></h1>
|
||
<div class="sidebar">
|
||
<p class="sidebar-title">further reading</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="../admin/filtron.html#searx-filtron"><span class="std std-ref">How to protect an instance</span></a></p></li>
|
||
<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> (<a class="reference internal" href="../admin/installation-nginx.html#installation-nginx"><span class="std std-ref">nginx</span></a> & <a class="reference internal" href="../admin/installation-apache.html#installation-apache"><span class="std std-ref">apache</span></a>)</p></li>
|
||
</ul>
|
||
</div>
|
||
<p>To simplify installation and maintenance of a filtron instance you can use the
|
||
script <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/filtron.sh">git://utils/filtron.sh</a>. In most cases you will install <a class="reference external" href="https://github.com/asciimoo/filtron">filtron</a>
|
||
simply by running the command:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo -H ./utils/filtron.sh install all
|
||
</pre></div>
|
||
</div>
|
||
<p>The script adds a <code class="docutils literal notranslate"><span class="pre">${SERVICE_USER}</span></code> (default:<code class="docutils literal notranslate"><span class="pre">filtron</span></code>) and installs <a class="reference external" href="https://github.com/asciimoo/filtron">filtron</a>
|
||
into this user account:</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Create a separated user account (<code class="docutils literal notranslate"><span class="pre">filtron</span></code>).</p></li>
|
||
<li><p>Download and install <a class="reference external" href="https://golang.org/">Go</a> binary in user’s $HOME (<code class="docutils literal notranslate"><span class="pre">~filtron</span></code>).</p></li>
|
||
<li><p>Install filtron with the package management from <a class="reference external" href="https://golang.org/">Go</a> (<code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span> <span class="pre">-v</span> <span class="pre">-u</span>
|
||
<span class="pre">github.com/asciimoo/filtron</span></code>)</p></li>
|
||
<li><p>Setup a proper rule configuration <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/templates/etc/filtron/rules.json">[ref]</a> (<code class="docutils literal notranslate"><span class="pre">/etc/filtron/rules.json</span></code>).</p></li>
|
||
<li><p>Setup a systemd service unit <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/templates/lib/systemd/system/filtron.service">[ref]</a>
|
||
(<code class="docutils literal notranslate"><span class="pre">/lib/systemd/system/filtron.service</span></code>).</p></li>
|
||
</ol>
|
||
<div class="section" id="create-user">
|
||
<h2>Create user<a class="headerlink" href="#create-user" title="Permalink to this headline">¶</a></h2>
|
||
<div class="sphinx-tabs docutils container">
|
||
<div class="ui top attached tabular menu sphinx-menu docutils container">
|
||
<div class="active item sphinx-data-tab-YmFzaA== docutils container">
|
||
<div class="docutils container">
|
||
<p>bash</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="ui bottom attached sphinx-tab tab segment sphinx-data-tab-YmFzaA== active docutils container">
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H useradd --shell /bin/bash --system <span class="se">\</span>
|
||
--home-dir /usr/local/filtron <span class="se">\</span>
|
||
--comment Privacy-respecting metasearch engine filtron
|
||
|
||
$ sudo -H mkdir /usr/local/filtron
|
||
$ sudo -H chown -R filtron:filtron /usr/local/filtron
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="install-go">
|
||
<h2>Install go<a class="headerlink" href="#install-go" title="Permalink to this headline">¶</a></h2>
|
||
<div class="sphinx-tabs docutils container">
|
||
<div class="ui top attached tabular menu sphinx-menu docutils container">
|
||
<div class="active item sphinx-data-tab-YmFzaA== docutils container">
|
||
<div class="docutils container">
|
||
<p>bash</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="ui bottom attached sphinx-tab tab segment sphinx-data-tab-YmFzaA== active docutils container">
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ cat > /usr/local/filtron/.go_env <span class="s"><<EOF</span>
|
||
<span class="s">export GOPATH=/usr/local/filtron/go-apps</span>
|
||
<span class="s">export PATH=$PATH:/usr/local/filtron/local/go/bin:$GOPATH/bin</span>
|
||
<span class="s">EOF</span>
|
||
$ sudo -i -u filtron
|
||
<span class="o">(</span>filtron<span class="o">)</span> $ <span class="nb">echo</span> <span class="s1">'source /usr/local/filtron/.go_env'</span> >> ~/.profile
|
||
<span class="o">(</span>filtron<span class="o">)</span> $ mkdir /usr/local/filtron/local
|
||
<span class="o">(</span>filtron<span class="o">)</span> $ wget --progress<span class="o">=</span>bar -O go1.13.5.linux-amd64.tar.gz <span class="se">\</span>
|
||
https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz
|
||
<span class="o">(</span>filtron<span class="o">)</span> $ tar -C /usr/local/filtron/local -xzf go1.13.5.linux-amd64.tar.gz
|
||
<span class="o">(</span>filtron<span class="o">)</span> $ which go
|
||
/usr/local/filtron/local/go/bin/go
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="install-filtron">
|
||
<h2>Install filtron<a class="headerlink" href="#install-filtron" title="Permalink to this headline">¶</a></h2>
|
||
<p>Install <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/templates/etc/filtron/rules.json">rules.json</a> at
|
||
<code class="docutils literal notranslate"><span class="pre">/etc/filtron/rules.json</span></code> (see <a class="reference internal" href="../admin/filtron.html#sample-configuration-of-filtron"><span class="std std-ref">Sample configuration of filtron</span></a>) and
|
||
install filtron software and systemd unit:</p>
|
||
<div class="sphinx-tabs docutils container">
|
||
<div class="ui top attached tabular menu sphinx-menu docutils container">
|
||
<div class="active item sphinx-data-tab-YmFzaA== docutils container">
|
||
<div class="docutils container">
|
||
<p>bash</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="ui bottom attached sphinx-tab tab segment sphinx-data-tab-YmFzaA== active docutils container">
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -i -u filtron
|
||
<span class="o">(</span>filtron<span class="o">)</span> $ go get -v -u github.com/asciimoo/filtron
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinx-tabs docutils container">
|
||
<div class="ui top attached tabular menu sphinx-menu docutils container">
|
||
<div class="active item sphinx-data-tab-c3lzdGVtZA== docutils container">
|
||
<div class="docutils container">
|
||
<p>systemd</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="ui bottom attached sphinx-tab tab segment sphinx-data-tab-c3lzdGVtZA== active docutils container">
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>Unit<span class="o">]</span>
|
||
|
||
<span class="nv">Description</span><span class="o">=</span>filtron
|
||
<span class="nv">After</span><span class="o">=</span>syslog.target
|
||
<span class="nv">After</span><span class="o">=</span>network.target
|
||
|
||
<span class="o">[</span>Service<span class="o">]</span>
|
||
|
||
<span class="nv">Type</span><span class="o">=</span>simple
|
||
<span class="nv">User</span><span class="o">=</span>filtron
|
||
<span class="nv">Group</span><span class="o">=</span>filtron
|
||
<span class="nv">WorkingDirectory</span><span class="o">=</span>/usr/local/filtron
|
||
<span class="nv">ExecStart</span><span class="o">=</span>/usr/local/filtron/go-apps/bin/filtron -api <span class="s1">'127.0.0.1:4005'</span> -listen <span class="s1">'127.0.0.1:4004'</span> -rules <span class="s1">'/etc/filtron/rules.json'</span> -target <span class="s1">'127.0.0.1:8888'</span>
|
||
|
||
<span class="nv">Restart</span><span class="o">=</span>always
|
||
<span class="nv">Environment</span><span class="o">=</span><span class="nv">USER</span><span class="o">=</span>filtron <span class="nv">HOME</span><span class="o">=</span>/usr/local/filtron
|
||
|
||
<span class="c1"># Some distributions may not support these hardening directives. If you cannot</span>
|
||
<span class="c1"># start the service due to an unknown option, comment out the ones not supported</span>
|
||
<span class="c1"># by your version of systemd.</span>
|
||
|
||
<span class="nv">ProtectSystem</span><span class="o">=</span>full
|
||
<span class="nv">PrivateDevices</span><span class="o">=</span>yes
|
||
<span class="nv">PrivateTmp</span><span class="o">=</span>yes
|
||
<span class="nv">NoNewPrivileges</span><span class="o">=</span><span class="nb">true</span>
|
||
|
||
<span class="o">[</span>Install<span class="o">]</span>
|
||
|
||
<span class="nv">WantedBy</span><span class="o">=</span>multi-user.target
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="overview">
|
||
<span id="filtron-sh-overview"></span><h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">--help</span></code> output of the script is largely self-explanatory
|
||
(<a class="reference internal" href="index.html#toolboxing-common"><span class="std std-ref">Common commands & environment</span></a>):</p>
|
||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage::
|
||
filtron.sh shell
|
||
filtron.sh install [all|user|rules]
|
||
filtron.sh update [filtron]
|
||
filtron.sh remove [all]
|
||
filtron.sh activate [service]
|
||
filtron.sh deactivate [service]
|
||
filtron.sh inspect [service]
|
||
filtron.sh option [debug-on|debug-off]
|
||
filtron.sh apache [install|remove]
|
||
filtron.sh nginx [install|remove]
|
||
|
||
shell
|
||
start interactive shell from user filtron
|
||
install / remove
|
||
:all: complete setup of filtron service
|
||
:user: add/remove service user 'filtron' (/usr/local/filtron)
|
||
:rules: reinstall filtron rules /etc/filtron/rules.json
|
||
update filtron
|
||
Update filtron installation (/usr/local/filtron)
|
||
activate service
|
||
activate and start service daemon (systemd unit)
|
||
deactivate service
|
||
stop and deactivate service daemon (systemd unit)
|
||
inspect service
|
||
show service status and log
|
||
option
|
||
set one of the available options
|
||
apache (http://10.20.0.154/searx)
|
||
:install: apache site with a reverse proxy (ProxyPass)
|
||
:remove: apache site searx.conf
|
||
nginx (http://10.20.0.154/searx)
|
||
:install: nginx site with a reverse proxy (ProxyPass)
|
||
:remove: nginx site searx.conf
|
||
|
||
filtron rules: /etc/filtron/rules.json
|
||
|
||
If needed, set PUBLIC_URL of your WEB service in the '.config.sh' file::
|
||
PUBLIC_URL : http://10.20.0.154/searx
|
||
PUBLIC_HOST : 10.20.0.154
|
||
SERVICE_USER : filtron
|
||
FILTRON_TARGET : 127.0.0.1:8888
|
||
FILTRON_API : 127.0.0.1:4005
|
||
FILTRON_LISTEN : 127.0.0.1:4004
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<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/searx_logo_small.png" alt="Logo"/>
|
||
</a></p>
|
||
|
||
|
||
<h3>Project Links</h3>
|
||
<ul>
|
||
<li><a href="https://github.com/searx/searx">Source</a>
|
||
|
||
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
|
||
|
||
<li><a href="https://searx.space/">Public instances</a>
|
||
|
||
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
|
||
</ul><h3>Navigation</h3>
|
||
<ul>
|
||
<li><a href="../index.html">Overview</a>
|
||
<ul>
|
||
<li><a href="index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">utils/*</span></code></a>
|
||
<ul>
|
||
<li>Previous: <a href="searx.sh.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">utils/searx.sh</span></code></a>
|
||
<li>Next: <a href="morty.sh.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils/morty.sh</span></code></a></ul>
|
||
</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>
|
||
<script>$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2015-2020, Adam Tauber, Noémi Ványi.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
<script src="../_static/version_warning_offset.js"></script>
|
||
|
||
</body>
|
||
</html> |