searxngRebrandZaclys/docs/utils/filtron.sh.rst

1.3 KiB

utils/filtron.sh

further reading

  • searx_filtron

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 users $HOME (~filtron).
  3. Install filtron with the package management of 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).

Overview

The --help output of the script is largely self-explanatory:

../utils/filtron.sh --help