Add virtualenv package

_sources/admin/api.rst.txt

@@ -0,0 +1,94 @@
+.. _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
+    }
+
+Embed search bar
+----------------
+
+The search bar can be embedded into websites. Just paste the example into the HTML of the site.
+URL of the searx instance and values are customizable.
+
+.. code:: html
+    
+    <form method="post" action="https://searx.me/">
+        <!-- search query --> <input type="text" name="q" />
+        <!-- categories   --> <input type="hidden" name="categories" value="general,social media" />
+        <!-- language     --> <input type="hidden" name="lang" value="all" />
+        <!-- locale       --> <input type="hidden" name="locale" value="en" />
+        <!-- date filter  --> <input type="hidden" name="time_range" value="month" />
+    </form>

_sources/admin/filtron.rst.txt

@@ -0,0 +1,114 @@
+How to protect an instance
+==========================
+
+Searx depens on external search services. To avoid the abuse of these services it is advised to limit the number of requests processed by searx.
+
+An application firewall, ``filtron`` solves exactly this problem. Information on how to install it can be found at the `project page of filtron <https://github.com/asciimoo/filtron>`__.
+
+Sample configuration of filtron
+-------------------------------
+
+An example configuration can be find below. This configuration limits the access of
+
+ * scripts or applications (roboagent limit)
+
+ * webcrawlers (botlimit)
+
+ * IPs which send too many requests (IP limit)
+
+ * too many json, csv, etc. requests (rss/json limit)
+
+ * the same UserAgent of if too many requests (useragent limit)
+
+
+.. code:: json
+
+    [
+        {
+            "name": "search request",
+            "filters": ["Param:q", "Path=^(/|/search)$"],
+            "interval": <time-interval-in-sec>,
+            "limit": <max-request-number-in-interval>,
+            "subrules": [
+                {
+                    "name": "roboagent limit",
+                    "interval": <time-interval-in-sec>,
+                    "limit": <max-request-number-in-interval>,
+                    "filters": ["Header:User-Agent=(curl|cURL|Wget|python-requests|Scrapy|FeedFetcher|Go-http-client)"],
+                    "actions": [
+                        {"name": "block",
+                         "params": {"message": "Rate limit exceeded"}}
+                    ]
+                },
+                {
+                    "name": "botlimit",
+                    "limit": 0,
+                    "stop": true,
+                    "filters": ["Header:User-Agent=(Googlebot|bingbot|Baiduspider|yacybot|YandexMobileBot|YandexBot|Yahoo! Slurp|MJ12bot|AhrefsBot|archive.org_bot|msnbot|MJ12bot|SeznamBot|linkdexbot|Netvibes|SMTBot|zgrab|James BOT)"],
+                    "actions": [
+                        {"name": "block",
+                         "params": {"message": "Rate limit exceeded"}}
+                    ]
+                },
+                {
+                    "name": "IP limit",
+                    "interval": <time-interval-in-sec>,
+                    "limit": <max-request-number-in-interval>,
+                    "stop": true,
+                    "aggregations": ["Header:X-Forwarded-For"],
+                    "actions": [
+                        {"name": "block",
+                         "params": {"message": "Rate limit exceeded"}}
+                    ]
+                },
+                {
+                    "name": "rss/json limit",
+                    "interval": <time-interval-in-sec>,
+                    "limit": <max-request-number-in-interval>,
+                    "stop": true,
+                    "filters": ["Param:format=(csv|json|rss)"],
+                    "actions": [
+                        {"name": "block",
+                         "params": {"message": "Rate limit exceeded"}}
+                    ]
+                },
+                {
+                    "name": "useragent limit",
+                    "interval": <time-interval-in-sec>,
+                    "limit": <max-request-number-in-interval>,
+                    "aggregations": ["Header:User-Agent"],
+                    "actions": [
+                        {"name": "block",
+                         "params": {"message": "Rate limit exceeded"}}
+                    ]
+                }
+            ]
+        }
+    ]
+
+
+
+Route request through filtron
+-----------------------------
+
+Filtron can be started using the following command:
+
+.. code:: bash
+
+    $ filtron -rules rules.json
+
+It listens on 127.0.0.1:4004 and forwards filtered requests to 127.0.0.1:8888 by default.
+
+Use it along with ``nginx`` with the following example configuration.
+
+.. code:: bash
+
+    location / {
+        proxy_set_header        Host    $http_host;
+        proxy_set_header        X-Real-IP $remote_addr;
+        proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header        X-Scheme $scheme;
+        proxy_pass http://127.0.0.1:4004/;
+    }
+
+Requests are coming from port 4004 going through filtron and then forwarded to port 8888 where a searx is being run.

_sources/admin/morty.rst.txt

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

_sources/blog/admin.rst.txt

@@ -0,0 +1,42 @@
+Searx admin interface: manage your instance from your browser
+=============================================================
+
+One of the biggest advantages of searx is being extremely customizable. But at first it can be daunting to newcomers.
+A barrier of taking advantage of this feature is our ugly settings file which is sometimes hard to understand and edit.
+
+To make self-hosting searx more accessible a new tool is introduced, called ``searx-admin``.
+It is a web application which is capable of managing your instance and manipulating its settings via a web UI.
+It aims to replace editing of ``settings.yml`` for less experienced administrators or people
+who prefer graphical admin interfaces.
+
+.. figure:: searx-admin-engines.png
+    :scale: 50 %
+    :alt: Screenshot of engine list
+    :align: center
+    :figclass: align-center
+    
+    Configuration page of engines
+
+
+Since ``searx-admin`` acts as a supervisor for searx, we have decided to implement it
+as a standalone tool instead of part of searx. Another reason for making it a standalone
+tool is that the codebase and dependencies of searx should not grow because of a fully optional feature,
+which does not affect existing instances.
+
+
+Installation
+------------
+
+Installation guide can be found in the repository of searx-admin:
+https://github.com/kvch/searx-admin#installation--usage
+
+Acknowledgements
+----------------
+
+This development was sponsored by `NLnet Foundation`_.
+
+.. _NLnet Foundation: https://nlnet.nl/
+
+
+| Happy hacking.
+| kvch // 2017.08.22 21:25

_sources/blog/blog.rst.txt

@@ -0,0 +1,8 @@
+Blog
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   python3
+   admin

_sources/blog/python3.rst.txt

@@ -0,0 +1,54 @@
+Introducing Python3 support
+===========================
+
+As most operation systems are coming with Python3 installed by default. So it is time for searx to support Python3. But don't worry support of Python2.7 won't be dropped.
+
+.. image:: searxpy3.png
+    :scale: 50 %
+    :alt: hurray
+    :align: center
+
+
+How to run searx using Python3
+------------------------------
+
+Please make sure that you run at least Python3.5.
+
+To run searx, first a Python3 virtualenv should be created. After entering the virtualenv,
+dependencies must be installed. Then run searx with python3 instead of the usual python command.
+
+.. code:: sh
+
+    virtualenv -p python3 venv3
+    source venv3/bin/activate
+    pip3 install -r requirements.txt
+    python3 searx/webapp.py
+
+
+If you want to run searx using Python2.7, you don't have to do anything differently as before.
+
+Fun facts
+---------
+
+- 115 files were changed when implementing the support for both Python versions.
+
+- All of the dependencies was compatible except for the robotframework used for browser tests. Thus, these tests were migrated to splinter. So from now on both versions are being tested on Travis and can be tested locally.
+
+If you found bugs...
+--------------------
+
+...please open an issue on `GitHub`_. Make sure that you mention your Python version in your issue,
+so we can investigate it properly.
+
+.. _GitHub: https://github.com/asciimoo/searx/issues
+
+Acknowledgement
+---------------
+
+This development was sponsored by `NLnet Foundation`_.
+
+.. _NLnet Foundation: https://nlnet.nl/
+
+
+| Happy hacking.
+| kvch // 2017.05.13 22:57

_sources/dev/contribution_guide.rst.txt

@@ -0,0 +1,98 @@
+How to contribute
+-----------------
+
+Prime directives: Privacy, Hackability
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Searx has two prime directives, privacy-by-design and hackability. The
+hackability comes in three levels:
+
+-  support of search engines
+-  plugins to alter search behaviour
+-  hacking searx itself
+
+Note the lack of "world domination" among the directives.
+Searx has no intention of wide mass-adoption, rounded
+corners, etc. The prime directive "privacy" deserves a separate
+chapter, as it's quite uncommon unfortunately.
+
+Privacy-by-design
+^^^^^^^^^^^^^^^^^
+
+Searx was born out of the need for a privacy-respecting search tool
+which can be extended easily to maximize both its search and its
+privacy protecting capabilities.
+
+A few widely used features work differently or turned off by default or not implemented
+at all as a consequence of privacy-by-design.
+
+If a feature reduces the privacy preserving aspects of searx, it
+should be switched off by default or should not implemented at all.
+There are plenty of search engines already providing such features.
+If a feature reduces the protection of searx, users must be
+informed about the effect of choosing to enable it. Features
+that protect privacy but differ from the expectations of the
+user should also be explained.
+
+Also, if you think that something works weird with searx,
+it's might be because of the tool you use is designed in a way to interfere with
+the privacy respect. Submitting a bugreport to the vendor of the tool that
+misbehaves might be a good feedback to reconsider the disrespect to
+its customers (e.g. GET vs POST requests in various browsers).
+
+Remember the other prime directive of searx is to be hackable, so if the
+above privacy concerns do not fancy you, simply fork it.
+
+Happy hacking.
+
+Code
+~~~~
+
+In order to submit a patch, please follow the steps below:
+
+- Follow coding conventions.
+
+  - PEP8 standards apply, except the convention of line length
+
+  - Maximum line length is 120 characters
+
+- Check if your code breaks existing tests. If so, update the tests or fix your code.
+
+- If your code can be unit-tested, add unit tests.
+
+- Add yourself to the AUTHORS file.
+
+- Create a pull request.
+
+For more help on getting started with searx development, see :ref:`devquickstart`.
+
+
+Translation
+~~~~~~~~~~~
+
+Translation currently takes place on
+`transifex <https://transifex.com/projects/p/searx>`__.
+
+**Please, do not update translation files in the repo.**
+
+Documentation
+~~~~~~~~~~~~~
+
+The documentation is built using Sphinx. So in order to be able to generate the required
+files, you have to install it on your system. (It can be installed easily using pip.)
+
+1. Checkout the gh-pages branch.
+
+2. Edit the rst file you wish to update. Or create a new rst file and place it under the appropriate folder.
+
+3. Build the documentation using Sphinx.
+
+4. Add the updated and created files of these extension:
+
+   - .rst
+
+   - .html
+
+   - .txt
+
+6. Create a pull request.

_sources/dev/engine_overview.rst.txt

@@ -0,0 +1,313 @@
+Engine overview
+===============
+
+
+searx is a `metasearch-engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__,
+so it uses different search engines to provide better results.
+
+Because there is no general search API which could be used for every
+search engine, an adapter has to be built between searx and the
+external search engines. Adapters are stored under the folder
+`searx/engines
+<https://github.com/asciimoo/searx/tree/master/searx/engines>`__.
+
+
+.. contents::
+   :depth: 3
+
+general engine configuration
+----------------------------
+
+It is required to tell searx the type of results the engine provides. The
+arguments can be set in the engine file or in the settings file
+(normally ``settings.yml``). The arguments in the settings file override
+the ones in the engine file.
+
+It does not matter if an option is stored in the engine file or in the
+settings. However, the standard way is the following:
+
+
+engine file
+~~~~~~~~~~~
+
++----------------------+-----------+-----------------------------------------+
+| argument             | type      | information                             |
++======================+===========+=========================================+
+| categories           | list      | pages, in which the engine is working   |
++----------------------+-----------+-----------------------------------------+
+| paging               | boolean   | support multible pages                  |
++----------------------+-----------+-----------------------------------------+
+| language\_support    | boolean   | support language choosing               |
++----------------------+-----------+-----------------------------------------+
+| time\_range\_support | boolean   | support search time range               |
++----------------------+-----------+-----------------------------------------+
+
+settings.yml
+~~~~~~~~~~~~
+
++------------+----------+-----------------------------------------------+
+| argument   | type     | information                                   |
++============+==========+===============================================+
+| name       | string   | name of search-engine                         |
++------------+----------+-----------------------------------------------+
+| engine     | string   | name of searx-engine (filename without .py)   |
++------------+----------+-----------------------------------------------+
+| shortcut   | string   | shortcut of search-engine                     |
++------------+----------+-----------------------------------------------+
+| timeout    | string   | specific timeout for search-engine            |
++------------+----------+-----------------------------------------------+
+
+overrides
+~~~~~~~~~
+
+A few of the options have default values in the engine, but are
+often overwritten by the settings. If ``None`` is assigned to an option
+in the engine file, it has to be redefined in the settings,
+otherwise searx will not start with that engine.
+
+The naming of overrides is arbitrary. But the recommended
+overrides are the following:
+
++-----------------------+----------+----------------------------------------------------------------+
+| argument              | type     | information                                                    |
++=======================+==========+================================================================+
+| base\_url             | string   | base-url, can be overwritten to use same engine on other URL   |
++-----------------------+----------+----------------------------------------------------------------+
+| number\_of\_results   | int      | maximum number of results per request                          |
++-----------------------+----------+----------------------------------------------------------------+
+| language              | string   | ISO code of language and country like en\_US                   |
++-----------------------+----------+----------------------------------------------------------------+
+| api\_key              | string   | api-key if required by engine                                  |
++-----------------------+----------+----------------------------------------------------------------+
+
+example code
+~~~~~~~~~~~~
+
+.. code:: python
+
+    # engine dependent config
+    categories = ['general']
+    paging = True
+    language_support = True
+
+making a request
+----------------
+
+To perform a search an URL have to be specified. In addition to
+specifying an URL, arguments can be passed to the query.
+
+passed arguments
+~~~~~~~~~~~~~~~~
+
+These arguments can be used to construct the search query. Furthermore,
+parameters with default value can be redefined for special purposes.
+
++----------------------+------------+------------------------------------------------------------------------+
+| argument             | type       | default-value, information                                             |
++======================+============+========================================================================+
+| url                  | string     | ``''``                                                                 |
++----------------------+------------+------------------------------------------------------------------------+
+| method               | string     | ``'GET'``                                                              |
++----------------------+------------+------------------------------------------------------------------------+
+| headers              | set        | ``{}``                                                                 |
++----------------------+------------+------------------------------------------------------------------------+
+| data                 | set        | ``{}``                                                                 |
++----------------------+------------+------------------------------------------------------------------------+
+| cookies              | set        | ``{}``                                                                 |
++----------------------+------------+------------------------------------------------------------------------+
+| verify               | boolean    | ``True``                                                               |
++----------------------+------------+------------------------------------------------------------------------+
+| headers.User-Agent   | string     | a random User-Agent                                                    |
++----------------------+------------+------------------------------------------------------------------------+
+| category             | string     | current category, like ``'general'``                                   |
++----------------------+------------+------------------------------------------------------------------------+
+| started              | datetime   | current date-time                                                      |
++----------------------+------------+------------------------------------------------------------------------+
+| pageno               | int        | current pagenumber                                                     |
++----------------------+------------+------------------------------------------------------------------------+
+| language             | string     | specific language code like ``'en_US'``, or ``'all'`` if unspecified   |
++----------------------+------------+------------------------------------------------------------------------+
+
+parsed arguments
+~~~~~~~~~~~~~~~~
+
+The function ``def request(query, params):`` always returns the
+``params`` variable. Inside searx, the following paramters can be
+used to specify a search request:
+
++------------+-----------+---------------------------------------------------------+
+| argument   | type      | information                                             |
++============+===========+=========================================================+
+| url        | string    | requested url                                           |
++------------+-----------+---------------------------------------------------------+
+| method     | string    | HTTP request method                                     |
++------------+-----------+---------------------------------------------------------+
+| headers    | set       | HTTP header information                                 |
++------------+-----------+---------------------------------------------------------+
+| data       | set       | HTTP data information (parsed if ``method != 'GET'``)   |
++------------+-----------+---------------------------------------------------------+
+| cookies    | set       | HTTP cookies                                            |
++------------+-----------+---------------------------------------------------------+
+| verify     | boolean   | Performing SSL-Validity check                           |
++------------+-----------+---------------------------------------------------------+
+
+example code
+~~~~~~~~~~~~
+
+.. code:: python
+
+    # search-url
+    base_url = 'https://example.com/'
+    search_string = 'search?{query}&page={page}'
+
+    # do search-request
+    def request(query, params):
+        search_path = search_string.format(
+            query=urlencode({'q': query}),
+            page=params['pageno'])
+
+        params['url'] = base_url + search_path
+
+        return params
+
+returned results
+----------------
+
+Searx is able to return results of different media-types.
+Currently the following media-types are supported:
+
+-  default
+-  images
+-  videos
+-  torrent
+-  map
+
+To set another media-type as default, the parameter
+``template`` must be set to the desired type.
+
+default
+~~~~~~~
+
++--------------------+---------------------------------------------------------------------------------------------------------------+
+| result-parameter   | information                                                                                                   |
++====================+===============================================================================================================+
+| url                | string, url of the result                                                                                     |
++--------------------+---------------------------------------------------------------------------------------------------------------+
+| title              | string, title of the result                                                                                   |
++--------------------+---------------------------------------------------------------------------------------------------------------+
+| content            | string, general result-text                                                                                   |
++--------------------+---------------------------------------------------------------------------------------------------------------+
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish     |
++--------------------+---------------------------------------------------------------------------------------------------------------+
+
+images
+~~~~~~
+
+to use this template, the parameter
+
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| result-parameter   | information                                                                                                                           |
++====================+=======================================================================================================================================+
+| template           | is set to ``images.html``                                                                                                             |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| url                | string, url to the result site                                                                                                        |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| title              | string, title of the result *(partly implemented)*                                                                                    |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| content            | *(partly implemented)*                                                                                                                |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(partly implemented)*      |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| img\_src           | string, url to the result image                                                                                                       |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| thumbnail\_src     | string, url to a small-preview image                                                                                                  |
++--------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+videos
+~~~~~~
+
++--------------------+--------------------------------------------------------------------------------------------------------------+
+| result-parameter   | information                                                                                                  |
++====================+==============================================================================================================+
+| template           | is set to ``videos.html``                                                                                    |
++--------------------+--------------------------------------------------------------------------------------------------------------+
+| url                | string, url of the result                                                                                    |
++--------------------+--------------------------------------------------------------------------------------------------------------+
+| title              | string, title of the result                                                                                  |
++--------------------+--------------------------------------------------------------------------------------------------------------+
+| content            | *(not implemented yet)*                                                                                      |
++--------------------+--------------------------------------------------------------------------------------------------------------+
+| publishedDate      | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    |
++--------------------+--------------------------------------------------------------------------------------------------------------+
+| thumbnail          | string, url to a small-preview image                                                                         |
++--------------------+--------------------------------------------------------------------------------------------------------------+
+
+torrent
+~~~~~~~
+
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| result-parameter | information                                                                                                                           |
++==================+=======================================================================================================================================+
+| template         | is set to ``torrent.html``                                                                                                            |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| url              | string, url of the result                                                                                                             |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| title            | string, title of the result                                                                                                           |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| content          | string, general result-text                                                                                                           |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| publishedDate    | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish *(not implemented yet)*     |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| seed             | int, number of seeder                                                                                                                 |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| leech            | int, number of leecher                                                                                                                |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| filesize         | int, size of file in bytes                                                                                                            |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| files            | int, number of files                                                                                                                  |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| magnetlink       | string, `magnetlink <https://en.wikipedia.org/wiki/Magnet_URI_scheme>`__ of the result                                                |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| torrentfile      | string, torrentfile of the result                                                                                                     |
++------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+
+map
+~~~
+
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| result-parameter        | information                                                                                                  |
++=========================+==============================================================================================================+
+| url                     | string, url of the result                                                                                    |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| title                   | string, title of the result                                                                                  |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| content                 | string, general result-text                                                                                  |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| publishedDate           | `datetime.datetime <https://docs.python.org/2/library/datetime.html#datetime-objects>`__, time of publish    |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| latitude                | latitude of result (in decimal format)                                                                       |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| longitude               | longitude of result (in decimal format)                                                                      |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| boundingbox             | boundingbox of result (array of 4. values ``[lat-min, lat-max, lon-min, lon-max]``)                          |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| geojson                 | geojson of result (http://geojson.org)                                                                       |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| osm.type                | type of osm-object (if OSM-Result)                                                                           |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| osm.id                  | id of osm-object (if OSM-Result)                                                                             |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| address.name            | name of object                                                                                               |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| address.road            | street name of object                                                                                        |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| address.house\_number   | house number of object                                                                                       |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| address.locality        | city, place of object                                                                                        |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| address.postcode        | postcode of object                                                                                           |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+| address.country         | country of object                                                                                            |
++-------------------------+--------------------------------------------------------------------------------------------------------------+
+

_sources/dev/install/installation.rst.txt

@@ -0,0 +1,323 @@
+.. _installation:
+
+Installation
+============
+
+.. contents::
+   :depth: 3
+
+Basic installation
+------------------
+
+Step by step installation for Debian/Ubuntu with virtualenv. For Ubuntu, be sure to have enable universe repository.
+
+Install packages:
+
+.. code:: sh
+
+    sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv virtualenv python-babel zlib1g-dev libffi-dev libssl-dev
+
+Install searx:
+
+.. code:: sh
+
+    cd /usr/local
+    sudo git clone https://github.com/asciimoo/searx.git
+    sudo useradd searx -d /usr/local/searx
+    sudo chown searx:searx -R /usr/local/searx
+
+Install dependencies in a virtualenv:
+
+.. code:: sh
+
+    sudo -u searx -i
+    cd /usr/local/searx
+    virtualenv searx-ve
+    . ./searx-ve/bin/activate
+    ./manage.sh update_packages
+
+Configuration
+-------------
+
+.. code:: sh
+
+    sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml
+
+Edit searx/settings.yml if necessary.
+
+Check
+-----
+
+Start searx:
+
+.. code:: sh
+
+    python searx/webapp.py
+
+Go to http://localhost:8888
+
+If everything works fine, disable the debug option in settings.yml:
+
+.. code:: sh
+
+    sed -i -e "s/debug : True/debug : False/g" searx/settings.yml
+
+At this point searx is not demonized ; uwsgi allows this.
+
+You can exit the virtualenv and the searx user bash (enter exit command
+twice).
+
+uwsgi
+-----
+
+Install packages:
+
+.. code:: sh
+
+    sudo apt-get install uwsgi uwsgi-plugin-python
+
+Create the configuration file /etc/uwsgi/apps-available/searx.ini with
+this content:
+
+::
+
+    [uwsgi]
+    # Who will run the code
+    uid = searx
+    gid = searx
+
+    # disable logging for privacy
+    disable-logging = true
+
+    # Number of workers (usually CPU count)
+    workers = 4
+
+    # The right granted on the created socket
+    chmod-socket = 666
+
+    # Plugin to use and interpretor config
+    single-interpreter = true
+    master = true
+    plugin = python
+    lazy-apps = true
+    enable-threads = true
+
+    # Module to import
+    module = searx.webapp
+
+    # Virtualenv and python path
+    virtualenv = /usr/local/searx/searx-ve/
+    pythonpath = /usr/local/searx/
+    chdir = /usr/local/searx/searx/
+
+Activate the uwsgi application and restart:
+
+.. code:: sh
+
+    cd /etc/uwsgi/apps-enabled
+    ln -s ../apps-available/searx.ini
+    /etc/init.d/uwsgi restart
+
+Web server
+----------
+
+with nginx
+^^^^^^^^^^
+
+If nginx is not installed (uwsgi will not work with the package
+nginx-light):
+
+.. code:: sh
+
+    sudo apt-get install nginx
+
+Hosted at /
+"""""""""""
+
+Create the configuration file /etc/nginx/sites-available/searx with this
+content:
+
+.. code:: nginx
+
+    server {
+        listen 80;
+        server_name searx.example.com;
+        root /usr/local/searx;
+
+        location / {
+                include uwsgi_params;
+                uwsgi_pass unix:/run/uwsgi/app/searx/socket;
+        }
+    }
+
+Restart service:
+
+.. code:: sh
+
+    sudo service nginx restart
+    sudo service uwsgi restart
+
+from subdirectory URL (/searx)
+""""""""""""""""""""""""""""""
+
+Add this configuration in the server config file
+/etc/nginx/sites-enabled/default:
+
+.. code:: nginx
+
+    location = /searx { rewrite ^ /searx/; }
+    location /searx {
+            try_files $uri @searx;
+    }
+    location @searx {
+            uwsgi_param SCRIPT_NAME /searx;
+            include uwsgi_params;
+            uwsgi_modifier1 30;
+            uwsgi_pass unix:/run/uwsgi/app/searx/socket;
+    }
+
+
+OR
+
+using reverse proxy
+(Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)
+
+.. code:: nginx
+
+    location /searx {
+        proxy_pass http://127.0.0.1:8888;
+        proxy_set_header Host $host;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Scheme $scheme;
+        proxy_set_header X-Script-Name /searx;
+        proxy_buffering off;
+    }
+
+
+Enable base\_url in searx/settings.yml
+
+::
+
+    base_url : http://your.domain.tld/searx/
+
+Restart service:
+
+.. code:: sh
+
+    sudo service nginx restart
+    sudo service uwsgi restart
+
+disable logs
+~~~~~~~~~~~~
+
+for better privacy you can disable nginx logs about searx.
+
+how to proceed: below ``uwsgi_pass`` in
+/etc/nginx/sites-available/default add
+
+::
+
+    access_log /dev/null;
+    error_log /dev/null;
+
+Restart service:
+
+.. code:: sh
+
+    sudo service nginx restart
+
+with apache
+^^^^^^^^^^^
+
+Add wsgi mod:
+
+.. code:: sh
+
+    sudo apt-get install libapache2-mod-uwsgi
+    sudo a2enmod uwsgi
+
+Add this configuration in the file /etc/apache2/apache2.conf:
+
+.. code:: apache
+
+    <Location />
+        Options FollowSymLinks Indexes
+        SetHandler uwsgi-handler
+        uWSGISocket /run/uwsgi/app/searx/socket
+    </Location>
+
+Note that if your instance of searx is not at the root, you should
+change ``<Location />`` by the location of your instance, like
+``<Location /searx>``.
+
+Restart Apache:
+
+.. code:: sh
+
+    sudo /etc/init.d/apache2 restart
+
+disable logs
+""""""""""""
+
+For better privacy you can disable Apache logs.
+
+WARNING: not tested
+
+WARNING: you can only disable logs for the whole (virtual) server not
+for a specific path.
+
+Go back to /etc/apache2/apache2.conf and above ``<Location />`` add:
+
+.. code:: apache
+
+    CustomLog /dev/null combined
+
+Restart Apache:
+
+.. code:: sh
+
+    sudo /etc/init.d/apache2 restart
+
+How to update
+-------------
+
+.. code:: sh
+
+    cd /usr/local/searx
+    sudo -u searx -i
+    . ./searx-ve/bin/activate
+    git stash
+    git pull origin master
+    git stash apply
+    ./manage.sh update_packages
+    sudo service uwsgi restart
+
+Docker
+------
+
+Make sure you have installed Docker. For instance, you can deploy searx like this:
+
+.. code:: sh
+
+    docker pull wonderfall/searx
+    docker run -d --name searx -p $PORT:8888 wonderfall/searx
+
+Go to http://localhost:$PORT.
+
+See https://hub.docker.com/r/wonderfall/searx/ for more informations.
+
+It's also possible to build searx from the embedded Dockerfile.
+
+.. code:: sh
+
+    git clone https://github.com/asciimoo/searx.git
+    cd searx
+    docker build -t whatever/searx .
+
+References
+==========
+
+    * https://about.okhin.fr/posts/Searx/ with some additions
+
+    * How to: `Setup searx in a couple of hours with a free SSL certificate <https://www.reddit.com/r/privacytoolsIO/comments/366kvn/how_to_setup_your_own_privacy_respecting_search/>`__
+

_sources/dev/install/installation.txt

@@ -15,7 +15,7 @@ Install packages:
 
 .. code:: sh
 
-    sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv python-pybabel zlib1g-dev libffi-dev libssl-dev
+    sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv virtualenv python-pybabel zlib1g-dev libffi-dev libssl-dev
 
 Install searx:
 

_sources/dev/plugins.rst.txt

@@ -0,0 +1,45 @@
+Plugins
+-------
+
+Plugins can extend or replace functionality of various components of
+searx.
+
+Example plugin
+~~~~~~~~~~~~~~
+
+.. code:: python
+
+    name = 'Example plugin'
+    description = 'This plugin extends the suggestions with the word "example"'
+    default_on = False  # disabled by default
+
+    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
+    def post_search(request, ctx):
+        ctx['search'].suggestions.add('example')
+        return True
+
+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``

_sources/dev/quickstart.rst.txt

@@ -0,0 +1,108 @@
+.. _devquickstart:
+
+Development Quickstart
+----------------------
+
+This quickstart guide gets your environment set up with searx. Furthermore, it gives a
+short introduction to the new manage.sh script.
+
+How to setup your development environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+First, clone the source code of searx to the desired folder. In this case the source
+is cloned to ~/myprojects/searx. Then create and activate the searx-ve
+virtualenv and install the required packages using manage.sh.
+
+.. code:: sh
+
+    cd ~/myprojects
+    git clone https://github.com/asciimoo/searx.git
+    cd searx
+    virtualenv searx-ve
+    . ./searx-ve/bin/activate
+    ./manage.sh update_dev_packages
+
+
+How to run tests
+~~~~~~~~~~~~~~~~
+
+Tests can be run using the manage.sh script.
+
+Following tests and checks are available:
+
+- Unit tests
+
+- Selenium tests
+
+- PEP8 validation
+
+- Unit test coverage check
+
+For example unit tests are run with the command below:
+
+.. code:: sh
+
+    ./manage.sh unit_tests
+
+For further test options, please consult the help of the manage.sh script.
+
+
+How to compile styles and javascript
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+How to build styles
+^^^^^^^^^^^^^^^^^^^
+
+Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.
+
+.. code:: sh
+
+    sudo apt-get install nodejs
+    sudo npm install -g less
+
+
+OR
+
+.. code:: sh
+
+    sudo apt-get install node-less
+
+After satisfying the requirements styles can be build using manage.sh
+
+.. code:: sh
+
+    ./manage.sh styles
+
+
+How to build the source of the oscar theme
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
+Node has to be installed.
+
+.. code:: sh
+
+    sudo apt-get install nodejs
+    sudo npm install -g grunt-cli
+
+After installing grunt, the files can be built using the following command: 
+
+.. code:: sh
+
+    ./manage.sh build_grunt
+
+
+
+Tips for debugging/development
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Turn on debug logging
+    Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
+    to turn on debug logging. When debug logging is enabled a stack trace appears,
+    instead of the cryptic ``Internal Server Error`` message. It can be turned on by setting
+    ``debug: False`` to ``debug: True`` in settings.yml.
+
+2. Run ``./manage.sh tests`` before creating a PR.
+    Failing build on Travis is common because of PEP8 checks. So a new commit must be created
+    containing these format fixes. This phase can be skipped if ``./manage.sh tests`` is run
+    locally before creating a PR.

_sources/dev/search_api.rst.txt

@@ -0,0 +1,204 @@
+Search API
+==========
+
+The search supports both ``GET`` and ``POST``.
+
+Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
+
+
+``GET /``
+
+``GET /search``
+
+Parameters
+~~~~~~~~~~
+
+.. code:: sh
+
+    q
+
+The search query. This string is passed to external search services.
+Thus, searx supports syntax of each search service. For example, ``site:github.com searx`` is a valid
+query for Google. However, if simply the query above is passed to any search engine which does not filter its
+results based on this syntax, you might not get the results you wanted.
+
+
+See more at :doc:`/user/search_syntax`
+
+Required.
+
+.. code:: sh
+
+    categories
+
+Comma separated list, specifies the active search categories
+
+Optional.
+
+.. code:: sh
+
+    engines
+
+Comma separated list, specifies the active search engines.
+
+Optional.
+
+.. code:: sh
+
+    lang
+
+Code of the language.
+
+Optional.
+
+Default: ``all``
+
+.. code:: sh
+
+    pageno
+
+Search page number.
+
+Optional.
+
+Default: ``1``
+
+.. code:: sh
+
+    time_range
+
+Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.
+
+Optional.
+
+Possible: ``day``, ``month``, ``year``
+
+.. code:: sh
+
+    format
+
+Output format of results.
+
+Optional.
+
+Possible: ``json``, ``csv``, ``rss``
+
+.. code:: sh
+
+    results_on_new_tab
+
+Open search results on new tab.
+
+Optional.
+
+Default: ``0``
+
+Possible: ``0``, ``1``
+
+.. code:: sh
+
+    image_proxy
+
+Proxy image results through searx.
+
+Optional.
+
+Default: ``False``
+
+Possible: ``True``, ``False``
+
+.. code:: sh
+
+    autocomplete
+
+Service which completes words as you type.
+
+Optional.
+
+Default: empty
+
+Possible: ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia``
+
+.. code:: sh
+
+    safesearch
+
+Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.
+
+Optional.
+
+Default: ``None``
+
+Possible: ``0``, ``1``, ``None``
+
+.. code:: sh
+
+    theme
+
+Theme of instance.
+
+Optional.
+
+Default: ``oscar``
+
+Possible: ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette``
+
+Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on his/her instance. See the available options in the preferences page of the instance.
+
+.. code:: sh
+
+    oscar-style
+
+Style of Oscar theme. It is only parsed if the theme of an instance is ``oscar``.
+
+Optional.
+
+Default: ``logicodev``
+
+Possible: ``pointhi``, ``logicodev``
+
+Please note, available styles depend on an instance. It is possible that an instance administrator deleted, created or renamed styles on his/her instance. See the available options in the preferences page of the instance.
+
+.. code:: sh
+
+    enabled_plugins
+
+List of enabled plugins.
+
+Optional.
+
+Default: ``HTTPS_rewrite``, ``Self_Informations``, ``Search_on_category_select``, ``Tracker_URL_remover``
+
+Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select``
+
+.. code:: sh
+
+    disabled_plugins
+
+List of disabled plugins.
+
+Optional.
+
+Default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``
+
+Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select``
+
+.. code:: sh
+
+    enabled_engines
+
+List of enabled engines.
+
+Optional.
+
+Possible:  all engines
+
+.. code:: sh
+
+    disabled_engines
+
+List of disabled engines.
+
+Optional.
+
+Possible: all engines

_sources/dev/translation.rst.txt

@@ -0,0 +1,61 @@
+Translation
+===========
+
+Requirements
+------------
+
+ * Transifex account
+
+ * Installed CLI tool of Transifex
+
+Init Transifex project
+----------------------
+
+After installing ``transifex`` using pip, run the following command to initialize the project.
+
+.. code:: shell
+
+    tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
+
+
+After ``$HOME/.transifexrc`` is created, get a Transifex API key and insert it into the configuration file.
+
+Create a configuration file for ``tx`` named ``$HOME/.tx/config``.
+
+.. code:: shell
+
+    [main]
+    host = https://www.transifex.com
+    [searx.messagespo]
+    file_filter = searx/translations/<lang>/LC_MESSAGES/messages.po
+    source_file = messages.pot
+    source_lang = en
+    type = PO
+
+
+Then run ``tx set``:
+
+.. code:: shell
+
+    tx set --auto-local -r searx.messagespo 'searx/translations/<lang>/LC_MESSAGES/messages.po' \
+    --source-lang en --type PO --source-file messages.pot --execute
+
+
+Update translations
+-------------------
+
+To retrieve the latest translations, pull it from Transifex.
+
+.. code:: shell
+
+    tx pull -a
+
+Then check the new languages. If strings translated are not enough, delete those folders, because
+those should not be compiled. Call the command below to compile the ``.po`` files.
+
+.. code:: shell
+
+    pybabel compile -d searx/translations
+
+
+After the compilation is finished commit the ``.po`` and ``.mo`` files and create a PR.

_sources/index.rst.txt

@@ -0,0 +1,56 @@
+Welcome to searx
+================
+
+Search without being tracked.
+
+Searx is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, searx can be used over Tor for online anonymity.
+
+Get started with searx by using one of the `public instances`_. If you don't trust anyone, you can set up your own, see :ref:`installation`.
+
+.. _public instances: https://github.com/asciimoo/searx/wiki/Searx-instances
+
+Features
+--------
+
+ - Self hosted
+ - No user tracking
+ - No user profiling
+ - About 70 supported search engines
+ - Easy integration with any search engine
+ - Cookies are not used by default
+ - Secure, encrypted connections (HTTPS/SSL)
+ - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
+
+
+User documentation
+------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   user/search_syntax
+   user/own-instance
+
+Administrator documentation
+---------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   dev/install/installation
+   admin/api
+   admin/filtron
+   admin/morty
+
+Developer documentation
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   dev/quickstart
+   dev/contribution_guide
+   dev/engine_overview
+   dev/search_api
+   dev/plugins
+   dev/translation

_sources/user/own-instance.rst.txt

@@ -0,0 +1,43 @@
+Why use a private instance?
+===========================
+
+"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.
+
+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.
+
+To gain more insight on how these instances work let's dive into how searx protects its users.
+
+How does searx protect privacy?
+-------------------------------
+
+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:
+
+ 1. removal of private data from requests going to search services
+ 2. not forwarding anything from a third party services through search services (e.g. advertisement)
+ 3. removal of private data from requests going to the result pages
+
+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.
+
+Searx does not serve ads 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.
+
+What are the consequences of using public instances?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If someone uses a public instance, he/she has to trust the administrator of that instance.
+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.
+
+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.
+
+I see. What about private instances?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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.
+
+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.
+
+Conclusion
+----------
+
+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.
+
+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.

_sources/user/search_syntax.rst.txt

@@ -0,0 +1,33 @@
+Search syntax
+=============
+
+Searx allows you to modify the default categories, engines and search
+language via the search query.
+
+Category/engine prefix: ``!``
+
+Language prefix: ``:``
+
+Prefix to add engines and categories to the currently selected
+categories: ``?``
+
+Abbrevations of the engines and languages are also accepted.
+Engine/category modifiers are chainable and inclusive (e.g. with
+`!it !ddg !wp qwer <https://searx.me/?q=%21it%20%21ddg%20%21wp%20qwer>`_
+search in IT category **and** duckduckgo **and** wikipedia for ``qwer``).
+
+See the `/preferences page <https://searx.me/preferences>`_ for the
+list of engines, categories and languages.
+
+Examples
+~~~~~~~~
+
+Search in wikipedia for ``qwer``:
+`!wp qwer <https://searx.me/?q=%21wp%20qwer>`__ or
+`!wikipedia qwer <https://searx.me/?q=%21wikipedia%20qwer>`_
+
+Image search:
+`!images Cthulhu <https://searx.me/?q=%21images%20Cthulhu>`_
+
+Custom language in wikipedia:
+`:hu !wp hackerspace <https://searx.me/?q=%3Ahu%20%21wp%20hackerspace>`_

_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -82,9 +82,21 @@ div.sphinxsidebar input {
 }
 
 div.sphinxsidebar #searchbox input[type="text"] {
-    width: 170px;
+    float: left;
+    width: 80%;
+    padding: 0.25em;
+    box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+    float: left;
+    width: 20%;
+    border-left: none;
+    padding: 0.25em;
+    box-sizing: border-box;
 }
 
+
 img {
     border: 0;
     max-width: 100%;
@@ -199,6 +211,11 @@ table.modindextable td {
 
 /* -- general body styles --------------------------------------------------- */
 
+div.body {
+    min-width: 450px;
+    max-width: 800px;
+}
+
 div.body p, div.body dd, div.body li, div.body blockquote {
     -moz-hyphens: auto;
     -ms-hyphens: auto;
@@ -332,6 +349,11 @@ table.docutils {
     border-collapse: collapse;
 }
 
+table.align-center {
+    margin-left: auto;
+    margin-right: auto;
+}
+
 table caption span.caption-number {
     font-style: italic;
 }
@@ -445,10 +467,14 @@ dd {
     margin-left: 30px;
 }
 
-dt:target, .highlighted {
+dt:target, span.highlighted {
     background-color: #fbe54e;
 }
 
+rect.highlighted {
+    fill: #fbe54e;
+}
+
 dl.glossary dt {
     font-weight: bold;
     font-size: 1.1em;

_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -45,7 +45,7 @@ jQuery.urlencode = encodeURIComponent;
  * it will always return arrays of strings for the value parts.
  */
 jQuery.getQueryParameters = function(s) {
-  if (typeof s == 'undefined')
+  if (typeof s === 'undefined')
     s = document.location.search;
   var parts = s.substr(s.indexOf('?') + 1).split('&');
   var result = {};
@@ -66,29 +66,55 @@ jQuery.getQueryParameters = function(s) {
  * span elements with the given class name.
  */
 jQuery.fn.highlightText = function(text, className) {
-  function highlight(node) {
-    if (node.nodeType == 3) {
+  function highlight(node, addItems) {
+    if (node.nodeType === 3) {
       var val = node.nodeValue;
       var pos = val.toLowerCase().indexOf(text);
-      if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
-        var span = document.createElement("span");
-        span.className = className;
+      if (pos >= 0 &&
+          !jQuery(node.parentNode).hasClass(className) &&
+          !jQuery(node.parentNode).hasClass("nohighlight")) {
+        var span;
+        var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+        if (isInSVG) {
+          span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+        } else {
+          span = document.createElement("span");
+          span.className = className;
+        }
         span.appendChild(document.createTextNode(val.substr(pos, text.length)));
         node.parentNode.insertBefore(span, node.parentNode.insertBefore(
           document.createTextNode(val.substr(pos + text.length)),
           node.nextSibling));
         node.nodeValue = val.substr(0, pos);
+        if (isInSVG) {
+          var bbox = span.getBBox();
+          var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+       	  rect.x.baseVal.value = bbox.x;
+          rect.y.baseVal.value = bbox.y;
+          rect.width.baseVal.value = bbox.width;
+          rect.height.baseVal.value = bbox.height;
+          rect.setAttribute('class', className);
+          var parentOfText = node.parentNode.parentNode;
+          addItems.push({
+              "parent": node.parentNode,
+              "target": rect});
+        }
       }
     }
     else if (!jQuery(node).is("button, select, textarea")) {
       jQuery.each(node.childNodes, function() {
-        highlight(this);
+        highlight(this, addItems);
       });
     }
   }
-  return this.each(function() {
-    highlight(this);
+  var addItems = [];
+  var result = this.each(function() {
+    highlight(this, addItems);
   });
+  for (var i = 0; i < addItems.length; ++i) {
+    jQuery(addItems[i].parent).before(addItems[i].target);
+  }
+  return result;
 };
 
 /*
@@ -131,21 +157,21 @@ var Documentation = {
    * i18n support
    */
   TRANSLATIONS : {},
-  PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
+  PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
   LOCALE : 'unknown',
 
   // gettext and ngettext don't access this so that the functions
   // can safely bound to a different name (_ = Documentation.gettext)
   gettext : function(string) {
     var translated = Documentation.TRANSLATIONS[string];
-    if (typeof translated == 'undefined')
+    if (typeof translated === 'undefined')
       return string;
-    return (typeof translated == 'string') ? translated : translated[0];
+    return (typeof translated === 'string') ? translated : translated[0];
   },
 
   ngettext : function(singular, plural, n) {
     var translated = Documentation.TRANSLATIONS[singular];
-    if (typeof translated == 'undefined')
+    if (typeof translated === 'undefined')
       return (n == 1) ? singular : plural;
     return translated[Documentation.PLURALEXPR(n)];
   },
@@ -180,7 +206,7 @@ var Documentation = {
    * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
    */
   fixFirefoxAnchorBug : function() {
-    if (document.location.hash)
+    if (document.location.hash && $.browser.mozilla)
       window.setTimeout(function() {
         document.location.href += '';
       }, 10);
@@ -216,7 +242,7 @@ var Documentation = {
       var src = $(this).attr('src');
       var idnum = $(this).attr('id').substr(7);
       $('tr.cg-' + idnum).toggle();
-      if (src.substr(-9) == 'minus.png')
+      if (src.substr(-9) === 'minus.png')
         $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
       else
         $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
@@ -248,7 +274,7 @@ var Documentation = {
     var path = document.location.pathname;
     var parts = path.split(/\//);
     $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
-      if (this == '..')
+      if (this === '..')
         parts.pop();
     });
     var url = parts.join('/');

_static/documentation_options.js

@@ -0,0 +1,9 @@
+var DOCUMENTATION_OPTIONS = {
+    URL_ROOT: '',
+    VERSION: '0.12.0',
+    LANGUAGE: 'None',
+    COLLAPSE_INDEX: false,
+    FILE_SUFFIX: '.html',
+    HAS_SOURCE: true,
+    SOURCELINK_SUFFIX: '.txt'
+};

_static/searchtools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -540,6 +540,9 @@ var Search = {
           });
         } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
           var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
+          if (suffix === undefined) {
+            suffix = '.txt';
+          }
           $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {

_static/websupport.js

@@ -4,7 +4,7 @@
  *
  * sphinx.websupport utilities for all documentation.
  *
- * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -301,7 +301,7 @@
     li.hide();
 
     // Determine where in the parents children list to insert this comment.
-    for(i=0; i < siblings.length; i++) {
+    for(var i=0; i < siblings.length; i++) {
       if (comp(comment, siblings[i]) <= 0) {
         $('#cd' + siblings[i].id)
           .parent()

admin/api.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Administration API &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -42,12 +33,12 @@
 <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></span><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><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></span><span class="p">{</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
   <span class="s2">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
   <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
     <span class="s2">&quot;map&quot;</span><span class="p">,</span>
@@ -117,7 +108,7 @@
 <h1>Embed search bar<a class="headerlink" href="#embed-search-bar" title="Permalink to this headline">¶</a></h1>
 <p>The search bar can be embedded into websites. Just paste the example into the HTML of the site.
 URL of the searx instance and values are customizable.</p>
-<div class="code html highlight-default"><div class="highlight"><pre><span></span>&lt;form method=&quot;post&quot; action=&quot;https://searx.me/&quot;&gt;
+<div class="code html highlight-default notranslate"><div class="highlight"><pre><span></span>&lt;form method=&quot;post&quot; action=&quot;https://searx.me/&quot;&gt;
     &lt;!-- search query --&gt; &lt;input type=&quot;text&quot; name=&quot;q&quot; /&gt;
     &lt;!-- categories   --&gt; &lt;input type=&quot;hidden&quot; name=&quot;categories&quot; value=&quot;general,social media&quot; /&gt;
     &lt;!-- language     --&gt; &lt;input type=&quot;hidden&quot; name=&quot;lang&quot; value=&quot;all&quot; /&gt;
@@ -133,7 +124,19 @@ URL of the searx instance and values are customizable.</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Administration API</a><ul>
+<li><a class="reference internal" href="#get-configuration-data">Get configuration data</a><ul>
+<li><a class="reference internal" href="#sample-response">Sample response</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a class="reference internal" href="#embed-search-bar">Embed search bar</a></li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -147,6 +150,25 @@ URL of the searx instance and values are customizable.</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/admin/api.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

admin/filtron.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>How to protect an instance &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -41,7 +32,7 @@
   <div class="section" id="how-to-protect-an-instance">
 <h1>How to protect an instance<a class="headerlink" href="#how-to-protect-an-instance" title="Permalink to this headline">¶</a></h1>
 <p>Searx depens on external search services. To avoid the abuse of these services it is advised to limit the number of requests processed by searx.</p>
-<p>An application firewall, <code class="docutils literal"><span class="pre">filtron</span></code> solves exactly this problem. Information on how to install it can be found at the <a class="reference external" href="https://github.com/asciimoo/filtron">project page of filtron</a>.</p>
+<p>An application firewall, <code class="docutils literal notranslate"><span class="pre">filtron</span></code> solves exactly this problem. Information on how to install it can be found at the <a class="reference external" href="https://github.com/asciimoo/filtron">project page of filtron</a>.</p>
 <div class="section" id="sample-configuration-of-filtron">
 <h2>Sample configuration of filtron<a class="headerlink" href="#sample-configuration-of-filtron" title="Permalink to this headline">¶</a></h2>
 <p>An example configuration can be find below. This configuration limits the access of</p>
@@ -54,7 +45,7 @@
 <li>the same UserAgent of if too many requests (useragent limit)</li>
 </ul>
 </div></blockquote>
-<div class="code json highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span>
+<div class="code json highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
     <span class="p">{</span>
         <span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;search request&quot;</span><span class="p">,</span>
         <span class="s2">&quot;filters&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;Param:q&quot;</span><span class="p">,</span> <span class="s2">&quot;Path=^(/|/search)$&quot;</span><span class="p">],</span>
@@ -122,12 +113,12 @@
 <div class="section" id="route-request-through-filtron">
 <h2>Route request through filtron<a class="headerlink" href="#route-request-through-filtron" title="Permalink to this headline">¶</a></h2>
 <p>Filtron can be started using the following command:</p>
-<div class="code bash highlight-default"><div class="highlight"><pre><span></span>$ filtron -rules rules.json
+<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span>$ filtron -rules rules.json
 </pre></div>
 </div>
 <p>It listens on 127.0.0.1:4004 and forwards filtered requests to 127.0.0.1:8888 by default.</p>
-<p>Use it along with <code class="docutils literal"><span class="pre">nginx</span></code> with the following example configuration.</p>
-<div class="code bash highlight-default"><div class="highlight"><pre><span></span>location / {
+<p>Use it along with <code class="docutils literal notranslate"><span class="pre">nginx</span></code> with the following example configuration.</p>
+<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span>location / {
     proxy_set_header        Host    $http_host;
     proxy_set_header        X-Real-IP $remote_addr;
     proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -145,7 +136,16 @@
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">How to protect an instance</a><ul>
+<li><a class="reference internal" href="#sample-configuration-of-filtron">Sample configuration of filtron</a></li>
+<li><a class="reference internal" href="#route-request-through-filtron">Route request through filtron</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -159,6 +159,25 @@
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/admin/filtron.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

admin/morty.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>How to setup result proxy &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -43,15 +34,15 @@
 <p>By default searx can only act as an image proxy for result images,
 but it is possible to proxify all the result URLs with an external service,
 <a class="reference external" href="https://github.com/asciimoo/morty">morty</a>.</p>
-<p>To use this feature, morty has to be installed and activated in searx’s <code class="docutils literal"><span class="pre">settings.yml</span></code>.</p>
-<p>Add the following snippet to your <code class="docutils literal"><span class="pre">settings.yml</span></code> and restart searx:</p>
-<div class="code yaml highlight-default"><div class="highlight"><pre><span></span><span class="n">result_proxy</span><span class="p">:</span>
+<p>To use this feature, morty has to be installed and activated in searx’s <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>.</p>
+<p>Add the following snippet to your <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> and restart searx:</p>
+<div class="code yaml highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">result_proxy</span><span class="p">:</span>
     <span class="n">url</span> <span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mi">3000</span><span class="o">/</span>
     <span class="n">key</span> <span class="p">:</span> <span class="n">your_morty_proxy_key</span>
 </pre></div>
 </div>
-<p><code class="docutils literal"><span class="pre">url</span></code> is the address of the running morty service</p>
-<p><code class="docutils literal"><span class="pre">key</span></code> is an optional argument, see <a class="reference external" href="https://github.com/asciimoo/morty">morty’s README</a> for more information.</p>
+<p><code class="docutils literal notranslate"><span class="pre">url</span></code> is the address of the running morty service</p>
+<p><code class="docutils literal notranslate"><span class="pre">key</span></code> is an optional argument, see <a class="reference external" href="https://github.com/asciimoo/morty">morty’s README</a> for more information.</p>
 </div>
 
 
@@ -73,6 +64,25 @@ but it is possible to proxify all the result URLs with an external service,
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/admin/morty.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

blog/admin.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Searx admin interface: manage your instance from your browser &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -28,8 +20,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -40,15 +31,15 @@
 <h1>Searx admin interface: manage your instance from your browser<a class="headerlink" href="#searx-admin-interface-manage-your-instance-from-your-browser" title="Permalink to this headline">¶</a></h1>
 <p>One of the biggest advantages of searx is being extremely customizable. But at first it can be daunting to newcomers.
 A barrier of taking advantage of this feature is our ugly settings file which is sometimes hard to understand and edit.</p>
-<p>To make self-hosting searx more accessible a new tool is introduced, called <code class="docutils literal"><span class="pre">searx-admin</span></code>.
+<p>To make self-hosting searx more accessible a new tool is introduced, called <code class="docutils literal notranslate"><span class="pre">searx-admin</span></code>.
 It is a web application which is capable of managing your instance and manipulating its settings via a web UI.
-It aims to replace editing of <code class="docutils literal"><span class="pre">settings.yml</span></code> for less experienced administrators or people
+It aims to replace editing of <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> for less experienced administrators or people
 who prefer graphical admin interfaces.</p>
 <div class="align-center figure" id="id1">
 <a class="reference internal image-reference" href="../_images/searx-admin-engines.png"><img alt="Screenshot of engine list" src="../_images/searx-admin-engines.png" style="width: 682.0px; height: 352.5px;" /></a>
 <p class="caption"><span class="caption-text">Configuration page of engines</span></p>
 </div>
-<p>Since <code class="docutils literal"><span class="pre">searx-admin</span></code> acts as a supervisor for searx, we have decided to implement it
+<p>Since <code class="docutils literal notranslate"><span class="pre">searx-admin</span></code> acts as a supervisor for searx, we have decided to implement it
 as a standalone tool instead of part of searx. Another reason for making it a standalone
 tool is that the codebase and dependencies of searx should not grow because of a fully optional feature,
 which does not affect existing instances.</p>
@@ -72,7 +63,16 @@ which does not affect existing instances.</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Searx admin interface: manage your instance from your browser</a><ul>
+<li><a class="reference internal" href="#installation">Installation</a></li>
+<li><a class="reference internal" href="#acknowledgements">Acknowledgements</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -86,6 +86,25 @@ which does not affect existing instances.</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/blog/admin.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

blog/blog.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Blog &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -28,8 +20,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -65,6 +56,25 @@
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/blog/blog.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

blog/python3.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Introducing Python3 support &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -28,8 +20,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -45,7 +36,7 @@
 <p>Please make sure that you run at least Python3.5.</p>
 <p>To run searx, first a Python3 virtualenv should be created. After entering the virtualenv,
 dependencies must be installed. Then run searx with python3 instead of the usual python command.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">virtualenv</span> <span class="o">-</span><span class="n">p</span> <span class="n">python3</span> <span class="n">venv3</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">virtualenv</span> <span class="o">-</span><span class="n">p</span> <span class="n">python3</span> <span class="n">venv3</span>
 <span class="n">source</span> <span class="n">venv3</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
 <span class="n">pip3</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
 <span class="n">python3</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
@@ -80,7 +71,18 @@ so we can investigate it properly.</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Introducing Python3 support</a><ul>
+<li><a class="reference internal" href="#how-to-run-searx-using-python3">How to run searx using Python3</a></li>
+<li><a class="reference internal" href="#fun-facts">Fun facts</a></li>
+<li><a class="reference internal" href="#if-you-found-bugs">If you found bugs…</a></li>
+<li><a class="reference internal" href="#acknowledgement">Acknowledgement</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -94,6 +96,25 @@ so we can investigate it properly.</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/blog/python3.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/contribution_guide.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>How to contribute &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -125,7 +116,21 @@ files, you have to install it on your system. (It can be installed easily using
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">How to contribute</a><ul>
+<li><a class="reference internal" href="#prime-directives-privacy-hackability">Prime directives: Privacy, Hackability</a><ul>
+<li><a class="reference internal" href="#privacy-by-design">Privacy-by-design</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#code">Code</a></li>
+<li><a class="reference internal" href="#translation">Translation</a></li>
+<li><a class="reference internal" href="#documentation">Documentation</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -139,6 +144,25 @@ files, you have to install it on your system. (It can be installed easily using
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/dev/contribution_guide.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/engine_overview.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Engine overview &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -79,7 +70,7 @@ external search engines. Adapters are stored under the folder
 <h2><a class="toc-backref" href="#id3">general engine configuration</a><a class="headerlink" href="#general-engine-configuration" title="Permalink to this headline">¶</a></h2>
 <p>It is required to tell searx the type of results the engine provides. The
 arguments can be set in the engine file or in the settings file
-(normally <code class="docutils literal"><span class="pre">settings.yml</span></code>). The arguments in the settings file override
+(normally <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>). The arguments in the settings file override
 the ones in the engine file.</p>
 <p>It does not matter if an option is stored in the engine file or in the
 settings. However, the standard way is the following:</p>
@@ -154,7 +145,7 @@ settings. However, the standard way is the following:</p>
 <div class="section" id="overrides">
 <h3><a class="toc-backref" href="#id6">overrides</a><a class="headerlink" href="#overrides" title="Permalink to this headline">¶</a></h3>
 <p>A few of the options have default values in the engine, but are
-often overwritten by the settings. If <code class="docutils literal"><span class="pre">None</span></code> is assigned to an option
+often overwritten by the settings. If <code class="docutils literal notranslate"><span class="pre">None</span></code> is assigned to an option
 in the engine file, it has to be redefined in the settings,
 otherwise searx will not start with that engine.</p>
 <p>The naming of overrides is arbitrary. But the recommended
@@ -193,7 +184,7 @@ 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-default"><div class="highlight"><pre><span></span><span class="c1"># engine dependent config</span>
+<div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><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="kc">True</span>
 <span class="n">language_support</span> <span class="o">=</span> <span class="kc">True</span>
@@ -224,27 +215,27 @@ parameters with default value can be redefined for special purposes.</p>
 <tbody valign="top">
 <tr class="row-even"><td>url</td>
 <td>string</td>
-<td><code class="docutils literal"><span class="pre">''</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">''</span></code></td>
 </tr>
 <tr class="row-odd"><td>method</td>
 <td>string</td>
-<td><code class="docutils literal"><span class="pre">'GET'</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">'GET'</span></code></td>
 </tr>
 <tr class="row-even"><td>headers</td>
 <td>set</td>
-<td><code class="docutils literal"><span class="pre">{}</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">{}</span></code></td>
 </tr>
 <tr class="row-odd"><td>data</td>
 <td>set</td>
-<td><code class="docutils literal"><span class="pre">{}</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">{}</span></code></td>
 </tr>
 <tr class="row-even"><td>cookies</td>
 <td>set</td>
-<td><code class="docutils literal"><span class="pre">{}</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">{}</span></code></td>
 </tr>
 <tr class="row-odd"><td>verify</td>
 <td>boolean</td>
-<td><code class="docutils literal"><span class="pre">True</span></code></td>
+<td><code class="docutils literal notranslate"><span class="pre">True</span></code></td>
 </tr>
 <tr class="row-even"><td>headers.User-Agent</td>
 <td>string</td>
@@ -252,7 +243,7 @@ parameters with default value can be redefined for special purposes.</p>
 </tr>
 <tr class="row-odd"><td>category</td>
 <td>string</td>
-<td>current category, like <code class="docutils literal"><span class="pre">'general'</span></code></td>
+<td>current category, like <code class="docutils literal notranslate"><span class="pre">'general'</span></code></td>
 </tr>
 <tr class="row-even"><td>started</td>
 <td>datetime</td>
@@ -264,15 +255,15 @@ parameters with default value can be redefined for special purposes.</p>
 </tr>
 <tr class="row-even"><td>language</td>
 <td>string</td>
-<td>specific language code like <code class="docutils literal"><span class="pre">'en_US'</span></code>, or <code class="docutils literal"><span class="pre">'all'</span></code> if unspecified</td>
+<td>specific language code like <code class="docutils literal notranslate"><span class="pre">'en_US'</span></code>, or <code class="docutils literal notranslate"><span class="pre">'all'</span></code> if unspecified</td>
 </tr>
 </tbody>
 </table>
 </div>
 <div class="section" id="parsed-arguments">
 <h3><a class="toc-backref" href="#id10">parsed arguments</a><a class="headerlink" href="#parsed-arguments" title="Permalink to this headline">¶</a></h3>
-<p>The function <code class="docutils literal"><span class="pre">def</span> <span class="pre">request(query,</span> <span class="pre">params):</span></code> always returns the
-<code class="docutils literal"><span class="pre">params</span></code> variable. Inside searx, the following paramters can be
+<p>The function <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">request(query,</span> <span class="pre">params):</span></code> always returns the
+<code class="docutils literal notranslate"><span class="pre">params</span></code> variable. Inside searx, the following paramters can be
 used to specify a search request:</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -301,7 +292,7 @@ used to specify a search request:</p>
 </tr>
 <tr class="row-odd"><td>data</td>
 <td>set</td>
-<td>HTTP data information (parsed if <code class="docutils literal"><span class="pre">method</span> <span class="pre">!=</span> <span class="pre">'GET'</span></code>)</td>
+<td>HTTP data information (parsed if <code class="docutils literal notranslate"><span class="pre">method</span> <span class="pre">!=</span> <span class="pre">'GET'</span></code>)</td>
 </tr>
 <tr class="row-even"><td>cookies</td>
 <td>set</td>
@@ -316,7 +307,7 @@ 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-default"><div class="highlight"><pre><span></span><span class="c1"># search-url</span>
+<div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><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?</span><span class="si">{query}</span><span class="s1">&amp;page=</span><span class="si">{page}</span><span class="s1">&#39;</span>
 
@@ -345,7 +336,7 @@ Currently the following media-types are supported:</p>
 <li>map</li>
 </ul>
 <p>To set another media-type as default, the parameter
-<code class="docutils literal"><span class="pre">template</span></code> must be set to the desired type.</p>
+<code class="docutils literal notranslate"><span class="pre">template</span></code> must be set to the desired type.</p>
 <div class="section" id="default">
 <h3><a class="toc-backref" href="#id13">default</a><a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h3>
 <table border="1" class="docutils">
@@ -389,7 +380,7 @@ Currently the following media-types are supported:</p>
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td>template</td>
-<td>is set to <code class="docutils literal"><span class="pre">images.html</span></code></td>
+<td>is set to <code class="docutils literal notranslate"><span class="pre">images.html</span></code></td>
 </tr>
 <tr class="row-odd"><td>url</td>
 <td>string, url to the result site</td>
@@ -426,7 +417,7 @@ Currently the following media-types are supported:</p>
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td>template</td>
-<td>is set to <code class="docutils literal"><span class="pre">videos.html</span></code></td>
+<td>is set to <code class="docutils literal notranslate"><span class="pre">videos.html</span></code></td>
 </tr>
 <tr class="row-odd"><td>url</td>
 <td>string, url of the result</td>
@@ -460,7 +451,7 @@ Currently the following media-types are supported:</p>
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td>template</td>
-<td>is set to <code class="docutils literal"><span class="pre">torrent.html</span></code></td>
+<td>is set to <code class="docutils literal notranslate"><span class="pre">torrent.html</span></code></td>
 </tr>
 <tr class="row-odd"><td>url</td>
 <td>string, url of the result</td>
@@ -527,7 +518,7 @@ Currently the following media-types are supported:</p>
 <td>longitude of result (in decimal format)</td>
 </tr>
 <tr class="row-even"><td>boundingbox</td>
-<td>boundingbox of result (array of 4. values <code class="docutils literal"><span class="pre">[lat-min,</span> <span class="pre">lat-max,</span> <span class="pre">lon-min,</span> <span class="pre">lon-max]</span></code>)</td>
+<td>boundingbox of result (array of 4. values <code class="docutils literal notranslate"><span class="pre">[lat-min,</span> <span class="pre">lat-max,</span> <span class="pre">lon-min,</span> <span class="pre">lon-max]</span></code>)</td>
 </tr>
 <tr class="row-odd"><td>geojson</td>
 <td>geojson of result (<a class="reference external" href="http://geojson.org">http://geojson.org</a>)</td>
@@ -567,7 +558,35 @@ Currently the following media-types are supported:</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Engine overview</a><ul>
+<li><a class="reference internal" href="#general-engine-configuration">general engine configuration</a><ul>
+<li><a class="reference internal" href="#engine-file">engine file</a></li>
+<li><a class="reference internal" href="#settings-yml">settings.yml</a></li>
+<li><a class="reference internal" href="#overrides">overrides</a></li>
+<li><a class="reference internal" href="#example-code">example code</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#making-a-request">making a request</a><ul>
+<li><a class="reference internal" href="#passed-arguments">passed arguments</a></li>
+<li><a class="reference internal" href="#parsed-arguments">parsed arguments</a></li>
+<li><a class="reference internal" href="#id1">example code</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#returned-results">returned results</a><ul>
+<li><a class="reference internal" href="#default">default</a></li>
+<li><a class="reference internal" href="#images">images</a></li>
+<li><a class="reference internal" href="#videos">videos</a></li>
+<li><a class="reference internal" href="#torrent">torrent</a></li>
+<li><a class="reference internal" href="#map">map</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -581,6 +600,25 @@ Currently the following media-types are supported:</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/dev/engine_overview.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/install/installation.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Installation &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -64,18 +55,18 @@
 <h2><a class="toc-backref" href="#id4">Basic installation</a><a class="headerlink" href="#basic-installation" title="Permalink to this headline">¶</a></h2>
 <p>Step by step installation for Debian/Ubuntu with virtualenv. For Ubuntu, be sure to have enable universe repository.</p>
 <p>Install packages:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">git</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">virtualenv</span> <span class="n">python</span><span class="o">-</span><span class="n">babel</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> <span class="n">libffi</span><span class="o">-</span><span class="n">dev</span> <span class="n">libssl</span><span class="o">-</span><span class="n">dev</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">git</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">dev</span> <span class="n">python</span><span class="o">-</span><span class="n">virtualenv</span> <span class="n">virtualenv</span> <span class="n">python</span><span class="o">-</span><span class="n">babel</span> <span class="n">zlib1g</span><span class="o">-</span><span class="n">dev</span> <span class="n">libffi</span><span class="o">-</span><span class="n">dev</span> <span class="n">libssl</span><span class="o">-</span><span class="n">dev</span>
 </pre></div>
 </div>
 <p>Install searx:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span>
 <span class="n">sudo</span> <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
 <span class="n">sudo</span> <span class="n">useradd</span> <span class="n">searx</span> <span class="o">-</span><span class="n">d</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
 <span class="n">sudo</span> <span class="n">chown</span> <span class="n">searx</span><span class="p">:</span><span class="n">searx</span> <span class="o">-</span><span class="n">R</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
 </pre></div>
 </div>
 <p>Install dependencies in a virtualenv:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
 <span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
 <span class="n">virtualenv</span> <span class="n">searx</span><span class="o">-</span><span class="n">ve</span>
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
@@ -85,7 +76,7 @@
 </div>
 <div class="section" id="configuration">
 <h2><a class="toc-backref" href="#id5">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;s/ultrasecretkey/`openssl rand -hex 16`/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;s/ultrasecretkey/`openssl rand -hex 16`/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
 </pre></div>
 </div>
 <p>Edit searx/settings.yml if necessary.</p>
@@ -93,12 +84,12 @@
 <div class="section" id="check">
 <h2><a class="toc-backref" href="#id6">Check</a><a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h2>
 <p>Start searx:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">searx</span><span class="o">/</span><span class="n">webapp</span><span class="o">.</span><span class="n">py</span>
 </pre></div>
 </div>
 <p>Go to <a class="reference external" href="http://localhost:8888">http://localhost:8888</a></p>
 <p>If everything works fine, disable the debug option in settings.yml:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;s/debug : True/debug : False/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">e</span> <span class="s2">&quot;s/debug : True/debug : False/g&quot;</span> <span class="n">searx</span><span class="o">/</span><span class="n">settings</span><span class="o">.</span><span class="n">yml</span>
 </pre></div>
 </div>
 <p>At this point searx is not demonized ; uwsgi allows this.</p>
@@ -108,12 +99,12 @@ twice).</p>
 <div class="section" id="uwsgi">
 <h2><a class="toc-backref" href="#id7">uwsgi</a><a class="headerlink" href="#uwsgi" title="Permalink to this headline">¶</a></h2>
 <p>Install packages:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">uwsgi</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">plugin</span><span class="o">-</span><span class="n">python</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">uwsgi</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">plugin</span><span class="o">-</span><span class="n">python</span>
 </pre></div>
 </div>
 <p>Create the configuration file /etc/uwsgi/apps-available/searx.ini with
 this content:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">uwsgi</span><span class="p">]</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">uwsgi</span><span class="p">]</span>
 <span class="c1"># Who will run the code</span>
 <span class="n">uid</span> <span class="o">=</span> <span class="n">searx</span>
 <span class="n">gid</span> <span class="o">=</span> <span class="n">searx</span>
@@ -144,7 +135,7 @@ this content:</p>
 </pre></div>
 </div>
 <p>Activate the uwsgi application and restart:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">apps</span><span class="o">-</span><span class="n">enabled</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">apps</span><span class="o">-</span><span class="n">enabled</span>
 <span class="n">ln</span> <span class="o">-</span><span class="n">s</span> <span class="o">../</span><span class="n">apps</span><span class="o">-</span><span class="n">available</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">ini</span>
 <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">uwsgi</span> <span class="n">restart</span>
 </pre></div>
@@ -156,14 +147,14 @@ this content:</p>
 <h3><a class="toc-backref" href="#id9">with nginx</a><a class="headerlink" href="#with-nginx" title="Permalink to this headline">¶</a></h3>
 <p>If nginx is not installed (uwsgi will not work with the package
 nginx-light):</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nginx</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nginx</span>
 </pre></div>
 </div>
 <div class="section" id="hosted-at">
 <h4>Hosted at /<a class="headerlink" href="#hosted-at" title="Permalink to this headline">¶</a></h4>
 <p>Create the configuration file /etc/nginx/sites-available/searx with this
 content:</p>
-<div class="code nginx highlight-default"><div class="highlight"><pre><span></span><span class="n">server</span> <span class="p">{</span>
+<div class="code nginx highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">server</span> <span class="p">{</span>
     <span class="n">listen</span> <span class="mi">80</span><span class="p">;</span>
     <span class="n">server_name</span> <span class="n">searx</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="p">;</span>
     <span class="n">root</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span><span class="p">;</span>
@@ -176,7 +167,7 @@ content:</p>
 </pre></div>
 </div>
 <p>Restart service:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
 <span class="n">sudo</span> <span class="n">service</span> <span class="n">uwsgi</span> <span class="n">restart</span>
 </pre></div>
 </div>
@@ -185,7 +176,7 @@ content:</p>
 <h4>from subdirectory URL (/searx)<a class="headerlink" href="#from-subdirectory-url-searx" title="Permalink to this headline">¶</a></h4>
 <p>Add this configuration in the server config file
 /etc/nginx/sites-enabled/default:</p>
-<div class="code nginx highlight-default"><div class="highlight"><pre><span></span>location = /searx { rewrite ^ /searx/; }
+<div class="code nginx highlight-default notranslate"><div class="highlight"><pre><span></span>location = /searx { rewrite ^ /searx/; }
 location /searx {
         try_files $uri @searx;
 }
@@ -200,7 +191,7 @@ location @searx {
 <p>OR</p>
 <p>using reverse proxy
 (Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)</p>
-<div class="code nginx highlight-default"><div class="highlight"><pre><span></span>location /searx {
+<div class="code nginx highlight-default notranslate"><div class="highlight"><pre><span></span>location /searx {
     proxy_pass http://127.0.0.1:8888;
     proxy_set_header Host $host;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -211,25 +202,25 @@ location @searx {
 </pre></div>
 </div>
 <p>Enable base_url in searx/settings.yml</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">base_url</span> <span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">tld</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">base_url</span> <span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">your</span><span class="o">.</span><span class="n">domain</span><span class="o">.</span><span class="n">tld</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span>
 </pre></div>
 </div>
 <p>Restart service:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
 <span class="n">sudo</span> <span class="n">service</span> <span class="n">uwsgi</span> <span class="n">restart</span>
 </pre></div>
 </div>
 <div class="section" id="disable-logs">
 <h5>disable logs<a class="headerlink" href="#disable-logs" title="Permalink to this headline">¶</a></h5>
 <p>for better privacy you can disable nginx logs about searx.</p>
-<p>how to proceed: below <code class="docutils literal"><span class="pre">uwsgi_pass</span></code> in
+<p>how to proceed: below <code class="docutils literal notranslate"><span class="pre">uwsgi_pass</span></code> in
 /etc/nginx/sites-available/default add</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">access_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">access_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
 <span class="n">error_log</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span><span class="p">;</span>
 </pre></div>
 </div>
 <p>Restart service:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">nginx</span> <span class="n">restart</span>
 </pre></div>
 </div>
 </div>
@@ -238,12 +229,12 @@ location @searx {
 <div class="section" id="with-apache">
 <h3><a class="toc-backref" href="#id10">with apache</a><a class="headerlink" href="#with-apache" title="Permalink to this headline">¶</a></h3>
 <p>Add wsgi mod:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libapache2</span><span class="o">-</span><span class="n">mod</span><span class="o">-</span><span class="n">uwsgi</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libapache2</span><span class="o">-</span><span class="n">mod</span><span class="o">-</span><span class="n">uwsgi</span>
 <span class="n">sudo</span> <span class="n">a2enmod</span> <span class="n">uwsgi</span>
 </pre></div>
 </div>
 <p>Add this configuration in the file /etc/apache2/apache2.conf:</p>
-<div class="code apache highlight-default"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">Location</span> <span class="o">/&gt;</span>
+<div class="code apache highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">Location</span> <span class="o">/&gt;</span>
     <span class="n">Options</span> <span class="n">FollowSymLinks</span> <span class="n">Indexes</span>
     <span class="n">SetHandler</span> <span class="n">uwsgi</span><span class="o">-</span><span class="n">handler</span>
     <span class="n">uWSGISocket</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">uwsgi</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">searx</span><span class="o">/</span><span class="n">socket</span>
@@ -251,10 +242,10 @@ location @searx {
 </pre></div>
 </div>
 <p>Note that if your instance of searx is not at the root, you should
-change <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> by the location of your instance, like
-<code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/searx&gt;</span></code>.</p>
+change <code class="docutils literal notranslate"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> by the location of your instance, like
+<code class="docutils literal notranslate"><span class="pre">&lt;Location</span> <span class="pre">/searx&gt;</span></code>.</p>
 <p>Restart Apache:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
 </pre></div>
 </div>
 <div class="section" id="id2">
@@ -263,12 +254,12 @@ change <code class="docutils literal"><span class="pre">&lt;Location</span> <spa
 <p>WARNING: not tested</p>
 <p>WARNING: you can only disable logs for the whole (virtual) server not
 for a specific path.</p>
-<p>Go back to /etc/apache2/apache2.conf and above <code class="docutils literal"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> add:</p>
-<div class="code apache highlight-default"><div class="highlight"><pre><span></span><span class="n">CustomLog</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="n">combined</span>
+<p>Go back to /etc/apache2/apache2.conf and above <code class="docutils literal notranslate"><span class="pre">&lt;Location</span> <span class="pre">/&gt;</span></code> add:</p>
+<div class="code apache highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">CustomLog</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="n">combined</span>
 </pre></div>
 </div>
 <p>Restart Apache:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">apache2</span> <span class="n">restart</span>
 </pre></div>
 </div>
 </div>
@@ -276,7 +267,7 @@ for a specific path.</p>
 </div>
 <div class="section" id="how-to-update">
 <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>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">searx</span>
 <span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">searx</span> <span class="o">-</span><span class="n">i</span>
 <span class="o">.</span> <span class="o">./</span><span class="n">searx</span><span class="o">-</span><span class="n">ve</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
 <span class="n">git</span> <span class="n">stash</span>
@@ -290,14 +281,14 @@ for a specific path.</p>
 <div class="section" id="docker">
 <h2><a class="toc-backref" href="#id12">Docker</a><a class="headerlink" href="#docker" title="Permalink to this headline">¶</a></h2>
 <p>Make sure you have installed Docker. For instance, you can deploy searx like this:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span>docker pull wonderfall/searx
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span>docker pull wonderfall/searx
 docker run -d --name searx -p $PORT:8888 wonderfall/searx
 </pre></div>
 </div>
 <p>Go to <a class="reference external" href="http://localhost:$PORT">http://localhost:$PORT</a>.</p>
 <p>See <a class="reference external" href="https://hub.docker.com/r/wonderfall/searx/">https://hub.docker.com/r/wonderfall/searx/</a> for more informations.</p>
 <p>It’s also possible to build searx from the embedded Dockerfile.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
 <span class="n">cd</span> <span class="n">searx</span>
 <span class="n">docker</span> <span class="n">build</span> <span class="o">-</span><span class="n">t</span> <span class="n">whatever</span><span class="o">/</span><span class="n">searx</span> <span class="o">.</span>
 </pre></div>
@@ -319,7 +310,36 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Installation</a><ul>
+<li><a class="reference internal" href="#basic-installation">Basic installation</a></li>
+<li><a class="reference internal" href="#configuration">Configuration</a></li>
+<li><a class="reference internal" href="#check">Check</a></li>
+<li><a class="reference internal" href="#uwsgi">uwsgi</a></li>
+<li><a class="reference internal" href="#web-server">Web server</a><ul>
+<li><a class="reference internal" href="#with-nginx">with nginx</a><ul>
+<li><a class="reference internal" href="#hosted-at">Hosted at /</a></li>
+<li><a class="reference internal" href="#from-subdirectory-url-searx">from subdirectory URL (/searx)</a><ul>
+<li><a class="reference internal" href="#disable-logs">disable logs</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a class="reference internal" href="#with-apache">with apache</a><ul>
+<li><a class="reference internal" href="#id2">disable logs</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a class="reference internal" href="#how-to-update">How to update</a></li>
+<li><a class="reference internal" href="#docker">Docker</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#references">References</a></li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../../index.html">Home</a></li>
@@ -333,6 +353,25 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../../_sources/dev/install/installation.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/plugins.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Plugins &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -44,7 +35,7 @@
 searx.</p>
 <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></span><span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;Example plugin&#39;</span>
+<div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;Example plugin&#39;</span>
 <span class="n">description</span> <span class="o">=</span> <span class="s1">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
 <span class="n">default_on</span> <span class="o">=</span> <span class="kc">False</span>  <span class="c1"># disabled by default</span>
 
@@ -66,15 +57,15 @@ searx.</p>
 <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>
+<p>Runs BEFORE the search request. Function to implement: <code class="docutils literal notranslate"><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>
+<p>Runs AFTER the search request. Function to implement: <code class="docutils literal notranslate"><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>
+<p>Runs when a new result is added to the result list. Function to implement: <code class="docutils literal notranslate"><span class="pre">on_result</span></code></p>
 </div>
 </div>
 </div>
@@ -84,7 +75,21 @@ searx.</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Plugins</a><ul>
+<li><a class="reference internal" href="#example-plugin">Example plugin</a></li>
+<li><a class="reference internal" href="#plugin-entry-points">Plugin entry points</a><ul>
+<li><a class="reference internal" href="#pre-search-hook">Pre search hook</a></li>
+<li><a class="reference internal" href="#post-search-hook">Post search hook</a></li>
+<li><a class="reference internal" href="#result-hook">Result hook</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -98,6 +103,25 @@ searx.</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/dev/plugins.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/quickstart.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Development Quickstart &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -47,7 +38,7 @@ short introduction to the new manage.sh script.</p>
 <p>First, clone the source code of searx to the desired folder. In this case the source
 is cloned to ~/myprojects/searx. Then create and activate the searx-ve
 virtualenv and install the required packages using manage.sh.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">myprojects</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">myprojects</span>
 <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">asciimoo</span><span class="o">/</span><span class="n">searx</span><span class="o">.</span><span class="n">git</span>
 <span class="n">cd</span> <span class="n">searx</span>
 <span class="n">virtualenv</span> <span class="n">searx</span><span class="o">-</span><span class="n">ve</span>
@@ -67,7 +58,7 @@ virtualenv and install the required packages using manage.sh.</p>
 <li>Unit test coverage check</li>
 </ul>
 <p>For example unit tests are run with the command below:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">unit_tests</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">unit_tests</span>
 </pre></div>
 </div>
 <p>For further test options, please consult the help of the manage.sh script.</p>
@@ -77,16 +68,16 @@ virtualenv and install the required packages using manage.sh.</p>
 <div class="section" id="how-to-build-styles">
 <h3>How to build styles<a class="headerlink" href="#how-to-build-styles" title="Permalink to this headline">¶</a></h3>
 <p>Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
 <span class="n">sudo</span> <span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">less</span>
 </pre></div>
 </div>
 <p>OR</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">node</span><span class="o">-</span><span class="n">less</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">node</span><span class="o">-</span><span class="n">less</span>
 </pre></div>
 </div>
 <p>After satisfying the requirements styles can be build using manage.sh</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">styles</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">styles</span>
 </pre></div>
 </div>
 </div>
@@ -94,12 +85,12 @@ virtualenv and install the required packages using manage.sh.</p>
 <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>
 <p>Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
 Node has to be installed.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">nodejs</span>
 <span class="n">sudo</span> <span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">grunt</span><span class="o">-</span><span class="n">cli</span>
 </pre></div>
 </div>
 <p>After installing grunt, the files can be built using the following command:</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">build_grunt</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">manage</span><span class="o">.</span><span class="n">sh</span> <span class="n">build_grunt</span>
 </pre></div>
 </div>
 </div>
@@ -111,14 +102,14 @@ Node has to be installed.</p>
 <dt>Turn on debug logging</dt>
 <dd>Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
 to turn on debug logging. When debug logging is enabled a stack trace appears,
-instead of the cryptic <code class="docutils literal"><span class="pre">Internal</span> <span class="pre">Server</span> <span class="pre">Error</span></code> message. It can be turned on by setting
-<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</dd>
+instead of the cryptic <code class="docutils literal notranslate"><span class="pre">Internal</span> <span class="pre">Server</span> <span class="pre">Error</span></code> message. It can be turned on by setting
+<code class="docutils literal notranslate"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal notranslate"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</dd>
 </dl>
 </li>
 <li><dl class="first docutils">
-<dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
+<dt>Run <code class="docutils literal notranslate"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
 <dd>Failing build on Travis is common because of PEP8 checks. So a new commit must be created
-containing these format fixes. This phase can be skipped if <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> is run
+containing these format fixes. This phase can be skipped if <code class="docutils literal notranslate"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> is run
 locally before creating a PR.</dd>
 </dl>
 </li>
@@ -131,7 +122,22 @@ locally before creating a PR.</dd>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Development Quickstart</a><ul>
+<li><a class="reference internal" href="#how-to-setup-your-development-environment">How to setup your development environment</a></li>
+<li><a class="reference internal" href="#how-to-run-tests">How to run tests</a></li>
+<li><a class="reference internal" href="#how-to-compile-styles-and-javascript">How to compile styles and javascript</a><ul>
+<li><a class="reference internal" href="#how-to-build-styles">How to build styles</a></li>
+<li><a class="reference internal" href="#how-to-build-the-source-of-the-oscar-theme">How to build the source of the oscar theme</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#tips-for-debugging-development">Tips for debugging/development</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -145,6 +151,25 @@ locally before creating a PR.</dd>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/dev/quickstart.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/search_api.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Search API &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -40,120 +31,120 @@
             
   <div class="section" id="search-api">
 <h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline">¶</a></h1>
-<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>.</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>
-<p><code class="docutils literal"><span class="pre">GET</span> <span class="pre">/</span></code></p>
-<p><code class="docutils literal"><span class="pre">GET</span> <span class="pre">/search</span></code></p>
+<p>The search supports both <code class="docutils literal notranslate"><span class="pre">GET</span></code> and <code class="docutils literal notranslate"><span class="pre">POST</span></code>.</p>
+<p>Furthermore, two enpoints <code class="docutils literal notranslate"><span class="pre">/</span></code> and <code class="docutils literal notranslate"><span class="pre">/search</span></code> are available for querying.</p>
+<p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/search</span></code></p>
 <div class="section" id="parameters">
 <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">q</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">q</span>
 </pre></div>
 </div>
 <p>The search query. This string is passed to external search services.
-Thus, searx supports syntax of each search service. For example, <code class="docutils literal"><span class="pre">site:github.com</span> <span class="pre">searx</span></code> is a valid
+Thus, searx supports syntax of each search service. For example, <code class="docutils literal notranslate"><span class="pre">site:github.com</span> <span class="pre">searx</span></code> is a valid
 query for Google. However, if simply the query above is passed to any search engine which does not filter its
 results based on this syntax, you might not get the results you wanted.</p>
 <p>See more at <a class="reference internal" href="../user/search_syntax.html"><span class="doc">Search syntax</span></a></p>
 <p>Required.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">categories</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">categories</span>
 </pre></div>
 </div>
 <p>Comma separated list, specifies the active search categories</p>
 <p>Optional.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">engines</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">engines</span>
 </pre></div>
 </div>
 <p>Comma separated list, specifies the active search engines.</p>
 <p>Optional.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">lang</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">lang</span>
 </pre></div>
 </div>
 <p>Code of the language.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">all</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">pageno</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">all</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pageno</span>
 </pre></div>
 </div>
 <p>Search page number.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">1</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">time_range</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">time_range</span>
 </pre></div>
 </div>
 <p>Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.</p>
 <p>Optional.</p>
-<p>Possible: <code class="docutils literal"><span class="pre">day</span></code>, <code class="docutils literal"><span class="pre">month</span></code>, <code class="docutils literal"><span class="pre">year</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="nb">format</span>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">day</span></code>, <code class="docutils literal notranslate"><span class="pre">month</span></code>, <code class="docutils literal notranslate"><span class="pre">year</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">format</span>
 </pre></div>
 </div>
 <p>Output format of results.</p>
 <p>Optional.</p>
-<p>Possible: <code class="docutils literal"><span class="pre">json</span></code>, <code class="docutils literal"><span class="pre">csv</span></code>, <code class="docutils literal"><span class="pre">rss</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">results_on_new_tab</span>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">json</span></code>, <code class="docutils literal notranslate"><span class="pre">csv</span></code>, <code class="docutils literal notranslate"><span class="pre">rss</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">results_on_new_tab</span>
 </pre></div>
 </div>
 <p>Open search results on new tab.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">0</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">0</span></code>, <code class="docutils literal"><span class="pre">1</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">image_proxy</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">0</span></code>, <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">image_proxy</span>
 </pre></div>
 </div>
 <p>Proxy image results through searx.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">False</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">True</span></code>, <code class="docutils literal"><span class="pre">False</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">autocomplete</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">False</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">True</span></code>, <code class="docutils literal notranslate"><span class="pre">False</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">autocomplete</span>
 </pre></div>
 </div>
 <p>Service which completes words as you type.</p>
 <p>Optional.</p>
 <p>Default: empty</p>
-<p>Possible: <code class="docutils literal"><span class="pre">google</span></code>, <code class="docutils literal"><span class="pre">dbpedia</span></code>, <code class="docutils literal"><span class="pre">duckduckgo</span></code>, <code class="docutils literal"><span class="pre">startpage</span></code>, <code class="docutils literal"><span class="pre">wikipedia</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">safesearch</span>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">google</span></code>, <code class="docutils literal notranslate"><span class="pre">dbpedia</span></code>, <code class="docutils literal notranslate"><span class="pre">duckduckgo</span></code>, <code class="docutils literal notranslate"><span class="pre">startpage</span></code>, <code class="docutils literal notranslate"><span class="pre">wikipedia</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">safesearch</span>
 </pre></div>
 </div>
 <p>Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">None</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">0</span></code>, <code class="docutils literal"><span class="pre">1</span></code>, <code class="docutils literal"><span class="pre">None</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">theme</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">0</span></code>, <code class="docutils literal notranslate"><span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">theme</span>
 </pre></div>
 </div>
 <p>Theme of instance.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">oscar</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">oscar</span></code>, <code class="docutils literal"><span class="pre">simple</span></code>, <code class="docutils literal"><span class="pre">legacy</span></code>, <code class="docutils literal"><span class="pre">pix-art</span></code>, <code class="docutils literal"><span class="pre">courgette</span></code></p>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">oscar</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">oscar</span></code>, <code class="docutils literal notranslate"><span class="pre">simple</span></code>, <code class="docutils literal notranslate"><span class="pre">legacy</span></code>, <code class="docutils literal notranslate"><span class="pre">pix-art</span></code>, <code class="docutils literal notranslate"><span class="pre">courgette</span></code></p>
 <p>Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on his/her instance. See the available options in the preferences page of the instance.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">oscar</span><span class="o">-</span><span class="n">style</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">oscar</span><span class="o">-</span><span class="n">style</span>
 </pre></div>
 </div>
-<p>Style of Oscar theme. It is only parsed if the theme of an instance is <code class="docutils literal"><span class="pre">oscar</span></code>.</p>
+<p>Style of Oscar theme. It is only parsed if the theme of an instance is <code class="docutils literal notranslate"><span class="pre">oscar</span></code>.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">logicodev</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">pointhi</span></code>, <code class="docutils literal"><span class="pre">logicodev</span></code></p>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">logicodev</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">pointhi</span></code>, <code class="docutils literal notranslate"><span class="pre">logicodev</span></code></p>
 <p>Please note, available styles depend on an instance. It is possible that an instance administrator deleted, created or renamed styles on his/her instance. See the available options in the preferences page of the instance.</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">enabled_plugins</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">enabled_plugins</span>
 </pre></div>
 </div>
 <p>List of enabled plugins.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal"><span class="pre">Self_Informations</span></code>, <code class="docutils literal"><span class="pre">Search_on_category_select</span></code>, <code class="docutils literal"><span class="pre">Tracker_URL_remover</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal"><span class="pre">Vim-like_hotkeys</span></code>, <code class="docutils literal"><span class="pre">Self_Informations</span></code>, <code class="docutils literal"><span class="pre">Tracker_URL_remover</span></code>, <code class="docutils literal"><span class="pre">Search_on_category_select</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">disabled_plugins</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal notranslate"><span class="pre">Self_Informations</span></code>, <code class="docutils literal notranslate"><span class="pre">Search_on_category_select</span></code>, <code class="docutils literal notranslate"><span class="pre">Tracker_URL_remover</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal notranslate"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal notranslate"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal notranslate"><span class="pre">Vim-like_hotkeys</span></code>, <code class="docutils literal notranslate"><span class="pre">Self_Informations</span></code>, <code class="docutils literal notranslate"><span class="pre">Tracker_URL_remover</span></code>, <code class="docutils literal notranslate"><span class="pre">Search_on_category_select</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">disabled_plugins</span>
 </pre></div>
 </div>
 <p>List of disabled plugins.</p>
 <p>Optional.</p>
-<p>Default: <code class="docutils literal"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal"><span class="pre">Vim-like_hotkeys</span></code></p>
-<p>Possible: <code class="docutils literal"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal"><span class="pre">Vim-like_hotkeys</span></code>, <code class="docutils literal"><span class="pre">Self_Informations</span></code>, <code class="docutils literal"><span class="pre">Tracker_URL_remover</span></code>, <code class="docutils literal"><span class="pre">Search_on_category_select</span></code></p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">enabled_engines</span>
+<p>Default: <code class="docutils literal notranslate"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal notranslate"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal notranslate"><span class="pre">Vim-like_hotkeys</span></code></p>
+<p>Possible: <code class="docutils literal notranslate"><span class="pre">DOAI_rewrite</span></code>, <code class="docutils literal notranslate"><span class="pre">HTTPS_rewrite</span></code>, <code class="docutils literal notranslate"><span class="pre">Infinite_scroll</span></code>, <code class="docutils literal notranslate"><span class="pre">Vim-like_hotkeys</span></code>, <code class="docutils literal notranslate"><span class="pre">Self_Informations</span></code>, <code class="docutils literal notranslate"><span class="pre">Tracker_URL_remover</span></code>, <code class="docutils literal notranslate"><span class="pre">Search_on_category_select</span></code></p>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">enabled_engines</span>
 </pre></div>
 </div>
 <p>List of enabled engines.</p>
 <p>Optional.</p>
 <p>Possible:  all engines</p>
-<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">disabled_engines</span>
+<div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">disabled_engines</span>
 </pre></div>
 </div>
 <p>List of disabled engines.</p>
@@ -167,7 +158,15 @@ results based on this syntax, you might not get the results you wanted.</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Search API</a><ul>
+<li><a class="reference internal" href="#parameters">Parameters</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -181,6 +180,25 @@ results based on this syntax, you might not get the results you wanted.</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/dev/search_api.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

dev/translation.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Translation &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -29,8 +21,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -50,13 +41,13 @@
 </div>
 <div class="section" id="init-transifex-project">
 <h2>Init Transifex project<a class="headerlink" href="#init-transifex-project" title="Permalink to this headline">¶</a></h2>
-<p>After installing <code class="docutils literal"><span class="pre">transifex</span></code> using pip, run the following command to initialize the project.</p>
-<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">init</span> <span class="c1"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
+<p>After installing <code class="docutils literal notranslate"><span class="pre">transifex</span></code> using pip, run the following command to initialize the project.</p>
+<div class="code shell highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">init</span> <span class="c1"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
 </pre></div>
 </div>
-<p>After <code class="docutils literal"><span class="pre">$HOME/.transifexrc</span></code> is created, get a Transifex API key and insert it into the configuration file.</p>
-<p>Create a configuration file for <code class="docutils literal"><span class="pre">tx</span></code> named <code class="docutils literal"><span class="pre">$HOME/.tx/config</span></code>.</p>
-<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">main</span><span class="p">]</span>
+<p>After <code class="docutils literal notranslate"><span class="pre">$HOME/.transifexrc</span></code> is created, get a Transifex API key and insert it into the configuration file.</p>
+<p>Create a configuration file for <code class="docutils literal notranslate"><span class="pre">tx</span></code> named <code class="docutils literal notranslate"><span class="pre">$HOME/.tx/config</span></code>.</p>
+<div class="code shell highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">main</span><span class="p">]</span>
 <span class="n">host</span> <span class="o">=</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">transifex</span><span class="o">.</span><span class="n">com</span>
 <span class="p">[</span><span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span><span class="p">]</span>
 <span class="n">file_filter</span> <span class="o">=</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span><span class="o">/&lt;</span><span class="n">lang</span><span class="o">&gt;/</span><span class="n">LC_MESSAGES</span><span class="o">/</span><span class="n">messages</span><span class="o">.</span><span class="n">po</span>
@@ -65,8 +56,8 @@
 <span class="nb">type</span> <span class="o">=</span> <span class="n">PO</span>
 </pre></div>
 </div>
-<p>Then run <code class="docutils literal"><span class="pre">tx</span> <span class="pre">set</span></code>:</p>
-<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="nb">set</span> <span class="o">--</span><span class="n">auto</span><span class="o">-</span><span class="n">local</span> <span class="o">-</span><span class="n">r</span> <span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span> <span class="s1">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> \
+<p>Then run <code class="docutils literal notranslate"><span class="pre">tx</span> <span class="pre">set</span></code>:</p>
+<div class="code shell highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="nb">set</span> <span class="o">--</span><span class="n">auto</span><span class="o">-</span><span class="n">local</span> <span class="o">-</span><span class="n">r</span> <span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span> <span class="s1">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> \
 <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>
@@ -74,15 +65,15 @@
 <div class="section" id="update-translations">
 <h2>Update translations<a class="headerlink" href="#update-translations" title="Permalink to this headline">¶</a></h2>
 <p>To retrieve the latest translations, pull it from Transifex.</p>
-<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">pull</span> <span class="o">-</span><span class="n">a</span>
+<div class="code shell highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">tx</span> <span class="n">pull</span> <span class="o">-</span><span class="n">a</span>
 </pre></div>
 </div>
 <p>Then check the new languages. If strings translated are not enough, delete those folders, because
-those should not be compiled. Call the command below to compile the <code class="docutils literal"><span class="pre">.po</span></code> files.</p>
-<div class="code shell highlight-default"><div class="highlight"><pre><span></span><span class="n">pybabel</span> <span class="nb">compile</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span>
+those should not be compiled. Call the command below to compile the <code class="docutils literal notranslate"><span class="pre">.po</span></code> files.</p>
+<div class="code shell highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pybabel</span> <span class="nb">compile</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span>
 </pre></div>
 </div>
-<p>After the compilation is finished commit the <code class="docutils literal"><span class="pre">.po</span></code> and <code class="docutils literal"><span class="pre">.mo</span></code> files and create a PR.</p>
+<p>After the compilation is finished commit the <code class="docutils literal notranslate"><span class="pre">.po</span></code> and <code class="docutils literal notranslate"><span class="pre">.mo</span></code> files and create a PR.</p>
 </div>
 </div>
 
@@ -91,7 +82,17 @@ those should not be compiled. Call the command below to compile the <code class=
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Translation</a><ul>
+<li><a class="reference internal" href="#requirements">Requirements</a></li>
+<li><a class="reference internal" href="#init-transifex-project">Init Transifex project</a></li>
+<li><a class="reference internal" href="#update-translations">Update translations</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -105,6 +106,25 @@ those should not be compiled. Call the command below to compile the <code class=
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/dev/translation.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

docs/dev/install/installation.rst

@@ -15,7 +15,7 @@ Install packages:
 
 .. code:: sh
 
-    sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv python-babel zlib1g-dev libffi-dev libssl-dev
+    sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv virtualenv python-babel zlib1g-dev libffi-dev libssl-dev
 
 Install searx:
 

genindex.html

@@ -5,20 +5,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Index &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="_static/documentation_options.js"></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>
@@ -29,8 +21,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -49,9 +40,7 @@
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-
-   <div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="index.html">Home</a></li>
@@ -65,7 +54,18 @@
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
-
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

index.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Welcome to searx &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="_static/documentation_options.js"></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>
@@ -29,8 +21,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -99,7 +90,18 @@
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="#">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Welcome to searx</a><ul>
+<li><a class="reference internal" href="#features">Features</a></li>
+<li><a class="reference internal" href="#user-documentation">User documentation</a></li>
+<li><a class="reference internal" href="#administrator-documentation">Administrator documentation</a></li>
+<li><a class="reference internal" href="#developer-documentation">Developer documentation</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="#">Home</a></li>
@@ -113,6 +115,25 @@
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/index.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

search.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Search &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="_static/documentation_options.js"></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>
@@ -36,8 +28,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
 
 
-  </head>
-  <body>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">

user/own-instance.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Why use a private instance? &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -79,7 +70,20 @@ This means that the user of the public instance does not know whether his/her re
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Why use a private instance?</a><ul>
+<li><a class="reference internal" href="#how-does-searx-protect-privacy">How does searx protect privacy?</a><ul>
+<li><a class="reference internal" href="#what-are-the-consequences-of-using-public-instances">What are the consequences of using public instances?</a></li>
+<li><a class="reference internal" href="#i-see-what-about-private-instances">I see. What about private instances?</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#conclusion">Conclusion</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -93,6 +97,25 @@ This means that the user of the public instance does not know whether his/her re
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/user/own-instance.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>

user/search_syntax.html

@@ -4,20 +4,12 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>Search syntax &#8212; searx 0.12.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.12.0',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" src="../_static/documentation_options.js"></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>
@@ -30,8 +22,7 @@
   <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>  
+  </head><body>  
 
     <div class="document">
       <div class="documentwrapper">
@@ -42,19 +33,19 @@
 <h1>Search syntax<a class="headerlink" href="#search-syntax" title="Permalink to this headline">¶</a></h1>
 <p>Searx allows you to modify the default categories, engines and search
 language via the search query.</p>
-<p>Category/engine prefix: <code class="docutils literal"><span class="pre">!</span></code></p>
-<p>Language prefix: <code class="docutils literal"><span class="pre">:</span></code></p>
+<p>Category/engine prefix: <code class="docutils literal notranslate"><span class="pre">!</span></code></p>
+<p>Language prefix: <code class="docutils literal notranslate"><span class="pre">:</span></code></p>
 <p>Prefix to add engines and categories to the currently selected
-categories: <code class="docutils literal"><span class="pre">?</span></code></p>
+categories: <code class="docutils literal notranslate"><span class="pre">?</span></code></p>
 <p>Abbrevations of the engines and languages are also accepted.
 Engine/category modifiers are chainable and inclusive (e.g. with
 <a class="reference external" href="https://searx.me/?q=%21it%20%21ddg%20%21wp%20qwer">!it !ddg !wp qwer</a>
-search in IT category <strong>and</strong> duckduckgo <strong>and</strong> wikipedia for <code class="docutils literal"><span class="pre">qwer</span></code>).</p>
+search in IT category <strong>and</strong> duckduckgo <strong>and</strong> wikipedia for <code class="docutils literal notranslate"><span class="pre">qwer</span></code>).</p>
 <p>See the <a class="reference external" href="https://searx.me/preferences">/preferences page</a> for the
 list of engines, categories and languages.</p>
 <div class="section" id="examples">
 <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
-<p>Search in wikipedia for <code class="docutils literal"><span class="pre">qwer</span></code>:
+<p>Search in wikipedia for <code class="docutils literal notranslate"><span class="pre">qwer</span></code>:
 <a class="reference external" href="https://searx.me/?q=%21wp%20qwer">!wp qwer</a> or
 <a class="reference external" href="https://searx.me/?q=%21wikipedia%20qwer">!wikipedia qwer</a></p>
 <p>Image search:
@@ -69,7 +60,15 @@ list of engines, categories and languages.</p>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Search syntax</a><ul>
+<li><a class="reference internal" href="#examples">Examples</a></li>
+</ul>
+</li>
+</ul>
+<div class="sidebar_container body">
 <h1>Searx</h1>
 <ul>
     <li><a href="../index.html">Home</a></li>
@@ -83,6 +82,25 @@ list of engines, categories and languages.</p>
     <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../_sources/user/search_syntax.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    </div>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
       </div>
       <div class="clearer"></div>