admin.rst 1.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. Searx admin interface: manage your instance from your browser
  2. =============================================================
  3. One of the biggest advantages of searx is being extremely customizable. But at first it can be daunting to newcomers.
  4. A barrier of taking advantage of this feature is our ugly settings file which is sometimes hard to understand and edit.
  5. To make self-hosting searx more accessible a new tool is introduced, called ``searx-admin``.
  6. It is a web application which is capable of managing your instance and manipulating its settings via a web UI.
  7. It aims to replace editing of ``settings.yml`` for less experienced administrators or people
  8. who prefer graphical admin interfaces.
  9. .. figure:: searx-admin-engines.png
  10. :scale: 50 %
  11. :alt: Screenshot of engine list
  12. :align: center
  13. :figclass: align-center
  14. Configuration page of engines
  15. Since ``searx-admin`` acts as a supervisor for searx, we have decided to implement it
  16. as a standalone tool instead of part of searx. Another reason for making it a standalone
  17. tool is that the codebase and dependencies of searx should not grow because of a fully optional feature,
  18. which does not affect existing instances.
  19. Installation
  20. ------------
  21. Installation guide can be found in the repository of searx-admin:
  22. https://github.com/kvch/searx-admin#installation--usage
  23. Acknowledgements
  24. ----------------
  25. This development was sponsored by `NLnet Foundation`_.
  26. .. _NLnet Foundation: https://nlnet.nl/
  27. | Happy hacking.
  28. | kvch // 2017.08.22 21:25