diff --git a/_sources/admin/api.txt b/_sources/admin/api.txt new file mode 100644 index 00000000..94508a28 --- /dev/null +++ b/_sources/admin/api.txt @@ -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 + } diff --git a/_sources/dev/plugins.txt b/_sources/dev/plugins.txt index c51fdf0e..0f52af0d 100644 --- a/_sources/dev/plugins.txt +++ b/_sources/dev/plugins.txt @@ -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`` diff --git a/_sources/dev/search_api.txt b/_sources/dev/search_api.txt index cd86fd71..59d3c825 100644 --- a/_sources/dev/search_api.txt +++ b/_sources/dev/search_api.txt @@ -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. diff --git a/_sources/index.txt b/_sources/index.txt index d6e21894..c24eff4d 100644 --- a/_sources/index.txt +++ b/_sources/index.txt @@ -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 diff --git a/_static/basic.css b/_static/basic.css index 9fa77d88..2b513f0c 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -52,6 +52,8 @@ div.sphinxsidebar { width: 230px; margin-left: -100%; font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; } div.sphinxsidebar ul { @@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] { width: 170px; } -div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; -} - img { border: 0; max-width: 100%; @@ -187,6 +185,13 @@ div.genindex-jumpbox { /* -- general body styles --------------------------------------------------- */ +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + a.headerlink { visibility: hidden; } diff --git a/_static/doctools.js b/_static/doctools.js index c7bfe760..81634956 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -124,6 +124,7 @@ var Documentation = { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); + }, /** @@ -252,6 +253,29 @@ var Documentation = { }); var url = parts.join('/'); return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keyup(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); } }; @@ -260,4 +284,4 @@ _ = Documentation.gettext; $(document).ready(function() { Documentation.init(); -}); +}); \ No newline at end of file diff --git a/_static/pygments.css b/_static/pygments.css index 8213e90b..57eadc03 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -4,10 +4,8 @@ .highlight .err { border: 1px solid #FF0000 } /* Error */ .highlight .k { color: #007020; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ .highlight .cp { color: #007020 } /* Comment.Preproc */ -.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ diff --git a/_static/searchtools.js b/_static/searchtools.js index efec3c43..066857ce 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -2,9 +2,9 @@ * searchtools.js_t * ~~~~~~~~~~~~~~~~ * - * Sphinx JavaScript utilties for the full-text search. + * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -623,7 +623,7 @@ var Search = { * helper function to return a node containing the * search summary for a given text. keywords is a list * of stemmed words, hlwords is the list of normal, unstemmed - * words. the first one is used to find the occurance, the + * words. the first one is used to find the occurrence, the * latter for highlighting it. */ makeSearchSummary : function(text, keywords, hlwords) { diff --git a/_static/style.css b/_static/style.css index facb30df..12dd187e 100644 --- a/_static/style.css +++ b/_static/style.css @@ -38,6 +38,8 @@ div.bodywrapper { div.sphinxsidebar { width: 220px; + word-wrap: normal !important; + overflow-wrap: normal !important; } hr { diff --git a/_static/websupport.js b/_static/websupport.js index 28d65db4..98e7f40b 100644 --- a/_static/websupport.js +++ b/_static/websupport.js @@ -2,9 +2,9 @@ * websupport.js * ~~~~~~~~~~~~~ * - * sphinx.websupport utilties for all documentation. + * sphinx.websupport utilities for all documentation. * - * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/admin/api.html b/admin/api.html new file mode 100644 index 00000000..43139771 --- /dev/null +++ b/admin/api.html @@ -0,0 +1,146 @@ + + + + + + + + Administration API — searx 0.9.0 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Administration API

+
+

Get configuration data

+
GET /config
+
+
+
+

Sample response

+
{
+  "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
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
+ © Copyright 2015-2016, Adam Tauber. +
+ + \ No newline at end of file diff --git a/dev/contribution_guide.html b/dev/contribution_guide.html index 3d070bf7..88860f9c 100644 --- a/dev/contribution_guide.html +++ b/dev/contribution_guide.html @@ -6,7 +6,7 @@ - How to contribute — searx 0.8.0 documentation + How to contribute — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - - + + @@ -146,7 +146,7 @@ files, you have to install it on your system. (It can be installed easily using
- © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
\ No newline at end of file diff --git a/dev/engine_overview.html b/dev/engine_overview.html index d5eef0a0..0476f907 100644 --- a/dev/engine_overview.html +++ b/dev/engine_overview.html @@ -6,7 +6,7 @@ - Engine overview — searx 0.8.0 documentation + Engine overview — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - + - + @@ -190,10 +190,10 @@ overrides are the following:

example code

-
# engine dependent config
-categories = ['general']
-paging = True
-language_support = True
+
# engine dependent config
+categories = ['general']
+paging = True
+language_support = True
@@ -313,17 +313,17 @@ used to specify a search request:

example code

-
# search-url
-base_url = 'https://example.com/'
-search_string = 'search?{query}&page={page}'
+
# search-url
+base_url = 'https://example.com/'
+search_string = 'search?{query}&page={page}'
 
-# do search-request
+# do search-request
 def request(query, params):
     search_path = search_string.format(
-        query=urlencode({'q': query}),
-        page=params['pageno'])
+        query=urlencode({'q': query}),
+        page=params['pageno'])
 
-    params['url'] = base_url + search_path
+    params['url'] = base_url + search_path
 
     return params
 

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

       

     

     

-      © Copyright 2015, Adam Tauber.
+      © Copyright 2015-2016, Adam Tauber.
     

   
 
\ No newline at end of file
diff --git a/dev/install/installation.html b/dev/install/installation.html
index 56fc8770..19043b62 100644
--- a/dev/install/installation.html
+++ b/dev/install/installation.html
@@ -6,7 +6,7 @@
   
     
     
-    Installation — searx 0.8.0 documentation
+    Installation — searx 0.9.0 documentation
     
     
     
@@ -14,7 +14,7 @@
     
     
     
-    
-    
-    
+    
+    
+    
    
   
   
@@ -332,7 +332,7 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
- © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
\ No newline at end of file diff --git a/dev/plugins.html b/dev/plugins.html index 83d33985..8fe6468d 100644 --- a/dev/plugins.html +++ b/dev/plugins.html @@ -6,7 +6,7 @@ - Plugins — searx 0.8.0 documentation + Plugins — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - + @@ -41,46 +41,42 @@

Plugins

-

Plugins can extend/replace functionality of various components inside +

Plugins can extend or replace functionality of various components of searx.

-
-

example_plugin.py

-
name = 'Example plugin'
-description = 'This plugin extends the suggestions with the word "example"'
-default_on = False  # disable by default
+

+
Example plugin

+
name = 'Example plugin'
+description = 'This plugin extends the suggestions with the word "example"'
+default_on = False  # disable by default
 
-js_dependencies = tuple()  # optional, list of static js files
-css_dependencies = tuple()  # optional, list of static css files
+js_dependencies = tuple()  # optional, list of static js files
+css_dependencies = tuple()  # optional, list of static css files
 
 
-# attach callback to the post search hook
-#  request: flask request object
-#  ctx: the whole local context of the post search hook
+# attach callback to the post search hook
+#  request: flask request object
+#  ctx: the whole local context of the post search hook
 def post_search(request, ctx):
-    ctx['search'].suggestions.add('example')
-    return True
+    ctx['search'].suggestions.add('example')
+    return True
 

 

 

-

-
Currently implemented plugin entry points (a.k.a hooks)

-
    
-
  • 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))
    • 
-

-
Feel free to add more hooks to the code if it is required by a plugin.

+

+
Plugin entry points

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

+

+
Pre search hook

+
Runs BEFORE the search request. Function to implement: pre_search

+

+

+
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

 

-

-
TODO

-
    
-
  • 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)
    • 
-

 

 

 
@@ -109,7 +105,7 @@ parallel)
       

     

     

-      © Copyright 2015, Adam Tauber.
+      © Copyright 2015-2016, Adam Tauber.
     

   
 
\ No newline at end of file
diff --git a/dev/quickstart.html b/dev/quickstart.html
index a1fa0091..7074f1d2 100644
--- a/dev/quickstart.html
+++ b/dev/quickstart.html
@@ -6,7 +6,7 @@
   
     
     
-    Development Quickstart — searx 0.8.0 documentation
+    Development Quickstart — searx 0.9.0 documentation
     
     
     
@@ -14,7 +14,7 @@
     
     
     
-    
+    
     
-    
+    
    
   
   
@@ -154,7 +154,7 @@ locally before creating a PR.
- © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
\ No newline at end of file diff --git a/dev/search_api.html b/dev/search_api.html index f616c4cc..eb583b41 100644 --- a/dev/search_api.html +++ b/dev/search_api.html @@ -6,7 +6,7 @@ - Search API — searx 0.8.0 documentation + Search API — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - + @@ -41,9 +41,13 @@

Search API

- @@ -107,7 +114,7 @@
- © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
\ No newline at end of file diff --git a/dev/translation.html b/dev/translation.html index ce142422..c30f854c 100644 --- a/dev/translation.html +++ b/dev/translation.html @@ -6,7 +6,7 @@ - Translation — searx 0.8.0 documentation + Translation — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - + @@ -43,13 +43,13 @@

run these commands in the root directory of searx

Add new language

-
pybabel init -i messages.pot -d searx/translations -l it
+
pybabel init -i messages.pot -d searx/translations -l it

Update .po files

-
./utils/update-translations.sh
+
./utils/update-translations.sh
 

 

 
You may have errors here. In that case, edit the
@@ -59,7 +59,7 @@

Compile translations

-
pybabel compile -d searx/translations
+
pybabel compile -d searx/translations
@@ -67,10 +67,10 @@

Transifex stuff

Init Project

-
tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
+
tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
 
-tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \
---source-lang en --type PO --source-file messages.pot --execute
+tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \
+--source-lang en --type PO --source-file messages.pot --execute
 

 

 
http://docs.transifex.com/client/init/

@@ -78,27 +78,27 @@ tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_

Get translations

-
tx pull -a
+
tx pull -a
 

 

 
http://docs.transifex.com/client/pull

Upload source File

-
tx push -s
+
tx push -s

Upload all Translation

-
tx push -s -t
+
tx push -s -t

upload specifc Translation

-
tx push -t -l tr
+
tx push -t -l tr
 

 

 
http://docs.transifex.com/client/push

@@ -130,7 +130,7 @@ tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_
- © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
\ No newline at end of file diff --git a/docs/_themes/searx_theme/static/style.css_t b/docs/_themes/searx_theme/static/style.css_t index 4a266671..0a312b76 100644 --- a/docs/_themes/searx_theme/static/style.css_t +++ b/docs/_themes/searx_theme/static/style.css_t @@ -38,6 +38,8 @@ div.bodywrapper { div.sphinxsidebar { width: {{ sidebar_width }}; + word-wrap: normal !important; + overflow-wrap: normal !important; } hr { diff --git a/docs/admin/api.rst b/docs/admin/api.rst new file mode 100644 index 00000000..94508a28 --- /dev/null +++ b/docs/admin/api.rst @@ -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 + } diff --git a/docs/conf.py b/docs/conf.py index 30fe9031..b1392bab 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,7 +49,7 @@ master_doc = 'index' # General information about the project. project = u'searx' -copyright = u'2015, Adam Tauber' +copyright = u'2015-2016, Adam Tauber' author = u'Adam Tauber' # The version info for the project you're documenting, acts as replacement for @@ -57,9 +57,9 @@ author = u'Adam Tauber' # built documents. # # The short X.Y version. -version = '0.8.0' +version = '0.9.0' # The full version, including alpha/beta/rc tags. -release = '0.8.0' +release = '0.9.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst index c51fdf0e..0f52af0d 100644 --- a/docs/dev/plugins.rst +++ b/docs/dev/plugins.rst @@ -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`` diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index cd86fd71..59d3c825 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -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. diff --git a/docs/index.rst b/docs/index.rst index d6e21894..c24eff4d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/genindex.html b/genindex.html index 39fa251d..7103651a 100644 --- a/genindex.html +++ b/genindex.html @@ -7,7 +7,7 @@ - Index — searx 0.8.0 documentation + Index — searx 0.9.0 documentation @@ -15,7 +15,7 @@ - + @@ -73,7 +73,7 @@
- © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
\ No newline at end of file diff --git a/index.html b/index.html index 1a07c58b..f7315f0f 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,7 @@ - Privacy-respecting free metasearch engine — searx 0.8.0 documentation + Welcome to searx — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - + @@ -38,9 +38,9 @@
-
-

Privacy-respecting free metasearch engine

-

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.

+
+

Welcome to searx

+

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

@@ -53,24 +53,34 @@
  • 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

    +
    +

    Administrator documentation

    +
    + +
    +

    Developer documentation

    - © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
    \ No newline at end of file diff --git a/objects.inv b/objects.inv index 15d8128d..41e76b18 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/search.html b/search.html index 32bbfbcb..0d944add 100644 --- a/search.html +++ b/search.html @@ -6,7 +6,7 @@ - Search — searx 0.8.0 documentation + Search — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - + @@ -93,7 +93,7 @@
    - © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
    \ No newline at end of file diff --git a/searchindex.js b/searchindex.js index a16afc77..81c01143 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:46,filenames:["dev/contribution_guide","dev/engine_overview","dev/install/installation","dev/plugins","dev/search_api","dev/translation","index","user/search_syntax"],objects:{},objnames:{},objtypes:{},terms:{"boolean":1,"break":0,"byte":1,"case":5,"char":[],"default":[],"function":[1,3,4],"import":2,"int":1,"new":[],"null":2,"return":[],"static":3,"switch":0,"true":[1,2,3],"while":[3,6],a2enmod:2,abbrev:7,abl:[0,1],about:[0,2,6],abov:[0,2],accept:7,access_log:2,activ:[2,4],adapt:1,add:[],addit:[1,2],addition:6,address:1,adopt:0,adress:1,after:5,agent:1,aggreg:6,all:[],allow:[2,7],alreadi:0,also:[0,2,7],alter:0,alwai:1,among:0,anonym:6,anoth:1,apache2:2,api_kei:1,app:2,appli:[0,2],applic:2,appreci:[],appropri:0,apt:2,arbitrari:1,arrai:1,asciimoo:[2,5],aspect:0,assign:1,attach:3,author:0,auto:5,avail:2,back:2,base:1,base_url:[1,2],bash:2,becaus:[0,1],behaviour:0,below:[0,2],better:[1,2,3],between:1,bin:2,born:0,both:[0,4],boundingbox:1,branch:0,browser:0,bugreport:0,build:[0,2],built:[0,1],calcul:[],call:3,callback:3,can:[0,1,2,3,5,6],capabl:0,care:[],categori:[1,4,7],certif:2,chainabl:7,chang:[2,5],chapter:0,charact:0,chdir:2,checkout:0,chmod:2,choos:[0,1],chown:2,citi:1,client:5,clone:2,collect:6,com:[1,2,5],combin:2,come:0,comma:4,command:[2,5],compon:3,concern:0,conf:2,config:[1,2],connect:6,consequ:0,construct:1,contain:[],content:[],context:3,convent:0,cooki:[1,6],corner:0,could:1,count:2,countri:1,coupl:2,cpu:2,creat:[0,2],css:3,css_depend:3,cthulhu:7,ctx:3,current:[],custom:[0,7],customlog:2,data:[1,6],date:1,datetim:1,ddg:7,debian:2,debug:2,decim:1,def:[1,3],default_on:3,demon:2,depend:[1,2],deploi:2,descript:[3,4],deserv:0,desir:1,dev:2,develop:[],deviat:[],differ:[0,1,3],digit:6,directori:5,disrespect:0,doc:5,dockerfil:2,doe:[1,6],doesn:[],domain:2,domin:0,don:[],duckduckgo:7,easili:0,edit:[0,2,5],educ:[],effect:0,embed:2,empti:[],en_u:1,enabl:[0,2],encrypt:6,engin:[],enough:[],enter:2,equival:4,error:5,error_log:2,essenti:2,etc:[0,2],everi:1,everyth:2,exampl:[],except:0,execut:5,exist:0,exit:2,expand:[],expect:0,explain:0,extend:[0,3],extens:0,extern:1,facil:[],fals:[2,3],fanci:0,featur:[],feedback:0,feel:3,few:[0,1],file:[],filenam:1,files:1,fill:[],fine:2,fix:0,flask:3,folder:[0,1],follow:[0,1],followsymlink:2,forget:[],fork:0,format:1,free:[],from:[],further:[],furthermor:1,geojson:1,get:[],gid:2,git:2,github:2,give:1,goal:[],goe:[],good:0,grant:2,hack:0,hackerspac:7,handler:2,happen:[],happi:0,have:[0,1,2,4,5],header:1,here:5,hex:2,highli:[],hour:2,hous:1,house_numb:1,howev:1,html:[0,1],http:[1,2,5,6],https_rewrit:3,hub:2,imag:[],img_src:1,implement:[],includ:2,inclus:7,index:2,inform:[0,1,2,6],ini:2,init:[],insert:[],insid:[1,3],instanc:[2,5],intent:0,interfer:0,internet:6,interpret:2,interpretor:2,iso:1,itself:0,js_depend:3,kei:1,known:[],lack:0,lang:5,language_support:1,lat:1,latitud:1,lc_messag:5,least:[],leech:1,leecher:1,length:0,level:0,libapache2:2,libffi:2,librari:[],libssl:2,libxslt:2,light:2,like:[1,2,3],line:0,list:[1,3,4,7],listen:2,local:[1,2,3,5],localhost:2,locat:2,lon:1,longitud:1,magnet_uri_schem:[],magnetlink:1,mai:5,main:[],make:[],manag:2,manner:[],map:[],mass:0,master:2,math:3,matter:1,max:1,maxim:0,maximis:[],maximum:[0,1],mayb:[],media:1,messag:5,messagespo:5,meta:[],method:[1,4],might:0,min:1,misbehav:0,mod:2,modif:[],modifi:[5,7],modul:2,more:[2,3],most:[],multibl:1,must:[0,1],name:[1,2,3,4],necessari:2,need:0,net:6,none:1,nor:6,normal:1,note:[0,2],number:[1,2,4],number_of_result:1,object:[1,3],observ:[],off:0,offer:6,often:1,okhin:2,on_result:3,onli:[],onlin:6,openssl:2,option:[1,2,3,4],order:0,org:1,organis:6,origin:2,osm:1,other:[0,1,6],otherwis:1,out:0,over:6,overwrit:[],overwritten:1,packag:2,page:[0,1,4,7],pageno:[1,4],pagenumb:1,parallel:3,param:1,paramt:1,parti:6,partli:1,patch:0,path:2,pep8:0,per:1,perform:1,perserv:[],pip:0,place:[0,1],pleas:0,plenti:0,plugin:[],point:[],port:2,possibl:2,post:[0,2,3,4],post_search:3,postcod:1,pot:5,pre:3,pre_search:3,prefer:7,prefix:7,preserv:0,preview:1,proce:2,profil:6,promot:6,protect:0,provid:[0,1],publish:1,publishedd:1,pull:[0,2,5],purpos:1,push:5,pybabel2:5,pybabel:[2,5],python2:5,python:2,pythonpath:2,quadratur:6,queri:[1,4,7],quit:0,qwer:7,rand:2,random:1,realli:[],recommend:1,reconsid:0,redefin:1,reduc:0,rememb:0,replac:3,repo:0,repositori:2,repres:1,request:[],requir:[0,1,3,4],respec:[],respect:[],restart:2,result:[],rewrit:2,right:[2,6],road:1,root:[2,5],round:0,rst:0,run:[2,3,5],same:1,script:5,script_nam:2,search:[],search_path:1,search_str:1,searx:[],secur:6,sed:2,see:[2,3,4,7],seed:1,seeder:1,select:7,self:6,separ:[0,4],seper:[],server_nam:2,servic:2,set:[],sethandl:2,setup:2,share:6,shortcut:1,should:[0,2],simpli:0,sinc:[],singl:2,site:[1,2],size:1,small:1,socket:2,softwar:6,solver:3,some:2,someth:0,sourc:[],special:1,specif:[1,2],specifi:[1,4],sphinx:0,ssl:[1,2,6],standard:[0,1],start:[1,2],stash:2,step:[0,2,5],store:[1,6],street:1,string:1,submit:0,sudo:2,suggest:3,support:[0,1,4],sure:2,syntax:[],system:0,take:0,taken:[],tell:1,templat:1,test:[0,2],text:1,thi:[1,2,3,5],thing:3,think:0,third:6,three:0,thu:[],thumbnail:1,thumbnail_src:1,time:1,timeout:1,titl:1,tld:2,tool:0,tor:6,torrentfil:1,toward:[],track:6,transifex:[],try_fil:2,tupl:3,turn:0,twice:2,two:0,txt:0,type:[1,5],ubuntu:2,uid:2,ultrasecretkei:2,uncommon:0,under:[0,1],unfortun:0,unit:0,univers:2,unix:2,unspecifi:1,updat:[],update_packag:2,upgrad:[],uri:2,urlencod:1,user:[0,1,2,6],useradd:2,usr:2,usual:2,util:5,uwsgi_modifier1:2,uwsgi_param:2,uwsgi_pass:2,uwsgisocket:2,valid:1,valu:1,variabl:1,variou:[0,3],vendor:0,verifi:1,via:7,virtual:2,virtualenv:2,wai:[0,1],want:[],warn:2,wathev:[],webapp:2,weird:0,welcom:[],what:[],whatev:2,when:1,where:[],which:[0,1,6],who:2,whole:[2,3],wide:0,width:[],wiki:[],wikipedia:7,wish:0,without:1,wonderfal:2,word:3,work:[0,1,2],worker:2,world:0,wsgi:2,www:5,yet:1,yml:[],you:[0,2,5,7],your:[0,2],yourself:0,zlib1g:2},titles:["How to contribute","Engine overview","Installation","Plugins","Search API","Translation","Privacy-respecting free metasearch engine","Search syntax"],titleterms:{"default":1,"new":5,"return":1,add:5,admin:[],all:5,apach:2,api:4,argument:1,basic:2,check:2,code:[0,1],compil:5,configur:[1,2],content:[1,2],contribut:0,current:3,design:0,develop:6,direct:0,disabl:2,docker:2,document:[0,6],endpoint:4,engin:[1,6],entri:3,exampl:[1,7],example_plugin:3,featur:6,file:[1,5],free:6,from:2,further:6,gener:1,get:5,hackabl:0,hook:3,host:2,how:[0,2],imag:1,implement:3,init:5,instal:2,languag:5,log:2,make:1,map:1,metasearch:6,nginx:2,onli:[],overrid:1,overview:1,paramet:4,pars:1,pass:1,plugin:3,point:3,prime:0,privaci:[0,6],project:5,read:6,request:1,respect:6,result:1,search:[4,7],searx:2,server:2,set:1,sourc:5,specifc:5,stuff:5,subdirectori:2,syntax:7,todo:3,torrent:1,transifex:5,translat:[0,5],updat:[2,5],upload:5,url:2,uwsgi:2,video:1,web:2,yml:1}}) \ No newline at end of file +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}}) \ No newline at end of file diff --git a/user/search_syntax.html b/user/search_syntax.html index b5e6133d..d0df6a1a 100644 --- a/user/search_syntax.html +++ b/user/search_syntax.html @@ -6,7 +6,7 @@ - Search syntax — searx 0.8.0 documentation + Search syntax — searx 0.9.0 documentation @@ -14,7 +14,7 @@ - - + + @@ -90,7 +90,7 @@ list of engines, categories and languages.

    - © Copyright 2015, Adam Tauber. + © Copyright 2015-2016, Adam Tauber.
    \ No newline at end of file