2020-02-03 13:25:51 +01:00
|
|
|
|
|
|
|
|
.. _filtron.sh:
|
|
|
|
|
|
|
|
|
|
====================
|
|
|
|
|
``utils/filtron.sh``
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
|
.. sidebar:: further reading
|
|
|
|
|
|
2020-03-06 14:47:00 +01:00
|
|
|
- :ref:`searx filtron`
|
2020-02-04 13:13:17 +01:00
|
|
|
- :ref:`architecture`
|
2020-04-09 15:04:23 +02:00
|
|
|
- :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
|
|
|
|
|
<installation apache>`)
|
2020-02-03 13:25:51 +01:00
|
|
|
|
|
|
|
|
.. _Go: https://golang.org/
|
|
|
|
|
.. _filtron: https://github.com/asciimoo/filtron
|
|
|
|
|
.. _filtron README: https://github.com/asciimoo/filtron/blob/master/README.md
|
|
|
|
|
|
|
|
|
|
To simplify installation and maintenance of a filtron instance you can use the
|
|
|
|
|
script :origin:`utils/filtron.sh`. In most cases you will install filtron_
|
|
|
|
|
simply by running the command:
|
|
|
|
|
|
|
|
|
|
.. code:: bash
|
|
|
|
|
|
|
|
|
|
sudo -H ./utils/filtron.sh install all
|
|
|
|
|
|
|
|
|
|
The script adds a ``${SERVICE_USER}`` (default:``filtron``) and installs filtron_
|
|
|
|
|
into this user account:
|
|
|
|
|
|
|
|
|
|
#. Create a separated user account (``filtron``).
|
2020-03-30 18:47:01 +02:00
|
|
|
#. Download and install Go_ binary in user's $HOME (``~filtron``).
|
|
|
|
|
#. Install filtron with the package management from Go_ (``go get -v -u
|
2020-02-03 13:25:51 +01:00
|
|
|
github.com/asciimoo/filtron``)
|
|
|
|
|
#. Setup a proper rule configuration :origin:`[ref]
|
|
|
|
|
<utils/templates/etc/filtron/rules.json>` (``/etc/filtron/rules.json``).
|
|
|
|
|
#. Setup a systemd service unit :origin:`[ref]
|
|
|
|
|
<utils/templates/lib/systemd/system/filtron.service>`
|
|
|
|
|
(``/lib/systemd/system/filtron.service``).
|
|
|
|
|
|
2020-04-03 20:24:40 +02:00
|
|
|
|
|
|
|
|
Create user
|
|
|
|
|
===========
|
|
|
|
|
|
2020-06-18 18:52:45 +02:00
|
|
|
.. kernel-include:: $DOCS_BUILD/includes/filtron.rst
|
2020-04-03 20:24:40 +02:00
|
|
|
:start-after: START create user
|
|
|
|
|
:end-before: END create user
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Install go
|
|
|
|
|
==========
|
|
|
|
|
|
2020-06-18 18:52:45 +02:00
|
|
|
.. kernel-include:: $DOCS_BUILD/includes/filtron.rst
|
2020-04-03 20:24:40 +02:00
|
|
|
:start-after: START install go
|
|
|
|
|
:end-before: END install go
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Install filtron
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
Install :origin:`rules.json <utils/templates/etc/filtron/rules.json>` at
|
|
|
|
|
``/etc/filtron/rules.json`` (see :ref:`Sample configuration of filtron`) and
|
|
|
|
|
install filtron software and systemd unit:
|
|
|
|
|
|
2020-06-18 18:52:45 +02:00
|
|
|
.. kernel-include:: $DOCS_BUILD/includes/filtron.rst
|
2020-04-03 20:24:40 +02:00
|
|
|
:start-after: START install filtron
|
|
|
|
|
:end-before: END install filtron
|
|
|
|
|
|
2020-06-18 18:52:45 +02:00
|
|
|
.. kernel-include:: $DOCS_BUILD/includes/filtron.rst
|
2020-04-03 20:24:40 +02:00
|
|
|
:start-after: START install systemd unit
|
|
|
|
|
:end-before: END install systemd unit
|
|
|
|
|
|
2020-03-30 18:47:01 +02:00
|
|
|
.. _filtron.sh overview:
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
The ``--help`` output of the script is largely self-explanatory
|
|
|
|
|
(:ref:`toolboxing common`):
|
|
|
|
|
|
|
|
|
|
.. program-output:: ../utils/filtron.sh --help
|
