diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2020-02-04 13:13:17 +0100 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2020-02-04 13:13:17 +0100 |
| commit | 9278f0fb45bab21247085a709c0e4bef743752db (patch) | |
| tree | 7d3e3fb057f767ed10ded7c1487bdb4d6c0b6d71 /docs/utils/index.rst | |
| parent | 8ca86f46d3dfd81a69d2c2d1515bb163f327826c (diff) | |
| download | searxng-9278f0fb45bab21247085a709c0e4bef743752db.tar.gz searxng-9278f0fb45bab21247085a709c0e4bef743752db.zip | |
docs: add some documentation about the tooling box ./utils/*
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/utils/index.rst')
| -rw-r--r-- | docs/utils/index.rst | 43 |
1 files changed, 36 insertions, 7 deletions
diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 4836ac652..9905d755f 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -1,9 +1,10 @@ .. _searx_utils: +.. _toolboxing: -====================== -Tooling box ``utils/`` -====================== +======================= +Tooling box ``utils/*`` +======================= In the folder :origin:`utils/` we maintain some tools useful for admins and developers. @@ -15,9 +16,37 @@ developers. filtron.sh morty.sh -.. hint:: +.. admonition:: Work needed! - ATM :ref:`filtron.sh` and :ref:`searx.sh` do supports only systemd init - process used by debian, ubuntu and many other dists. If you have working - init.d files to start/stop services, please contribute / thanks! + 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 :pull:`PR <../pulls>`, see + :ref:`how to contribute`. +.. _toolboxing common: + +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! + +.. _toolboxing setup: + +Tooling box setup +================= + +The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile +setup`). + +.. literalinclude:: ../../.config.sh + :language: bash |