lasers
/
searx
mirror of https://github.com/searx/searx
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

generated files of parent

This commit is contained in:
Noemi Vanyi 2016-07-09 22:32:57 +02:00
parent 18a8e609b3
commit c086959da0
15 changed files with 367 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
_sources/admin/api.txt Normal file
View File

@ -0,0 +1,78 @@
.. _adminapi:
Administration API
------------------
Get configuration data
~~~~~~~~~~~~~~~~~~~~~~
.. code:: sh
GET /config
Sample response
```````````````
.. code:: sh
{
"autocomplete": "",
"categories": [
"map",
"it",
"images",
],
"default_locale": "",
"default_theme": "oscar",
"engines": [
{
"categories": [
"map"
],
"enabled": true,
"name": "openstreetmap",
"shortcut": "osm"
},
{
"categories": [
"it"
],
"enabled": true,
"name": "arch linux wiki",
"shortcut": "al"
},
{
"categories": [
"images"
],
"enabled": true,
"name": "google images",
"shortcut": "goi"
},
{
"categories": [
"it"
],
"enabled": false,
"name": "bitbucket",
"shortcut": "bb"
},
],
"instance_name": "searx",
"locales": {
"de": "Deutsch (German)",
"en": "English",
"eo": "Esperanto (Esperanto)",
},
"plugins": [
{
"enabled": true,
"name": "HTTPS rewrite"
},
{
"enabled": false,
"name": "Vim-like hotkeys"
}
],
"safe_search": 0
}

34
_sources/dev/plugins.txt
View File

@ -1,11 +1,11 @@
Plugins
-------
Plugins can extend/replace functionality of various components inside
Plugins can extend or replace functionality of various components of
searx.
example\_plugin.py
~~~~~~~~~~~~~~~~~~
Example plugin
~~~~~~~~~~~~~~
.. code:: python
@ -24,22 +24,22 @@ example\_plugin.py
ctx['search'].suggestions.add('example')
return True
Currently implemented plugin entry points (a.k.a hooks)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Plugin entry points
~~~~~~~~~~~~~~~~~~~
- Pre search hook (``pre_search``)
- Post search hook (``post_search``)
- Result hook (``on_result``) (is called if a new result is added (see
https\_rewrite plugin))
Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.
Feel free to add more hooks to the code if it is required by a plugin.
Pre search hook
```````````````
TODO
~~~~
Runs BEFORE the search request. Function to implement: ``pre_search``
- Better documentation
- More hooks
- search hook (is called while searx is requesting results (for
example: things like math-solver), the different hooks are running
parallel)
Post search hook
````````````````
Runs AFTER the search request. Function to implement: ``post_search``
Result hook
```````````
Runs when a new result is added to the result list. Function to implement: ``on_result``

19
_sources/dev/search_api.txt
View File

@ -1,13 +1,20 @@
Search API
==========
Search API endpoints: ``/``, ``/search``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
Endpoints have equivalent functionality.
Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
.. code:: sh
GET /
.. code:: sh
GET /search
Parameters
^^^^^^^^^^
``````````
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| Name | Description | |
@ -18,7 +25,7 @@ Parameters
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| ``engines`` | Comma separated list, specifies the active search engines | optional |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| ``lang`` | Code of the language | optional (default: ``all``) |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| ``pageno`` | Search page number | optional (default: ``1``) |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
Both ``GET`` and ``POST`` methods are supported.

21
_sources/index.txt
View File

@ -1,7 +1,7 @@
Privacy-respecting free metasearch engine
=========================================
Welcome to searx
================
Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
Features
@ -15,16 +15,26 @@ Features
- Does not collect its users data
- Offers secure, encrypted connections (HTTPS/SSL)
- Hosted by organisations, such as La Quadrature du Net, which promote digital rights
- About 70 supported search engines
- Easy intergration with any search engine
Further reading
---------------
User documentation
------------------
.. toctree::
:maxdepth: 1
user/search_syntax
Administrator documentation
---------------------------
.. toctree::
:maxdepth: 1
dev/install/installation
admin/api
Developer documentation
-----------------------
@ -34,7 +44,6 @@ Developer documentation
dev/quickstart
dev/contribution_guide
dev/install/installation
dev/engine_overview
dev/search_api
dev/plugins

146
admin/api.html Normal file
View File

@ -0,0 +1,146 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Administration API &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
<link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
<link rel="prev" title="Installation" href="../dev/install/installation.html" />
<link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="administration-api">
<span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline"></a></h1>
<div class="section" id="get-configuration-data">
<h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline"></a></h2>
<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
</pre></div>
</div>
<div class="section" id="sample-response">
<h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline"></a></h3>
<div class="code sh highlight-default"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;map&quot;</span><span class="p">,</span>
<span class="s">&quot;it&quot;</span><span class="p">,</span>
<span class="s">&quot;images&quot;</span><span class="p">,</span>
<span class="p">],</span>
<span class="s">&quot;default_locale&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;default_theme&quot;</span><span class="p">:</span> <span class="s">&quot;oscar&quot;</span><span class="p">,</span>
<span class="s">&quot;engines&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;map&quot;</span>
<span class="p">],</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;openstreetmap&quot;</span><span class="p">,</span>
<span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;osm&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;it&quot;</span>
<span class="p">],</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;arch linux wiki&quot;</span><span class="p">,</span>
<span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;al&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;images&quot;</span>
<span class="p">],</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;google images&quot;</span><span class="p">,</span>
<span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;goi&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;it&quot;</span>
<span class="p">],</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;bitbucket&quot;</span><span class="p">,</span>
<span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;bb&quot;</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="s">&quot;instance_name&quot;</span><span class="p">:</span> <span class="s">&quot;searx&quot;</span><span class="p">,</span>
<span class="s">&quot;locales&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;de&quot;</span><span class="p">:</span> <span class="s">&quot;Deutsch (German)&quot;</span><span class="p">,</span>
<span class="s">&quot;en&quot;</span><span class="p">:</span> <span class="s">&quot;English&quot;</span><span class="p">,</span>
<span class="s">&quot;eo&quot;</span><span class="p">:</span> <span class="s">&quot;Esperanto (Esperanto)&quot;</span><span class="p">,</span>
<span class="p">},</span>
<span class="s">&quot;plugins&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;HTTPS rewrite&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Vim-like hotkeys&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s">&quot;safe_search&quot;</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="sidebar_container body">
<h1>Searx</h1>
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="https://github.com/asciimoo/searx">Source</a></li>
<li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
<li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
</ul>
<hr />
<ul>
<li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
<li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
<li><a href="https://gratipay.com/searx">Gratipay</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>

10
dev/contribution_guide.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>How to contribute &mdash; searx 0.8.0 documentation</title>
<title>How to contribute &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.0',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,8 +23,8 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
<link rel="next" title="Installation" href="install/installation.html" />
<link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
<link rel="next" title="Engine overview" href="engine_overview.html" />
<link rel="prev" title="Development Quickstart" href="quickstart.html" />
@ -146,7 +146,7 @@ files, you have to install it on your system. (It can be installed easily using
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015, Adam Tauber.
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>

32
dev/engine_overview.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Engine overview &mdash; searx 0.8.0 documentation</title>
<title>Engine overview &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.0',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,9 +23,9 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
<link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
<link rel="next" title="Search API" href="search_api.html" />
<link rel="prev" title="Installation" href="install/installation.html" />
<link rel="prev" title="How to contribute" href="contribution_guide.html" />
<link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@ -190,10 +190,10 @@ overrides are the following:</p>
</div>
<div class="section" id="example-code">
<h3><a class="toc-backref" href="#id7">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline"></a></h3>
<div class="code python highlight-python"><div class="highlight"><pre><span class="c1"># engine dependent config</span>
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
<span class="n">paging</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">language_support</span> <span class="o">=</span> <span class="bp">True</span>
<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># engine dependent config</span>
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;general&#39;</span><span class="p">]</span>
<span class="n">paging</span> <span class="o">=</span> <span class="k">True</span>
<span class="n">language_support</span> <span class="o">=</span> <span class="k">True</span>
</pre></div>
</div>
</div>
@ -313,17 +313,17 @@ used to specify a search request:</p>
</div>
<div class="section" id="id1">
<h3><a class="toc-backref" href="#id11">example code</a><a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="code python highlight-python"><div class="highlight"><pre><span class="c1"># search-url</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://example.com/&#39;</span>
<span class="n">search_string</span> <span class="o">=</span> <span class="s1">&#39;search?{query}&amp;page={page}&#39;</span>
<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># search-url</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="s">&#39;https://example.com/&#39;</span>
<span class="n">search_string</span> <span class="o">=</span> <span class="s">&#39;search?{query}&amp;page={page}&#39;</span>
<span class="c1"># do search-request</span>
<span class="c"># do search-request</span>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<span class="k">return</span> <span class="n">params</span>
</pre></div>
@ -582,7 +582,7 @@ Currently the following media-types are supported:</p>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015, Adam Tauber.
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>

12
dev/install/installation.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation &mdash; searx 0.8.0 documentation</title>
<title>Installation &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '0.8.0',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,9 +23,9 @@
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="searx 0.8.0 documentation" href="../../index.html" />
<link rel="next" title="Engine overview" href="../engine_overview.html" />
<link rel="prev" title="How to contribute" href="../contribution_guide.html" />
<link rel="top" title="searx 0.9.0 documentation" href="../../index.html" />
<link rel="next" title="Administration API" href="../../admin/api.html" />
<link rel="prev" title="Search syntax" href="../../user/search_syntax.html" />
<link media="only screen and (max-device-width: 480px)" href="../../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@ -332,7 +332,7 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015, Adam Tauber.
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>

38
dev/plugins.html
View File

@ -41,10 +41,10 @@
<div class="section" id="plugins">
<h1>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline"></a></h1>
<p>Plugins can extend/replace functionality of various components inside
<p>Plugins can extend or replace functionality of various components of
searx.</p>
<div class="section" id="example-plugin-py">
<h2>example_plugin.py<a class="headerlink" href="#example-plugin-py" title="Permalink to this headline"></a></h2>
<div class="section" id="example-plugin">
<h2>Example plugin<a class="headerlink" href="#example-plugin" title="Permalink to this headline"></a></h2>
<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>
<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>
<span class="n">default_on</span> <span class="o">=</span> <span class="k">False</span> <span class="c"># disable by default</span>
@ -62,25 +62,21 @@ searx.</p>
</pre></div>
</div>
</div>
<div class="section" id="currently-implemented-plugin-entry-points-a-k-a-hooks">
<h2>Currently implemented plugin entry points (a.k.a hooks)<a class="headerlink" href="#currently-implemented-plugin-entry-points-a-k-a-hooks" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Pre search hook (<code class="docutils literal"><span class="pre">pre_search</span></code>)</li>
<li>Post search hook (<code class="docutils literal"><span class="pre">post_search</span></code>)</li>
<li>Result hook (<code class="docutils literal"><span class="pre">on_result</span></code>) (is called if a new result is added (see
https_rewrite plugin))</li>
</ul>
<p>Feel free to add more hooks to the code if it is required by a plugin.</p>
<div class="section" id="plugin-entry-points">
<h2>Plugin entry points<a class="headerlink" href="#plugin-entry-points" title="Permalink to this headline"></a></h2>
<p>Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.</p>
<div class="section" id="pre-search-hook">
<h3>Pre search hook<a class="headerlink" href="#pre-search-hook" title="Permalink to this headline"></a></h3>
<p>Runs BEFORE the search request. Function to implement: <code class="docutils literal"><span class="pre">pre_search</span></code></p>
</div>
<div class="section" id="post-search-hook">
<h3>Post search hook<a class="headerlink" href="#post-search-hook" title="Permalink to this headline"></a></h3>
<p>Runs AFTER the search request. Function to implement: <code class="docutils literal"><span class="pre">post_search</span></code></p>
</div>
<div class="section" id="result-hook">
<h3>Result hook<a class="headerlink" href="#result-hook" title="Permalink to this headline"></a></h3>
<p>Runs when a new result is added to the result list. Function to implement: <code class="docutils literal"><span class="pre">on_result</span></code></p>
</div>
<div class="section" id="todo">
<h2>TODO<a class="headerlink" href="#todo" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Better documentation</li>
<li>More hooks</li>
<li>search hook (is called while searx is requesting results (for
example: things like math-solver), the different hooks are running
parallel)</li>
</ul>
</div>
</div>

10
dev/quickstart.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Development Quickstart &mdash; searx 0.8.0 documentation</title>
<title>Development Quickstart &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.0',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,9 +23,9 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
<link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
<link rel="next" title="How to contribute" href="contribution_guide.html" />
<link rel="prev" title="Search syntax" href="../user/search_syntax.html" />
<link rel="prev" title="Administration API" href="../admin/api.html" />
<link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@ -154,7 +154,7 @@ locally before creating a PR.</p>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015, Adam Tauber.
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>

17
dev/search_api.html
View File

@ -41,9 +41,13 @@
<div class="section" id="search-api">
<h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline"></a></h1>
<div class="section" id="search-api-endpoints-search">
<h2>Search API endpoints: <code class="docutils literal"><span class="pre">/</span></code>, <code class="docutils literal"><span class="pre">/search</span></code><a class="headerlink" href="#search-api-endpoints-search" title="Permalink to this headline"></a></h2>
<p>Endpoints have equivalent functionality.</p>
<p>The search supports both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code>. However, using <code class="docutils literal"><span class="pre">GET</span></code> the parameters of the request remain hidden. So it is advised to use <code class="docutils literal"><span class="pre">GET</span></code> for querying.</p>
<p>Furthermore, two enpoints <code class="docutils literal"><span class="pre">/</span></code> and <code class="docutils literal"><span class="pre">/search</span></code> are available for querying.</p>
<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span>
</pre></div>
</div>
<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">search</span>
</pre></div>
</div>
<div class="section" id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline"></a></h2>
@ -72,13 +76,16 @@
<td>Comma separated list, specifies the active search engines</td>
<td>optional</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pageno</span></code></td>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lang</span></code></td>
<td>Code of the language</td>
<td>optional (default: <code class="docutils literal"><span class="pre">all</span></code>)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">pageno</span></code></td>
<td>Search page number</td>
<td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
</tr>
</tbody>
</table>
<p>Both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code> methods are supported.</p>
</div>
</div>

28
dev/translation.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Translation &mdash; searx 0.8.0 documentation</title>
<title>Translation &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.0',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
<link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
<link rel="prev" title="Plugins" href="plugins.html" />
@ -43,13 +43,13 @@
<p>run these commands in the root directory of searx</p>
<div class="section" id="add-new-language">
<h2>Add new language<a class="headerlink" href="#add-new-language" title="Permalink to this headline"></a></h2>
<div class="code shell highlight-python"><div class="highlight"><pre>pybabel init -i messages.pot -d searx/translations -l it
<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>
</pre></div>
</div>
</div>
<div class="section" id="update-po-files">
<h2>Update .po files<a class="headerlink" href="#update-po-files" title="Permalink to this headline"></a></h2>
<div class="code shell highlight-python"><div class="highlight"><pre>./utils/update-translations.sh
<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>
</pre></div>
</div>
<p>You may have errors here. In that case, edit the
@ -59,7 +59,7 @@
</div>
<div class="section" id="compile-translations">
<h2>Compile translations<a class="headerlink" href="#compile-translations" title="Permalink to this headline"></a></h2>
<div class="code shell highlight-python"><div class="highlight"><pre>pybabel compile -d searx/translations
<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>
</pre></div>
</div>
</div>
@ -67,10 +67,10 @@
<h2>Transifex stuff<a class="headerlink" href="#transifex-stuff" title="Permalink to this headline"></a></h2>
<div class="section" id="init-project">
<h3>Init Project<a class="headerlink" href="#init-project" title="Permalink to this headline"></a></h3>
<div class="code shell highlight-python"><div class="highlight"><pre>tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
<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>
tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39; \
--source-lang en --type PO --source-file messages.pot --execute
<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> \
<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>
</pre></div>
</div>
<p><a class="reference external" href="http://docs.transifex.com/client/init/">http://docs.transifex.com/client/init/</a></p>
@ -78,27 +78,27 @@ tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_
</div>
<div class="section" id="get-translations">
<h3>Get translations<a class="headerlink" href="#get-translations" title="Permalink to this headline"></a></h3>
<div class="code shell highlight-python"><div class="highlight"><pre>tx pull -a
<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>
</pre></div>
</div>
<p><a class="reference external" href="http://docs.transifex.com/client/pull">http://docs.transifex.com/client/pull</a></p>
</div>
<div class="section" id="upload-source-file">
<h3>Upload source File<a class="headerlink" href="#upload-source-file" title="Permalink to this headline"></a></h3>
<div class="code shell highlight-python"><div class="highlight"><pre>tx push -s
<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>
</pre></div>
</div>
</div>
<div class="section" id="upload-all-translation">
<h3>Upload all Translation<a class="headerlink" href="#upload-all-translation" title="Permalink to this headline"></a></h3>
<div class="code shell highlight-python"><div class="highlight"><pre>tx push -s -t
<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>
</pre></div>
</div>
</div>
</div>
<div class="section" id="upload-specifc-translation">
<h2>upload specifc Translation<a class="headerlink" href="#upload-specifc-translation" title="Permalink to this headline"></a></h2>
<div class="code shell highlight-python"><div class="highlight"><pre>tx push -t -l tr
<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>
</pre></div>
</div>
<p><a class="reference external" href="http://docs.transifex.com/client/push">http://docs.transifex.com/client/push</a></p>
@ -130,7 +130,7 @@ tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015, Adam Tauber.
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>

24
index.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Privacy-respecting free metasearch engine &mdash; searx 0.9.0 documentation</title>
<title>Welcome to searx &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -38,9 +38,9 @@
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="privacy-respecting-free-metasearch-engine">
<h1>Privacy-respecting free metasearch engine<a class="headerlink" href="#privacy-respecting-free-metasearch-engine" title="Permalink to this headline"></a></h1>
<p>Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
<div class="section" id="welcome-to-searx">
<h1>Welcome to searx<a class="headerlink" href="#welcome-to-searx" title="Permalink to this headline"></a></h1>
<p>Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
<blockquote>
@ -53,24 +53,34 @@
<li>Does not collect its users data</li>
<li>Offers secure, encrypted connections (HTTPS/SSL)</li>
<li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
<li>About 70 supported search engines</li>
<li>Easy intergration with any search engine</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="further-reading">
<h2>Further reading<a class="headerlink" href="#further-reading" title="Permalink to this headline"></a></h2>
<div class="section" id="user-documentation">
<h2>User documentation<a class="headerlink" href="#user-documentation" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/search_syntax.html">Search syntax</a></li>
</ul>
</div>
</div>
<div class="section" id="administrator-documentation">
<h2>Administrator documentation<a class="headerlink" href="#administrator-documentation" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/api.html">Administration API</a></li>
</ul>
</div>
</div>
<div class="section" id="developer-documentation">
<h2>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev/quickstart.html">Development Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/contribution_guide.html">How to contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/engine_overview.html">Engine overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/search_api.html">Search API</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/plugins.html">Plugins</a></li>

2
searchindex.js
View File

@ -1 +1 @@
Search.setIndex({envversion:49,filenames:["dev/plugins","dev/search_api","index"],objects:{},objnames:{},objtypes:{},terms:{"default":[0,1,2],"function":[0,1],"new":0,"return":0,"static":0,"true":0,"while":[0,2],about:2,activ:1,add:0,addition:2,aggreg:2,anonym:2,attach:0,better:0,both:1,call:0,callback:0,can:[0,2],categori:1,code:0,collect:2,comma:1,compon:0,connect:2,context:0,contribut:2,cooki:2,css:0,css_depend:0,ctx:0,data:2,def:0,default_on:0,descript:[0,1],differ:0,digit:2,disabl:0,document:0,doe:2,encrypt:2,engin:1,engine:2,equival:1,exampl:0,extend:0,fals:0,feel:0,file:0,flask:0,free:0,from:2,get:1,have:1,host:2,how:2,https:2,https_rewrit:0,inform:2,insid:0,installat:2,internet:2,js_depend:0,like:0,list:[0,1],local:0,math:0,method:1,more:0,name:[0,1],net:2,nor:2,number:1,object:0,offer:2,on_result:0,onlin:2,option:[0,1],organis:2,other:2,over:2,overview:2,page:1,pageno:1,parallel:0,parti:2,post:[0,1],post_search:0,pre:0,pre_search:0,profil:2,promot:2,quadratur:2,queri:1,quickstart:2,replac:0,request:0,requir:[0,1],result:[0,2],right:2,run:0,search:0,searx:[0,2],secur:2,see:[0,1],self:2,separ:1,share:2,softwar:2,solver:0,specifi:1,ssl:2,store:2,suggest:0,support:1,syntax:[1,2],thi:0,thing:0,third:2,tor:2,track:2,translat:2,tupl:0,user:2,variou:0,which:2,whole:0,word:0},titles:["Plugins","Search API","Privacy-respecting free metasearch engine"],titleterms:{api:1,current:0,develop:2,document:2,endpoint:1,engin:2,entri:0,example_plugin:0,featur:2,free:2,further:2,hook:0,implement:0,metasearch:2,paramet:1,plugin:0,point:0,privaci:2,read:2,respect:2,search:1,todo:0}})
Search.setIndex({envversion:49,filenames:["dev/plugins","dev/search_api","index"],objects:{},objnames:{},objtypes:{},terms:{"default":[0,1,2],"function":0,"new":0,"return":0,"static":0,"true":0,"while":2,about:2,activ:1,add:0,addition:2,advis:1,after:0,aggreg:2,all:1,ani:2,anonym:2,attach:0,avail:1,before:0,behaviour:0,both:1,callback:0,can:[0,2],categori:1,code:1,collect:2,comma:1,compon:0,connect:2,context:0,contribut:2,cooki:2,css:0,css_depend:0,ctx:0,data:2,def:0,default_on:0,defin:0,descript:[0,1],digit:2,disabl:0,doe:2,easi:2,encrypt:2,engin:[],engine:2,enpoint:1,entry:0,extend:0,fals:0,feel:0,file:0,fit:0,flask:0,free:[],from:2,furthermor:1,get:1,hidden:1,host:2,how:2,howev:1,https:2,implement:0,inform:2,installat:2,intergr:2,internet:2,js_depend:0,lang:1,languag:1,list:[0,1],local:0,more:2,name:[0,1],net:2,nor:2,now:0,number:1,object:0,offer:2,on_result:0,onli:0,onlin:2,option:[0,1],organis:2,over:2,overview:2,page:1,pageno:1,parti:2,post_search:0,pre_search:0,profil:2,promot:2,quadratur:2,queri:1,quickstart:2,remain:1,replac:0,request:[0,1],requir:1,right:[0,2],run:0,searx:0,secur:2,see:1,self:2,separ:1,share:2,softwar:2,specifi:1,ssl:2,store:2,suggest:0,support:[1,2],syntax:[1,2],than:2,thi:0,third:2,three:0,tor:2,track:2,translat:2,tupl:0,two:1,variou:0,when:0,which:2,whole:0,word:0,your:0},titles:["Plugins","Search API","Welcome to searx"],titleterms:{administr:2,api:1,develop:2,doc:[],document:2,engin:[],entri:0,exampl:0,featur:2,free:[],hook:0,metasearch:[],paramet:1,plugin:0,point:0,post:0,pre:0,privaci:[],respect:[],result:0,search:[0,1],searx:2,user:2,welcom:2}})

10
user/search_syntax.html
View File

@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search syntax &mdash; searx 0.8.0 documentation</title>
<title>Search syntax &mdash; searx 0.9.0 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -14,7 +14,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.0',
VERSION: '0.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,8 +23,8 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
<link rel="next" title="How to contribute" href="../dev/contribution_guide.html" />
<link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
<link rel="next" title="Installation" href="../dev/install/installation.html" />
<link rel="prev" title="Privacy-respecting free metasearch engine" href="../index.html" />
@ -90,7 +90,7 @@ list of engines, categories and languages.</p>
<div class="clearer"></div>
</div>
<div class="footer">
&copy; Copyright 2015, Adam Tauber.
&copy; Copyright 2015-2016, Adam Tauber.
</div>
</body>
</html>