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