searxngRebrandZaclys/docs/utils/index.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.3 KiB

Tooling box utils/*

In the folder utils/ we maintain some tools useful for admins and developers.

searx.sh filtron.sh morty.sh

Work needed!

Our scripts to maintain services do most support only systemd init process used by debian, ubuntu and many other dists. In general our scripts are only partially usable on debian systems. We are working on this limitation, if you have any contribution, please send us your PR <../pulls>, see how to contribute.

Common commands

Scripts to maintain services often dispose of common commands and environments.

shell:

Opens a shell from the service user ${SERVICE_USSR}, very helpful for troubleshooting.

inspect service:

Shows status and log of the service, most often you have a option to enable more verbose debug logs. Very helpful for debugging, but be careful not to enable debugging in a production environment!

Tooling box setup

The main setup is done in the .config.sh (read also makefile setup).

../../.config.sh