index.rst 961 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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. .. toctree::
  9. :maxdepth: 2
  10. :caption: Contents
  11. searx.sh
  12. filtron.sh
  13. morty.sh
  14. .. _toolboxing common:
  15. Common commands
  16. ===============
  17. Scripts to maintain services often dispose of common commands and environments.
  18. ``shell``:
  19. Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for
  20. troubleshooting.
  21. ``inspect service``:
  22. Shows status and log of the service, most often you have a option to enable
  23. more verbose debug logs. Very helpful for debugging, but be careful not to
  24. enable debugging in a production environment!
  25. .. _toolboxing setup:
  26. Tooling box setup
  27. =================
  28. The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile
  29. setup`).
  30. .. literalinclude:: ../../.config.sh
  31. :language: bash