summaryrefslogtreecommitdiff
path: root/docs/blog/admin.rst
blob: e95316192a5828d066e723a303bea25090bd47d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
=============================================================
Searx admin interface
=============================================================

.. _searx-admin: https://github.com/kvch/searx-admin#searx-admin
.. _NLnet Foundation: https://nlnet.nl/

  manage your instance from your browser

.. sidebar:: Installation

   Installation guide can be found in the repository of searx-admin_.

One of the biggest advantages of searx is being extremely customizable. But at
first it can be daunting to newcomers.  A barrier of taking advantage of this
feature is our ugly settings file which is sometimes hard to understand and
edit.

To make self-hosting searx more accessible a new tool is introduced, called
``searx-admin``.  It is a web application which is capable of managing your
instance and manipulating its settings via a web UI.  It aims to replace editing
of ``settings.yml`` for less experienced administrators or people who prefer
graphical admin interfaces.

.. figure:: searx-admin-engines.png
   :alt: Screenshot of engine list

   Configuration page of engines

Since ``searx-admin`` acts as a supervisor for searx, we have decided to
implement it as a standalone tool instead of part of searx.  Another reason for
making it a standalone tool is that the codebase and dependencies of searx
should not grow because of a fully optional feature, which does not affect
existing instances.


Acknowledgements
================

This development was sponsored by `NLnet Foundation`_.

| Happy hacking.
| kvch // 2017.08.22 21:25