mirror of https://github.com/searx/searx
blog: add post about searx-admin
This commit is contained in:
Noémi Ványi
parent
ea264a861e
commit
73c8819acb
|
|
@ -47,8 +47,10 @@
|
|||
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
|
||||
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
|
||||
|
|
@ -59,7 +61,9 @@
|
|||
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #06287e } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Searx admin interface: manage your instance from your browser — searx 0.12.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.12.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
|
||||
<link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="searx-admin-interface-manage-your-instance-from-your-browser">
|
||||
<h1>Searx admin interface: manage your instance from your browser<a class="headerlink" href="#searx-admin-interface-manage-your-instance-from-your-browser" title="Permalink to this headline">¶</a></h1>
|
||||
<p>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.</p>
|
||||
<p>To make self-hosting searx more accessible a new tool is introduced, called <code class="docutils literal"><span class="pre">searx-admin</span></code>.
|
||||
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 <code class="docutils literal"><span class="pre">settings.yml</span></code> for less experienced administrators or people
|
||||
who prefer graphical admin interfaces.</p>
|
||||
<div class="align-center figure" id="id1">
|
||||
<a class="reference internal image-reference" href="../_images/searx-admin-engines.png"><img alt="Screenshot of engine list" src="../_images/searx-admin-engines.png" style="width: 682.0px; height: 352.5px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Configuration page of engines</span></p>
|
||||
</div>
|
||||
<p>Since <code class="docutils literal"><span class="pre">searx-admin</span></code> 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.</p>
|
||||
<div class="section" id="installation">
|
||||
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Installation guide can be found in the repository of searx-admin:
|
||||
<a class="reference external" href="https://github.com/kvch/searx-admin#installation--usage">https://github.com/kvch/searx-admin#installation–usage</a></p>
|
||||
</div>
|
||||
<div class="section" id="acknowledgements">
|
||||
<h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This development was sponsored by <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
|
||||
<div class="line-block">
|
||||
<div class="line">Happy hacking.</div>
|
||||
<div class="line">kvch // 2017.08.22 21:25</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="sidebar_container body">
|
||||
<h1>Searx</h1>
|
||||
<ul>
|
||||
<li><a href="../index.html">Home</a></li>
|
||||
<li><a href="https://github.com/asciimoo/searx">Source</a></li>
|
||||
<li><a href="blog.html">Blog</a></li>
|
||||
<li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
|
||||
<li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
|
||||
</ul>
|
||||
<hr />
|
||||
<ul>
|
||||
<li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
|
||||
<li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
|
||||
<li><a href="https://gratipay.com/searx">Gratipay</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2015-2017, Adam Tauber.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -41,6 +41,7 @@
|
|||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="python3.html">Introducing Python3 support</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="admin.html">Searx admin interface: manage your instance from your browser</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -106,22 +106,20 @@ Node has to be installed.</p>
|
|||
</div>
|
||||
<div class="section" id="tips-for-debugging-development">
|
||||
<h2>Tips for debugging/development<a class="headerlink" href="#tips-for-debugging-development" title="Permalink to this headline">¶</a></h2>
|
||||
<ol class="arabic">
|
||||
<ol class="arabic simple">
|
||||
<li><dl class="first docutils">
|
||||
<dt>Turn on debug logging</dt>
|
||||
<dd><p class="first last">Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
|
||||
<dd>Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
|
||||
to turn on debug logging. When debug logging is enabled a stack trace appears,
|
||||
instead of the cryptic <code class="docutils literal"><span class="pre">Internal</span> <span class="pre">Server</span> <span class="pre">Error</span></code> message. It can be turned on by setting
|
||||
<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</p>
|
||||
</dd>
|
||||
<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="first docutils">
|
||||
<dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
|
||||
<dd><p class="first last">Failing build on Travis is common because of PEP8 checks. So a new commit must be created
|
||||
<dd>Failing build on Travis is common because of PEP8 checks. So a new commit must be created
|
||||
containing these format fixes. This phase can be skipped if <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> is run
|
||||
locally before creating a PR.</p>
|
||||
</dd>
|
||||
locally before creating a PR.</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
Searx admin interface: manage your instance from your browser
|
||||
=============================================================
|
||||
|
||||
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
|
||||
:scale: 50 %
|
||||
:alt: Screenshot of engine list
|
||||
:align: center
|
||||
:figclass: align-center
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Installation guide can be found in the repository of searx-admin:
|
||||
https://github.com/kvch/searx-admin#installation--usage
|
||||
|
||||
Acknowledgements
|
||||
----------------
|
||||
|
||||
This development was sponsored by `NLnet Foundation`_.
|
||||
|
||||
.. _NLnet Foundation: https://nlnet.nl/
|
||||
|
||||
|
||||
| Happy hacking.
|
||||
| kvch // 2017.08.22 21:25
|
||||
|
|
@ -5,3 +5,4 @@ Blog
|
|||
:maxdepth: 1
|
||||
|
||||
python3
|
||||
admin
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue