index.rst 1.4 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. .. toctree::
  9. :maxdepth: 2
  10. :caption: Contents
  11. searx.sh
  12. filtron.sh
  13. morty.sh
  14. lxc.sh
  15. .. _toolboxing common:
  16. Common commands & environment
  17. =============================
  18. Scripts to maintain services often dispose of common commands and environments.
  19. ``shell`` : command
  20. Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for
  21. troubleshooting.
  22. ``inspect service`` : command
  23. Shows status and log of the service, most often you have a option to enable
  24. more verbose debug logs. Very helpful for debugging, but be careful not to
  25. enable debugging in a production environment!
  26. ``FORCE_TIMEOUT`` : environment
  27. Sets timeout for interactive prompts. If you want to run a script in batch
  28. job, with defaults choices, set ``FORCE_TIMEOUT=0``. By example; to install a
  29. reverse proxy for filtron on all containers of the :ref:`searx suite
  30. <lxc-searx.env>` use ::
  31. sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install
  32. .. _toolboxing setup:
  33. Tooling box setup
  34. =================
  35. The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile
  36. setup`).
  37. .. literalinclude:: ../../.config.sh
  38. :language: bash