e0eb48b · searx · git.iko.soy

git.iko.soy/searx

Merge pull request #752 from kvch/gh-pages

documentation update && new page

commite0eb48b4f61aa000150bda74967496bee2d7a394 authorAdam Tauber <asciimoo@gmail.com> dateSat 5 Nov 2016, 17:19 (10 years ago) parenta2206c2 40251e6

29 files changed+669−429

compare with master

unifiedsplit

_sources/dev/engine_overview.txt+114−112

@@ -30,15 +30,17 @@ settings. However, the standard way is the following:

3030engine file

3131~~~~~~~~~~~

3232

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

4244

4345settings.yml

4446~~~~~~~~~~~~

@@ -186,126 +188,126 @@ To set another media-type as default, the parameter

186188default

187189~~~~~~~

188190

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

200202

201203images

202204~~~~~~

203205

204206to use this template, the parameter

205207

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

223225

224226videos

225227~~~~~~

226228

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

242244

243245torrent

244246~~~~~~~

245247

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

271273

272274

273275map

274276~~~

275277

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

311313

_sources/dev/plugins.txt+1−1

@@ -11,7 +11,7 @@ Example plugin

1111

1212 name = 'Example plugin'

1313 description = 'This plugin extends the suggestions with the word "example"'

14− default_on = False # disable by default

14+ default_on = False # disabled by default

1515

1616 js_dependencies = tuple() # optional, list of static js files

1717 css_dependencies = tuple() # optional, list of static css files

_sources/index.txt+2−1

@@ -16,7 +16,7 @@ Features

1616 - No user tracking

1717 - No user profiling

1818 - About 70 supported search engines

19− - Easy intergration with any search engines

19+ - Easy integration with any search engine

2020 - Cookies are not used by default

2121 - Secure, encrypted connections (HTTPS/SSL)

2222 - Hosted by organisations, such as La Quadrature du Net, which promote digital rights

@@ -29,6 +29,7 @@ User documentation

2929 :maxdepth: 1

3030

3131 user/search_syntax

32+ user/own-instance

3233

3334Administrator documentation

3435---------------------------

_sources/user/own-instance.txtnew file+43

@@ -0,0 +1,43 @@

1+Why use a private instance?

2+===========================

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.

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.

8+To gain more insight on how these instances work let's dive into how searx protects its users.

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.

_static/basic.css+7

@@ -494,6 +494,13 @@ pre {

494494 overflow-y: hidden; /* fixes display issues on Chrome browsers */

495495}

496496

497+span.pre {

498+ -moz-hyphens: none;

499+ -ms-hyphens: none;

500+ -webkit-hyphens: none;

501+ hyphens: none;

502+}

503+

497504td.linenos pre {

498505 padding: 5px 0px;

499506 border: 0;

_static/pygments.css+2

@@ -4,8 +4,10 @@

44.highlight .err { border: 1px solid #FF0000 } /* Error */

55.highlight .k { color: #007020; font-weight: bold } /* Keyword */

66.highlight .o { color: #666666 } /* Operator */

7+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */

78.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */

89.highlight .cp { color: #007020 } /* Comment.Preproc */

10+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */

911.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */

1012.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */

1113.highlight .gd { color: #A00000 } /* Generic.Deleted */

_static/searchtools.js+1−1

@@ -324,7 +324,7 @@ var Search = {

324324 var searchterms = [];

325325 var excluded = [];

326326 var hlterms = [];

327− var tmp = query.split(/\s+/);

327+ var tmp = query.split(/\W+/);

328328 var objectterms = [];

329329 for (i = 0; i < tmp.length; i++) {

330330 if (tmp[i] !== "") {

admin/api.html+47−45

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Administration API — searx 0.9.0 documentation</title>

9+ <title>Administration API — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,8 +23,10 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2830 <link rel="prev" title="Installation" href="../dev/install/installation.html" />

2931

3032

@@ -43,71 +45,71 @@

4345<h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>

4446<div class="section" id="get-configuration-data">

4547<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>GET /config

48+<div class="code sh highlight-default"><div class="highlight"><pre>GET /config

4749</pre></div>

4850</div>

4951<div class="section" id="sample-response">

5052<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>{

52− "autocomplete": "",

53− "categories": [

54− "map",

55− "it",

56− "images",

53+<div class="code sh highlight-default"><div class="highlight"><pre>{

54+ "autocomplete": "",

55+ "categories": [

56+ "map",

57+ "it",

58+ "images",

5759 ],

58− "default_locale": "",

59− "default_theme": "oscar",

60− "engines": [

60+ "default_locale": "",

61+ "default_theme": "oscar",

62+ "engines": [

6163 {

62− "categories": [

63− "map"

64+ "categories": [

65+ "map"

6466 ],

65− "enabled": true,

66− "name": "openstreetmap",

67− "shortcut": "osm"

67+ "enabled": true,

68+ "name": "openstreetmap",

69+ "shortcut": "osm"

6870 },

6971 {

70− "categories": [

71− "it"

72+ "categories": [

73+ "it"

7274 ],

73− "enabled": true,

74− "name": "arch linux wiki",

75− "shortcut": "al"

75+ "enabled": true,

76+ "name": "arch linux wiki",

77+ "shortcut": "al"

7678 },

7779 {

78− "categories": [

79− "images"

80+ "categories": [

81+ "images"

8082 ],

81− "enabled": true,

82− "name": "google images",

83− "shortcut": "goi"

83+ "enabled": true,

84+ "name": "google images",

85+ "shortcut": "goi"

8486 },

8587 {

86− "categories": [

87− "it"

88+ "categories": [

89+ "it"

8890 ],

89− "enabled": false,

90− "name": "bitbucket",

91− "shortcut": "bb"

91+ "enabled": false,

92+ "name": "bitbucket",

93+ "shortcut": "bb"

9294 },

9395 ],

94− "instance_name": "searx",

95− "locales": {

96− "de": "Deutsch (German)",

97− "en": "English",

98− "eo": "Esperanto (Esperanto)",

96+ "instance_name": "searx",

97+ "locales": {

98+ "de": "Deutsch (German)",

99+ "en": "English",

100+ "eo": "Esperanto (Esperanto)",

99101 },

100− "plugins": [

102+ "plugins": [

101103 {

102− "enabled": true,

103− "name": "HTTPS rewrite"

104+ "enabled": true,

105+ "name": "HTTPS rewrite"

104106 },

105107 {

106− "enabled": false,

107− "name": "Vim-like hotkeys"

108+ "enabled": false,

109+ "name": "Vim-like hotkeys"

108110 }

109111 ],

110− "safe_search": 0

112+ "safe_search": 0

111113}

112114</pre></div>

113115</div>

admin/filtron.html+3−3

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>How to protect an instance — searx 0.9.0 documentation</title>

9+ <title>How to protect an instance — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -25,7 +25,7 @@

2525 <script type="text/javascript" src="../_static/doctools.js"></script>

2626 <link rel="index" title="Index" href="../genindex.html" />

2727 <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" />

2929 <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />

3030 <link rel="prev" title="Administration API" href="api.html" />

3131

dev/contribution_guide.html+5−3

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>How to contribute — searx 0.9.0 documentation</title>

9+ <title>How to contribute — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,7 +23,9 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2729 <link rel="next" title="Engine overview" href="engine_overview.html" />

2830 <link rel="prev" title="Development Quickstart" href="quickstart.html" />

2931

dev/engine_overview.html+62−54

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Engine overview — searx 0.9.0 documentation</title>

9+ <title>Engine overview — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,7 +23,9 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2729 <link rel="next" title="Search API" href="search_api.html" />

2830 <link rel="prev" title="How to contribute" href="contribution_guide.html" />

2931

@@ -88,9 +90,9 @@ settings. However, the standard way is the following:

8890<h3><a class="toc-backref" href="#id4">engine file</a><a class="headerlink" href="#engine-file" title="Permalink to this headline">¶</a></h3>

8991<table border="1" class="docutils">

9092<colgroup>

91−<col width="29%" />

93+<col width="30%" />

9294<col width="15%" />

93−<col width="56%" />

95+<col width="55%" />

9496</colgroup>

9597<thead valign="bottom">

9698<tr class="row-odd"><th class="head">argument</th>

@@ -111,6 +113,10 @@ settings. However, the standard way is the following:

111113<td>boolean</td>

112114<td>support language choosing</td>

113115</tr>

116+<tr class="row-odd"><td>time_range_support</td>

117+<td>boolean</td>

118+<td>support search time range</td>

119+</tr>

114120</tbody>

115121</table>

116122</div>

@@ -190,10 +196,10 @@ overrides are the following:

190196</div>

191197<div class="section" id="example-code">

192198<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># engine dependent config

194−categories = ['general']

195−paging = True

196−language_support = True

199+<div class="code python highlight-default"><div class="highlight"><pre># engine dependent config

200+categories = ['general']

201+paging = True

202+language_support = True

197203</pre></div>

198204</div>

199205</div>

@@ -313,17 +319,17 @@ used to specify a search request:

313319</div>

314320<div class="section" id="id1">

315321<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># search-url

317−base_url = 'https://example.com/'

318−search_string = 'search?{query}&page={page}'

322+<div class="code python highlight-default"><div class="highlight"><pre># search-url

323+base_url = 'https://example.com/'

324+search_string = 'search?{query}&page={page}'

319325

320−# do search-request

326+# do search-request

321327def request(query, params):

322328 search_path = search_string.format(

323− query=urlencode({'q': query}),

324− page=params['pageno'])

329+ query=urlencode({'q': query}),

330+ page=params['pageno'])

325331

326− params['url'] = base_url + search_path

332+ params['url'] = base_url + search_path

327333

328334 return params

329335</pre></div>

@@ -347,8 +353,8 @@ Currently the following media-types are supported:

347353<h3><a class="toc-backref" href="#id13">default</a><a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>

348354<table border="1" class="docutils">

349355<colgroup>

350−<col width="13%" />

351−<col width="87%" />

356+<col width="15%" />

357+<col width="85%" />

352358</colgroup>

353359<thead valign="bottom">

354360<tr class="row-odd"><th class="head">result-parameter</th>

@@ -357,16 +363,16 @@ Currently the following media-types are supported:

357363</thead>

358364<tbody valign="top">

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

361367</tr>

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

364370</tr>

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

367373</tr>

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

370376</tr>

371377</tbody>

372378</table>

@@ -376,8 +382,8 @@ Currently the following media-types are supported:

376382to use this template, the parameter

377383<table border="1" class="docutils">

378384<colgroup>

379−<col width="11%" />

380−<col width="89%" />

385+<col width="13%" />

386+<col width="87%" />

381387</colgroup>

382388<thead valign="bottom">

383389<tr class="row-odd"><th class="head">result-parameter</th>

@@ -389,22 +395,22 @@ Currently the following media-types are supported:

389395<td>is set to <code class="docutils literal">images.html</code></td>

390396</tr>

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

393399</tr>

394400<tr class="row-even"><td>title</td>

395−<td>string, which is representing the title of the result (partly implemented)</td>

401+<td>string, title of the result (partly implemented)</td>

396402</tr>

397403<tr class="row-odd"><td>content</td>

398404<td>(partly implemented)</td>

399405</tr>

400406<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 (partly implemented)</td>

407+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish (partly implemented)</td>

402408</tr>

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

405411</tr>

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

408414</tr>

409415</tbody>

410416</table>

@@ -413,8 +419,8 @@ Currently the following media-types are supported:

413419<h3><a class="toc-backref" href="#id15">videos</a><a class="headerlink" href="#videos" title="Permalink to this headline">¶</a></h3>

414420<table border="1" class="docutils">

415421<colgroup>

416−<col width="13%" />

417−<col width="87%" />

422+<col width="15%" />

423+<col width="85%" />

418424</colgroup>

419425<thead valign="bottom">

420426<tr class="row-odd"><th class="head">result-parameter</th>

@@ -426,19 +432,19 @@ Currently the following media-types are supported:

426432<td>is set to <code class="docutils literal">videos.html</code></td>

427433</tr>

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

430436</tr>

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

433439</tr>

434440<tr class="row-odd"><td>content</td>

435441<td>(not implemented yet)</td>

436442</tr>

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

439445</tr>

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

442448</tr>

443449</tbody>

444450</table>

@@ -447,27 +453,29 @@ Currently the following media-types are supported:

447453<h3><a class="toc-backref" href="#id16">torrent</a><a class="headerlink" href="#torrent" title="Permalink to this headline">¶</a></h3>

448454<table border="1" class="docutils">

449455<colgroup>

450−<col width="10%" />

451−<col width="90%" />

456+<col width="12%" />

457+<col width="88%" />

452458</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>

456462</tr>

463+</thead>

464+<tbody valign="top">

457465<tr class="row-even"><td>template</td>

458−<td>is set to <code class="docutils literal">`torrent.html`</code></td>

466+<td>is set to <code class="docutils literal">torrent.html</code></td>

459467</tr>

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

462470</tr>

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

465473</tr>

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

468476</tr>

469477<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 (not implemented yet)</td>

478+<td><a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime-objects">datetime.datetime</a>, time of publish (not implemented yet)</td>

471479</tr>

472480<tr class="row-odd"><td>seed</td>

473481<td>int, number of seeder</td>

@@ -482,10 +490,10 @@ Currently the following media-types are supported:

482490<td>int, number of files</td>

483491</tr>

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

486494</tr>

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

489497</tr>

490498</tbody>

491499</table>

@@ -494,8 +502,8 @@ Currently the following media-types are supported:

494502<h3><a class="toc-backref" href="#id17">map</a><a class="headerlink" href="#map" title="Permalink to this headline">¶</a></h3>

495503<table border="1" class="docutils">

496504<colgroup>

497−<col width="16%" />

498−<col width="84%" />

505+<col width="19%" />

506+<col width="81%" />

499507</colgroup>

500508<thead valign="bottom">

501509<tr class="row-odd"><th class="head">result-parameter</th>

@@ -504,16 +512,16 @@ Currently the following media-types are supported:

504512</thead>

505513<tbody valign="top">

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

508516</tr>

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

511519</tr>

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

514522</tr>

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

517525</tr>

518526<tr class="row-even"><td>latitude</td>

519527<td>latitude of result (in decimal format)</td>

@@ -537,7 +545,7 @@ Currently the following media-types are supported:

537545<td>name of object</td>

538546</tr>

539547<tr class="row-odd"><td>address.road</td>

540−<td>street adress of object</td>

548+<td>street name of object</td>

541549</tr>

542550<tr class="row-even"><td>address.house_number</td>

543551<td>house number of object</td>

dev/install/installation.html+38−36

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Installation — searx 0.9.0 documentation</title>

9+ <title>Installation — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,7 +23,9 @@

2323 <script type="text/javascript" src="../../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../../_static/underscore.js"></script>

2525 <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" />

2729 <link rel="next" title="Administration API" href="../../admin/api.html" />

2830 <link rel="prev" title="Search syntax" href="../../user/search_syntax.html" />

2931

@@ -68,18 +70,18 @@ certificate</a>

6870<h2><a class="toc-backref" href="#id4">Basic installation</a><a class="headerlink" href="#basic-installation" title="Permalink to this headline">¶</a></h2>

6971For Ubuntu, be sure to have enable universe repository.

7072Install packages:

71−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv python-pybabel zlib1g-dev libffi-dev libssl-dev

73+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv python-pybabel zlib1g-dev libffi-dev libssl-dev

7274</pre></div>

7375</div>

7476Install searx:

75−<div class="code sh highlight-default"><div class="highlight"><pre>cd /usr/local

77+<div class="code sh highlight-default"><div class="highlight"><pre>cd /usr/local

7678sudo git clone https://github.com/asciimoo/searx.git

7779sudo useradd searx -d /usr/local/searx

7880sudo chown searx:searx -R /usr/local/searx

7981</pre></div>

8082</div>

8183Install dependencies in a virtualenv:

82−<div class="code sh highlight-default"><div class="highlight"><pre>sudo -u searx -i

84+<div class="code sh highlight-default"><div class="highlight"><pre>sudo -u searx -i

8385cd /usr/local/searx

8486virtualenv searx-ve

8587. ./searx-ve/bin/activate

@@ -89,7 +91,7 @@ certificate</a>

8991</div>

9092<div class="section" id="configuration">

9193<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>sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml

94+<div class="code sh highlight-default"><div class="highlight"><pre>sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml

9395</pre></div>

9496</div>

9597Edit searx/settings.yml if necessary.

@@ -97,12 +99,12 @@ certificate</a>

9799<div class="section" id="check">

98100<h2><a class="toc-backref" href="#id6">Check</a><a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h2>

99101Start searx:

100−<div class="code sh highlight-default"><div class="highlight"><pre>python searx/webapp.py

102+<div class="code sh highlight-default"><div class="highlight"><pre>python searx/webapp.py

101103</pre></div>

102104</div>

103105Go to <a class="reference external" href="http://localhost:8888">http://localhost:8888</a>

104106If everything works fine, disable the debug option in settings.yml:

105−<div class="code sh highlight-default"><div class="highlight"><pre>sed -i -e "s/debug : True/debug : False/g" searx/settings.yml

107+<div class="code sh highlight-default"><div class="highlight"><pre>sed -i -e "s/debug : True/debug : False/g" searx/settings.yml

106108</pre></div>

107109</div>

108110At this point searx is not demonized ; uwsgi allows this.

@@ -112,41 +114,41 @@ twice).

112114<div class="section" id="uwsgi">

113115<h2><a class="toc-backref" href="#id7">uwsgi</a><a class="headerlink" href="#uwsgi" title="Permalink to this headline">¶</a></h2>

114116Install packages:

115−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install uwsgi uwsgi-plugin-python

117+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install uwsgi uwsgi-plugin-python

116118</pre></div>

117119</div>

118120Create the configuration file /etc/uwsgi/apps-available/searx.ini with

119121this content:

120−<div class="highlight-default"><div class="highlight"><pre>[uwsgi]

121−# Who will run the code

122+<div class="highlight-default"><div class="highlight"><pre>[uwsgi]

123+# Who will run the code

122124uid = searx

123125gid = searx

124126

125−# disable logging for privacy

127+# disable logging for privacy

126128disable-logging = true

127129

128−# Number of workers (usually CPU count)

130+# Number of workers (usually CPU count)

129131workers = 4

130132

131−# The right granted on the created socket

133+# The right granted on the created socket

132134chmod-socket = 666

133135

134−# Plugin to use and interpretor config

136+# Plugin to use and interpretor config

135137single-interpreter = true

136138master = true

137139plugin = python

138140

139−# Module to import

141+# Module to import

140142module = searx.webapp

141143

142−# Virtualenv and python path

144+# Virtualenv and python path

143145virtualenv = /usr/local/searx/searx-ve/

144146pythonpath = /usr/local/searx/

145147chdir = /usr/local/searx/searx/

146148</pre></div>

147149</div>

148150Activate the uwsgi application and restart:

149−<div class="code sh highlight-default"><div class="highlight"><pre>cd /etc/uwsgi/apps-enabled

151+<div class="code sh highlight-default"><div class="highlight"><pre>cd /etc/uwsgi/apps-enabled

150152ln -s ../apps-available/searx.ini

151153/etc/init.d/uwsgi restart

152154</pre></div>

@@ -158,14 +160,14 @@ this content:

158160<h3><a class="toc-backref" href="#id9">with nginx</a><a class="headerlink" href="#with-nginx" title="Permalink to this headline">¶</a></h3>

159161If nginx is not installed (uwsgi will not work with the package

160162nginx-light):

161−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install nginx

163+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install nginx

162164</pre></div>

163165</div>

164166<div class="section" id="hosted-at">

165167<h4>Hosted at /<a class="headerlink" href="#hosted-at" title="Permalink to this headline">¶</a></h4>

166168Create the configuration file /etc/nginx/sites-available/searx with this

167169content:

168−<div class="code nginx highlight-default"><div class="highlight"><pre>server {

170+<div class="code nginx highlight-default"><div class="highlight"><pre>server {

169171 listen 80;

170172 server_name searx.example.com;

171173 root /usr/local/searx;

@@ -178,7 +180,7 @@ content:

178180</pre></div>

179181</div>

180182Restart service:

181−<div class="code sh highlight-default"><div class="highlight"><pre>sudo service nginx restart

183+<div class="code sh highlight-default"><div class="highlight"><pre>sudo service nginx restart

182184sudo service uwsgi restart

183185</pre></div>

184186</div>

@@ -187,7 +189,7 @@ content:

187189<h4>from subdirectory URL (/searx)<a class="headerlink" href="#from-subdirectory-url-searx" title="Permalink to this headline">¶</a></h4>

188190Add this configuration in the server config file

189191/etc/nginx/sites-available/default:

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>location = /searx { rewrite ^ /searx/; }

191193location /searx {

192194 try_files $uri @searx;

193195}

@@ -202,7 +204,7 @@ location @searx {

202204OR

203205using reverse proxy

204206(Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)

205−<div class="code nginx highlight-default"><div class="highlight"><pre>location /searx {

207+<div class="code nginx highlight-default"><div class="highlight"><pre>location /searx {

206208 proxy_pass http://127.0.0.1:8888;

207209 proxy_set_header Host $host;

208210 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

@@ -213,11 +215,11 @@ location @searx {

213215</pre></div>

214216</div>

215217Enable base_url in searx/settings.yml

216−<div class="highlight-default"><div class="highlight"><pre>base_url : http://your.domain.tld/searx/

218+<div class="highlight-default"><div class="highlight"><pre>base_url : http://your.domain.tld/searx/

217219</pre></div>

218220</div>

219221Restart service:

220−<div class="code sh highlight-default"><div class="highlight"><pre>sudo service nginx restart

222+<div class="code sh highlight-default"><div class="highlight"><pre>sudo service nginx restart

221223sudo service uwsgi restart

222224</pre></div>

223225</div>

@@ -226,12 +228,12 @@ location @searx {

226228for better privacy you can disable nginx logs about searx.

227229how to proceed: below <code class="docutils literal">uwsgi_pass</code> in

228230/etc/nginx/sites-available/default add

229−<div class="highlight-default"><div class="highlight"><pre>access_log /dev/null;

231+<div class="highlight-default"><div class="highlight"><pre>access_log /dev/null;

230232error_log /dev/null;

231233</pre></div>

232234</div>

233235Restart service:

234−<div class="code sh highlight-default"><div class="highlight"><pre>sudo service nginx restart

236+<div class="code sh highlight-default"><div class="highlight"><pre>sudo service nginx restart

235237</pre></div>

236238</div>

237239</div>

@@ -240,12 +242,12 @@ location @searx {

240242<div class="section" id="with-apache">

241243<h3><a class="toc-backref" href="#id10">with apache</a><a class="headerlink" href="#with-apache" title="Permalink to this headline">¶</a></h3>

242244Add wsgi mod:

243−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install libapache2-mod-uwsgi

245+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install libapache2-mod-uwsgi

244246sudo a2enmod uwsgi

245247</pre></div>

246248</div>

247249Add this configuration in the file /etc/apache2/apache2.conf:

248−<div class="code apache highlight-default"><div class="highlight"><pre><Location />

250+<div class="code apache highlight-default"><div class="highlight"><pre><Location />

249251 Options FollowSymLinks Indexes

250252 SetHandler uwsgi-handler

251253 uWSGISocket /run/uwsgi/app/searx/socket

@@ -256,7 +258,7 @@ location @searx {

256258change <code class="docutils literal"><Location /></code> by the location of your instance, like

257259<code class="docutils literal"><Location /searx></code>.

258260Restart Apache:

259−<div class="code sh highlight-default"><div class="highlight"><pre>sudo /etc/init.d/apache2 restart

261+<div class="code sh highlight-default"><div class="highlight"><pre>sudo /etc/init.d/apache2 restart

260262</pre></div>

261263</div>

262264<div class="section" id="id2">

@@ -266,11 +268,11 @@ change <code class="docutils literal"><Location <spa

266268WARNING: you can only disable logs for the whole (virtual) server not

267269for a specific path.

268270Go back to /etc/apache2/apache2.conf and above <code class="docutils literal"><Location /></code> add:

269−<div class="code apache highlight-default"><div class="highlight"><pre>CustomLog /dev/null combined

271+<div class="code apache highlight-default"><div class="highlight"><pre>CustomLog /dev/null combined

270272</pre></div>

271273</div>

272274Restart Apache:

273−<div class="code sh highlight-default"><div class="highlight"><pre>sudo /etc/init.d/apache2 restart

275+<div class="code sh highlight-default"><div class="highlight"><pre>sudo /etc/init.d/apache2 restart

274276</pre></div>

275277</div>

276278</div>

@@ -278,7 +280,7 @@ for a specific path.

278280</div>

279281<div class="section" id="how-to-update">

280282<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>cd /usr/local/searx

283+<div class="code sh highlight-default"><div class="highlight"><pre>cd /usr/local/searx

282284sudo -u searx -i

283285. ./searx-ve/bin/activate

284286git stash

@@ -292,14 +294,14 @@ for a specific path.

292294<div class="section" id="docker">

293295<h2><a class="toc-backref" href="#id12">Docker</a><a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h2>

294296Make sure you have installed Docker. For instance, you can deploy searx like this:

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>docker pull wonderfall/searx

296298docker run -d --name searx -p $PORT:8888 wonderfall/searx

297299</pre></div>

298300</div>

299301Go to <a class="reference external" href="http://localhost:$PORT">http://localhost:$PORT</a>.

300302See <a class="reference external" href="https://hub.docker.com/r/wonderfall/searx/">https://hub.docker.com/r/wonderfall/searx/</a> for more informations.

301303It’s also possible to build searx from the embedded Dockerfile.

302−<div class="code sh highlight-default"><div class="highlight"><pre>git clone https://github.com/asciimoo/searx.git

304+<div class="code sh highlight-default"><div class="highlight"><pre>git clone https://github.com/asciimoo/searx.git

303305cd searx

304306docker build -t whatever/searx .

305307</pre></div>

dev/plugins.html+15−13

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Plugins — searx 0.9.0 documentation</title>

9+ <title>Plugins — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,7 +23,9 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2729 <link rel="next" title="Translation" href="translation.html" />

2830 <link rel="prev" title="Search API" href="search_api.html" />

2931

@@ -45,20 +47,20 @@

4547searx.

4648<div class="section" id="example-plugin">

4749<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>name = 'Example plugin'

49−description = 'This plugin extends the suggestions with the word "example"'

50−default_on = False # disable by default

50+<div class="code python highlight-default"><div class="highlight"><pre>name = 'Example plugin'

51+description = 'This plugin extends the suggestions with the word "example"'

52+default_on = False # disabled by default

5153

52−js_dependencies = tuple() # optional, list of static js files

53−css_dependencies = tuple() # optional, list of static css files

54+js_dependencies = tuple() # optional, list of static js files

55+css_dependencies = tuple() # optional, list of static css files

5456

5557

56−# attach callback to the post search hook

57−# request: flask request object

58−# ctx: the whole local context of the post search hook

58+# attach callback to the post search hook

59+# request: flask request object

60+# ctx: the whole local context of the post search hook

5961def post_search(request, ctx):

60− ctx['search'].suggestions.add('example')

61− return True

62+ ctx['search'].suggestions.add('example')

63+ return True

6264</pre></div>

6365</div>

6466</div>

dev/quickstart.html+13−11

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Development Quickstart — searx 0.9.0 documentation</title>

9+ <title>Development Quickstart — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,9 +23,11 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2729 <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" />

2931

3032

3133 <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />

@@ -48,7 +50,7 @@ short introduction to the new manage.sh script.

4850First, clone the source code of searx to the desired folder. In this case the source

4951is cloned to ~/myprojects/searx. Then create and activate the searx-ve

5052virtualenv and install the required packages using manage.sh.

51−<div class="code sh highlight-default"><div class="highlight"><pre>cd ~/myprojects

53+<div class="code sh highlight-default"><div class="highlight"><pre>cd ~/myprojects

5254git clone https://github.com/asciimoo/searx.git

5355cd searx

5456virtualenv searx-ve

@@ -68,7 +70,7 @@ virtualenv and install the required packages using manage.sh.

6870<li>Unit test coverage check</li>

6971</ul>

7072For example unit tests are run with the command below:

71−<div class="code sh highlight-default"><div class="highlight"><pre>./manage.sh unit_tests

73+<div class="code sh highlight-default"><div class="highlight"><pre>./manage.sh unit_tests

7274</pre></div>

7375</div>

7476For further test options, please consult the help of the manage.sh script.

@@ -78,16 +80,16 @@ virtualenv and install the required packages using manage.sh.

7880<div class="section" id="how-to-build-styles">

7981<h3>How to build styles<a class="headerlink" href="#how-to-build-styles" title="Permalink to this headline">¶</a></h3>

8082Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.

81−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install nodejs

83+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install nodejs

8284sudo npm install -g less

8385</pre></div>

8486</div>

8587OR

86−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install node-less

88+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install node-less

8789</pre></div>

8890</div>

8991After satisfying the requirements styles can be build using manage.sh

90−<div class="code sh highlight-default"><div class="highlight"><pre>./manage.sh styles

92+<div class="code sh highlight-default"><div class="highlight"><pre>./manage.sh styles

9193</pre></div>

9294</div>

9395</div>

@@ -95,12 +97,12 @@ virtualenv and install the required packages using manage.sh.

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

9698Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first

9799Node has to be installed.

98−<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install nodejs

100+<div class="code sh highlight-default"><div class="highlight"><pre>sudo apt-get install nodejs

99101sudo npm install -g grunt-cli

100102</pre></div>

101103</div>

102104After installing grunt, the files can be built using the following command:

103−<div class="code sh highlight-default"><div class="highlight"><pre>./manage.sh build_grunt

105+<div class="code sh highlight-default"><div class="highlight"><pre>./manage.sh build_grunt

104106</pre></div>

105107</div>

106108</div>

dev/search_api.html+5−3

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Search API — searx 0.9.0 documentation</title>

9+ <title>Search API — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,7 +23,9 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2729 <link rel="next" title="Plugins" href="plugins.html" />

2830 <link rel="prev" title="Engine overview" href="engine_overview.html" />

2931

dev/translation.html+14−12

@@ -6,7 +6,7 @@

66 <head>

77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9− <title>Translation — searx 0.9.0 documentation</title>

9+ <title>Translation — searx 0.10.0 documentation</title>

1010

1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />

1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

@@ -14,7 +14,7 @@

1414 <script type="text/javascript">

1515 var DOCUMENTATION_OPTIONS = {

1616 URL_ROOT: '../',

17− VERSION: '0.9.0',

17+ VERSION: '0.10.0',

1818 COLLAPSE_INDEX: false,

1919 FILE_SUFFIX: '.html',

2020 HAS_SOURCE: true

@@ -23,7 +23,9 @@

2323 <script type="text/javascript" src="../_static/jquery.js"></script>

2424 <script type="text/javascript" src="../_static/underscore.js"></script>

2525 <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" />

2729 <link rel="prev" title="Plugins" href="plugins.html" />

2830

2931

@@ -43,13 +45,13 @@

4345run these commands in the root directory of searx

4446<div class="section" id="add-new-language">

4547<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>pybabel init -i messages.pot -d searx/translations -l it

48+<div class="code shell highlight-default"><div class="highlight"><pre>pybabel init -i messages.pot -d searx/translations -l it

4749</pre></div>

4850</div>

4951</div>

5052<div class="section" id="update-po-files">

5153<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>./utils/update-translations.sh

54+<div class="code shell highlight-default"><div class="highlight"><pre>./utils/update-translations.sh

5355</pre></div>

5456</div>

5557You may have errors here. In that case, edit the

@@ -59,7 +61,7 @@

5961</div>

6062<div class="section" id="compile-translations">

6163<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>pybabel compile -d searx/translations

64+<div class="code shell highlight-default"><div class="highlight"><pre>pybabel compile -d searx/translations

6365</pre></div>

6466</div>

6567</div>

@@ -67,9 +69,9 @@

6769<h2>Transifex stuff<a class="headerlink" href="#transifex-stuff" title="Permalink to this headline">¶</a></h2>

6870<div class="section" id="init-project">

6971<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>tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/

72+<div class="code shell highlight-default"><div class="highlight"><pre>tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/

7173

72−tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \

74+tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \

7375--source-lang en --type PO --source-file messages.pot --execute

7476</pre></div>

7577</div>

@@ -78,27 +80,27 @@

7880</div>

7981<div class="section" id="get-translations">

8082<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>tx pull -a

83+<div class="code shell highlight-default"><div class="highlight"><pre>tx pull -a

8284</pre></div>

8385</div>

8486<a class="reference external" href="http://docs.transifex.com/client/pull">http://docs.transifex.com/client/pull</a>

8587</div>

8688<div class="section" id="upload-source-file">

8789<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>tx push -s

90+<div class="code shell highlight-default"><div class="highlight"><pre>tx push -s

8991</pre></div>

9092</div>

9193</div>

9294<div class="section" id="upload-all-translation">

9395<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>tx push -s -t

96+<div class="code shell highlight-default"><div class="highlight"><pre>tx push -s -t

9597</pre></div>

9698</div>

9799</div>

98100</div>

99101<div class="section" id="upload-specifc-translation">

100102<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>tx push -t -l tr

103+<div class="code shell highlight-default"><div class="highlight"><pre>tx push -t -l tr

102104</pre></div>

103105</div>

104106<a class="reference external" href="http://docs.transifex.com/client/push">http://docs.transifex.com/client/push</a>

docs/conf.py+2−2

@@ -57,9 +57,9 @@ author = u'Adam Tauber'

5757# built documents.

5858#

5959# The short X.Y version.

60−version = '0.9.0'

60+version = '0.10.0'

6161# The full version, including alpha/beta/rc tags.

62−release = '0.9.0'

62+release = '0.10.0'

6363

6464# The language for content autogenerated by Sphinx. Refer to documentation

6565# for a list of supported languages.

docs/dev/engine_overview.rst+114−112