index.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .. _searx_utils:
  2. .. _toolboxing:
  3. =======================
  4. Tooling box ``utils/*``
  5. =======================
  6. In the folder :origin:`utils/` we maintain some tools useful for admins and
  7. developers.
  8. .. sidebar:: Work needed!
  9. Our scripts to maintain services do most support only systemd init process
  10. used by debian, ubuntu and many other dists. In general our scripts are only
  11. partially usable on debian systems. We are working on this limitation, if
  12. you have any contribution, please send us your :pull:`PR <../pulls>`, see
  13. :ref:`how to contribute`.
  14. .. toctree::
  15. :maxdepth: 2
  16. :caption: Contents
  17. searx.sh
  18. filtron.sh
  19. morty.sh
  20. .. _toolboxing common:
  21. Common commands
  22. ===============
  23. Scripts to maintain services often dispose of common commands and environments.
  24. ``shell``:
  25. Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for
  26. troubleshooting.
  27. ``inspect service``:
  28. Shows status and log of the service, most often you have a option to enable
  29. more verbose debug logs. Very helpful for debugging, but be careful not to
  30. enable debugging in a production environment!
  31. .. _toolboxing setup:
  32. Tooling box setup
  33. =================
  34. The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile
  35. setup`).
  36. .. literalinclude:: ../../.config.sh
  37. :language: bash