Browse Source

Merge pull request #752 from kvch/gh-pages

documentation update && new page
Adam Tauber 8 years ago
parent
commit
e0eb48b4f6

+ 114
- 112
_sources/dev/engine_overview.txt View File

30
 engine file
30
 engine file
31
 ~~~~~~~~~~~
31
 ~~~~~~~~~~~
32
 
32
 
33
-+---------------------+-----------+-----------------------------------------+
34
-| argument            | type      | information                             |
35
-+=====================+===========+=========================================+
36
-| categories          | list      | pages, in which the engine is working   |
37
-+---------------------+-----------+-----------------------------------------+
38
-| paging              | boolean   | support multible pages                  |
39
-+---------------------+-----------+-----------------------------------------+
40
-| language\_support   | boolean   | support language choosing               |
41
-+---------------------+-----------+-----------------------------------------+
33
++----------------------+-----------+-----------------------------------------+
34
+| argument             | type      | information                             |
35
++======================+===========+=========================================+
36
+| categories           | list      | pages, in which the engine is working   |
37
++----------------------+-----------+-----------------------------------------+
38
+| paging               | boolean   | support multible pages                  |
39
++----------------------+-----------+-----------------------------------------+
40
+| language\_support    | boolean   | support language choosing               |
41
++----------------------+-----------+-----------------------------------------+
42
+| time\_range\_support | boolean   | support search time range               |
43
++----------------------+-----------+-----------------------------------------+
42
 
44
 
43
 settings.yml
45
 settings.yml
44
 ~~~~~~~~~~~~
46
 ~~~~~~~~~~~~
186
 default
188
 default
187
 ~~~~~~~
189
 ~~~~~~~
188
 
190
 
189
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
190
-| result-parameter   | information                                                                                                                        |
191
-+====================+====================================================================================================================================+
192
-| url                | string, which is representing the url of the result                                                                                |
193
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
194
-| title              | string, which is representing the title of the result                                                                              |
195
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
196
-| content            | string, which is giving a general result-text                                                                                      |
197
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
198
-| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   |
199
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
191
++--------------------+---------------------------------------------------------------------------------------------------------------+
192
+| result-parameter   | information                                                                                                   |
193
++====================+===============================================================================================================+
194
+| url                | string, url of the result                                                                                     |
195
++--------------------+---------------------------------------------------------------------------------------------------------------+
196
+| title              | string, title of the result                                                                                   |
197
++--------------------+---------------------------------------------------------------------------------------------------------------+
198
+| content            | string, general result-text                                                                                   |
199
++--------------------+---------------------------------------------------------------------------------------------------------------+
200
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish     |
201
++--------------------+---------------------------------------------------------------------------------------------------------------+
200
 
202
 
201
 images
203
 images
202
 ~~~~~~
204
 ~~~~~~
203
 
205
 
204
 to use this template, the parameter
206
 to use this template, the parameter
205
 
207
 
206
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
207
-| result-parameter   | information                                                                                                                                               |
208
-+====================+===========================================================================================================================================================+
209
-| template           | is set to ``images.html``                                                                                                                                 |
210
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
211
-| url                | string, which is representing the url to the result site                                                                                                  |
212
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
213
-| title              | string, which is representing the title of the result *(partly implemented)*                                                                              |
214
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
215
-| content            | *(partly implemented)*                                                                                                                                    |
216
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
217
-| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(partly implemented)*   |
218
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
219
-| img\_src           | string, which is representing the url to the result image                                                                                                 |
220
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
221
-| thumbnail\_src     | string, which is representing the url to a small-preview image                                                                                            |
222
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
208
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
209
+| result-parameter   | information                                                                                                                           |
210
++====================+=======================================================================================================================================+
211
+| template           | is set to ``images.html``                                                                                                             |
212
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
213
+| url                | string, url to the result site                                                                                                        |
214
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
215
+| title              | string, title of the result *(partly implemented)*                                                                                    |
216
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
217
+| content            | *(partly implemented)*                                                                                                                |
218
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
219
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(partly implemented)*      |
220
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
221
+| img\_src           | string, url to the result image                                                                                                       |
222
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
223
+| thumbnail\_src     | string, url to a small-preview image                                                                                                  |
224
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
223
 
225
 
224
 videos
226
 videos
225
 ~~~~~~
227
 ~~~~~~
226
 
228
 
227
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
228
-| result-parameter   | information                                                                                                                        |
229
-+====================+====================================================================================================================================+
230
-| template           | is set to ``videos.html``                                                                                                          |
231
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
232
-| url                | string, which is representing the url of the result                                                                                |
233
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
234
-| title              | string, which is representing the title of the result                                                                              |
235
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
236
-| content            | *(not implemented yet)*                                                                                                            |
237
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
238
-| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   |
239
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
240
-| thumbnail          | string, which is representing the url to a small-preview image                                                                     |
241
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
229
++--------------------+--------------------------------------------------------------------------------------------------------------+
230
+| result-parameter   | information                                                                                                  |
231
++====================+==============================================================================================================+
232
+| template           | is set to ``videos.html``                                                                                    |
233
++--------------------+--------------------------------------------------------------------------------------------------------------+
234
+| url                | string, url of the result                                                                                    |
235
++--------------------+--------------------------------------------------------------------------------------------------------------+
236
+| title              | string, title of the result                                                                                  |
237
++--------------------+--------------------------------------------------------------------------------------------------------------+
238
+| content            | *(not implemented yet)*                                                                                      |
239
++--------------------+--------------------------------------------------------------------------------------------------------------+
240
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    |
241
++--------------------+--------------------------------------------------------------------------------------------------------------+
242
+| thumbnail          | string, url to a small-preview image                                                                         |
243
++--------------------+--------------------------------------------------------------------------------------------------------------+
242
 
244
 
243
 torrent
245
 torrent
244
 ~~~~~~~
246
 ~~~~~~~
245
 
247
 
246
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
247
-| result-parameter | information                                                                                                                                              |
248
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
249
-| template         | is set to ```torrent.html```                                                                                                                             |
250
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
251
-| url              | string, which is representing the url of the result                                                                                                      |
252
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
253
-| title            | string, which is representing the title of the result                                                                                                    |
254
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
255
-| content          | string, which is giving a general result-text                                                                                                            |
256
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
257
-| publishedDate    | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(not implemented yet)* |
258
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
259
-| seed             | int, number of seeder                                                                                                                                    |
260
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
261
-| leech            | int, number of leecher                                                                                                                                   |
262
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
263
-| filesize         | int, size of file in bytes                                                                                                                               |
264
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
265
-| files            | int, number of files                                                                                                                                     |
266
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
267
-| magnetlink       | string, which is the `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                      |
268
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
269
-| torrentfile      | string, which is the torrentfile of the result                                                                                                           |
270
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
248
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
249
+| result-parameter | information                                                                                                                           |
250
++==================+=======================================================================================================================================+
251
+| template         | is set to ``torrent.html``                                                                                                            |
252
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
253
+| url              | string, url of the result                                                                                                             |
254
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
255
+| title            | string, title of the result                                                                                                           |
256
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
257
+| content          | string, general result-text                                                                                                           |
258
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
259
+| publishedDate    | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(not implemented yet)*     |
260
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
261
+| seed             | int, number of seeder                                                                                                                 |
262
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
263
+| leech            | int, number of leecher                                                                                                                |
264
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
265
+| filesize         | int, size of file in bytes                                                                                                            |
266
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
267
+| files            | int, number of files                                                                                                                  |
268
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
269
+| magnetlink       | string, `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                |
270
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
271
+| torrentfile      | string, torrentfile of the result                                                                                                     |
272
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
271
 
273
 
272
 
274
 
273
 map
275
 map
274
 ~~~
276
 ~~~
275
 
277
 
276
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
277
-| result-parameter        | information                                                                                                                        |
278
-+=========================+====================================================================================================================================+
279
-| url                     | string, which is representing the url of the result                                                                                |
280
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
281
-| title                   | string, which is representing the title of the result                                                                              |
282
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
283
-| content                 | string, which is giving a general result-text                                                                                      |
284
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
285
-| publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   |
286
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
287
-| latitude                | latitude of result (in decimal format)                                                                                             |
288
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
289
-| longitude               | longitude of result (in decimal format)                                                                                            |
290
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
291
-| boundingbox             | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``)                                                |
292
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
293
-| geojson                 | geojson of result (http://geojson.org)                                                                                             |
294
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
295
-| osm.type                | type of osm-object (if OSM-Result)                                                                                                 |
296
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
297
-| osm.id                  | id of osm-object (if OSM-Result)                                                                                                   |
298
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
299
-| address.name            | name of object                                                                                                                     |
300
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
301
-| address.road            | street adress of object                                                                                                            |
302
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
303
-| address.house\_number   | house number of object                                                                                                             |
304
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
305
-| address.locality        | city, place of object                                                                                                              |
306
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
307
-| address.postcode        | postcode of object                                                                                                                 |
308
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
309
-| address.country         | country of object                                                                                                                  |
310
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
278
++-------------------------+--------------------------------------------------------------------------------------------------------------+
279
+| result-parameter        | information                                                                                                  |
280
++=========================+==============================================================================================================+
281
+| url                     | string, url of the result                                                                                    |
282
++-------------------------+--------------------------------------------------------------------------------------------------------------+
283
+| title                   | string, title of the result                                                                                  |
284
++-------------------------+--------------------------------------------------------------------------------------------------------------+
285
+| content                 | string, general result-text                                                                                  |
286
++-------------------------+--------------------------------------------------------------------------------------------------------------+
287
+| publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    |
288
++-------------------------+--------------------------------------------------------------------------------------------------------------+
289
+| latitude                | latitude of result (in decimal format)                                                                       |
290
++-------------------------+--------------------------------------------------------------------------------------------------------------+
291
+| longitude               | longitude of result (in decimal format)                                                                      |
292
++-------------------------+--------------------------------------------------------------------------------------------------------------+
293
+| boundingbox             | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``)                          |
294
++-------------------------+--------------------------------------------------------------------------------------------------------------+
295
+| geojson                 | geojson of result (http://geojson.org)                                                                       |
296
++-------------------------+--------------------------------------------------------------------------------------------------------------+
297
+| osm.type                | type of osm-object (if OSM-Result)                                                                           |
298
++-------------------------+--------------------------------------------------------------------------------------------------------------+
299
+| osm.id                  | id of osm-object (if OSM-Result)                                                                             |
300
++-------------------------+--------------------------------------------------------------------------------------------------------------+
301
+| address.name            | name of object                                                                                               |
302
++-------------------------+--------------------------------------------------------------------------------------------------------------+
303
+| address.road            | street name of object                                                                                        |
304
++-------------------------+--------------------------------------------------------------------------------------------------------------+
305
+| address.house\_number   | house number of object                                                                                       |
306
++-------------------------+--------------------------------------------------------------------------------------------------------------+
307
+| address.locality        | city, place of object                                                                                        |
308
++-------------------------+--------------------------------------------------------------------------------------------------------------+
309
+| address.postcode        | postcode of object                                                                                           |
310
++-------------------------+--------------------------------------------------------------------------------------------------------------+
311
+| address.country         | country of object                                                                                            |
312
++-------------------------+--------------------------------------------------------------------------------------------------------------+
311
 
313
 

+ 1
- 1
_sources/dev/plugins.txt View File

11
 
11
 
12
     name = 'Example plugin'
12
     name = 'Example plugin'
13
     description = 'This plugin extends the suggestions with the word "example"'
13
     description = 'This plugin extends the suggestions with the word "example"'
14
-    default_on = False  # disable by default
14
+    default_on = False  # disabled by default
15
 
15
 
16
     js_dependencies = tuple()  # optional, list of static js files
16
     js_dependencies = tuple()  # optional, list of static js files
17
     css_dependencies = tuple()  # optional, list of static css files
17
     css_dependencies = tuple()  # optional, list of static css files

+ 2
- 1
_sources/index.txt View File

16
  - No user tracking
16
  - No user tracking
17
  - No user profiling
17
  - No user profiling
18
  - About 70 supported search engines
18
  - About 70 supported search engines
19
- - Easy intergration with any search engines
19
+ - Easy integration with any search engine
20
  - Cookies are not used by default
20
  - Cookies are not used by default
21
  - Secure, encrypted connections (HTTPS/SSL)
21
  - Secure, encrypted connections (HTTPS/SSL)
22
  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
22
  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
29
    :maxdepth: 1
29
    :maxdepth: 1
30
 
30
 
31
    user/search_syntax
31
    user/search_syntax
32
+   user/own-instance
32
 
33
 
33
 Administrator documentation
34
 Administrator documentation
34
 ---------------------------
35
 ---------------------------

+ 43
- 0
_sources/user/own-instance.txt View File

1
+Why use a private instance?
2
+===========================
3
+
4
+"Is it worth to run my own instance?" is a common question among searx users. Before answering this question, see what options a searx user has.
5
+
6
+Public instances are open to everyone who has access to its URL. Usually, these are operated by unknown parties (from the users' point of view). Private instances can be used by a select group of people. It is for example a searx of group of friends or a company which can be accessed through VPN. Also it can be single user one which runs on the user's laptop.
7
+
8
+To gain more insight on how these instances work let's dive into how searx protects its users.
9
+
10
+How does searx protect privacy?
11
+-------------------------------
12
+
13
+Searx protects the privacy of its users in multiple ways regardless of the type of the instance (private, public). Removal of private data from search requests comes in three forms:
14
+
15
+ 1. removal of private data from requests going to search services
16
+ 2. not forwarding anything from a third party services through search services (e.g. advertisement)
17
+ 3. removal of private data from requests going to the result pages
18
+
19
+Removing private data means not sending cookies to external search engines and generating a random browser profile for every request. Thus, it does not matter if a public or private instance handles the request, because it is anonymized in both cases. IP addresses will be the IP of the instance. But searx can be configured to use proxy or Tor. `Result proxy <https://github.com/asciimoo/morty>`__ is supported, too.
20
+
21
+Searx does not serve adds or tracking content unlike most search services. So private data is not forwarded to third parties who might monetize it. Besides protecting users from search services, both referring page and search query are hidden from visited result pages.
22
+
23
+What are the consequences of using public instances?
24
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25
+
26
+If someone uses a public instance, he/she has to trust the administrator of that instance.
27
+This means that the user of the public instance does not know whether his/her requests are logged, aggregated and sent or sold to a third party.
28
+
29
+Also, public instances without proper protection are more vulnerable to abusing the search service, In this case the external service in exchange returns CAPTCHAs or bans the IP of the instance. Thus, search requests return less results.
30
+
31
+I see. What about private instances?
32
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
+
34
+If users run their own instances, everything is in their control: the source code, logging settings and private data. Unknown instance administrators do not have to be trusted.
35
+
36
+Furthermore, as the default settings of their instance is editable, there is no need to use cookies to tailor searx to their needs. So preferences will not be reset to defaults when clearing browser cookies. As settings are stored on their computer, it will not be accessible to others as long as their computer is not compromised.
37
+
38
+Conclusion
39
+----------
40
+
41
+Always use an instance which is operated by people you trust. The privacy features of searx are available to users no matter what kind of instance they use.
42
+
43
+If someone is on the go or just wants to try searx for the first time public instances are the best choices. Additionally, public instance are making a world a better place, because those who cannot or do not want to run an instance, have access to a privacy respecting search service.

+ 7
- 0
_static/basic.css View File

494
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
494
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
495
 }
495
 }
496
 
496
 
497
+span.pre {
498
+    -moz-hyphens: none;
499
+    -ms-hyphens: none;
500
+    -webkit-hyphens: none;
501
+    hyphens: none;
502
+}
503
+
497
 td.linenos pre {
504
 td.linenos pre {
498
     padding: 5px 0px;
505
     padding: 5px 0px;
499
     border: 0;
506
     border: 0;

+ 2
- 0
_static/pygments.css View File

4
 .highlight .err { border: 1px solid #FF0000 } /* Error */
4
 .highlight .err { border: 1px solid #FF0000 } /* Error */
5
 .highlight .k { color: #007020; font-weight: bold } /* Keyword */
5
 .highlight .k { color: #007020; font-weight: bold } /* Keyword */
6
 .highlight .o { color: #666666 } /* Operator */
6
 .highlight .o { color: #666666 } /* Operator */
7
+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
7
 .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
8
 .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
8
 .highlight .cp { color: #007020 } /* Comment.Preproc */
9
 .highlight .cp { color: #007020 } /* Comment.Preproc */
10
+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
9
 .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
11
 .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
10
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
12
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
11
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
13
 .highlight .gd { color: #A00000 } /* Generic.Deleted */

+ 1
- 1
_static/searchtools.js View File

324
     var searchterms = [];
324
     var searchterms = [];
325
     var excluded = [];
325
     var excluded = [];
326
     var hlterms = [];
326
     var hlterms = [];
327
-    var tmp = query.split(/\s+/);
327
+    var tmp = query.split(/\W+/);
328
     var objectterms = [];
328
     var objectterms = [];
329
     for (i = 0; i < tmp.length; i++) {
329
     for (i = 0; i < tmp.length; i++) {
330
       if (tmp[i] !== "") {
330
       if (tmp[i] !== "") {

+ 47
- 45
admin/api.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Administration API &mdash; searx 0.9.0 documentation</title>
9
+    <title>Administration API &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
27
-    <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
29
+    <link rel="next" title="How to protect an instance" href="filtron.html" />
28
     <link rel="prev" title="Installation" href="../dev/install/installation.html" />
30
     <link rel="prev" title="Installation" href="../dev/install/installation.html" />
29
    
31
    
30
   
32
   
43
 <span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>
45
 <span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>
44
 <div class="section" id="get-configuration-data">
46
 <div class="section" id="get-configuration-data">
45
 <h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline">¶</a></h2>
47
 <h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline">¶</a></h2>
46
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
48
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
47
 </pre></div>
49
 </pre></div>
48
 </div>
50
 </div>
49
 <div class="section" id="sample-response">
51
 <div class="section" id="sample-response">
50
 <h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline">¶</a></h3>
52
 <h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline">¶</a></h3>
51
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="p">{</span>
52
-  <span class="s">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
53
-  <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
54
-    <span class="s">&quot;map&quot;</span><span class="p">,</span>
55
-    <span class="s">&quot;it&quot;</span><span class="p">,</span>
56
-    <span class="s">&quot;images&quot;</span><span class="p">,</span>
53
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
54
+  <span class="s2">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
55
+  <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
56
+    <span class="s2">&quot;map&quot;</span><span class="p">,</span>
57
+    <span class="s2">&quot;it&quot;</span><span class="p">,</span>
58
+    <span class="s2">&quot;images&quot;</span><span class="p">,</span>
57
   <span class="p">],</span>
59
   <span class="p">],</span>
58
-  <span class="s">&quot;default_locale&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
59
-  <span class="s">&quot;default_theme&quot;</span><span class="p">:</span> <span class="s">&quot;oscar&quot;</span><span class="p">,</span>
60
-  <span class="s">&quot;engines&quot;</span><span class="p">:</span> <span class="p">[</span>
60
+  <span class="s2">&quot;default_locale&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
61
+  <span class="s2">&quot;default_theme&quot;</span><span class="p">:</span> <span class="s2">&quot;oscar&quot;</span><span class="p">,</span>
62
+  <span class="s2">&quot;engines&quot;</span><span class="p">:</span> <span class="p">[</span>
61
     <span class="p">{</span>
63
     <span class="p">{</span>
62
-      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
63
-        <span class="s">&quot;map&quot;</span>
64
+      <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
65
+        <span class="s2">&quot;map&quot;</span>
64
       <span class="p">],</span>
66
       <span class="p">],</span>
65
-      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
66
-      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;openstreetmap&quot;</span><span class="p">,</span>
67
-      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;osm&quot;</span>
67
+      <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
68
+      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;openstreetmap&quot;</span><span class="p">,</span>
69
+      <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;osm&quot;</span>
68
     <span class="p">},</span>
70
     <span class="p">},</span>
69
     <span class="p">{</span>
71
     <span class="p">{</span>
70
-      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
71
-        <span class="s">&quot;it&quot;</span>
72
+      <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
73
+        <span class="s2">&quot;it&quot;</span>
72
       <span class="p">],</span>
74
       <span class="p">],</span>
73
-      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
74
-      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;arch linux wiki&quot;</span><span class="p">,</span>
75
-      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;al&quot;</span>
75
+      <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
76
+      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;arch linux wiki&quot;</span><span class="p">,</span>
77
+      <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;al&quot;</span>
76
     <span class="p">},</span>
78
     <span class="p">},</span>
77
     <span class="p">{</span>
79
     <span class="p">{</span>
78
-      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
79
-        <span class="s">&quot;images&quot;</span>
80
+      <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
81
+        <span class="s2">&quot;images&quot;</span>
80
       <span class="p">],</span>
82
       <span class="p">],</span>
81
-      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
82
-      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;google images&quot;</span><span class="p">,</span>
83
-      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;goi&quot;</span>
83
+      <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
84
+      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;google images&quot;</span><span class="p">,</span>
85
+      <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;goi&quot;</span>
84
     <span class="p">},</span>
86
     <span class="p">},</span>
85
     <span class="p">{</span>
87
     <span class="p">{</span>
86
-      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
87
-        <span class="s">&quot;it&quot;</span>
88
+      <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
89
+        <span class="s2">&quot;it&quot;</span>
88
       <span class="p">],</span>
90
       <span class="p">],</span>
89
-      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
90
-      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;bitbucket&quot;</span><span class="p">,</span>
91
-      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;bb&quot;</span>
91
+      <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
92
+      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;bitbucket&quot;</span><span class="p">,</span>
93
+      <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;bb&quot;</span>
92
     <span class="p">},</span>
94
     <span class="p">},</span>
93
   <span class="p">],</span>
95
   <span class="p">],</span>
94
-  <span class="s">&quot;instance_name&quot;</span><span class="p">:</span> <span class="s">&quot;searx&quot;</span><span class="p">,</span>
95
-  <span class="s">&quot;locales&quot;</span><span class="p">:</span> <span class="p">{</span>
96
-    <span class="s">&quot;de&quot;</span><span class="p">:</span> <span class="s">&quot;Deutsch (German)&quot;</span><span class="p">,</span>
97
-    <span class="s">&quot;en&quot;</span><span class="p">:</span> <span class="s">&quot;English&quot;</span><span class="p">,</span>
98
-    <span class="s">&quot;eo&quot;</span><span class="p">:</span> <span class="s">&quot;Esperanto (Esperanto)&quot;</span><span class="p">,</span>
96
+  <span class="s2">&quot;instance_name&quot;</span><span class="p">:</span> <span class="s2">&quot;searx&quot;</span><span class="p">,</span>
97
+  <span class="s2">&quot;locales&quot;</span><span class="p">:</span> <span class="p">{</span>
98
+    <span class="s2">&quot;de&quot;</span><span class="p">:</span> <span class="s2">&quot;Deutsch (German)&quot;</span><span class="p">,</span>
99
+    <span class="s2">&quot;en&quot;</span><span class="p">:</span> <span class="s2">&quot;English&quot;</span><span class="p">,</span>
100
+    <span class="s2">&quot;eo&quot;</span><span class="p">:</span> <span class="s2">&quot;Esperanto (Esperanto)&quot;</span><span class="p">,</span>
99
   <span class="p">},</span>
101
   <span class="p">},</span>
100
-  <span class="s">&quot;plugins&quot;</span><span class="p">:</span> <span class="p">[</span>
102
+  <span class="s2">&quot;plugins&quot;</span><span class="p">:</span> <span class="p">[</span>
101
     <span class="p">{</span>
103
     <span class="p">{</span>
102
-      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
103
-      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;HTTPS rewrite&quot;</span>
104
+      <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
105
+      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;HTTPS rewrite&quot;</span>
104
     <span class="p">},</span>
106
     <span class="p">},</span>
105
     <span class="p">{</span>
107
     <span class="p">{</span>
106
-      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
107
-      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Vim-like hotkeys&quot;</span>
108
+      <span class="s2">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
109
+      <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;Vim-like hotkeys&quot;</span>
108
     <span class="p">}</span>
110
     <span class="p">}</span>
109
   <span class="p">],</span>
111
   <span class="p">],</span>
110
-  <span class="s">&quot;safe_search&quot;</span><span class="p">:</span> <span class="mi">0</span>
112
+  <span class="s2">&quot;safe_search&quot;</span><span class="p">:</span> <span class="mi">0</span>
111
 <span class="p">}</span>
113
 <span class="p">}</span>
112
 </pre></div>
114
 </pre></div>
113
 </div>
115
 </div>

+ 3
- 3
admin/filtron.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>How to protect an instance &#8212; searx 0.9.0 documentation</title>
9
+    <title>How to protect an instance &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
     <link rel="index" title="Index" href="../genindex.html" />
26
     <link rel="index" title="Index" href="../genindex.html" />
27
     <link rel="search" title="Search" href="../search.html" />
27
     <link rel="search" title="Search" href="../search.html" />
28
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
29
     <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
29
     <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
30
     <link rel="prev" title="Administration API" href="api.html" />
30
     <link rel="prev" title="Administration API" href="api.html" />
31
    
31
    

+ 5
- 3
dev/contribution_guide.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>How to contribute &mdash; searx 0.9.0 documentation</title>
9
+    <title>How to contribute &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="next" title="Engine overview" href="engine_overview.html" />
29
     <link rel="next" title="Engine overview" href="engine_overview.html" />
28
     <link rel="prev" title="Development Quickstart" href="quickstart.html" />
30
     <link rel="prev" title="Development Quickstart" href="quickstart.html" />
29
    
31
    

+ 62
- 54
dev/engine_overview.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Engine overview &mdash; searx 0.9.0 documentation</title>
9
+    <title>Engine overview &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="next" title="Search API" href="search_api.html" />
29
     <link rel="next" title="Search API" href="search_api.html" />
28
     <link rel="prev" title="How to contribute" href="contribution_guide.html" />
30
     <link rel="prev" title="How to contribute" href="contribution_guide.html" />
29
    
31
    
88
 <h3><a class="toc-backref" href="#id4">engine file</a><a class="headerlink" href="#engine-file" title="Permalink to this headline">¶</a></h3>
90
 <h3><a class="toc-backref" href="#id4">engine file</a><a class="headerlink" href="#engine-file" title="Permalink to this headline">¶</a></h3>
89
 <table border="1" class="docutils">
91
 <table border="1" class="docutils">
90
 <colgroup>
92
 <colgroup>
91
-<col width="29%" />
93
+<col width="30%" />
92
 <col width="15%" />
94
 <col width="15%" />
93
-<col width="56%" />
95
+<col width="55%" />
94
 </colgroup>
96
 </colgroup>
95
 <thead valign="bottom">
97
 <thead valign="bottom">
96
 <tr class="row-odd"><th class="head">argument</th>
98
 <tr class="row-odd"><th class="head">argument</th>
111
 <td>boolean</td>
113
 <td>boolean</td>
112
 <td>support language choosing</td>
114
 <td>support language choosing</td>
113
 </tr>
115
 </tr>
116
+<tr class="row-odd"><td>time_range_support</td>
117
+<td>boolean</td>
118
+<td>support search time range</td>
119
+</tr>
114
 </tbody>
120
 </tbody>
115
 </table>
121
 </table>
116
 </div>
122
 </div>
190
 </div>
196
 </div>
191
 <div class="section" id="example-code">
197
 <div class="section" id="example-code">
192
 <h3><a class="toc-backref" href="#id7">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h3>
198
 <h3><a class="toc-backref" href="#id7">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h3>
193
-<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># engine dependent config</span>
194
-<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;general&#39;</span><span class="p">]</span>
195
-<span class="n">paging</span> <span class="o">=</span> <span class="k">True</span>
196
-<span class="n">language_support</span> <span class="o">=</span> <span class="k">True</span>
199
+<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="c1"># engine dependent config</span>
200
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
201
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
202
+<span class="n">language_support</span> <span class="o">=</span> <span class="kc">True</span>
197
 </pre></div>
203
 </pre></div>
198
 </div>
204
 </div>
199
 </div>
205
 </div>
313
 </div>
319
 </div>
314
 <div class="section" id="id1">
320
 <div class="section" id="id1">
315
 <h3><a class="toc-backref" href="#id11">example code</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
321
 <h3><a class="toc-backref" href="#id11">example code</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
316
-<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># search-url</span>
317
-<span class="n">base_url</span> <span class="o">=</span> <span class="s">&#39;https://example.com/&#39;</span>
318
-<span class="n">search_string</span> <span class="o">=</span> <span class="s">&#39;search?{query}&amp;page={page}&#39;</span>
322
+<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="c1"># search-url</span>
323
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://example.com/&#39;</span>
324
+<span class="n">search_string</span> <span class="o">=</span> <span class="s1">&#39;search?</span><span class="si">{query}</span><span class="s1">&amp;page=</span><span class="si">{page}</span><span class="s1">&#39;</span>
319
 
325
 
320
-<span class="c"># do search-request</span>
326
+<span class="c1"># do search-request</span>
321
 <span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
327
 <span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
322
     <span class="n">search_path</span> <span class="o">=</span> <span class="n">search_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
328
     <span class="n">search_path</span> <span class="o">=</span> <span class="n">search_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
323
-        <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
324
-        <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;pageno&#39;</span><span class="p">])</span>
329
+        <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
330
+        <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">])</span>
325
 
331
 
326
-    <span class="n">params</span><span class="p">[</span><span class="s">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
332
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
327
 
333
 
328
     <span class="k">return</span> <span class="n">params</span>
334
     <span class="k">return</span> <span class="n">params</span>
329
 </pre></div>
335
 </pre></div>
347
 <h3><a class="toc-backref" href="#id13">default</a><a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>
353
 <h3><a class="toc-backref" href="#id13">default</a><a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>
348
 <table border="1" class="docutils">
354
 <table border="1" class="docutils">
349
 <colgroup>
355
 <colgroup>
350
-<col width="13%" />
351
-<col width="87%" />
356
+<col width="15%" />
357
+<col width="85%" />
352
 </colgroup>
358
 </colgroup>
353
 <thead valign="bottom">
359
 <thead valign="bottom">
354
 <tr class="row-odd"><th class="head">result-parameter</th>
360
 <tr class="row-odd"><th class="head">result-parameter</th>
357
 </thead>
363
 </thead>
358
 <tbody valign="top">
364
 <tbody valign="top">
359
 <tr class="row-even"><td>url</td>
365
 <tr class="row-even"><td>url</td>
360
-<td>string, which is representing the url of the result</td>
366
+<td>string, url of the result</td>
361
 </tr>
367
 </tr>
362
 <tr class="row-odd"><td>title</td>
368
 <tr class="row-odd"><td>title</td>
363
-<td>string, which is representing the title of the result</td>
369
+<td>string, title of the result</td>
364
 </tr>
370
 </tr>
365
 <tr class="row-even"><td>content</td>
371
 <tr class="row-even"><td>content</td>
366
-<td>string, which is giving a general result-text</td>
372
+<td>string, general result-text</td>
367
 </tr>
373
 </tr>
368
 <tr class="row-odd"><td>publishedDate</td>
374
 <tr class="row-odd"><td>publishedDate</td>
369
-<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published</td>
375
+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish</td>
370
 </tr>
376
 </tr>
371
 </tbody>
377
 </tbody>
372
 </table>
378
 </table>
376
 <p>to use this template, the parameter</p>
382
 <p>to use this template, the parameter</p>
377
 <table border="1" class="docutils">
383
 <table border="1" class="docutils">
378
 <colgroup>
384
 <colgroup>
379
-<col width="11%" />
380
-<col width="89%" />
385
+<col width="13%" />
386
+<col width="87%" />
381
 </colgroup>
387
 </colgroup>
382
 <thead valign="bottom">
388
 <thead valign="bottom">
383
 <tr class="row-odd"><th class="head">result-parameter</th>
389
 <tr class="row-odd"><th class="head">result-parameter</th>
389
 <td>is set to <code class="docutils literal"><span class="pre">images.html</span></code></td>
395
 <td>is set to <code class="docutils literal"><span class="pre">images.html</span></code></td>
390
 </tr>
396
 </tr>
391
 <tr class="row-odd"><td>url</td>
397
 <tr class="row-odd"><td>url</td>
392
-<td>string, which is representing the url to the result site</td>
398
+<td>string, url to the result site</td>
393
 </tr>
399
 </tr>
394
 <tr class="row-even"><td>title</td>
400
 <tr class="row-even"><td>title</td>
395
-<td>string, which is representing the title of the result <em>(partly implemented)</em></td>
401
+<td>string, title of the result <em>(partly implemented)</em></td>
396
 </tr>
402
 </tr>
397
 <tr class="row-odd"><td>content</td>
403
 <tr class="row-odd"><td>content</td>
398
 <td><em>(partly implemented)</em></td>
404
 <td><em>(partly implemented)</em></td>
399
 </tr>
405
 </tr>
400
 <tr class="row-even"><td>publishedDate</td>
406
 <tr class="row-even"><td>publishedDate</td>
401
-<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published <em>(partly implemented)</em></td>
407
+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish <em>(partly implemented)</em></td>
402
 </tr>
408
 </tr>
403
 <tr class="row-odd"><td>img_src</td>
409
 <tr class="row-odd"><td>img_src</td>
404
-<td>string, which is representing the url to the result image</td>
410
+<td>string, url to the result image</td>
405
 </tr>
411
 </tr>
406
 <tr class="row-even"><td>thumbnail_src</td>
412
 <tr class="row-even"><td>thumbnail_src</td>
407
-<td>string, which is representing the url to a small-preview image</td>
413
+<td>string, url to a small-preview image</td>
408
 </tr>
414
 </tr>
409
 </tbody>
415
 </tbody>
410
 </table>
416
 </table>
413
 <h3><a class="toc-backref" href="#id15">videos</a><a class="headerlink" href="#videos" title="Permalink to this headline">¶</a></h3>
419
 <h3><a class="toc-backref" href="#id15">videos</a><a class="headerlink" href="#videos" title="Permalink to this headline">¶</a></h3>
414
 <table border="1" class="docutils">
420
 <table border="1" class="docutils">
415
 <colgroup>
421
 <colgroup>
416
-<col width="13%" />
417
-<col width="87%" />
422
+<col width="15%" />
423
+<col width="85%" />
418
 </colgroup>
424
 </colgroup>
419
 <thead valign="bottom">
425
 <thead valign="bottom">
420
 <tr class="row-odd"><th class="head">result-parameter</th>
426
 <tr class="row-odd"><th class="head">result-parameter</th>
426
 <td>is set to <code class="docutils literal"><span class="pre">videos.html</span></code></td>
432
 <td>is set to <code class="docutils literal"><span class="pre">videos.html</span></code></td>
427
 </tr>
433
 </tr>
428
 <tr class="row-odd"><td>url</td>
434
 <tr class="row-odd"><td>url</td>
429
-<td>string, which is representing the url of the result</td>
435
+<td>string, url of the result</td>
430
 </tr>
436
 </tr>
431
 <tr class="row-even"><td>title</td>
437
 <tr class="row-even"><td>title</td>
432
-<td>string, which is representing the title of the result</td>
438
+<td>string, title of the result</td>
433
 </tr>
439
 </tr>
434
 <tr class="row-odd"><td>content</td>
440
 <tr class="row-odd"><td>content</td>
435
 <td><em>(not implemented yet)</em></td>
441
 <td><em>(not implemented yet)</em></td>
436
 </tr>
442
 </tr>
437
 <tr class="row-even"><td>publishedDate</td>
443
 <tr class="row-even"><td>publishedDate</td>
438
-<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published</td>
444
+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish</td>
439
 </tr>
445
 </tr>
440
 <tr class="row-odd"><td>thumbnail</td>
446
 <tr class="row-odd"><td>thumbnail</td>
441
-<td>string, which is representing the url to a small-preview image</td>
447
+<td>string, url to a small-preview image</td>
442
 </tr>
448
 </tr>
443
 </tbody>
449
 </tbody>
444
 </table>
450
 </table>
447
 <h3><a class="toc-backref" href="#id16">torrent</a><a class="headerlink" href="#torrent" title="Permalink to this headline">¶</a></h3>
453
 <h3><a class="toc-backref" href="#id16">torrent</a><a class="headerlink" href="#torrent" title="Permalink to this headline">¶</a></h3>
448
 <table border="1" class="docutils">
454
 <table border="1" class="docutils">
449
 <colgroup>
455
 <colgroup>
450
-<col width="10%" />
451
-<col width="90%" />
456
+<col width="12%" />
457
+<col width="88%" />
452
 </colgroup>
458
 </colgroup>
453
-<tbody valign="top">
454
-<tr class="row-odd"><td>result-parameter</td>
455
-<td>information</td>
459
+<thead valign="bottom">
460
+<tr class="row-odd"><th class="head">result-parameter</th>
461
+<th class="head">information</th>
456
 </tr>
462
 </tr>
463
+</thead>
464
+<tbody valign="top">
457
 <tr class="row-even"><td>template</td>
465
 <tr class="row-even"><td>template</td>
458
-<td>is set to <code class="docutils literal"><span class="pre">`torrent.html`</span></code></td>
466
+<td>is set to <code class="docutils literal"><span class="pre">torrent.html</span></code></td>
459
 </tr>
467
 </tr>
460
 <tr class="row-odd"><td>url</td>
468
 <tr class="row-odd"><td>url</td>
461
-<td>string, which is representing the url of the result</td>
469
+<td>string, url of the result</td>
462
 </tr>
470
 </tr>
463
 <tr class="row-even"><td>title</td>
471
 <tr class="row-even"><td>title</td>
464
-<td>string, which is representing the title of the result</td>
472
+<td>string, title of the result</td>
465
 </tr>
473
 </tr>
466
 <tr class="row-odd"><td>content</td>
474
 <tr class="row-odd"><td>content</td>
467
-<td>string, which is giving a general result-text</td>
475
+<td>string, general result-text</td>
468
 </tr>
476
 </tr>
469
 <tr class="row-even"><td>publishedDate</td>
477
 <tr class="row-even"><td>publishedDate</td>
470
-<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published <em>(not implemented yet)</em></td>
478
+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish <em>(not implemented yet)</em></td>
471
 </tr>
479
 </tr>
472
 <tr class="row-odd"><td>seed</td>
480
 <tr class="row-odd"><td>seed</td>
473
 <td>int, number of seeder</td>
481
 <td>int, number of seeder</td>
482
 <td>int, number of files</td>
490
 <td>int, number of files</td>
483
 </tr>
491
 </tr>
484
 <tr class="row-odd"><td>magnetlink</td>
492
 <tr class="row-odd"><td>magnetlink</td>
485
-<td>string, which is the <a class="reference external" href="https://en.wikipedia.org/wiki/Magnet_URI_scheme">magnetlink</a> of the result</td>
493
+<td>string, <a class="reference external" href="https://en.wikipedia.org/wiki/Magnet_URI_scheme">magnetlink</a> of the result</td>
486
 </tr>
494
 </tr>
487
 <tr class="row-even"><td>torrentfile</td>
495
 <tr class="row-even"><td>torrentfile</td>
488
-<td>string, which is the torrentfile of the result</td>
496
+<td>string, torrentfile of the result</td>
489
 </tr>
497
 </tr>
490
 </tbody>
498
 </tbody>
491
 </table>
499
 </table>
494
 <h3><a class="toc-backref" href="#id17">map</a><a class="headerlink" href="#map" title="Permalink to this headline">¶</a></h3>
502
 <h3><a class="toc-backref" href="#id17">map</a><a class="headerlink" href="#map" title="Permalink to this headline">¶</a></h3>
495
 <table border="1" class="docutils">
503
 <table border="1" class="docutils">
496
 <colgroup>
504
 <colgroup>
497
-<col width="16%" />
498
-<col width="84%" />
505
+<col width="19%" />
506
+<col width="81%" />
499
 </colgroup>
507
 </colgroup>
500
 <thead valign="bottom">
508
 <thead valign="bottom">
501
 <tr class="row-odd"><th class="head">result-parameter</th>
509
 <tr class="row-odd"><th class="head">result-parameter</th>
504
 </thead>
512
 </thead>
505
 <tbody valign="top">
513
 <tbody valign="top">
506
 <tr class="row-even"><td>url</td>
514
 <tr class="row-even"><td>url</td>
507
-<td>string, which is representing the url of the result</td>
515
+<td>string, url of the result</td>
508
 </tr>
516
 </tr>
509
 <tr class="row-odd"><td>title</td>
517
 <tr class="row-odd"><td>title</td>
510
-<td>string, which is representing the title of the result</td>
518
+<td>string, title of the result</td>
511
 </tr>
519
 </tr>
512
 <tr class="row-even"><td>content</td>
520
 <tr class="row-even"><td>content</td>
513
-<td>string, which is giving a general result-text</td>
521
+<td>string, general result-text</td>
514
 </tr>
522
 </tr>
515
 <tr class="row-odd"><td>publishedDate</td>
523
 <tr class="row-odd"><td>publishedDate</td>
516
-<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, represent when the result is published</td>
524
+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish</td>
517
 </tr>
525
 </tr>
518
 <tr class="row-even"><td>latitude</td>
526
 <tr class="row-even"><td>latitude</td>
519
 <td>latitude of result (in decimal format)</td>
527
 <td>latitude of result (in decimal format)</td>
537
 <td>name of object</td>
545
 <td>name of object</td>
538
 </tr>
546
 </tr>
539
 <tr class="row-odd"><td>address.road</td>
547
 <tr class="row-odd"><td>address.road</td>
540
-<td>street adress of object</td>
548
+<td>street name of object</td>
541
 </tr>
549
 </tr>
542
 <tr class="row-even"><td>address.house_number</td>
550
 <tr class="row-even"><td>address.house_number</td>
543
 <td>house number of object</td>
551
 <td>house number of object</td>

+ 38
- 36
dev/install/installation.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Installation &mdash; searx 0.9.0 documentation</title>
9
+    <title>Installation &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../../',
16
         URL_ROOT:    '../../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../../index.html" />
26
+    <link rel="index" title="Index" href="../../genindex.html" />
27
+    <link rel="search" title="Search" href="../../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../../index.html" />
27
     <link rel="next" title="Administration API" href="../../admin/api.html" />
29
     <link rel="next" title="Administration API" href="../../admin/api.html" />
28
     <link rel="prev" title="Search syntax" href="../../user/search_syntax.html" />
30
     <link rel="prev" title="Search syntax" href="../../user/search_syntax.html" />
29
    
31
    
68
 <h2><a class="toc-backref" href="#id4">Basic installation</a><a class="headerlink" href="#basic-installation" title="Permalink to this headline">¶</a></h2>
70
 <h2><a class="toc-backref" href="#id4">Basic installation</a><a class="headerlink" href="#basic-installation" title="Permalink to this headline">¶</a></h2>
69
 <p>For Ubuntu, be sure to have enable universe repository.</p>
71
 <p>For Ubuntu, be sure to have enable universe repository.</p>
70
 <p>Install packages:</p>
72
 <p>Install packages:</p>
71
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">git</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">virtualenv</span> <span class="n">python</span><span class="o">-</span><span class="n">pybabel</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> <span class="n">libffi</span><span class="o">-</span><span class="n">dev</span> <span class="n">libssl</span><span class="o">-</span><span class="n">dev</span>
73
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">git</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">virtualenv</span> <span class="n">python</span><span class="o">-</span><span class="n">pybabel</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> <span class="n">libffi</span><span class="o">-</span><span class="n">dev</span> <span class="n">libssl</span><span class="o">-</span><span class="n">dev</span>
72
 </pre></div>
74
 </pre></div>
73
 </div>
75
 </div>
74
 <p>Install searx:</p>
76
 <p>Install searx:</p>
75
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span>
77
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span>
76
 <span class="n">sudo</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
78
 <span class="n">sudo</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
77
 <span class="n">sudo</span> <span class="n">useradd</span> <span class="n">searx</span> <span class="o">-</span><span class="n">d</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
79
 <span class="n">sudo</span> <span class="n">useradd</span> <span class="n">searx</span> <span class="o">-</span><span class="n">d</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
78
 <span class="n">sudo</span> <span class="n">chown</span> <span class="n">searx</span><span class="p">:</span><span class="n">searx</span> <span class="o">-</span><span class="n">R</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
80
 <span class="n">sudo</span> <span class="n">chown</span> <span class="n">searx</span><span class="p">:</span><span class="n">searx</span> <span class="o">-</span><span class="n">R</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
79
 </pre></div>
81
 </pre></div>
80
 </div>
82
 </div>
81
 <p>Install dependencies in a virtualenv:</p>
83
 <p>Install dependencies in a virtualenv:</p>
82
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
84
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
83
 <span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
85
 <span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
84
 <span class="n">virtualenv</span> <span class="n">searx</span><span class="o">-</span><span class="n">ve</span>
86
 <span class="n">virtualenv</span> <span class="n">searx</span><span class="o">-</span><span class="n">ve</span>
85
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
87
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
89
 </div>
91
 </div>
90
 <div class="section" id="configuration">
92
 <div class="section" id="configuration">
91
 <h2><a class="toc-backref" href="#id5">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
93
 <h2><a class="toc-backref" href="#id5">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
92
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s">&quot;s/ultrasecretkey/`openssl rand -hex 16`/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
94
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;s/ultrasecretkey/`openssl rand -hex 16`/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
93
 </pre></div>
95
 </pre></div>
94
 </div>
96
 </div>
95
 <p>Edit searx/settings.yml if necessary.</p>
97
 <p>Edit searx/settings.yml if necessary.</p>
97
 <div class="section" id="check">
99
 <div class="section" id="check">
98
 <h2><a class="toc-backref" href="#id6">Check</a><a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h2>
100
 <h2><a class="toc-backref" href="#id6">Check</a><a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h2>
99
 <p>Start searx:</p>
101
 <p>Start searx:</p>
100
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">python</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
102
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
101
 </pre></div>
103
 </pre></div>
102
 </div>
104
 </div>
103
 <p>Go to <a class="reference external" href="http://localhost:8888">http://localhost:8888</a></p>
105
 <p>Go to <a class="reference external" href="http://localhost:8888">http://localhost:8888</a></p>
104
 <p>If everything works fine, disable the debug option in settings.yml:</p>
106
 <p>If everything works fine, disable the debug option in settings.yml:</p>
105
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s">&quot;s/debug : True/debug : False/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
107
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;s/debug : True/debug : False/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
106
 </pre></div>
108
 </pre></div>
107
 </div>
109
 </div>
108
 <p>At this point searx is not demonized ; uwsgi allows this.</p>
110
 <p>At this point searx is not demonized ; uwsgi allows this.</p>
112
 <div class="section" id="uwsgi">
114
 <div class="section" id="uwsgi">
113
 <h2><a class="toc-backref" href="#id7">uwsgi</a><a class="headerlink" href="#uwsgi" title="Permalink to this headline">¶</a></h2>
115
 <h2><a class="toc-backref" href="#id7">uwsgi</a><a class="headerlink" href="#uwsgi" title="Permalink to this headline">¶</a></h2>
114
 <p>Install packages:</p>
116
 <p>Install packages:</p>
115
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">uwsgi</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">plugin</span><span class="o">-</span><span class="n">python</span>
117
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">uwsgi</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">plugin</span><span class="o">-</span><span class="n">python</span>
116
 </pre></div>
118
 </pre></div>
117
 </div>
119
 </div>
118
 <p>Create the configuration file /etc/uwsgi/apps-available/searx.ini with
120
 <p>Create the configuration file /etc/uwsgi/apps-available/searx.ini with
119
 this content:</p>
121
 this content:</p>
120
-<div class="highlight-default"><div class="highlight"><pre><span class="p">[</span><span class="n">uwsgi</span><span class="p">]</span>
121
-<span class="c"># Who will run the code</span>
122
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">uwsgi</span><span class="p">]</span>
123
+<span class="c1"># Who will run the code</span>
122
 <span class="n">uid</span> <span class="o">=</span> <span class="n">searx</span>
124
 <span class="n">uid</span> <span class="o">=</span> <span class="n">searx</span>
123
 <span class="n">gid</span> <span class="o">=</span> <span class="n">searx</span>
125
 <span class="n">gid</span> <span class="o">=</span> <span class="n">searx</span>
124
 
126
 
125
-<span class="c"># disable logging for privacy</span>
127
+<span class="c1"># disable logging for privacy</span>
126
 <span class="n">disable</span><span class="o">-</span><span class="n">logging</span> <span class="o">=</span> <span class="n">true</span>
128
 <span class="n">disable</span><span class="o">-</span><span class="n">logging</span> <span class="o">=</span> <span class="n">true</span>
127
 
129
 
128
-<span class="c"># Number of workers (usually CPU count)</span>
130
+<span class="c1"># Number of workers (usually CPU count)</span>
129
 <span class="n">workers</span> <span class="o">=</span> <span class="mi">4</span>
131
 <span class="n">workers</span> <span class="o">=</span> <span class="mi">4</span>
130
 
132
 
131
-<span class="c"># The right granted on the created socket</span>
133
+<span class="c1"># The right granted on the created socket</span>
132
 <span class="n">chmod</span><span class="o">-</span><span class="n">socket</span> <span class="o">=</span> <span class="mi">666</span>
134
 <span class="n">chmod</span><span class="o">-</span><span class="n">socket</span> <span class="o">=</span> <span class="mi">666</span>
133
 
135
 
134
-<span class="c"># Plugin to use and interpretor config</span>
136
+<span class="c1"># Plugin to use and interpretor config</span>
135
 <span class="n">single</span><span class="o">-</span><span class="n">interpreter</span> <span class="o">=</span> <span class="n">true</span>
137
 <span class="n">single</span><span class="o">-</span><span class="n">interpreter</span> <span class="o">=</span> <span class="n">true</span>
136
 <span class="n">master</span> <span class="o">=</span> <span class="n">true</span>
138
 <span class="n">master</span> <span class="o">=</span> <span class="n">true</span>
137
 <span class="n">plugin</span> <span class="o">=</span> <span class="n">python</span>
139
 <span class="n">plugin</span> <span class="o">=</span> <span class="n">python</span>
138
 
140
 
139
-<span class="c"># Module to import</span>
141
+<span class="c1"># Module to import</span>
140
 <span class="n">module</span> <span class="o">=</span> <span class="n">searx</span><span class="o">.</span><span class="n">webapp</span>
142
 <span class="n">module</span> <span class="o">=</span> <span class="n">searx</span><span class="o">.</span><span class="n">webapp</span>
141
 
143
 
142
-<span class="c"># Virtualenv and python path</span>
144
+<span class="c1"># Virtualenv and python path</span>
143
 <span class="n">virtualenv</span> <span class="o">=</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span>
145
 <span class="n">virtualenv</span> <span class="o">=</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span>
144
 <span class="n">pythonpath</span> <span class="o">=</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
146
 <span class="n">pythonpath</span> <span class="o">=</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
145
 <span class="n">chdir</span> <span class="o">=</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
147
 <span class="n">chdir</span> <span class="o">=</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
146
 </pre></div>
148
 </pre></div>
147
 </div>
149
 </div>
148
 <p>Activate the uwsgi application and restart:</p>
150
 <p>Activate the uwsgi application and restart:</p>
149
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">cd</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">apps</span><span class="o">-</span><span class="n">enabled</span>
151
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">apps</span><span class="o">-</span><span class="n">enabled</span>
150
 <span class="n">ln</span> <span class="o">-</span><span class="n">s</span> <span class="o">../</span><span class="n">apps</span><span class="o">-</span><span class="n">available</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">ini</span>
152
 <span class="n">ln</span> <span class="o">-</span><span class="n">s</span> <span class="o">../</span><span class="n">apps</span><span class="o">-</span><span class="n">available</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">ini</span>
151
 <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">uwsgi</span> <span class="n">restart</span>
153
 <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">uwsgi</span> <span class="n">restart</span>
152
 </pre></div>
154
 </pre></div>
158
 <h3><a class="toc-backref" href="#id9">with nginx</a><a class="headerlink" href="#with-nginx" title="Permalink to this headline">¶</a></h3>
160
 <h3><a class="toc-backref" href="#id9">with nginx</a><a class="headerlink" href="#with-nginx" title="Permalink to this headline">¶</a></h3>
159
 <p>If nginx is not installed (uwsgi will not work with the package
161
 <p>If nginx is not installed (uwsgi will not work with the package
160
 nginx-light):</p>
162
 nginx-light):</p>
161
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nginx</span>
163
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nginx</span>
162
 </pre></div>
164
 </pre></div>
163
 </div>
165
 </div>
164
 <div class="section" id="hosted-at">
166
 <div class="section" id="hosted-at">
165
 <h4>Hosted at /<a class="headerlink" href="#hosted-at" title="Permalink to this headline">¶</a></h4>
167
 <h4>Hosted at /<a class="headerlink" href="#hosted-at" title="Permalink to this headline">¶</a></h4>
166
 <p>Create the configuration file /etc/nginx/sites-available/searx with this
168
 <p>Create the configuration file /etc/nginx/sites-available/searx with this
167
 content:</p>
169
 content:</p>
168
-<div class="code nginx highlight-default"><div class="highlight"><pre><span class="n">server</span> <span class="p">{</span>
170
+<div class="code nginx highlight-default"><div class="highlight"><pre><span></span><span class="n">server</span> <span class="p">{</span>
169
     <span class="n">listen</span> <span class="mi">80</span><span class="p">;</span>
171
     <span class="n">listen</span> <span class="mi">80</span><span class="p">;</span>
170
     <span class="n">server_name</span> <span class="n">searx</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="p">;</span>
172
     <span class="n">server_name</span> <span class="n">searx</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="p">;</span>
171
     <span class="n">root</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="p">;</span>
173
     <span class="n">root</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="p">;</span>
178
 </pre></div>
180
 </pre></div>
179
 </div>
181
 </div>
180
 <p>Restart service:</p>
182
 <p>Restart service:</p>
181
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
183
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
182
 <span class="n">sudo</span> <span class="n">service</span> <span class="n">uwsgi</span> <span class="n">restart</span>
184
 <span class="n">sudo</span> <span class="n">service</span> <span class="n">uwsgi</span> <span class="n">restart</span>
183
 </pre></div>
185
 </pre></div>
184
 </div>
186
 </div>
187
 <h4>from subdirectory URL (/searx)<a class="headerlink" href="#from-subdirectory-url-searx" title="Permalink to this headline">¶</a></h4>
189
 <h4>from subdirectory URL (/searx)<a class="headerlink" href="#from-subdirectory-url-searx" title="Permalink to this headline">¶</a></h4>
188
 <p>Add this configuration in the server config file
190
 <p>Add this configuration in the server config file
189
 /etc/nginx/sites-available/default:</p>
191
 /etc/nginx/sites-available/default:</p>
190
-<div class="code nginx highlight-default"><div class="highlight"><pre>location = /searx { rewrite ^ /searx/; }
192
+<div class="code nginx highlight-default"><div class="highlight"><pre><span></span>location = /searx { rewrite ^ /searx/; }
191
 location /searx {
193
 location /searx {
192
         try_files $uri @searx;
194
         try_files $uri @searx;
193
 }
195
 }
202
 <p>OR</p>
204
 <p>OR</p>
203
 <p>using reverse proxy
205
 <p>using reverse proxy
204
 (Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)</p>
206
 (Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)</p>
205
-<div class="code nginx highlight-default"><div class="highlight"><pre>location /searx {
207
+<div class="code nginx highlight-default"><div class="highlight"><pre><span></span>location /searx {
206
     proxy_pass http://127.0.0.1:8888;
208
     proxy_pass http://127.0.0.1:8888;
207
     proxy_set_header Host $host;
209
     proxy_set_header Host $host;
208
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
210
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
213
 </pre></div>
215
 </pre></div>
214
 </div>
216
 </div>
215
 <p>Enable base_url in searx/settings.yml</p>
217
 <p>Enable base_url in searx/settings.yml</p>
216
-<div class="highlight-default"><div class="highlight"><pre><span class="n">base_url</span> <span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">tld</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
218
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">base_url</span> <span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">tld</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
217
 </pre></div>
219
 </pre></div>
218
 </div>
220
 </div>
219
 <p>Restart service:</p>
221
 <p>Restart service:</p>
220
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
222
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
221
 <span class="n">sudo</span> <span class="n">service</span> <span class="n">uwsgi</span> <span class="n">restart</span>
223
 <span class="n">sudo</span> <span class="n">service</span> <span class="n">uwsgi</span> <span class="n">restart</span>
222
 </pre></div>
224
 </pre></div>
223
 </div>
225
 </div>
226
 <p>for better privacy you can disable nginx logs about searx.</p>
228
 <p>for better privacy you can disable nginx logs about searx.</p>
227
 <p>how to proceed: below <code class="docutils literal"><span class="pre">uwsgi_pass</span></code> in
229
 <p>how to proceed: below <code class="docutils literal"><span class="pre">uwsgi_pass</span></code> in
228
 /etc/nginx/sites-available/default add</p>
230
 /etc/nginx/sites-available/default add</p>
229
-<div class="highlight-default"><div class="highlight"><pre><span class="n">access_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
231
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">access_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
230
 <span class="n">error_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
232
 <span class="n">error_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
231
 </pre></div>
233
 </pre></div>
232
 </div>
234
 </div>
233
 <p>Restart service:</p>
235
 <p>Restart service:</p>
234
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
236
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
235
 </pre></div>
237
 </pre></div>
236
 </div>
238
 </div>
237
 </div>
239
 </div>
240
 <div class="section" id="with-apache">
242
 <div class="section" id="with-apache">
241
 <h3><a class="toc-backref" href="#id10">with apache</a><a class="headerlink" href="#with-apache" title="Permalink to this headline">¶</a></h3>
243
 <h3><a class="toc-backref" href="#id10">with apache</a><a class="headerlink" href="#with-apache" title="Permalink to this headline">¶</a></h3>
242
 <p>Add wsgi mod:</p>
244
 <p>Add wsgi mod:</p>
243
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libapache2</span><span class="o">-</span><span class="n">mod</span><span class="o">-</span><span class="n">uwsgi</span>
245
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libapache2</span><span class="o">-</span><span class="n">mod</span><span class="o">-</span><span class="n">uwsgi</span>
244
 <span class="n">sudo</span> <span class="n">a2enmod</span> <span class="n">uwsgi</span>
246
 <span class="n">sudo</span> <span class="n">a2enmod</span> <span class="n">uwsgi</span>
245
 </pre></div>
247
 </pre></div>
246
 </div>
248
 </div>
247
 <p>Add this configuration in the file /etc/apache2/apache2.conf:</p>
249
 <p>Add this configuration in the file /etc/apache2/apache2.conf:</p>
248
-<div class="code apache highlight-default"><div class="highlight"><pre><span class="o">&lt;</span><span class="n">Location</span> <span class="o">/&gt;</span>
250
+<div class="code apache highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">Location</span> <span class="o">/&gt;</span>
249
     <span class="n">Options</span> <span class="n">FollowSymLinks</span> <span class="n">Indexes</span>
251
     <span class="n">Options</span> <span class="n">FollowSymLinks</span> <span class="n">Indexes</span>
250
     <span class="n">SetHandler</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">handler</span>
252
     <span class="n">SetHandler</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">handler</span>
251
     <span class="n">uWSGISocket</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">socket</span>
253
     <span class="n">uWSGISocket</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">socket</span>
256
 change <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> by the location of your instance, like
258
 change <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> by the location of your instance, like
257
 <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/searx&gt;</span></code>.</p>
259
 <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/searx&gt;</span></code>.</p>
258
 <p>Restart Apache:</p>
260
 <p>Restart Apache:</p>
259
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
261
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
260
 </pre></div>
262
 </pre></div>
261
 </div>
263
 </div>
262
 <div class="section" id="id2">
264
 <div class="section" id="id2">
266
 <p>WARNING: you can only disable logs for the whole (virtual) server not
268
 <p>WARNING: you can only disable logs for the whole (virtual) server not
267
 for a specific path.</p>
269
 for a specific path.</p>
268
 <p>Go back to /etc/apache2/apache2.conf and above <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> add:</p>
270
 <p>Go back to /etc/apache2/apache2.conf and above <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> add:</p>
269
-<div class="code apache highlight-default"><div class="highlight"><pre><span class="n">CustomLog</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="n">combined</span>
271
+<div class="code apache highlight-default"><div class="highlight"><pre><span></span><span class="n">CustomLog</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="n">combined</span>
270
 </pre></div>
272
 </pre></div>
271
 </div>
273
 </div>
272
 <p>Restart Apache:</p>
274
 <p>Restart Apache:</p>
273
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
275
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
274
 </pre></div>
276
 </pre></div>
275
 </div>
277
 </div>
276
 </div>
278
 </div>
278
 </div>
280
 </div>
279
 <div class="section" id="how-to-update">
281
 <div class="section" id="how-to-update">
280
 <h2><a class="toc-backref" href="#id11">How to update</a><a class="headerlink" href="#how-to-update" title="Permalink to this headline">¶</a></h2>
282
 <h2><a class="toc-backref" href="#id11">How to update</a><a class="headerlink" href="#how-to-update" title="Permalink to this headline">¶</a></h2>
281
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
283
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
282
 <span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
284
 <span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
283
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
285
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
284
 <span class="n">git</span> <span class="n">stash</span>
286
 <span class="n">git</span> <span class="n">stash</span>
292
 <div class="section" id="docker">
294
 <div class="section" id="docker">
293
 <h2><a class="toc-backref" href="#id12">Docker</a><a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h2>
295
 <h2><a class="toc-backref" href="#id12">Docker</a><a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h2>
294
 <p>Make sure you have installed Docker. For instance, you can deploy searx like this:</p>
296
 <p>Make sure you have installed Docker. For instance, you can deploy searx like this:</p>
295
-<div class="code sh highlight-default"><div class="highlight"><pre>docker pull wonderfall/searx
297
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span>docker pull wonderfall/searx
296
 docker run -d --name searx -p $PORT:8888 wonderfall/searx
298
 docker run -d --name searx -p $PORT:8888 wonderfall/searx
297
 </pre></div>
299
 </pre></div>
298
 </div>
300
 </div>
299
 <p>Go to <a class="reference external" href="http://localhost:$PORT">http://localhost:$PORT</a>.</p>
301
 <p>Go to <a class="reference external" href="http://localhost:$PORT">http://localhost:$PORT</a>.</p>
300
 <p>See <a class="reference external" href="https://hub.docker.com/r/wonderfall/searx/">https://hub.docker.com/r/wonderfall/searx/</a> for more informations.</p>
302
 <p>See <a class="reference external" href="https://hub.docker.com/r/wonderfall/searx/">https://hub.docker.com/r/wonderfall/searx/</a> for more informations.</p>
301
 <p>It&#8217;s also possible to build searx from the embedded Dockerfile.</p>
303
 <p>It&#8217;s also possible to build searx from the embedded Dockerfile.</p>
302
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
304
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
303
 <span class="n">cd</span> <span class="n">searx</span>
305
 <span class="n">cd</span> <span class="n">searx</span>
304
 <span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">whatever</span><span class="o">/</span><span class="n">searx</span> <span class="o">.</span>
306
 <span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">whatever</span><span class="o">/</span><span class="n">searx</span> <span class="o">.</span>
305
 </pre></div>
307
 </pre></div>

+ 15
- 13
dev/plugins.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Plugins &mdash; searx 0.9.0 documentation</title>
9
+    <title>Plugins &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="next" title="Translation" href="translation.html" />
29
     <link rel="next" title="Translation" href="translation.html" />
28
     <link rel="prev" title="Search API" href="search_api.html" />
30
     <link rel="prev" title="Search API" href="search_api.html" />
29
    
31
    
45
 searx.</p>
47
 searx.</p>
46
 <div class="section" id="example-plugin">
48
 <div class="section" id="example-plugin">
47
 <h2>Example plugin<a class="headerlink" href="#example-plugin" title="Permalink to this headline">¶</a></h2>
49
 <h2>Example plugin<a class="headerlink" href="#example-plugin" title="Permalink to this headline">¶</a></h2>
48
-<div class="code python highlight-default"><div class="highlight"><pre><span class="n">name</span> <span class="o">=</span> <span class="s">&#39;Example plugin&#39;</span>
49
-<span class="n">description</span> <span class="o">=</span> <span class="s">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
50
-<span class="n">default_on</span> <span class="o">=</span> <span class="k">False</span>  <span class="c"># disable by default</span>
50
+<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;Example plugin&#39;</span>
51
+<span class="n">description</span> <span class="o">=</span> <span class="s1">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
52
+<span class="n">default_on</span> <span class="o">=</span> <span class="kc">False</span>  <span class="c1"># disabled by default</span>
51
 
53
 
52
-<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c"># optional, list of static js files</span>
53
-<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c"># optional, list of static css files</span>
54
+<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c1"># optional, list of static js files</span>
55
+<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c1"># optional, list of static css files</span>
54
 
56
 
55
 
57
 
56
-<span class="c"># attach callback to the post search hook</span>
57
-<span class="c">#  request: flask request object</span>
58
-<span class="c">#  ctx: the whole local context of the post search hook</span>
58
+<span class="c1"># attach callback to the post search hook</span>
59
+<span class="c1">#  request: flask request object</span>
60
+<span class="c1">#  ctx: the whole local context of the post search hook</span>
59
 <span class="k">def</span> <span class="nf">post_search</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
61
 <span class="k">def</span> <span class="nf">post_search</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
60
-    <span class="n">ctx</span><span class="p">[</span><span class="s">&#39;search&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">&#39;example&#39;</span><span class="p">)</span>
61
-    <span class="k">return</span> <span class="k">True</span>
62
+    <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">)</span>
63
+    <span class="k">return</span> <span class="kc">True</span>
62
 </pre></div>
64
 </pre></div>
63
 </div>
65
 </div>
64
 </div>
66
 </div>

+ 13
- 11
dev/quickstart.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Development Quickstart &mdash; searx 0.9.0 documentation</title>
9
+    <title>Development Quickstart &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="next" title="How to contribute" href="contribution_guide.html" />
29
     <link rel="next" title="How to contribute" href="contribution_guide.html" />
28
-    <link rel="prev" title="Administration API" href="../admin/api.html" />
30
+    <link rel="prev" title="How to protect an instance" href="../admin/filtron.html" />
29
    
31
    
30
   
32
   
31
   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
33
   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
48
 <p>First, clone the source code of searx to the desired folder. In this case the source
50
 <p>First, clone the source code of searx to the desired folder. In this case the source
49
 is cloned to ~/myprojects/searx. Then create and activate the searx-ve
51
 is cloned to ~/myprojects/searx. Then create and activate the searx-ve
50
 virtualenv and install the required packages using manage.sh.</p>
52
 virtualenv and install the required packages using manage.sh.</p>
51
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">cd</span> <span class="o">~/</span><span class="n">myprojects</span>
53
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">myprojects</span>
52
 <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
54
 <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
53
 <span class="n">cd</span> <span class="n">searx</span>
55
 <span class="n">cd</span> <span class="n">searx</span>
54
 <span class="n">virtualenv</span> <span class="n">searx</span><span class="o">-</span><span class="n">ve</span>
56
 <span class="n">virtualenv</span> <span class="n">searx</span><span class="o">-</span><span class="n">ve</span>
68
 <li>Unit test coverage check</li>
70
 <li>Unit test coverage check</li>
69
 </ul>
71
 </ul>
70
 <p>For example unit tests are run with the command below:</p>
72
 <p>For example unit tests are run with the command below:</p>
71
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">unit_tests</span>
73
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">unit_tests</span>
72
 </pre></div>
74
 </pre></div>
73
 </div>
75
 </div>
74
 <p>For further test options, please consult the help of the manage.sh script.</p>
76
 <p>For further test options, please consult the help of the manage.sh script.</p>
78
 <div class="section" id="how-to-build-styles">
80
 <div class="section" id="how-to-build-styles">
79
 <h3>How to build styles<a class="headerlink" href="#how-to-build-styles" title="Permalink to this headline">¶</a></h3>
81
 <h3>How to build styles<a class="headerlink" href="#how-to-build-styles" title="Permalink to this headline">¶</a></h3>
80
 <p>Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.</p>
82
 <p>Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.</p>
81
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
83
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
82
 <span class="n">sudo</span> <span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">less</span>
84
 <span class="n">sudo</span> <span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">less</span>
83
 </pre></div>
85
 </pre></div>
84
 </div>
86
 </div>
85
 <p>OR</p>
87
 <p>OR</p>
86
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">node</span><span class="o">-</span><span class="n">less</span>
88
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">node</span><span class="o">-</span><span class="n">less</span>
87
 </pre></div>
89
 </pre></div>
88
 </div>
90
 </div>
89
 <p>After satisfying the requirements styles can be build using manage.sh</p>
91
 <p>After satisfying the requirements styles can be build using manage.sh</p>
90
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">styles</span>
92
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">styles</span>
91
 </pre></div>
93
 </pre></div>
92
 </div>
94
 </div>
93
 </div>
95
 </div>
95
 <h3>How to build the source of the oscar theme<a class="headerlink" href="#how-to-build-the-source-of-the-oscar-theme" title="Permalink to this headline">¶</a></h3>
97
 <h3>How to build the source of the oscar theme<a class="headerlink" href="#how-to-build-the-source-of-the-oscar-theme" title="Permalink to this headline">¶</a></h3>
96
 <p>Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
98
 <p>Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
97
 Node has to be installed.</p>
99
 Node has to be installed.</p>
98
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
100
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
99
 <span class="n">sudo</span> <span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">grunt</span><span class="o">-</span><span class="n">cli</span>
101
 <span class="n">sudo</span> <span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">grunt</span><span class="o">-</span><span class="n">cli</span>
100
 </pre></div>
102
 </pre></div>
101
 </div>
103
 </div>
102
 <p>After installing grunt, the files can be built using the following command:</p>
104
 <p>After installing grunt, the files can be built using the following command:</p>
103
-<div class="code sh highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">build_grunt</span>
105
+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">build_grunt</span>
104
 </pre></div>
106
 </pre></div>
105
 </div>
107
 </div>
106
 </div>
108
 </div>

+ 5
- 3
dev/search_api.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Search API &mdash; searx 0.9.0 documentation</title>
9
+    <title>Search API &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="next" title="Plugins" href="plugins.html" />
29
     <link rel="next" title="Plugins" href="plugins.html" />
28
     <link rel="prev" title="Engine overview" href="engine_overview.html" />
30
     <link rel="prev" title="Engine overview" href="engine_overview.html" />
29
    
31
    

+ 14
- 12
dev/translation.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Translation &mdash; searx 0.9.0 documentation</title>
9
+    <title>Translation &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="prev" title="Plugins" href="plugins.html" />
29
     <link rel="prev" title="Plugins" href="plugins.html" />
28
    
30
    
29
   
31
   
43
 <p>run these commands in the root directory of searx</p>
45
 <p>run these commands in the root directory of searx</p>
44
 <div class="section" id="add-new-language">
46
 <div class="section" id="add-new-language">
45
 <h2>Add new language<a class="headerlink" href="#add-new-language" title="Permalink to this headline">¶</a></h2>
47
 <h2>Add new language<a class="headerlink" href="#add-new-language" title="Permalink to this headline">¶</a></h2>
46
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">pybabel</span> <span class="n">init</span> <span class="o">-</span><span class="n">i</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span> <span class="o">-</span><span class="n">l</span> <span class="n">it</span>
48
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">pybabel</span> <span class="n">init</span> <span class="o">-</span><span class="n">i</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span> <span class="o">-</span><span class="n">l</span> <span class="n">it</span>
47
 </pre></div>
49
 </pre></div>
48
 </div>
50
 </div>
49
 </div>
51
 </div>
50
 <div class="section" id="update-po-files">
52
 <div class="section" id="update-po-files">
51
 <h2>Update .po files<a class="headerlink" href="#update-po-files" title="Permalink to this headline">¶</a></h2>
53
 <h2>Update .po files<a class="headerlink" href="#update-po-files" title="Permalink to this headline">¶</a></h2>
52
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">update</span><span class="o">-</span><span class="n">translations</span><span class="o">.</span><span class="n">sh</span>
54
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">update</span><span class="o">-</span><span class="n">translations</span><span class="o">.</span><span class="n">sh</span>
53
 </pre></div>
55
 </pre></div>
54
 </div>
56
 </div>
55
 <p>You may have errors here. In that case, edit the
57
 <p>You may have errors here. In that case, edit the
59
 </div>
61
 </div>
60
 <div class="section" id="compile-translations">
62
 <div class="section" id="compile-translations">
61
 <h2>Compile translations<a class="headerlink" href="#compile-translations" title="Permalink to this headline">¶</a></h2>
63
 <h2>Compile translations<a class="headerlink" href="#compile-translations" title="Permalink to this headline">¶</a></h2>
62
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">pybabel</span> <span class="nb">compile</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span>
64
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">pybabel</span> <span class="nb">compile</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span>
63
 </pre></div>
65
 </pre></div>
64
 </div>
66
 </div>
65
 </div>
67
 </div>
67
 <h2>Transifex stuff<a class="headerlink" href="#transifex-stuff" title="Permalink to this headline">¶</a></h2>
69
 <h2>Transifex stuff<a class="headerlink" href="#transifex-stuff" title="Permalink to this headline">¶</a></h2>
68
 <div class="section" id="init-project">
70
 <div class="section" id="init-project">
69
 <h3>Init Project<a class="headerlink" href="#init-project" title="Permalink to this headline">¶</a></h3>
71
 <h3>Init Project<a class="headerlink" href="#init-project" title="Permalink to this headline">¶</a></h3>
70
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">init</span> <span class="c"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
72
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">init</span> <span class="c1"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
71
 
73
 
72
-<span class="n">tx</span> <span class="nb">set</span> <span class="o">--</span><span class="n">auto</span><span class="o">-</span><span class="n">local</span> <span class="o">-</span><span class="n">r</span> <span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span> <span class="s">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> \
74
+<span class="n">tx</span> <span class="nb">set</span> <span class="o">--</span><span class="n">auto</span><span class="o">-</span><span class="n">local</span> <span class="o">-</span><span class="n">r</span> <span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span> <span class="s1">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> \
73
 <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">lang</span> <span class="n">en</span> <span class="o">--</span><span class="nb">type</span> <span class="n">PO</span> <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">file</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">--</span><span class="n">execute</span>
75
 <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">lang</span> <span class="n">en</span> <span class="o">--</span><span class="nb">type</span> <span class="n">PO</span> <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">file</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">--</span><span class="n">execute</span>
74
 </pre></div>
76
 </pre></div>
75
 </div>
77
 </div>
78
 </div>
80
 </div>
79
 <div class="section" id="get-translations">
81
 <div class="section" id="get-translations">
80
 <h3>Get translations<a class="headerlink" href="#get-translations" title="Permalink to this headline">¶</a></h3>
82
 <h3>Get translations<a class="headerlink" href="#get-translations" title="Permalink to this headline">¶</a></h3>
81
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">pull</span> <span class="o">-</span><span class="n">a</span>
83
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">pull</span> <span class="o">-</span><span class="n">a</span>
82
 </pre></div>
84
 </pre></div>
83
 </div>
85
 </div>
84
 <p><a class="reference external" href="http://docs.transifex.com/client/pull">http://docs.transifex.com/client/pull</a></p>
86
 <p><a class="reference external" href="http://docs.transifex.com/client/pull">http://docs.transifex.com/client/pull</a></p>
85
 </div>
87
 </div>
86
 <div class="section" id="upload-source-file">
88
 <div class="section" id="upload-source-file">
87
 <h3>Upload source File<a class="headerlink" href="#upload-source-file" title="Permalink to this headline">¶</a></h3>
89
 <h3>Upload source File<a class="headerlink" href="#upload-source-file" title="Permalink to this headline">¶</a></h3>
88
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span>
90
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span>
89
 </pre></div>
91
 </pre></div>
90
 </div>
92
 </div>
91
 </div>
93
 </div>
92
 <div class="section" id="upload-all-translation">
94
 <div class="section" id="upload-all-translation">
93
 <h3>Upload all Translation<a class="headerlink" href="#upload-all-translation" title="Permalink to this headline">¶</a></h3>
95
 <h3>Upload all Translation<a class="headerlink" href="#upload-all-translation" title="Permalink to this headline">¶</a></h3>
94
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span> <span class="o">-</span><span class="n">t</span>
96
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span> <span class="o">-</span><span class="n">t</span>
95
 </pre></div>
97
 </pre></div>
96
 </div>
98
 </div>
97
 </div>
99
 </div>
98
 </div>
100
 </div>
99
 <div class="section" id="upload-specifc-translation">
101
 <div class="section" id="upload-specifc-translation">
100
 <h2>upload specifc Translation<a class="headerlink" href="#upload-specifc-translation" title="Permalink to this headline">¶</a></h2>
102
 <h2>upload specifc Translation<a class="headerlink" href="#upload-specifc-translation" title="Permalink to this headline">¶</a></h2>
101
-<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">t</span> <span class="o">-</span><span class="n">l</span> <span class="n">tr</span>
103
+<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">t</span> <span class="o">-</span><span class="n">l</span> <span class="n">tr</span>
102
 </pre></div>
104
 </pre></div>
103
 </div>
105
 </div>
104
 <p><a class="reference external" href="http://docs.transifex.com/client/push">http://docs.transifex.com/client/push</a></p>
106
 <p><a class="reference external" href="http://docs.transifex.com/client/push">http://docs.transifex.com/client/push</a></p>

+ 2
- 2
docs/conf.py View File

57
 # built documents.
57
 # built documents.
58
 #
58
 #
59
 # The short X.Y version.
59
 # The short X.Y version.
60
-version = '0.9.0'
60
+version = '0.10.0'
61
 # The full version, including alpha/beta/rc tags.
61
 # The full version, including alpha/beta/rc tags.
62
-release = '0.9.0'
62
+release = '0.10.0'
63
 
63
 
64
 # The language for content autogenerated by Sphinx. Refer to documentation
64
 # The language for content autogenerated by Sphinx. Refer to documentation
65
 # for a list of supported languages.
65
 # for a list of supported languages.

+ 114
- 112
docs/dev/engine_overview.rst View File

30
 engine file
30
 engine file
31
 ~~~~~~~~~~~
31
 ~~~~~~~~~~~
32
 
32
 
33
-+---------------------+-----------+-----------------------------------------+
34
-| argument            | type      | information                             |
35
-+=====================+===========+=========================================+
36
-| categories          | list      | pages, in which the engine is working   |
37
-+---------------------+-----------+-----------------------------------------+
38
-| paging              | boolean   | support multible pages                  |
39
-+---------------------+-----------+-----------------------------------------+
40
-| language\_support   | boolean   | support language choosing               |
41
-+---------------------+-----------+-----------------------------------------+
33
++----------------------+-----------+-----------------------------------------+
34
+| argument             | type      | information                             |
35
++======================+===========+=========================================+
36
+| categories           | list      | pages, in which the engine is working   |
37
++----------------------+-----------+-----------------------------------------+
38
+| paging               | boolean   | support multible pages                  |
39
++----------------------+-----------+-----------------------------------------+
40
+| language\_support    | boolean   | support language choosing               |
41
++----------------------+-----------+-----------------------------------------+
42
+| time\_range\_support | boolean   | support search time range               |
43
++----------------------+-----------+-----------------------------------------+
42
 
44
 
43
 settings.yml
45
 settings.yml
44
 ~~~~~~~~~~~~
46
 ~~~~~~~~~~~~
186
 default
188
 default
187
 ~~~~~~~
189
 ~~~~~~~
188
 
190
 
189
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
190
-| result-parameter   | information                                                                                                                        |
191
-+====================+====================================================================================================================================+
192
-| url                | string, which is representing the url of the result                                                                                |
193
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
194
-| title              | string, which is representing the title of the result                                                                              |
195
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
196
-| content            | string, which is giving a general result-text                                                                                      |
197
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
198
-| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   |
199
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
191
++--------------------+---------------------------------------------------------------------------------------------------------------+
192
+| result-parameter   | information                                                                                                   |
193
++====================+===============================================================================================================+
194
+| url                | string, url of the result                                                                                     |
195
++--------------------+---------------------------------------------------------------------------------------------------------------+
196
+| title              | string, title of the result                                                                                   |
197
++--------------------+---------------------------------------------------------------------------------------------------------------+
198
+| content            | string, general result-text                                                                                   |
199
++--------------------+---------------------------------------------------------------------------------------------------------------+
200
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish     |
201
++--------------------+---------------------------------------------------------------------------------------------------------------+
200
 
202
 
201
 images
203
 images
202
 ~~~~~~
204
 ~~~~~~
203
 
205
 
204
 to use this template, the parameter
206
 to use this template, the parameter
205
 
207
 
206
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
207
-| result-parameter   | information                                                                                                                                               |
208
-+====================+===========================================================================================================================================================+
209
-| template           | is set to ``images.html``                                                                                                                                 |
210
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
211
-| url                | string, which is representing the url to the result site                                                                                                  |
212
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
213
-| title              | string, which is representing the title of the result *(partly implemented)*                                                                              |
214
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
215
-| content            | *(partly implemented)*                                                                                                                                    |
216
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
217
-| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(partly implemented)*   |
218
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
219
-| img\_src           | string, which is representing the url to the result image                                                                                                 |
220
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
221
-| thumbnail\_src     | string, which is representing the url to a small-preview image                                                                                            |
222
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
208
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
209
+| result-parameter   | information                                                                                                                           |
210
++====================+=======================================================================================================================================+
211
+| template           | is set to ``images.html``                                                                                                             |
212
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
213
+| url                | string, url to the result site                                                                                                        |
214
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
215
+| title              | string, title of the result *(partly implemented)*                                                                                    |
216
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
217
+| content            | *(partly implemented)*                                                                                                                |
218
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
219
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(partly implemented)*      |
220
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
221
+| img\_src           | string, url to the result image                                                                                                       |
222
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
223
+| thumbnail\_src     | string, url to a small-preview image                                                                                                  |
224
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
223
 
225
 
224
 videos
226
 videos
225
 ~~~~~~
227
 ~~~~~~
226
 
228
 
227
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
228
-| result-parameter   | information                                                                                                                        |
229
-+====================+====================================================================================================================================+
230
-| template           | is set to ``videos.html``                                                                                                          |
231
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
232
-| url                | string, which is representing the url of the result                                                                                |
233
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
234
-| title              | string, which is representing the title of the result                                                                              |
235
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
236
-| content            | *(not implemented yet)*                                                                                                            |
237
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
238
-| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   |
239
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
240
-| thumbnail          | string, which is representing the url to a small-preview image                                                                     |
241
-+--------------------+------------------------------------------------------------------------------------------------------------------------------------+
229
++--------------------+--------------------------------------------------------------------------------------------------------------+
230
+| result-parameter   | information                                                                                                  |
231
++====================+==============================================================================================================+
232
+| template           | is set to ``videos.html``                                                                                    |
233
++--------------------+--------------------------------------------------------------------------------------------------------------+
234
+| url                | string, url of the result                                                                                    |
235
++--------------------+--------------------------------------------------------------------------------------------------------------+
236
+| title              | string, title of the result                                                                                  |
237
++--------------------+--------------------------------------------------------------------------------------------------------------+
238
+| content            | *(not implemented yet)*                                                                                      |
239
++--------------------+--------------------------------------------------------------------------------------------------------------+
240
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    |
241
++--------------------+--------------------------------------------------------------------------------------------------------------+
242
+| thumbnail          | string, url to a small-preview image                                                                         |
243
++--------------------+--------------------------------------------------------------------------------------------------------------+
242
 
244
 
243
 torrent
245
 torrent
244
 ~~~~~~~
246
 ~~~~~~~
245
 
247
 
246
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
247
-| result-parameter | information                                                                                                                                              |
248
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
249
-| template         | is set to ```torrent.html```                                                                                                                             |
250
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
251
-| url              | string, which is representing the url of the result                                                                                                      |
252
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
253
-| title            | string, which is representing the title of the result                                                                                                    |
254
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
255
-| content          | string, which is giving a general result-text                                                                                                            |
256
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
257
-| publishedDate    | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published *(not implemented yet)* |
258
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
259
-| seed             | int, number of seeder                                                                                                                                    |
260
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
261
-| leech            | int, number of leecher                                                                                                                                   |
262
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
263
-| filesize         | int, size of file in bytes                                                                                                                               |
264
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
265
-| files            | int, number of files                                                                                                                                     |
266
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
267
-| magnetlink       | string, which is the `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                      |
268
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
269
-| torrentfile      | string, which is the torrentfile of the result                                                                                                           |
270
-+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
248
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
249
+| result-parameter | information                                                                                                                           |
250
++==================+=======================================================================================================================================+
251
+| template         | is set to ``torrent.html``                                                                                                            |
252
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
253
+| url              | string, url of the result                                                                                                             |
254
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
255
+| title            | string, title of the result                                                                                                           |
256
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
257
+| content          | string, general result-text                                                                                                           |
258
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
259
+| publishedDate    | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(not implemented yet)*     |
260
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
261
+| seed             | int, number of seeder                                                                                                                 |
262
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
263
+| leech            | int, number of leecher                                                                                                                |
264
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
265
+| filesize         | int, size of file in bytes                                                                                                            |
266
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
267
+| files            | int, number of files                                                                                                                  |
268
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
269
+| magnetlink       | string, `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                |
270
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
271
+| torrentfile      | string, torrentfile of the result                                                                                                     |
272
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
271
 
273
 
272
 
274
 
273
 map
275
 map
274
 ~~~
276
 ~~~
275
 
277
 
276
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
277
-| result-parameter        | information                                                                                                                        |
278
-+=========================+====================================================================================================================================+
279
-| url                     | string, which is representing the url of the result                                                                                |
280
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
281
-| title                   | string, which is representing the title of the result                                                                              |
282
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
283
-| content                 | string, which is giving a general result-text                                                                                      |
284
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
285
-| publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, represent when the result is published   |
286
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
287
-| latitude                | latitude of result (in decimal format)                                                                                             |
288
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
289
-| longitude               | longitude of result (in decimal format)                                                                                            |
290
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
291
-| boundingbox             | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``)                                                |
292
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
293
-| geojson                 | geojson of result (http://geojson.org)                                                                                             |
294
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
295
-| osm.type                | type of osm-object (if OSM-Result)                                                                                                 |
296
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
297
-| osm.id                  | id of osm-object (if OSM-Result)                                                                                                   |
298
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
299
-| address.name            | name of object                                                                                                                     |
300
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
301
-| address.road            | street adress of object                                                                                                            |
302
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
303
-| address.house\_number   | house number of object                                                                                                             |
304
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
305
-| address.locality        | city, place of object                                                                                                              |
306
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
307
-| address.postcode        | postcode of object                                                                                                                 |
308
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
309
-| address.country         | country of object                                                                                                                  |
310
-+-------------------------+------------------------------------------------------------------------------------------------------------------------------------+
278
++-------------------------+--------------------------------------------------------------------------------------------------------------+
279
+| result-parameter        | information                                                                                                  |
280
++=========================+==============================================================================================================+
281
+| url                     | string, url of the result                                                                                    |
282
++-------------------------+--------------------------------------------------------------------------------------------------------------+
283
+| title                   | string, title of the result                                                                                  |
284
++-------------------------+--------------------------------------------------------------------------------------------------------------+
285
+| content                 | string, general result-text                                                                                  |
286
++-------------------------+--------------------------------------------------------------------------------------------------------------+
287
+| publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    |
288
++-------------------------+--------------------------------------------------------------------------------------------------------------+
289
+| latitude                | latitude of result (in decimal format)                                                                       |
290
++-------------------------+--------------------------------------------------------------------------------------------------------------+
291
+| longitude               | longitude of result (in decimal format)                                                                      |
292
++-------------------------+--------------------------------------------------------------------------------------------------------------+
293
+| boundingbox             | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``)                          |
294
++-------------------------+--------------------------------------------------------------------------------------------------------------+
295
+| geojson                 | geojson of result (http://geojson.org)                                                                       |
296
++-------------------------+--------------------------------------------------------------------------------------------------------------+
297
+| osm.type                | type of osm-object (if OSM-Result)                                                                           |
298
++-------------------------+--------------------------------------------------------------------------------------------------------------+
299
+| osm.id                  | id of osm-object (if OSM-Result)                                                                             |
300
++-------------------------+--------------------------------------------------------------------------------------------------------------+
301
+| address.name            | name of object                                                                                               |
302
++-------------------------+--------------------------------------------------------------------------------------------------------------+
303
+| address.road            | street name of object                                                                                        |
304
++-------------------------+--------------------------------------------------------------------------------------------------------------+
305
+| address.house\_number   | house number of object                                                                                       |
306
++-------------------------+--------------------------------------------------------------------------------------------------------------+
307
+| address.locality        | city, place of object                                                                                        |
308
++-------------------------+--------------------------------------------------------------------------------------------------------------+
309
+| address.postcode        | postcode of object                                                                                           |
310
++-------------------------+--------------------------------------------------------------------------------------------------------------+
311
+| address.country         | country of object                                                                                            |
312
++-------------------------+--------------------------------------------------------------------------------------------------------------+
311
 
313
 

+ 1
- 1
docs/dev/plugins.rst View File

11
 
11
 
12
     name = 'Example plugin'
12
     name = 'Example plugin'
13
     description = 'This plugin extends the suggestions with the word "example"'
13
     description = 'This plugin extends the suggestions with the word "example"'
14
-    default_on = False  # disable by default
14
+    default_on = False  # disabled by default
15
 
15
 
16
     js_dependencies = tuple()  # optional, list of static js files
16
     js_dependencies = tuple()  # optional, list of static js files
17
     css_dependencies = tuple()  # optional, list of static css files
17
     css_dependencies = tuple()  # optional, list of static css files

+ 2
- 1
docs/index.rst View File

16
  - No user tracking
16
  - No user tracking
17
  - No user profiling
17
  - No user profiling
18
  - About 70 supported search engines
18
  - About 70 supported search engines
19
- - Easy intergration with any search engines
19
+ - Easy integration with any search engine
20
  - Cookies are not used by default
20
  - Cookies are not used by default
21
  - Secure, encrypted connections (HTTPS/SSL)
21
  - Secure, encrypted connections (HTTPS/SSL)
22
  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
22
  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
29
    :maxdepth: 1
29
    :maxdepth: 1
30
 
30
 
31
    user/search_syntax
31
    user/search_syntax
32
+   user/own-instance
32
 
33
 
33
 Administrator documentation
34
 Administrator documentation
34
 ---------------------------
35
 ---------------------------

+ 43
- 0
docs/user/own-instance.rst View File

1
+Why use a private instance?
2
+===========================
3
+
4
+"Is it worth to run my own instance?" is a common question among searx users. Before answering this question, see what options a searx user has.
5
+
6
+Public instances are open to everyone who has access to its URL. Usually, these are operated by unknown parties (from the users' point of view). Private instances can be used by a select group of people. It is for example a searx of group of friends or a company which can be accessed through VPN. Also it can be single user one which runs on the user's laptop.
7
+
8
+To gain more insight on how these instances work let's dive into how searx protects its users.
9
+
10
+How does searx protect privacy?
11
+-------------------------------
12
+
13
+Searx protects the privacy of its users in multiple ways regardless of the type of the instance (private, public). Removal of private data from search requests comes in three forms:
14
+
15
+ 1. removal of private data from requests going to search services
16
+ 2. not forwarding anything from a third party services through search services (e.g. advertisement)
17
+ 3. removal of private data from requests going to the result pages
18
+
19
+Removing private data means not sending cookies to external search engines and generating a random browser profile for every request. Thus, it does not matter if a public or private instance handles the request, because it is anonymized in both cases. IP addresses will be the IP of the instance. But searx can be configured to use proxy or Tor. `Result proxy <https://github.com/asciimoo/morty>`__ is supported, too.
20
+
21
+Searx does not serve adds or tracking content unlike most search services. So private data is not forwarded to third parties who might monetize it. Besides protecting users from search services, both referring page and search query are hidden from visited result pages.
22
+
23
+What are the consequences of using public instances?
24
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25
+
26
+If someone uses a public instance, he/she has to trust the administrator of that instance.
27
+This means that the user of the public instance does not know whether his/her requests are logged, aggregated and sent or sold to a third party.
28
+
29
+Also, public instances without proper protection are more vulnerable to abusing the search service, In this case the external service in exchange returns CAPTCHAs or bans the IP of the instance. Thus, search requests return less results.
30
+
31
+I see. What about private instances?
32
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
+
34
+If users run their own instances, everything is in their control: the source code, logging settings and private data. Unknown instance administrators do not have to be trusted.
35
+
36
+Furthermore, as the default settings of their instance is editable, there is no need to use cookies to tailor searx to their needs. So preferences will not be reset to defaults when clearing browser cookies. As settings are stored on their computer, it will not be accessible to others as long as their computer is not compromised.
37
+
38
+Conclusion
39
+----------
40
+
41
+Always use an instance which is operated by people you trust. The privacy features of searx are available to users no matter what kind of instance they use.
42
+
43
+If someone is on the go or just wants to try searx for the first time public instances are the best choices. Additionally, public instance are making a world a better place, because those who cannot or do not want to run an instance, have access to a privacy respecting search service.

+ 5
- 3
genindex.html View File

7
   <head>
7
   <head>
8
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
     
9
     
10
-    <title>Index &mdash; searx 0.9.0 documentation</title>
10
+    <title>Index &#8212; searx 0.10.0 documentation</title>
11
     
11
     
12
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
13
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15
     <script type="text/javascript">
15
     <script type="text/javascript">
16
       var DOCUMENTATION_OPTIONS = {
16
       var DOCUMENTATION_OPTIONS = {
17
         URL_ROOT:    './',
17
         URL_ROOT:    './',
18
-        VERSION:     '0.9.0',
18
+        VERSION:     '0.10.0',
19
         COLLAPSE_INDEX: false,
19
         COLLAPSE_INDEX: false,
20
         FILE_SUFFIX: '.html',
20
         FILE_SUFFIX: '.html',
21
         HAS_SOURCE:  true
21
         HAS_SOURCE:  true
24
     <script type="text/javascript" src="_static/jquery.js"></script>
24
     <script type="text/javascript" src="_static/jquery.js"></script>
25
     <script type="text/javascript" src="_static/underscore.js"></script>
25
     <script type="text/javascript" src="_static/underscore.js"></script>
26
     <script type="text/javascript" src="_static/doctools.js"></script>
26
     <script type="text/javascript" src="_static/doctools.js"></script>
27
-    <link rel="top" title="searx 0.9.0 documentation" href="index.html" />
27
+    <link rel="index" title="Index" href="#" />
28
+    <link rel="search" title="Search" href="search.html" />
29
+    <link rel="top" title="searx 0.10.0 documentation" href="index.html" />
28
    
30
    
29
   
31
   
30
   <link media="only screen and (max-device-width: 480px)" href="_static/small_flask.css" type= "text/css" rel="stylesheet" />
32
   <link media="only screen and (max-device-width: 480px)" href="_static/small_flask.css" type= "text/css" rel="stylesheet" />

+ 8
- 4
index.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Welcome to searx &mdash; searx 0.9.0 documentation</title>
9
+    <title>Welcome to searx &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    './',
16
         URL_ROOT:    './',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="_static/jquery.js"></script>
23
     <script type="text/javascript" src="_static/jquery.js"></script>
24
     <script type="text/javascript" src="_static/underscore.js"></script>
24
     <script type="text/javascript" src="_static/underscore.js"></script>
25
     <script type="text/javascript" src="_static/doctools.js"></script>
25
     <script type="text/javascript" src="_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="#" />
26
+    <link rel="index" title="Index" href="genindex.html" />
27
+    <link rel="search" title="Search" href="search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="#" />
27
     <link rel="next" title="Search syntax" href="user/search_syntax.html" />
29
     <link rel="next" title="Search syntax" href="user/search_syntax.html" />
28
    
30
    
29
   
31
   
51
 <li>No user tracking</li>
53
 <li>No user tracking</li>
52
 <li>No user profiling</li>
54
 <li>No user profiling</li>
53
 <li>About 70 supported search engines</li>
55
 <li>About 70 supported search engines</li>
54
-<li>Easy intergration with any search engines</li>
56
+<li>Easy integration with any search engine</li>
55
 <li>Cookies are not used by default</li>
57
 <li>Cookies are not used by default</li>
56
 <li>Secure, encrypted connections (HTTPS/SSL)</li>
58
 <li>Secure, encrypted connections (HTTPS/SSL)</li>
57
 <li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
59
 <li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
63
 <div class="toctree-wrapper compound">
65
 <div class="toctree-wrapper compound">
64
 <ul>
66
 <ul>
65
 <li class="toctree-l1"><a class="reference internal" href="user/search_syntax.html">Search syntax</a></li>
67
 <li class="toctree-l1"><a class="reference internal" href="user/search_syntax.html">Search syntax</a></li>
68
+<li class="toctree-l1"><a class="reference internal" href="user/own-instance.html">Why use a private instance?</a></li>
66
 </ul>
69
 </ul>
67
 </div>
70
 </div>
68
 </div>
71
 </div>
72
 <ul>
75
 <ul>
73
 <li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
76
 <li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
74
 <li class="toctree-l1"><a class="reference internal" href="admin/api.html">Administration API</a></li>
77
 <li class="toctree-l1"><a class="reference internal" href="admin/api.html">Administration API</a></li>
78
+<li class="toctree-l1"><a class="reference internal" href="admin/api.html#embed-search-bar">Embed search bar</a></li>
75
 <li class="toctree-l1"><a class="reference internal" href="admin/filtron.html">How to protect an instance</a></li>
79
 <li class="toctree-l1"><a class="reference internal" href="admin/filtron.html">How to protect an instance</a></li>
76
 </ul>
80
 </ul>
77
 </div>
81
 </div>

+ 2
- 3
objects.inv View File

1
 # Sphinx inventory version 2
1
 # Sphinx inventory version 2
2
 # Project: searx
2
 # Project: searx
3
-# Version: 0.9.0
3
+# Version: 0.10.0
4
 # The remainder of this file is compressed using zlib.
4
 # The remainder of this file is compressed using zlib.
5
-xÚu’ËNÃ0E÷ù
6
-K°
[v•@¢¤ ØGn<¤#;ø‘’¿'ñÄy¸aÕúÞ¹g&csÑ :ð™uâIèŠå�ŒGñáâÉŽã­3Ü¡VìXœ²PS’ŸAÞæîî÷’ºC¥•3xö£XÖ¬»ïWÐ(¯úÊœf³
�ªF¥îÀt×–ØDz	"‹bà ²ŽKiè¶WCÄÓJ	¸Vú¡‡M	“L¡‚¡þÇcõ=0ŒK#‹C©gè@ê¶åØûìˆnªK™ÜèÖ!ÈG8Ï—2\’²ûß¼²(ú¹c6|~;£�âŸákP¨ünQ�+þfKÙ4㪢0ØñªÏ
Ø*‡ªf_€5à8-€ÑsÈ-vúµ}
¾iá%L�'Â&AÚf¥¯!óLܹí•ã›‘oÝ
�¤ìMõQ‚
5
+xÚuSÁnà ½ç+�¶kWíºËTi“ÖäN›´cEÁKÑd@Òöï8¤�¤§„÷ìçgl(o„ZÓVëø׌¬	MàÃÑ5’lÂQXg¨Z‘Ín[aÄ��Îxd–:˜þ¦OÄiÒí€9BÊ:ª L*.éä¼üÝý’ýšiåŒ8tÜ×�à0u²‘Yiˆz j¡`¯{0½€S)VШôA’À¨Û“2}Ñt!¶ƒŠÛ	åZÙù¶T`LÚá!Æÿu‚ýz
ãÊ”+ƒY/ЃÔmÊ‘�‘‹"¨aÇ}±9ƒ"Ÿñ<ÅIÙåž'¦~]��[÷aÁº_ŠækPBq8ç	MWì«kØàqñ
’éÂ’„~Cp1ËÌÝÍizŸÙ<Íܵ—U"°ü»æ�„Á'^xž�X6€­¡ê,˜µ>©UzbÓþfäÐëñ(Bý=u0¾ÏgÔ&n/ÊÑóL0c3GUÿ>ؘ¬

+ 1
- 1
requirements.txt View File

1
-sphinx
1
+sphinx==1.4.8

+ 5
- 3
search.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Search &mdash; searx 0.9.0 documentation</title>
9
+    <title>Search &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    './',
16
         URL_ROOT:    './',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
24
     <script type="text/javascript" src="_static/underscore.js"></script>
24
     <script type="text/javascript" src="_static/underscore.js"></script>
25
     <script type="text/javascript" src="_static/doctools.js"></script>
25
     <script type="text/javascript" src="_static/doctools.js"></script>
26
     <script type="text/javascript" src="_static/searchtools.js"></script>
26
     <script type="text/javascript" src="_static/searchtools.js"></script>
27
-    <link rel="top" title="searx 0.9.0 documentation" href="index.html" />
27
+    <link rel="index" title="Index" href="genindex.html" />
28
+    <link rel="search" title="Search" href="#" />
29
+    <link rel="top" title="searx 0.10.0 documentation" href="index.html" />
28
   <script type="text/javascript">
30
   <script type="text/javascript">
29
     jQuery(function() { Search.loadIndex("searchindex.js"); });
31
     jQuery(function() { Search.loadIndex("searchindex.js"); });
30
   </script>
32
   </script>

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


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

1
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
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
+    
9
+    <title>Why use a private instance? &#8212; searx 0.10.0 documentation</title>
10
+    
11
+    <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13
+    
14
+    <script type="text/javascript">
15
+      var DOCUMENTATION_OPTIONS = {
16
+        URL_ROOT:    '../',
17
+        VERSION:     '0.10.0',
18
+        COLLAPSE_INDEX: false,
19
+        FILE_SUFFIX: '.html',
20
+        HAS_SOURCE:  true
21
+      };
22
+    </script>
23
+    <script type="text/javascript" src="../_static/jquery.js"></script>
24
+    <script type="text/javascript" src="../_static/underscore.js"></script>
25
+    <script type="text/javascript" src="../_static/doctools.js"></script>
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
29
+    <link rel="next" title="Installation" href="../dev/install/installation.html" />
30
+    <link rel="prev" title="Search syntax" href="search_syntax.html" />
31
+   
32
+  
33
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
34
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
35
+
36
+  </head>
37
+  <body role="document">  
38
+
39
+    <div class="document">
40
+      <div class="documentwrapper">
41
+        <div class="bodywrapper">
42
+          <div class="body" role="main">
43
+            
44
+  <div class="section" id="why-use-a-private-instance">
45
+<h1>Why use a private instance?<a class="headerlink" href="#why-use-a-private-instance" title="Permalink to this headline">¶</a></h1>
46
+<p>&#8220;Is it worth to run my own instance?&#8221; is a common question among searx users. Before answering this question, see what options a searx user has.</p>
47
+<p>Public instances are open to everyone who has access to its URL. Usually, these are operated by unknown parties (from the users&#8217; point of view). Private instances can be used by a select group of people. It is for example a searx of group of friends or a company which can be accessed through VPN. Also it can be single user one which runs on the user&#8217;s laptop.</p>
48
+<p>To gain more insight on how these instances work let&#8217;s dive into how searx protects its users.</p>
49
+<div class="section" id="how-does-searx-protect-privacy">
50
+<h2>How does searx protect privacy?<a class="headerlink" href="#how-does-searx-protect-privacy" title="Permalink to this headline">¶</a></h2>
51
+<p>Searx protects the privacy of its users in multiple ways regardless of the type of the instance (private, public). Removal of private data from search requests comes in three forms:</p>
52
+<blockquote>
53
+<div><ol class="arabic simple">
54
+<li>removal of private data from requests going to search services</li>
55
+<li>not forwarding anything from a third party services through search services (e.g. advertisement)</li>
56
+<li>removal of private data from requests going to the result pages</li>
57
+</ol>
58
+</div></blockquote>
59
+<p>Removing private data means not sending cookies to external search engines and generating a random browser profile for every request. Thus, it does not matter if a public or private instance handles the request, because it is anonymized in both cases. IP addresses will be the IP of the instance. But searx can be configured to use proxy or Tor. <a class="reference external" href="https://github.com/asciimoo/morty">Result proxy</a> is supported, too.</p>
60
+<p>Searx does not serve adds or tracking content unlike most search services. So private data is not forwarded to third parties who might monetize it. Besides protecting users from search services, both referring page and search query are hidden from visited result pages.</p>
61
+<div class="section" id="what-are-the-consequences-of-using-public-instances">
62
+<h3>What are the consequences of using public instances?<a class="headerlink" href="#what-are-the-consequences-of-using-public-instances" title="Permalink to this headline">¶</a></h3>
63
+<p>If someone uses a public instance, he/she has to trust the administrator of that instance.
64
+This means that the user of the public instance does not know whether his/her requests are logged, aggregated and sent or sold to a third party.</p>
65
+<p>Also, public instances without proper protection are more vulnerable to abusing the search service, In this case the external service in exchange returns CAPTCHAs or bans the IP of the instance. Thus, search requests return less results.</p>
66
+</div>
67
+<div class="section" id="i-see-what-about-private-instances">
68
+<h3>I see. What about private instances?<a class="headerlink" href="#i-see-what-about-private-instances" title="Permalink to this headline">¶</a></h3>
69
+<p>If users run their own instances, everything is in their control: the source code, logging settings and private data. Unknown instance administrators do not have to be trusted.</p>
70
+<p>Furthermore, as the default settings of their instance is editable, there is no need to use cookies to tailor searx to their needs. So preferences will not be reset to defaults when clearing browser cookies. As settings are stored on their computer, it will not be accessible to others as long as their computer is not compromised.</p>
71
+</div>
72
+</div>
73
+<div class="section" id="conclusion">
74
+<h2>Conclusion<a class="headerlink" href="#conclusion" title="Permalink to this headline">¶</a></h2>
75
+<p>Always use an instance which is operated by people you trust. The privacy features of searx are available to users no matter what kind of instance they use.</p>
76
+<p>If someone is on the go or just wants to try searx for the first time public instances are the best choices. Additionally, public instance are making a world a better place, because those who cannot or do not want to run an instance, have access to a privacy respecting search service.</p>
77
+</div>
78
+</div>
79
+
80
+
81
+          </div>
82
+        </div>
83
+      </div>
84
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
85
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
86
+<h1>Searx</h1>
87
+<ul>
88
+    <li><a href="../index.html">Home</a></li>
89
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
90
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
91
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
92
+</ul>
93
+<hr />
94
+<ul>
95
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
96
+    <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>
97
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
98
+</ul>
99
+</div>
100
+        </div>
101
+      </div>
102
+      <div class="clearer"></div>
103
+    </div>
104
+    <div class="footer">
105
+      &copy; Copyright 2015-2016, Adam Tauber.
106
+    </div>
107
+  </body>
108
+</html>

+ 5
- 3
user/search_syntax.html View File

6
   <head>
6
   <head>
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
     
8
     
9
-    <title>Search syntax &mdash; searx 0.9.0 documentation</title>
9
+    <title>Search syntax &#8212; searx 0.10.0 documentation</title>
10
     
10
     
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
11
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
     <script type="text/javascript">
14
     <script type="text/javascript">
15
       var DOCUMENTATION_OPTIONS = {
15
       var DOCUMENTATION_OPTIONS = {
16
         URL_ROOT:    '../',
16
         URL_ROOT:    '../',
17
-        VERSION:     '0.9.0',
17
+        VERSION:     '0.10.0',
18
         COLLAPSE_INDEX: false,
18
         COLLAPSE_INDEX: false,
19
         FILE_SUFFIX: '.html',
19
         FILE_SUFFIX: '.html',
20
         HAS_SOURCE:  true
20
         HAS_SOURCE:  true
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
23
     <script type="text/javascript" src="../_static/jquery.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
24
     <script type="text/javascript" src="../_static/underscore.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
25
     <script type="text/javascript" src="../_static/doctools.js"></script>
26
-    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
26
+    <link rel="index" title="Index" href="../genindex.html" />
27
+    <link rel="search" title="Search" href="../search.html" />
28
+    <link rel="top" title="searx 0.10.0 documentation" href="../index.html" />
27
     <link rel="next" title="Installation" href="../dev/install/installation.html" />
29
     <link rel="next" title="Installation" href="../dev/install/installation.html" />
28
     <link rel="prev" title="Welcome to searx" href="../index.html" />
30
     <link rel="prev" title="Welcome to searx" href="../index.html" />
29
    
31