searxngRebrandZaclys/docs/utils/filtron.sh.rst

utils/filtron.sh

further reading

• searxng filtron
• architecture
• installation (nginx <installation nginx> & apache <installation apache>)

To simplify installation and maintenance of a filtron instance you can use the script utils/filtron.sh. In most cases you will install filtron simply by running the command:

sudo -H ./utils/filtron.sh install all

The script adds a ${SERVICE_USER} (default:filtron) and installs filtron into this user account:

1. Create a separated user account (filtron).
2. Download and install Go binary in user's $HOME (~filtron).
3. Install filtron with the package management from Go (go get -v -u github.com/asciimoo/filtron)
4. Setup a proper rule configuration [ref] <utils/templates/etc/filtron/rules.json> (/etc/filtron/rules.json).
5. Setup a systemd service unit [ref] <utils/templates/lib/systemd/system/filtron.service> (/lib/systemd/system/filtron.service).

Create user

$DOCS_BUILD/includes/filtron.rst

Install go

$DOCS_BUILD/includes/filtron.rst

Install filtron

Install rules.json <utils/templates/etc/filtron/rules.json> at /etc/filtron/rules.json (see Sample configuration of filtron) and install filtron software and systemd unit:

$DOCS_BUILD/includes/filtron.rst

$DOCS_BUILD/includes/filtron.rst

Overview

The --help output of the script is largely self-explanatory (toolboxing common):

../utils/filtron.sh --help