mirror of
https://github.com/searxng/searxng
synced 2024-01-01 19:24:07 +01:00
docs: add some documentation about the tooling box ./utils/*
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
parent
8ca86f46d3
commit
9278f0fb45
8 changed files with 153 additions and 28 deletions
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue