searxng/docs/utils/filtron.sh.rst
Markus Heiser 9278f0fb45 docs: add some documentation about the tooling box ./utils/*
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-04 13:13:17 +01:00

1.8 KiB

utils/filtron.sh

further reading

  • 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 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).

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

Overview

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

../utils/filtron.sh --help