Procházet zdrojové kódy

Merge pull request #1006 from kvch/gh-pages

blog: add post about searx-admin
Adam Tauber před 7 roky
rodič
revize
e3160c40df
9 změnil soubory, kde provedl 153 přidání a 8 odebrání
  1. 4
    0
      _static/pygments.css
  2. 99
    0
      blog/admin.html
  3. 1
    0
      blog/blog.html
  4. 5
    7
      dev/quickstart.html
  5. 42
    0
      docs/blog/admin.rst
  6. 1
    0
      docs/blog/blog.rst
  7. binární
      docs/blog/searx-admin-engines.png
  8. binární
      objects.inv
  9. 1
    1
      searchindex.js

+ 4
- 0
_static/pygments.css Zobrazit soubor

@@ -47,8 +47,10 @@
47 47
 .highlight .mh { color: #208050 } /* Literal.Number.Hex */
48 48
 .highlight .mi { color: #208050 } /* Literal.Number.Integer */
49 49
 .highlight .mo { color: #208050 } /* Literal.Number.Oct */
50
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
50 51
 .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
51 52
 .highlight .sc { color: #4070a0 } /* Literal.String.Char */
53
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
52 54
 .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
53 55
 .highlight .s2 { color: #4070a0 } /* Literal.String.Double */
54 56
 .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
@@ -59,7 +61,9 @@
59 61
 .highlight .s1 { color: #4070a0 } /* Literal.String.Single */
60 62
 .highlight .ss { color: #517918 } /* Literal.String.Symbol */
61 63
 .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
64
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
62 65
 .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
63 66
 .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
64 67
 .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
68
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
65 69
 .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */

+ 99
- 0
blog/admin.html Zobrazit soubor

@@ -0,0 +1,99 @@
1
+
2
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
+
5
+<html xmlns="http://www.w3.org/1999/xhtml">
6
+  <head>
7
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+    <title>Searx admin interface: manage your instance from your browser &#8212; searx 0.12.0 documentation</title>
9
+    <link rel="stylesheet" href="../_static/style.css" type="text/css" />
10
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
11
+    <script type="text/javascript">
12
+      var DOCUMENTATION_OPTIONS = {
13
+        URL_ROOT:    '../',
14
+        VERSION:     '0.12.0',
15
+        COLLAPSE_INDEX: false,
16
+        FILE_SUFFIX: '.html',
17
+        HAS_SOURCE:  true,
18
+        SOURCELINK_SUFFIX: '.txt'
19
+      };
20
+    </script>
21
+    <script type="text/javascript" src="../_static/jquery.js"></script>
22
+    <script type="text/javascript" src="../_static/underscore.js"></script>
23
+    <script type="text/javascript" src="../_static/doctools.js"></script>
24
+    <link rel="index" title="Index" href="../genindex.html" />
25
+    <link rel="search" title="Search" href="../search.html" />
26
+   
27
+  
28
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
29
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
30
+
31
+  </head>
32
+  <body>  
33
+
34
+    <div class="document">
35
+      <div class="documentwrapper">
36
+        <div class="bodywrapper">
37
+          <div class="body" role="main">
38
+            
39
+  <div class="section" id="searx-admin-interface-manage-your-instance-from-your-browser">
40
+<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>
41
+<p>One of the biggest advantages of searx is being extremely customizable. But at first it can be daunting to newcomers.
42
+A barrier of taking advantage of this feature is our ugly settings file which is sometimes hard to understand and edit.</p>
43
+<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>.
44
+It is a web application which is capable of managing your instance and manipulating its settings via a web UI.
45
+It aims to replace editing of <code class="docutils literal"><span class="pre">settings.yml</span></code> for less experienced administrators or people
46
+who prefer graphical admin interfaces.</p>
47
+<div class="align-center figure" id="id1">
48
+<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>
49
+<p class="caption"><span class="caption-text">Configuration page of engines</span></p>
50
+</div>
51
+<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
52
+as a standalone tool instead of part of searx. Another reason for making it a standalone
53
+tool is that the codebase and dependencies of searx should not grow because of a fully optional feature,
54
+which does not affect existing instances.</p>
55
+<div class="section" id="installation">
56
+<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
57
+<p>Installation guide can be found in the repository of searx-admin:
58
+<a class="reference external" href="https://github.com/kvch/searx-admin#installation--usage">https://github.com/kvch/searx-admin#installation–usage</a></p>
59
+</div>
60
+<div class="section" id="acknowledgements">
61
+<h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h2>
62
+<p>This development was sponsored by <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
63
+<div class="line-block">
64
+<div class="line">Happy hacking.</div>
65
+<div class="line">kvch // 2017.08.22 21:25</div>
66
+</div>
67
+</div>
68
+</div>
69
+
70
+
71
+          </div>
72
+        </div>
73
+      </div>
74
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
75
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
76
+<h1>Searx</h1>
77
+<ul>
78
+    <li><a href="../index.html">Home</a></li>
79
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
80
+    <li><a href="blog.html">Blog</a></li>
81
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
82
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
83
+</ul>
84
+<hr />
85
+<ul>
86
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
87
+    <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>
88
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
89
+</ul>
90
+</div>
91
+        </div>
92
+      </div>
93
+      <div class="clearer"></div>
94
+    </div>
95
+    <div class="footer">
96
+      &copy; Copyright 2015-2017, Adam Tauber.
97
+    </div>
98
+  </body>
99
+</html>

+ 1
- 0
blog/blog.html Zobrazit soubor

@@ -41,6 +41,7 @@
41 41
 <div class="toctree-wrapper compound">
42 42
 <ul>
43 43
 <li class="toctree-l1"><a class="reference internal" href="python3.html">Introducing Python3 support</a></li>
44
+<li class="toctree-l1"><a class="reference internal" href="admin.html">Searx admin interface: manage your instance from your browser</a></li>
44 45
 </ul>
45 46
 </div>
46 47
 </div>

+ 5
- 7
dev/quickstart.html Zobrazit soubor

@@ -106,22 +106,20 @@ Node has to be installed.</p>
106 106
 </div>
107 107
 <div class="section" id="tips-for-debugging-development">
108 108
 <h2>Tips for debugging/development<a class="headerlink" href="#tips-for-debugging-development" title="Permalink to this headline">¶</a></h2>
109
-<ol class="arabic">
109
+<ol class="arabic simple">
110 110
 <li><dl class="first docutils">
111 111
 <dt>Turn on debug logging</dt>
112
-<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
112
+<dd>Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
113 113
 to turn on debug logging. When debug logging is enabled a stack trace appears,
114 114
 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
115
-<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>
116
-</dd>
115
+<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>
117 116
 </dl>
118 117
 </li>
119 118
 <li><dl class="first docutils">
120 119
 <dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
121
-<dd><p class="first last">Failing build on Travis is common because of PEP8 checks. So a new commit must be created
120
+<dd>Failing build on Travis is common because of PEP8 checks. So a new commit must be created
122 121
 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
123
-locally before creating a PR.</p>
124
-</dd>
122
+locally before creating a PR.</dd>
125 123
 </dl>
126 124
 </li>
127 125
 </ol>

+ 42
- 0
docs/blog/admin.rst Zobrazit soubor

@@ -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

+ 1
- 0
docs/blog/blog.rst Zobrazit soubor

@@ -5,3 +5,4 @@ Blog
5 5
    :maxdepth: 1
6 6
 
7 7
    python3
8
+   admin

binární
docs/blog/searx-admin-engines.png Zobrazit soubor


binární
objects.inv Zobrazit soubor


+ 1
- 1
searchindex.js
Diff nebyl zobrazen, protože je příliš veliký
Zobrazit soubor