free
/
searx
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 11 Wiki Activity
Browse Source

[enh] add morty documentation

Adam Tauber 7 years ago
parent
44174aca8b
commit
ea264a861e
21 changed files with 112 additions and 51 deletions
Split View Show Diff Stats
  1. 0
    3
      admin/api.html
  2. 1
    4
      admin/filtron.html
  3. 86
    0
      admin/morty.html
  4. 0
    3
      blog/blog.html
  5. 0
    3
      blog/python3.html
  6. 0
    3
      dev/contribution_guide.html
  7. 0
    3
      dev/engine_overview.html
  8. 0
    3
      dev/install/installation.html
  9. 0
    3
      dev/plugins.html
  10. 1
    4
      dev/quickstart.html
  11. 0
    3
      dev/search_api.html
  12. 0
    3
      dev/translation.html
  13. 21
    0
      docs/admin/morty.rst
  14. 1
    0
      docs/index.rst
  15. 0
    3
      genindex.html
  16. 1
    3
      index.html
  17. BIN
      objects.inv
  18. 0
    3
      search.html
  19. 1
    1
      searchindex.js
  20. 0
    3
      user/own-instance.html
  21. 0
    3
      user/search_syntax.html

+ 0
- 3
admin/api.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Administration API &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 1
- 4
admin/filtron.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>How to protect an instance &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',
 
@@ -26,7 +23,7 @@
26 23 
     <script type="text/javascript" src="../_static/doctools.js"></script>
27 24 
     <link rel="index" title="Index" href="../genindex.html" />
28 25 
     <link rel="search" title="Search" href="../search.html" />
29 
-    <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
26 
+    <link rel="next" title="How to setup result proxy" href="morty.html" />
30 27 
     <link rel="prev" title="Administration API" href="api.html" />
31 28
32 29

+ 86
- 0
admin/morty.html View File 

@@ -0,0 +1,86 @@
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>How to setup result proxy &#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 
+    <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
27 
+    <link rel="prev" title="How to protect an instance" href="filtron.html" />
28 
+
29 
+
30 
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
31 
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
32 
+
33 
+  </head>
34 
+  <body>
35 
+
36 
+    <div class="document">
37 
+      <div class="documentwrapper">
38 
+        <div class="bodywrapper">
39 
+          <div class="body" role="main">
40 
+
41 
+  <div class="section" id="how-to-setup-result-proxy">
42 
+<h1>How to setup result proxy<a class="headerlink" href="#how-to-setup-result-proxy" title="Permalink to this headline">¶</a></h1>
43 
+<p>By default searx can only act as an image proxy for result images,
44 
+but it is possible to proxify all the result URLs with an external service,
45 
+<a class="reference external" href="https://github.com/asciimoo/morty">morty</a>.</p>
46 
+<p>To use this feature, morty has to be installed and activated in searx’s <code class="docutils literal"><span class="pre">settings.yml</span></code>.</p>
47 
+<p>Add the following snippet to your <code class="docutils literal"><span class="pre">settings.yml</span></code> and restart searx:</p>
48 
+<div class="code yaml highlight-default"><div class="highlight"><pre><span></span><span class="n">result_proxy</span><span class="p">:</span>
49 
+    <span class="n">url</span> <span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mi">3000</span><span class="o">/</span>
50 
+    <span class="n">key</span> <span class="p">:</span> <span class="n">your_morty_proxy_key</span>
51 
+</pre></div>
52 
+</div>
53 
+<p><code class="docutils literal"><span class="pre">url</span></code> is the address of the running morty service</p>
54 
+<p><code class="docutils literal"><span class="pre">key</span></code> is an optional argument, see <a class="reference external" href="https://github.com/asciimoo/morty">morty’s README</a> for more information.</p>
55 
+</div>
56 
+
57 
+
58 
+          </div>
59 
+        </div>
60 
+      </div>
61 
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
62 
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
63 
+<h1>Searx</h1>
64 
+<ul>
65 
+    <li><a href="../index.html">Home</a></li>
66 
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
67 
+    <li><a href="../blog/blog.html">Blog</a></li>
68 
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
69 
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
70 
+</ul>
71 
+<hr />
72 
+<ul>
73 
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
74 
+    <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>
75 
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
76 
+</ul>
77 
+</div>
78 
+        </div>
79 
+      </div>
80 
+      <div class="clearer"></div>
81 
+    </div>
82 
+    <div class="footer">
83 
+      &copy; Copyright 2015-2017, Adam Tauber.
84 
+    </div>
85 
+  </body>
86 
+</html>

+ 0
- 3
blog/blog.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Blog &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 0
- 3
blog/python3.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Introducing Python3 support &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 0
- 3
dev/contribution_guide.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>How to contribute &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 0
- 3
dev/engine_overview.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Engine overview &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 0
- 3
dev/install/installation.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Installation &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../../',

+ 0
- 3
dev/plugins.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Plugins &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 1
- 4
dev/quickstart.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Development Quickstart &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',
 
@@ -27,7 +24,7 @@
27 24 
     <link rel="index" title="Index" href="../genindex.html" />
28 25 
     <link rel="search" title="Search" href="../search.html" />
29 26 
     <link rel="next" title="How to contribute" href="contribution_guide.html" />
30 
-    <link rel="prev" title="How to protect an instance" href="../admin/filtron.html" />
27 
+    <link rel="prev" title="How to setup result proxy" href="../admin/morty.html" />
31 28
32 29
33 30 
   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />

+ 0
- 3
dev/search_api.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Search API &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 0
- 3
dev/translation.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Translation &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 21
- 0
docs/admin/morty.rst View File 

@@ -0,0 +1,21 @@
1 
+How to setup result proxy
2 
+=========================
3 
+
4 
+By default searx can only act as an image proxy for result images,
5 
+but it is possible to proxify all the result URLs with an external service,
6 
+`morty <https://github.com/asciimoo/morty>`__.
7 
+
8 
+To use this feature, morty has to be installed and activated in searx's ``settings.yml``.
9 
+
10 
+Add the following snippet to your ``settings.yml`` and restart searx:
11 
+
12 
+
13 
+.. code:: yaml
14 
+
15 
+    result_proxy:
16 
+        url : http://127.0.0.1:3000/
17 
+        key : your_morty_proxy_key
18 
+
19 
+``url`` is the address of the running morty service
20 
+
21 
+``key`` is an optional argument, see `morty's README <https://github.com/asciimoo/morty>`__ for more information.

+ 1
- 0
docs/index.rst View File 

@@ -40,6 +40,7 @@ Administrator documentation
40 40 
    dev/install/installation
41 41 
    admin/api
42 42 
    admin/filtron
43 
+   admin/morty
43 44
44 45 
 Developer documentation
45 46 
 -----------------------

+ 0
- 3
genindex.html View File 

@@ -6,12 +6,9 @@
6 6 
 <html xmlns="http://www.w3.org/1999/xhtml">
7 7 
   <head>
8 8 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 
-
10 9 
     <title>Index &#8212; searx 0.12.0 documentation</title>
11 
-
12 10 
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
13 11 
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14 
-
15 12 
     <script type="text/javascript">
16 13 
       var DOCUMENTATION_OPTIONS = {
17 14 
         URL_ROOT:    './',

+ 1
- 3
index.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Welcome to searx &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    './',
 
@@ -78,6 +75,7 @@
78 75 
 <li class="toctree-l1"><a class="reference internal" href="admin/api.html">Administration API</a></li>
79 76 
 <li class="toctree-l1"><a class="reference internal" href="admin/api.html#embed-search-bar">Embed search bar</a></li>
80 77 
 <li class="toctree-l1"><a class="reference internal" href="admin/filtron.html">How to protect an instance</a></li>
78 
+<li class="toctree-l1"><a class="reference internal" href="admin/morty.html">How to setup result proxy</a></li>
81 79 
 </ul>
82 80 
 </div>
83 81 
 </div>

BIN
objects.inv View File


+ 0
- 3
search.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Search &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    './',

+ 1
- 1
searchindex.js
File diff suppressed because it is too large
View File


+ 0
- 3
user/own-instance.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Why use a private instance? &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',

+ 0
- 3
user/search_syntax.html View File 

@@ -5,12 +5,9 @@
5 5 
 <html xmlns="http://www.w3.org/1999/xhtml">
6 6 
   <head>
7 7 
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8 
-
9 8 
     <title>Search syntax &#8212; searx 0.12.0 documentation</title>
10 
-
11 9 
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12 10 
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 
-
14 11 
     <script type="text/javascript">
15 12 
       var DOCUMENTATION_OPTIONS = {
16 13 
         URL_ROOT:    '../',