index.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .. _searx_utils:
  2. .. _toolboxing:
  3. ========================================
  4. Tooling box ``utils`` for administrators
  5. ========================================
  6. In the folder :origin:`utils/` we maintain some tools useful for administrators.
  7. .. toctree::
  8. :maxdepth: 2
  9. :caption: Contents
  10. searx.sh
  11. filtron.sh
  12. morty.sh
  13. lxc.sh
  14. .. _toolboxing common:
  15. Common commands & environment
  16. =============================
  17. Scripts to maintain services often dispose of common commands and environments.
  18. ``shell`` : command
  19. Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for
  20. troubleshooting.
  21. ``inspect service`` : command
  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. ``FORCE_TIMEOUT`` : environment
  26. Sets timeout for interactive prompts. If you want to run a script in batch
  27. job, with defaults choices, set ``FORCE_TIMEOUT=0``. By example; to install a
  28. reverse proxy for filtron on all containers of the :ref:`searx suite
  29. <lxc-searx.env>` use ::
  30. sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install
  31. .. _toolboxing setup:
  32. Tooling box setup
  33. =================
  34. The main setup is done in the :origin:`.config.sh` (read also :ref:`settings
  35. global`).
  36. .. literalinclude:: ../../.config.sh
  37. :language: bash