installation-granian.rst.txt 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. _searxng granian:
  2. =======
  3. Granian
  4. =======
  5. .. _Options: https://github.com/emmett-framework/granian/blob/master/README.md#options
  6. .. _Workers and threads: https://github.com/emmett-framework/granian/blob/master/README.md#workers-and-threads
  7. .. _Backpressure: https://github.com/emmett-framework/granian/blob/master/README.md#backpressure
  8. .. _Runtime mode: https://github.com/emmett-framework/granian/blob/master/README.md#runtime-mode
  9. .. sidebar:: further reading
  10. - `Options`_
  11. - `Workers and threads`_
  12. - `Backpressure`_
  13. - `Runtime mode`_
  14. .. note::
  15. Granian will be the future replacement for :ref:`searxng uwsgi` in SearXNG.
  16. At the moment, it's only officially supported in the :ref:`installation
  17. container`.
  18. .. _Granian installation:
  19. Installation
  20. ============
  21. We only recommend installing Granian with pip, as officially documented. Run
  22. the following command in the Python environment of the SearXNG installation:
  23. .. code:: sh
  24. $ pip install granian
  25. .. _Granian configuration:
  26. Configuration
  27. =============
  28. .. note::
  29. It's not advised to modify the amount of workers, expect increased resource
  30. usage and potential issues with :ref:`botdetection`.
  31. Granian can be configured via option parameters and environment variables
  32. (``$GRANIAN_*``).
  33. We provide sane defaults that should fit most use cases, however if you feel
  34. you should change something, Granian documents all available parameters in the
  35. `Options`_ section.