forked from zaclys/searxng
475 lines
13 KiB
Bash
Executable File
475 lines
13 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# -*- coding: utf-8; mode: sh indent-tabs-mode: nil -*-
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
# shellcheck disable=SC2119,SC2001
|
|
|
|
# shellcheck source=utils/lib.sh
|
|
source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
|
|
# shellcheck source=utils/brand.env
|
|
source "${REPO_ROOT}/utils/brand.env"
|
|
source_dot_config
|
|
source "${REPO_ROOT}/utils/lxc-searx.env"
|
|
in_container && lxc_set_suite_env
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# config
|
|
# ----------------------------------------------------------------------------
|
|
|
|
PUBLIC_URL="${PUBLIC_URL:-http://$(uname -n)/searx}"
|
|
PUBLIC_HOST="${PUBLIC_HOST:-$(echo "$PUBLIC_URL" | sed -e 's/[^/]*\/\/\([^@]*@\)\?\([^:/]*\).*/\2/')}"
|
|
|
|
FILTRON_URL_PATH="${FILTRON_URL_PATH:-$(echo "${PUBLIC_URL}" \
|
|
| sed -e 's,^.*://[^/]*\(/.*\),\1,g')}"
|
|
[[ "${FILTRON_URL_PATH}" == "${PUBLIC_URL}" ]] && FILTRON_URL_PATH=/
|
|
|
|
FILTRON_ETC="/etc/filtron"
|
|
|
|
FILTRON_RULES="$FILTRON_ETC/rules.json"
|
|
|
|
FILTRON_API="${FILTRON_API:-127.0.0.1:4005}"
|
|
FILTRON_LISTEN="${FILTRON_LISTEN:-127.0.0.1:4004}"
|
|
FILTRON_TARGET="${FILTRON_TARGET:-127.0.0.1:8888}"
|
|
|
|
SERVICE_NAME="filtron"
|
|
SERVICE_USER="${SERVICE_USER:-${SERVICE_NAME}}"
|
|
SERVICE_HOME_BASE="${SERVICE_HOME_BASE:-/usr/local}"
|
|
SERVICE_HOME="${SERVICE_HOME_BASE}/${SERVICE_USER}"
|
|
SERVICE_SYSTEMD_UNIT="${SYSTEMD_UNITS}/${SERVICE_NAME}.service"
|
|
# shellcheck disable=SC2034
|
|
SERVICE_GROUP="${SERVICE_USER}"
|
|
|
|
# shellcheck disable=SC2034
|
|
SERVICE_GROUP="${SERVICE_USER}"
|
|
|
|
GO_ENV="${SERVICE_HOME}/.go_env"
|
|
GO_PKG_URL="https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz"
|
|
GO_TAR=$(basename "$GO_PKG_URL")
|
|
|
|
# Apache Settings
|
|
|
|
APACHE_FILTRON_SITE="searx.conf"
|
|
|
|
# shellcheck disable=SC2034
|
|
CONFIG_FILES=(
|
|
"${FILTRON_RULES}"
|
|
"${SERVICE_SYSTEMD_UNIT}"
|
|
)
|
|
|
|
# ----------------------------------------------------------------------------
|
|
usage() {
|
|
# ----------------------------------------------------------------------------
|
|
|
|
# shellcheck disable=SC1117
|
|
cat <<EOF
|
|
|
|
usage::
|
|
|
|
$(basename "$0") shell
|
|
$(basename "$0") install [all|user|rules]
|
|
$(basename "$0") update [filtron]
|
|
$(basename "$0") remove [all]
|
|
$(basename "$0") activate [service]
|
|
$(basename "$0") deactivate [service]
|
|
$(basename "$0") inspect [service]
|
|
$(basename "$0") option [debug-on|debug-off]
|
|
$(basename "$0") apache [install|remove]
|
|
|
|
shell
|
|
start interactive shell from user ${SERVICE_USER}
|
|
install / remove
|
|
:all: complete setup of filtron service
|
|
:user: add/remove service user '$SERVICE_USER' ($SERVICE_HOME)
|
|
:rules: reinstall filtron rules $FILTRON_RULES
|
|
update filtron
|
|
Update filtron installation ($SERVICE_HOME)
|
|
activate service
|
|
activate and start service daemon (systemd unit)
|
|
deactivate service
|
|
stop and deactivate service daemon (systemd unit)
|
|
inspect service
|
|
show service status and log
|
|
option
|
|
set one of the available options
|
|
apache (${PUBLIC_URL})
|
|
:install: apache site with a reverse proxy (ProxyPass)
|
|
:remove: apache site ${APACHE_FILTRON_SITE}
|
|
|
|
filtron rules: ${FILTRON_RULES}
|
|
|
|
If needed, set PUBLIC_URL of your WEB service in the '${DOT_CONFIG#"$REPO_ROOT/"}' file::
|
|
|
|
PUBLIC_URL : ${PUBLIC_URL}
|
|
PUBLIC_HOST : ${PUBLIC_HOST}
|
|
SERVICE_USER : ${SERVICE_USER}
|
|
FILTRON_API : ${FILTRON_API}
|
|
FILTRON_LISTEN : ${FILTRON_LISTEN}
|
|
FILTRON_TARGET : ${FILTRON_TARGET}
|
|
|
|
EOF
|
|
[[ -n ${1} ]] && err_msg "$1"
|
|
}
|
|
|
|
main() {
|
|
rst_title "$SERVICE_NAME" part
|
|
|
|
required_commands \
|
|
sudo install git wget curl \
|
|
|| exit
|
|
|
|
local _usage="unknown or missing $1 command $2"
|
|
|
|
case $1 in
|
|
--source-only) ;;
|
|
-h|--help) usage; exit 0;;
|
|
|
|
shell)
|
|
sudo_or_exit
|
|
interactive_shell "${SERVICE_USER}"
|
|
;;
|
|
inspect)
|
|
case $2 in
|
|
service)
|
|
sudo_or_exit
|
|
inspect_service
|
|
;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
install)
|
|
sudo_or_exit
|
|
case $2 in
|
|
all) install_all ;;
|
|
user) assert_user ;;
|
|
rules)
|
|
rst_title "Re-Install filtron rules"
|
|
echo
|
|
install_template --no-eval "$FILTRON_RULES" root root 644
|
|
systemd_restart_service "${SERVICE_NAME}"
|
|
;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
update)
|
|
sudo_or_exit
|
|
case $2 in
|
|
filtron) update_filtron ;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
remove)
|
|
sudo_or_exit
|
|
case $2 in
|
|
all) remove_all;;
|
|
user) drop_service_account "${SERVICE_USER}" ;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
activate)
|
|
sudo_or_exit
|
|
case $2 in
|
|
service) systemd_activate_service "${SERVICE_NAME}" ;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
deactivate)
|
|
sudo_or_exit
|
|
case $2 in
|
|
service) systemd_deactivate_service "${SERVICE_NAME}" ;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
apache)
|
|
sudo_or_exit
|
|
case $2 in
|
|
install) install_apache_site ;;
|
|
remove) remove_apache_site ;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
option)
|
|
sudo_or_exit
|
|
case $2 in
|
|
debug-on) echo; enable_debug ;;
|
|
debug-off) echo; disable_debug ;;
|
|
*) usage "$_usage"; exit 42;;
|
|
esac ;;
|
|
doc)
|
|
echo
|
|
echo ".. generic utils/filtron.sh documentation"
|
|
;;
|
|
|
|
*) usage "unknown or missing command $1"; exit 42;;
|
|
esac
|
|
}
|
|
|
|
install_all() {
|
|
rst_title "Install $SERVICE_NAME (service)"
|
|
assert_user
|
|
wait_key
|
|
install_go "${GO_PKG_URL}" "${GO_TAR}" "${SERVICE_USER}"
|
|
wait_key
|
|
install_filtron
|
|
wait_key
|
|
systemd_install_service "${SERVICE_NAME}" "${SERVICE_SYSTEMD_UNIT}"
|
|
wait_key
|
|
echo
|
|
if ! service_is_available "http://${FILTRON_LISTEN}" ; then
|
|
err_msg "Filtron does not listening on: http://${FILTRON_LISTEN}"
|
|
fi
|
|
if apache_is_installed; then
|
|
info_msg "Apache is installed on this host."
|
|
if ask_yn "Do you want to install a reverse proxy (ProxyPass)" Yn; then
|
|
install_apache_site
|
|
fi
|
|
fi
|
|
if ask_yn "Do you want to inspect the installation?" Ny; then
|
|
inspect_service
|
|
fi
|
|
|
|
}
|
|
|
|
remove_all() {
|
|
rst_title "De-Install $SERVICE_NAME (service)"
|
|
|
|
rst_para "\
|
|
It goes without saying that this script can only be used to remove
|
|
installations that were installed with this script."
|
|
|
|
if ! systemd_remove_service "${SERVICE_NAME}" "${SERVICE_SYSTEMD_UNIT}"; then
|
|
return 42
|
|
fi
|
|
drop_service_account "${SERVICE_USER}"
|
|
rm -r "$FILTRON_ETC" 2>&1 | prefix_stdout
|
|
if service_is_available "${PUBLIC_URL}"; then
|
|
MSG="** Don't forget to remove your public site! (${PUBLIC_URL}) **" wait_key 10
|
|
fi
|
|
}
|
|
|
|
assert_user() {
|
|
rst_title "user $SERVICE_USER" section
|
|
echo
|
|
tee_stderr 1 <<EOF | bash | prefix_stdout
|
|
useradd --shell /bin/bash --system \
|
|
--home-dir "$SERVICE_HOME" \
|
|
--comment 'Reverse HTTP proxy to filter requests' $SERVICE_USER
|
|
mkdir "$SERVICE_HOME"
|
|
chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
|
|
groups $SERVICE_USER
|
|
EOF
|
|
SERVICE_HOME="$(sudo -i -u "$SERVICE_USER" echo \$HOME)"
|
|
export SERVICE_HOME
|
|
echo "export SERVICE_HOME=$SERVICE_HOME"
|
|
|
|
cat > "$GO_ENV" <<EOF
|
|
export GOPATH=\$HOME/go-apps
|
|
export PATH=\$PATH:\$HOME/local/go/bin:\$GOPATH/bin
|
|
EOF
|
|
echo "Environment $GO_ENV has been setup."
|
|
|
|
tee_stderr <<EOF | sudo -i -u "$SERVICE_USER"
|
|
grep -qFs -- 'source $GO_ENV' ~/.profile || echo 'source $GO_ENV' >> ~/.profile
|
|
EOF
|
|
}
|
|
|
|
filtron_is_installed() {
|
|
[[ -f $SERVICE_HOME/go-apps/bin/filtron ]]
|
|
}
|
|
|
|
_svcpr=" ${_Yellow}|${SERVICE_USER}|${_creset} "
|
|
|
|
install_filtron() {
|
|
rst_title "Install filtron in user's ~/go-apps" section
|
|
echo
|
|
tee_stderr <<EOF | sudo -i -u "$SERVICE_USER" 2>&1 | prefix_stdout "$_svcpr"
|
|
go get -v -u github.com/asciimoo/filtron
|
|
EOF
|
|
install_template --no-eval "$FILTRON_RULES" root root 644
|
|
}
|
|
|
|
update_filtron() {
|
|
rst_title "Update filtron" section
|
|
echo
|
|
tee_stderr <<EOF | sudo -i -u "$SERVICE_USER" 2>&1 | prefix_stdout "$_svcpr"
|
|
go get -v -u github.com/asciimoo/filtron
|
|
EOF
|
|
}
|
|
|
|
inspect_service() {
|
|
|
|
rst_title "service status & log"
|
|
|
|
cat <<EOF
|
|
|
|
sourced ${DOT_CONFIG#"$REPO_ROOT/"} :
|
|
|
|
PUBLIC_URL : ${PUBLIC_URL}
|
|
PUBLIC_HOST : ${PUBLIC_HOST}
|
|
FILTRON_URL_PATH : ${FILTRON_URL_PATH}
|
|
FILTRON_API : ${FILTRON_API}
|
|
FILTRON_LISTEN : ${FILTRON_LISTEN}
|
|
FILTRON_TARGET : ${FILTRON_TARGET}
|
|
|
|
EOF
|
|
|
|
apache_is_installed && info_msg "Apache is installed."
|
|
|
|
if service_account_is_available "$SERVICE_USER"; then
|
|
info_msg "service account $SERVICE_USER available."
|
|
else
|
|
err_msg "service account $SERVICE_USER not available!"
|
|
fi
|
|
if go_is_available "$SERVICE_USER"; then
|
|
info_msg "~$SERVICE_USER: go is installed"
|
|
else
|
|
err_msg "~$SERVICE_USER: go is not installed"
|
|
fi
|
|
if filtron_is_installed; then
|
|
info_msg "~$SERVICE_USER: filtron app is installed"
|
|
else
|
|
err_msg "~$SERVICE_USER: filtron app is not installed!"
|
|
fi
|
|
|
|
if ! service_is_available "http://${FILTRON_API}"; then
|
|
err_msg "API not available at: http://${FILTRON_API}"
|
|
fi
|
|
|
|
if ! service_is_available "http://${FILTRON_LISTEN}" ; then
|
|
err_msg "Filtron does not listening on: http://${FILTRON_LISTEN}"
|
|
fi
|
|
|
|
if service_is_available "http://${FILTRON_TARGET}" ; then
|
|
info_msg "Filtron's target is available at: http://${FILTRON_TARGET}"
|
|
fi
|
|
|
|
if ! service_is_available "${PUBLIC_URL}"; then
|
|
warn_msg "Public service at ${PUBLIC_URL} is not available!"
|
|
if ! in_container; then
|
|
warn_msg "Check if public name is correct and routed or use the public IP from above."
|
|
fi
|
|
fi
|
|
|
|
if in_container; then
|
|
lxc_suite_info
|
|
else
|
|
info_msg "public URL --> ${PUBLIC_URL}"
|
|
info_msg "internal URL --> http://${FILTRON_LISTEN}"
|
|
fi
|
|
|
|
|
|
local _debug_on
|
|
if ask_yn "Enable filtron debug mode?"; then
|
|
enable_debug
|
|
_debug_on=1
|
|
fi
|
|
echo
|
|
systemctl --no-pager -l status "${SERVICE_NAME}"
|
|
echo
|
|
|
|
info_msg "public URL --> ${PUBLIC_URL}"
|
|
# shellcheck disable=SC2059
|
|
printf "// use ${_BCyan}CTRL-C${_creset} to stop monitoring the log"
|
|
read -r -s -n1 -t 5
|
|
echo
|
|
while true; do
|
|
trap break 2
|
|
journalctl -f -u "${SERVICE_NAME}"
|
|
done
|
|
|
|
if [[ $_debug_on == 1 ]]; then
|
|
disable_debug
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
|
|
enable_debug() {
|
|
info_msg "try to enable debug mode ..."
|
|
python <<EOF
|
|
import sys, json
|
|
|
|
debug = {
|
|
u'name': u'debug request'
|
|
, u'filters': []
|
|
, u'interval': 0
|
|
, u'limit': 0
|
|
, u'actions': [{u'name': u'log'}]
|
|
}
|
|
|
|
with open('$FILTRON_RULES') as rules:
|
|
j = json.load(rules)
|
|
|
|
pos = None
|
|
for i in range(len(j)):
|
|
if j[i].get('name') == 'debug request':
|
|
pos = i
|
|
break
|
|
if pos is not None:
|
|
j[pos] = debug
|
|
else:
|
|
j.append(debug)
|
|
with open('$FILTRON_RULES', 'w') as rules:
|
|
json.dump(j, rules, indent=2, sort_keys=True)
|
|
|
|
EOF
|
|
systemctl restart "${SERVICE_NAME}.service"
|
|
}
|
|
|
|
disable_debug() {
|
|
info_msg "try to disable debug mode ..."
|
|
python <<EOF
|
|
import sys, json
|
|
with open('$FILTRON_RULES') as rules:
|
|
j = json.load(rules)
|
|
|
|
pos = None
|
|
for i in range(len(j)):
|
|
if j[i].get('name') == 'debug request':
|
|
pos = i
|
|
break
|
|
if pos is not None:
|
|
del j[pos]
|
|
with open('$FILTRON_RULES', 'w') as rules:
|
|
json.dump(j, rules, indent=2, sort_keys=True)
|
|
EOF
|
|
systemctl restart "${SERVICE_NAME}.service"
|
|
}
|
|
|
|
install_apache_site() {
|
|
|
|
rst_title "Install Apache site $APACHE_FILTRON_SITE"
|
|
|
|
rst_para "\
|
|
This installs a reverse proxy (ProxyPass) into apache site (${APACHE_FILTRON_SITE})"
|
|
|
|
! apache_is_installed && err_msg "Apache is not installed."
|
|
|
|
if ! ask_yn "Do you really want to continue?"; then
|
|
return
|
|
fi
|
|
|
|
a2enmod headers
|
|
a2enmod proxy
|
|
a2enmod proxy_http
|
|
|
|
echo
|
|
apache_install_site --variant=filtron "${APACHE_FILTRON_SITE}"
|
|
|
|
info_msg "testing public url .."
|
|
if ! service_is_available "${PUBLIC_URL}"; then
|
|
err_msg "Public service at ${PUBLIC_URL} is not available!"
|
|
fi
|
|
}
|
|
|
|
remove_apache_site() {
|
|
|
|
rst_title "Remove Apache site $APACHE_FILTRON_SITE"
|
|
|
|
rst_para "\
|
|
This removes apache site ${APACHE_FILTRON_SITE}."
|
|
|
|
! apache_is_installed && err_msg "Apache is not installed."
|
|
|
|
if ! ask_yn "Do you really want to continue?"; then
|
|
return
|
|
fi
|
|
|
|
apache_remove_site "$APACHE_FILTRON_SITE"
|
|
}
|
|
|
|
# ----------------------------------------------------------------------------
|
|
main "$@"
|
|
# ----------------------------------------------------------------------------
|