searxng/docs/utils/filtron.sh.rst
Markus Heiser 853be4e11c utils/filtron.sh: add generic documentation
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-03 20:24:40 +02:00

2.6 KiB

utils/filtron.sh

further reading

  • installation
  • searx filtron
  • architecture

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

Install go

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:

Overview

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

../utils/filtron.sh --help

Public Reverse Proxy

To install searx in your public HTTP server use:

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

apache

../../utils/templates/etc/apache2/sites-available/searx.conf:filtron

language

apache

Ubuntu / debian

$ sudo -H a2enmod headers $ sudo -H a2enmod proxy $ sudo -H a2enmod proxy_http