admin.rst 1.5 KB

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