diff --git a/_downloads/ad0ebe55d6b53b1559e0ca8dee6f30b9/reST.rst b/_downloads/ad0ebe55d6b53b1559e0ca8dee6f30b9/reST.rst index 4835cbbc..7b253d9e 100644 --- a/_downloads/ad0ebe55d6b53b1559e0ca8dee6f30b9/reST.rst +++ b/_downloads/ad0ebe55d6b53b1559e0ca8dee6f30b9/reST.rst @@ -326,7 +326,7 @@ Literal blocks The simplest form of :duref:`literal-blocks` is a indented block introduced by two colons (``::``). For highlighting use :dudir:`highlight` or :ref:`reST code` directive. To include literals from external files use directive -:dudir:`literalinclude`. +:rst:dir:`literalinclude`. .. _reST literal: @@ -1312,9 +1312,8 @@ others are basic-tabs_ and code-tabs_. Below a *group-tab* example from .. literalinclude:: ../admin/buildhosts.rst :language: reST - :start-after: .. _system requirements: - :end-before: .. _system requirements END: - + :start-after: .. SNIP sh lint requirements + :end-before: .. SNAP sh lint requirements .. _math: diff --git a/_images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.svg b/_images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.svg index a5b36733..8b13661f 100644 --- a/_images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.svg +++ b/_images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.svg @@ -1,31 +1,31 @@ - foo - + bar - -bar + +bar baz - -baz + +baz bar->baz - - + + diff --git a/_images/arch_public.dot b/_images/arch_public.dot index a46c96de..5018225c 100644 --- a/_images/arch_public.dot +++ b/_images/arch_public.dot @@ -4,11 +4,11 @@ digraph G { edge [fontname="Sans"]; browser [label="Browser", shape=Mdiamond]; - rp [label="Reverse Proxy", href="url to configure reverse proxy"]; - filtron [label="Filtron", href="https://github.com/asciimoo/filtron"]; - morty [label="Morty", href="https://github.com/asciimoo/morty"]; + rp [label="Reverse Proxy", href="https://asciimoo.github.io/searx/utils/filtron.sh.html#public-reverse-proxy"]; + filtron [label="Filtron", href="https://asciimoo.github.io/searx/utils/filtron.sh.html"]; + morty [label="Morty", href="https://asciimoo.github.io/searx/utils/morty.sh.html"]; static [label="Static files", href="url to configure static files"]; - uwsgi [label="uwsgi", href="url to configure uwsgi"] + uwsgi [label="uwsgi", href="https://asciimoo.github.io/searx/utils/searx.sh.html"] searx1 [label="Searx #1"]; searx2 [label="Searx #2"]; searx3 [label="Searx #3"]; diff --git a/_images/arch_public.svg b/_images/arch_public.svg index 9d44ed50..f8b12adf 100644 --- a/_images/arch_public.svg +++ b/_images/arch_public.svg @@ -1,156 +1,156 @@ - - - + + G - + cluster_searx - -Searx instance + +Searx instance browser - - - - - -Browser + + + + + +Browser rp - - -Reverse Proxy + + +Reverse Proxy browser->rp - - -HTTPS + + +HTTPS filtron - - -Filtron + + +Filtron rp->filtron - - -HTTP + + +HTTP morty - - -Morty + + +Morty rp->morty - - -optional: images and HTML pages proxy + + +optional: images and HTML pages proxy static - -Static files + +Static files rp->static - - -optional: reverse proxy serves directly static files + + +optional: reverse proxy serves directly static files uwsgi - - -uwsgi + + +uwsgi filtron->uwsgi - - -HTTP + + +HTTP searx1 - -Searx #1 + +Searx #1 uwsgi->searx1 - - + + searx2 - -Searx #2 + +Searx #2 uwsgi->searx2 - - + + searx3 - -Searx #3 + +Searx #3 uwsgi->searx3 - - + + searx4 - -Searx #4 + +Searx #4 uwsgi->searx4 - - + + diff --git a/_images/hello.svg b/_images/hello.svg index 18be1da8..efecdd72 100644 --- a/_images/hello.svg +++ b/_images/hello.svg @@ -1,30 +1,30 @@ - G - + Hello - -Hello + +Hello World - -World + +World Hello--World - + diff --git a/_images/math/07c9ff4251510b06013159f4e45ec9ab97044096.svg b/_images/math/07c9ff4251510b06013159f4e45ec9ab97044096.svg new file mode 100644 index 00000000..56e0153c --- /dev/null +++ b/_images/math/07c9ff4251510b06013159f4e45ec9ab97044096.svg @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/_images/math/3b8127a8eed95247f9249ea6c85e8e86df1baa82.svg b/_images/math/3b8127a8eed95247f9249ea6c85e8e86df1baa82.svg new file mode 100644 index 00000000..d49851cd --- /dev/null +++ b/_images/math/3b8127a8eed95247f9249ea6c85e8e86df1baa82.svg @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/_images/math/6673b43f9fe29455c1fcd1164e5844698cc64d38.svg b/_images/math/6673b43f9fe29455c1fcd1164e5844698cc64d38.svg new file mode 100644 index 00000000..69195bdd --- /dev/null +++ b/_images/math/6673b43f9fe29455c1fcd1164e5844698cc64d38.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/_images/math/a6a994cb6e7278ec30eaebe7e636046d3deccb5b.svg b/_images/math/a6a994cb6e7278ec30eaebe7e636046d3deccb5b.svg new file mode 100644 index 00000000..a89b7f7d --- /dev/null +++ b/_images/math/a6a994cb6e7278ec30eaebe7e636046d3deccb5b.svg @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/_sources/admin/architecture.rst.txt b/_sources/admin/architecture.rst.txt index 7064a294..464e765e 100644 --- a/_sources/admin/architecture.rst.txt +++ b/_sources/admin/architecture.rst.txt @@ -4,17 +4,21 @@ Architecture ============ -.. sidebar:: Needs work! +.. sidebar:: Further reading - This article needs some work / Searx is a collaborative effort. If you have - any contribution, feel welcome to send us your :pull:`PR <../pulls>`, see - :ref:`how to contribute`. + - Reverse Proxy: :ref:`Apache ` & :ref:`nginx ` + - Filtron: :ref:`searx filtron` + - Morty: :ref:`searx morty` + - uWSGI: :ref:`searx uwsgi` + - Searx: :ref:`installation basic` Herein you will find some hints and suggestions about typical architectures of searx infrastructures. We start with a contribution from :pull:`@dalf <1776#issuecomment-567917320>`. -It shows a *reference* setup for public searx instances. +It shows a *reference* setup for public searx instances which can build up and +maintained by the scripts from our :ref:`toolboxing`. .. _arch public: diff --git a/_sources/admin/buildhosts.rst.txt b/_sources/admin/buildhosts.rst.txt index 5260da03..04698d8d 100644 --- a/_sources/admin/buildhosts.rst.txt +++ b/_sources/admin/buildhosts.rst.txt @@ -9,8 +9,27 @@ Buildhosts If you have any contribution send us your :pull:`PR <../pulls>`, see :ref:`how to contribute`. +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + To get best results from build, its recommend to install additional packages -on build hosts. +on build hosts (see :ref:`searx.sh`).:: + + sudo -H ./utils/searx.sh buildhost + +This will install packages needed by searx: + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START distro-packages + :end-before: END distro-packages + +and packages needed to build docuemtation and run tests: + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START build-packages + :end-before: END build-packages .. _docs build: @@ -35,8 +54,17 @@ processing additional packages are needed. The XeTeX_ needed not only for PDF creation, its also needed for :ref:`math` when HTML output is build. To be able to do :ref:`sphinx:math-support` without CDNs, the math are rendered -as images (``sphinx.ext.imgmath`` extension). If your docs build (``make -docs``) shows warnings like this:: +as images (``sphinx.ext.imgmath`` extension). + +Here is the extract from the :origin:`docs/conf.py` file, setting math renderer +to ``imgmath``: + +.. literalinclude:: ../conf.py + :language: python + :start-after: # sphinx.ext.imgmath setup + :end-before: # sphinx.ext.imgmath setup END + +If your docs build (``make docs``) shows warnings like this:: WARNING: dot(1) not found, for better output quality install \ graphviz from http://www.graphviz.org @@ -47,8 +75,6 @@ docs``) shows warnings like this:: you need to install additional packages on your build host, to get better HTML output. -.. _system requirements: - .. tabs:: .. group-tab:: Ubuntu / debian @@ -92,12 +118,38 @@ For PDF output you also need: $ sudo dnf install \ texlive-collection-fontsrecommended texlive-collection-latex \ - dejavu-sans-fonts dejavu-serif-fonts dejavu-sans-mono-fonts + dejavu-sans-fonts dejavu-serif-fonts dejavu-sans-mono-fonts \ + ImageMagick -.. _system requirements END: +.. _sh lint: -.. literalinclude:: ../conf.py - :language: python - :start-after: # sphinx.ext.imgmath setup - :end-before: # sphinx.ext.imgmath setup END +Lint shell scripts +================== +.. _ShellCheck: https://github.com/koalaman/shellcheck + +To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool. + +.. SNIP sh lint requirements + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code-block:: sh + + $ sudo apt install shellcheck + + .. group-tab:: Arch Linux + + .. code-block:: sh + + $ sudo pacman -S shellcheck + + .. group-tab:: Fedora / RHEL + + .. code-block:: sh + + $ sudo dnf install ShellCheck + +.. SNAP sh lint requirements diff --git a/_sources/admin/filtron.rst.txt b/_sources/admin/filtron.rst.txt index 07dcb9bc..8bf64164 100644 --- a/_sources/admin/filtron.rst.txt +++ b/_sources/admin/filtron.rst.txt @@ -1,18 +1,51 @@ + +.. _searx filtron: + ========================== How to protect an instance ========================== -Searx depens on external search services. To avoid the abuse of these services +.. sidebar:: further reading + + - :ref:`filtron.sh` + - :ref:`nginx searx site` + + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +.. _filtron: https://github.com/asciimoo/filtron + +Searx depends 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 -`__. +An application firewall, filtron_ solves exactly this problem. Filtron is just +a middleware between your web server (nginx, apache, ...) and searx, we describe +such infratructures in chapter: :ref:`architecture`. +filtron & go +============ + +.. _Go: https://golang.org/ +.. _filtron README: https://github.com/asciimoo/filtron/blob/master/README.md + +Filtron needs Go_ installed. If Go_ is preinstalled, filtron_ is simply +installed by ``go get`` package management (see `filtron README`_). If you use +filtron as middleware, a more isolated setup is recommended. To simplify such +an installation and the maintenance of, use our script :ref:`filtron.sh`. + +.. _Sample configuration of filtron: + Sample configuration of filtron =============================== +.. sidebar:: Tooling box + + - :origin:`/etc/filtron/rules.json ` + An example configuration can be find below. This configuration limits the access of: @@ -24,105 +57,113 @@ of: .. code:: json - [{ - "name":"search request", - "filters":[ - "Param:q", - "Path=^(/|/search)$" - ], - "interval":"", - "limit":"", - "subrules":[ - { - "name":"roboagent limit", - "interval":"", - "limit":"", - "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":"", - "limit":"", - "stop":true, - "aggregations":[ - "Header:X-Forwarded-For" - ], - "actions":[ - { - "name":"block", - "params":{ - "message":"Rate limit exceeded" - } - } - ] - }, - { - "name":"rss/json limit", - "interval":"", - "limit":"", - "stop":true, - "filters":[ - "Param:format=(csv|json|rss)" - ], - "actions":[ - { - "name":"block", - "params":{ - "message":"Rate limit exceeded" - } - } - ] - }, - { - "name":"useragent limit", - "interval":"", - "limit":"", - "aggregations":[ - "Header:User-Agent" - ], - "actions":[ - { - "name":"block", - "params":{ - "message":"Rate limit exceeded" - } - } - ] - } - ] - }] + [ + { "name": "search request", + "filters": [ + "Param:q", + "Path=^(/|/search)$" + ], + "interval": "", + "limit": "", + "subrules": [ + { + "name": "roboagent limit", + "interval": "", + "limit": "", + "filters": [ + "Header:User-Agent=(curl|cURL|Wget|python-requests|Scrapy|FeedFetcher|Go-http-client)" + ], + "actions": [ + { "name": "log"}, + { "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": "log"}, + { "name": "block", + "params": { + "message": "Rate limit exceeded" + } + } + ] + }, + { + "name": "IP limit", + "interval": "", + "limit": "", + "stop": true, + "aggregations": [ + "Header:X-Forwarded-For" + ], + "actions": [ + { "name": "log"}, + { "name": "block", + "params": { + "message": "Rate limit exceeded" + } + } + ] + }, + { + "name": "rss/json limit", + "interval": "", + "limit": "", + "stop": true, + "filters": [ + "Param:format=(csv|json|rss)" + ], + "actions": [ + { "name": "log"}, + { "name": "block", + "params": { + "message": "Rate limit exceeded" + } + } + ] + }, + { + "name": "useragent limit", + "interval": "", + "limit": "", + "aggregations": [ + "Header:User-Agent" + ], + "actions": [ + { "name": "log"}, + { "name": "block", + "params": { + "message": "Rate limit exceeded" + } + } + ] + } + ] + } + ] +.. _filtron route request: Route request through filtron ============================= +.. sidebar:: further reading + + - :ref:`filtron.sh overview` + - :ref:`installation nginx` + - :ref:`installation apache` + Filtron can be started using the following command: .. code:: sh @@ -136,13 +177,24 @@ Use it along with ``nginx`` with the following example configuration. .. code:: nginx - 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/; + # https://example.org/searx + + location /searx { + proxy_pass http://127.0.0.1:4004/; + + proxy_set_header Host $http_host; + proxy_set_header Connection $http_connection; + 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_set_header X-Script-Name /searx; } + location /searx/static { + /usr/local/searx/searx-src/searx/static; + } + + Requests are coming from port 4004 going through filtron and then forwarded to -port 8888 where a searx is being run. +port 8888 where a searx is being run. For a complete setup see: :ref:`nginx +searx site`. diff --git a/_sources/admin/index.rst.txt b/_sources/admin/index.rst.txt index b3c7f511..c708c4ff 100644 --- a/_sources/admin/index.rst.txt +++ b/_sources/admin/index.rst.txt @@ -3,9 +3,16 @@ Administrator documentation =========================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents installation + installation-searx + installation-uwsgi + installation-nginx + installation-apache + installation-docker + update-searx settings api architecture diff --git a/_sources/admin/installation-apache.rst.txt b/_sources/admin/installation-apache.rst.txt new file mode 100644 index 00000000..217e5771 --- /dev/null +++ b/_sources/admin/installation-apache.rst.txt @@ -0,0 +1,514 @@ +.. _installation apache: + +=================== +Install with apache +=================== + +.. _Apache: https://httpd.apache.org/ +.. _Apache Debian: + https://cwiki.apache.org/confluence/display/HTTPD/DistrosDefaultLayout#DistrosDefaultLayout-Debian,Ubuntu(Apachehttpd2.x): +.. _README.Debian: + https://salsa.debian.org/apache-team/apache2/raw/master/debian/apache2.README.Debian +.. _Apache Arch Linux: + https://wiki.archlinux.org/index.php/Apache_HTTP_Server +.. _Apache Fedora: + https://docs.fedoraproject.org/en-US/quick-docs/getting-started-with-apache-http-server/index.html +.. _Apache directives: + https://httpd.apache.org/docs/trunk/mod/directives.html +.. _Getting Started: + https://httpd.apache.org/docs/current/en/getting-started.html +.. _Terms Used to Describe Directives: + https://httpd.apache.org/docs/current/en/mod/directive-dict.html +.. _Configuration Files: + https://httpd.apache.org/docs/current/en/configuring.html +.. _ProxyPreserveHost: https://httpd.apache.org/docs/trunk/mod/mod_proxy.html#proxypreservehost +.. _LoadModule: + https://httpd.apache.org/docs/2.4/mod/mod_so.html#loadmodule +.. _DocumentRoot: + https://httpd.apache.org/docs/trunk/mod/core.html#documentroot +.. _Location: + https://httpd.apache.org/docs/trunk/mod/core.html#location +.. _uWSGI Apache support: + https://uwsgi-docs.readthedocs.io/en/latest/Apache.html +.. _mod_proxy_uwsgi: + https://uwsgi-docs.readthedocs.io/en/latest/Apache.html#mod-proxy-uwsgi + +.. sidebar:: further read + + - `Apache Arch Linux`_ + - `Apache Debian`_ and `README.Debian`_ + - `Apache Fedora`_ + - `Apache directives`_ + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +---- + +**Install** :ref:`apache searx site` using :ref:`filtron.sh ` + +.. code:: bash + + $ sudo -H ./utils/filtron.sh apache install + +**Install** :ref:`apache searx site` using :ref:`morty.sh ` + +.. code:: bash + + $ sudo -H ./utils/morty.sh apache install + +---- + +The apache HTTP server +====================== + +If Apache_ is not installed, install it now. If apache_ is new to you, the +`Getting Started`_, `Configuration Files`_ and `Terms Used to Describe +Directives`_ documentation gives first orientation. There is also a list of +`Apache directives`_ *to keep in the pocket*. + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + sudo -H apt-get install apache2 + + .. group-tab:: Arch Linux + + .. code:: sh + + sudo -H pacman -S apache + sudo -H systemctl enable httpd + sudo -H systemctl start http + + .. group-tab:: Fedora / RHEL + + .. code:: sh + + sudo -H dnf install httpd + sudo -H systemctl enable httpd + sudo -H systemctl start httpd + +Now at http://localhost you should see any kind of *Welcome* or *Test* page. +How this default intro site is configured, depends on the linux distribution +(compare `Apache directives`_). + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + less /etc/apache2/sites-enabled/000-default.conf + + In this file, there is a line setting the `DocumentRoot`_ directive: + + .. code:: apache + + DocumentRoot /var/www/html + + And the *welcome* page is the HTML file at ``/var/www/html/index.html``. + + .. group-tab:: Arch Linux + + .. code:: sh + + less /etc/httpd/conf/httpd.conf + + In this file, there is a line setting the `DocumentRoot`_ directive: + + .. code:: apache + + DocumentRoot "/srv/http" + + Options Indexes FollowSymLinks + AllowOverride None + Require all granted + + + The *welcome* page of Arch Linux is a page showing directory located at + ``DocumentRoot``. This is *directory* page is generated by the Module + `mod_autoindex `_: + + .. code:: apache + + LoadModule autoindex_module modules/mod_autoindex.so + ... + Include conf/extra/httpd-autoindex.conf + + .. group-tab:: Fedora / RHEL + + .. code:: sh + + less /etc/httpd/conf/httpd.conf + + In this file, there is a line setting the ``DocumentRoot`` directive: + + .. code:: apache + + DocumentRoot "/var/www/html" + ... + + AllowOverride None + # Allow open access: + Require all granted + + + On fresh installations, the ``/var/www`` is empty and the *default + welcome page* is shown, the configuration is located at:: + + less /etc/httpd/conf.d/welcome.conf + +.. _apache searx site: + +Apache Reverse Proxy +==================== + +.. sidebar:: public to the internet? + + If your searx instance is public, stop here and first install :ref:`filtron + reverse proxy ` and :ref:`result proxy morty `, see + :ref:`installation scripts`. If already done, follow setup: *searx via + filtron plus morty*. + +To setup a Apache revers proxy you have to enable the *headers* and *proxy* +modules and create a `Location`_ configuration for the searx site. In most +distributions you have to un-comment the lines in the main configuration file, +except in :ref:`The Debian Layout`. + +To pass the HTTP HOST header +With ProxyPreserveHost_ the incoming Host HTTP request header is passed to the +proxied host. + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + In the Apache setup, enable headers and proxy modules: + + .. code:: sh + + sudo -H a2enmod headers + sudo -H a2enmod proxy + sudo -H a2enmod proxy_http + + In :ref:`The Debian Layout` you create a ``searx.conf`` with the + ```` directive and save this file in the *sites + available* folder at ``/etc/apache2/sites-available``. To enable the + ``searx.conf`` use :man:`a2ensite`: + + .. code:: sh + + sudo -H a2ensite searx.conf + + .. group-tab:: Arch Linux + + In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy + modules (LoadModule_): + + .. code:: apache + + FIXME needs test + + LoadModule headers_module modules/mod_headers.so + LoadModule proxy_module modules/mod_proxy.so + LoadModule proxy_http_module modules/mod_proxy_http.so + + .. group-tab:: Fedora / RHEL + + In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy + modules (LoadModule_): + + .. code:: apache + + FIXME needs test + + LoadModule headers_module modules/mod_headers.so + LoadModule proxy_module modules/mod_proxy.so + LoadModule proxy_http_module modules/mod_proxy_http.so + +.. tabs:: + + .. group-tab:: searx via filtron plus morty + + Use this setup, if your instance is public to the internet, compare + figure: :ref:`architecture ` and :ref:`installation scripts`. + + 1. Configure a reverse proxy for :ref:`filtron `, listening on + *localhost 4004* (:ref:`filtron route request`): + + .. code:: apache + + + + # SetEnvIf Request_URI "/searx" dontlog + # CustomLog /dev/null combined env=dontlog + + Require all granted + + Order deny,allow + Deny from all + #Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1 + Allow from all + + ProxyPreserveHost On + ProxyPass http://127.0.0.1:4004 + RequestHeader set X-Script-Name /searx + + + + 2. Configure reverse proxy for :ref:`morty `, listening on + *localhost 3000* + + .. code:: apache + + ProxyPreserveHost On + + + + # SetEnvIf Request_URI "/morty" dontlog + # CustomLog /dev/null combined env=dontlog + + Require all granted + + Order deny,allow + Deny from all + #Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1 + Allow from all + + ProxyPass http://127.0.0.1:3000 + RequestHeader set X-Script-Name /morty + + + + Note that reverse proxy advised to be used in case of single-user or + low-traffic instances. For a fully result proxification add :ref:`morty's + ` **public URL** to your :origin:`searx/settings.yml`: + + .. code:: yaml + + result_proxy: + # replace example.org with your server's public name + url : https://example.org/morty + + server: + image_proxy : True + +uWSGI support +============= + +Be warned, with this setup, your instance isn't :ref:`protected `, nevertheless it is good enough for intranet usage. In modern Linux +distributions, the `mod_proxy_uwsgi`_ is compiled into the *normal* apache +package and you need to install only the :ref:`uWSGI ` package: + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + sudo -H apt-get install uwsgi + + # Ubuntu =< 18.04 + sudo -H apt-get install libapache2-mod-proxy-uwsgi + + .. group-tab:: Arch Linux + + .. code:: sh + + sudo -H pacman -S uwsgi + + .. group-tab:: Fedora / RHEL + + .. code:: sh + + sudo -H dnf install uwsgi + +The next example shows a configuration using the `uWSGI Apache support`_ via +unix sockets and `mod_proxy_uwsgi`_. + +For socket communication, you have to activate ``socket = +/run/uwsgi/app/searx/socket`` and comment out the ``http = 127.0.0.1:8888`` +configuration in your :ref:`uwsgi ini file `. If not +already exists, create a folder for the unix sockets, which can be used by the +searx account (see :ref:`create searx user`): + +.. code:: bash + + sudo -H mkdir -p /run/uwsgi/app/searx/ + sudo -H chown -R searx:searx /run/uwsgi/app/searx/ + +If the server is public; to limit access to your intranet replace ``Allow from +all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: apache + + LoadModule headers_module /usr/lib/apache2/mod_headers.so + LoadModule proxy_module /usr/lib/apache2/modules/mod_proxy.so + LoadModule proxy_uwsgi_module /usr/lib/apache2/modules/mod_proxy_uwsgi.so + + # SetEnvIf Request_URI /searx dontlog + # CustomLog /dev/null combined env=dontlog + + + + Require all granted + Order deny,allow + Deny from all + # Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1 + Allow from all + + ProxyPreserveHost On + ProxyPass unix:/run/uwsgi/app/searx/socket|uwsgi://uwsgi-uds-searx/ + + + + .. group-tab:: Arch Linux + + .. code:: apache + + FIXME needs test + + LoadModule proxy_module modules/mod_proxy.so + LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so + + # SetEnvIf Request_URI /searx dontlog + # CustomLog /dev/null combined env=dontlog + + + + Require all granted + Order deny,allow + Deny from all + # Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1 + Allow from all + + ProxyPreserveHost On + ProxyPass unix:/run/uwsgi/app/searx/socket|uwsgi://uwsgi-uds-searx/ + + + + .. group-tab:: Fedora / RHEL + + .. code:: apache + + FIXME needs test + + LoadModule proxy_module modules/mod_proxy.so + LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so + + + # SetEnvIf Request_URI /searx dontlog + # CustomLog /dev/null combined env=dontlog + + + + Require all granted + Order deny,allow + Deny from all + # Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1 + Allow from all + + ProxyPreserveHost On + ProxyPass unix:/run/uwsgi/app/searx/socket|uwsgi://uwsgi-uds-searx/ + + + + + + .. group-tab:: old mod_wsgi + + We show this only for historical reasons, DON'T USE `mod_uwsgi + `_. + ANYMORE! + + .. code:: apache + + + + # SetEnvIf Request_URI "/searx" dontlog + # CustomLog /dev/null combined env=dontlog + + + + Require all granted + + Options FollowSymLinks Indexes + SetHandler uwsgi-handler + uWSGISocket /run/uwsgi/app/searx/socket + + Order deny,allow + Deny from all + # Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1 + Allow from all + + + + + +.. _restart apache: + +Restart service +=============== + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + sudo -H systemctl restart apache2 + sudo -H service uwsgi restart searx + + .. group-tab:: Arch Linux + + .. code:: sh + + sudo -H systemctl restart httpd + sudo -H systemctl restart uwsgi@searx + + .. group-tab:: Fedora / RHEL + + .. code:: sh + + sudo -H systemctl restart httpd + sudo -H touch /etc/uwsgi.d/searx.ini + + +disable logs +============ + +For better privacy you can disable Apache logs. In the examples above activate +one of the lines and `restart apache`_:: + + + # SetEnvIf Request_URI "/searx" dontlog + # CustomLog /dev/null combined env=dontlog + +The ``CustomLog`` directive disable logs for the whole (virtual) server, use it +when the URL of the service does not have a path component (``/searx``) / is +located at root (``/``). + +.. _The Debian Layout: + +The Debian Layout +================= + +Be aware that the Debian layout is quite different from the standard Apache +configuration. For details look at the README.Debian_ +(``/usr/share/doc/apache2/README.Debian.gz``). Some commands you should know on +Debian: + +* :man:`apache2ctl`: Apache HTTP server control interface +* :man:`a2enmod`, :man:`a2dismod`: switch on/off modules +* :man:`a2enconf`, :man:`a2disconf`: switch on/off configurations +* :man:`a2ensite`, :man:`a2dissite`: switch on/off sites diff --git a/_sources/admin/installation-docker.rst.txt b/_sources/admin/installation-docker.rst.txt new file mode 100644 index 00000000..340e6631 --- /dev/null +++ b/_sources/admin/installation-docker.rst.txt @@ -0,0 +1,28 @@ +.. _installation docker: + +=================== +Docker installation +=================== + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +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 . diff --git a/_sources/admin/installation-nginx.rst.txt b/_sources/admin/installation-nginx.rst.txt new file mode 100644 index 00000000..5e32d968 --- /dev/null +++ b/_sources/admin/installation-nginx.rst.txt @@ -0,0 +1,381 @@ +.. _installation nginx: + +================== +Install with nginx +================== + +.. _nginx: + https://docs.nginx.com/nginx/admin-guide/ +.. _nginx server configuration: + https://docs.nginx.com/nginx/admin-guide/web-server/web-server/#setting-up-virtual-servers +.. _nginx beginners guide: + http://nginx.org/en/docs/beginners_guide.html +.. _Getting Started wiki: + https://www.nginx.com/resources/wiki/start/ +.. _uWSGI support from nginx: + https://uwsgi-docs.readthedocs.io/en/latest/Nginx.html +.. _uwsgi_params: + https://uwsgi-docs.readthedocs.io/en/latest/Nginx.html#configuring-nginx +.. _SCRIPT_NAME: + https://werkzeug.palletsprojects.com/en/1.0.x/wsgi/#werkzeug.wsgi.get_script_name + +.. sidebar:: further reading + + - nginx_ + - `nginx beginners guide`_ + - `nginx server configuration`_ + - `Getting Started wiki`_ + - `uWSGI support from nginx`_ + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +---- + +**Install** :ref:`nginx searx site` using :ref:`filtron.sh ` + +.. code:: bash + + $ sudo -H ./utils/filtron.sh nginx install + +**Install** :ref:`nginx searx site` using :ref:`morty.sh ` + +.. code:: bash + + $ sudo -H ./utils/morty.sh nginx install + +---- + + +The nginx HTTP server +===================== + +If nginx_ is not installed (uwsgi will not work with the package nginx-light), +install it now. + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + sudo -H apt-get install nginx + + .. group-tab:: Arch Linux + + .. code-block:: sh + + sudo -H pacman -S nginx-mainline + sudo -H systemctl enable nginx + sudo -H systemctl start nginx + + .. group-tab:: Fedora / RHEL + + .. code-block:: sh + + sudo -H dnf install nginx + sudo -H systemctl enable nginx + sudo -H systemctl start nginx + +Now at http://localhost you should see a *Welcome to nginx!* page, on Fedora you +see a *Fedora Webserver - Test Page*. The test page comes from the default +`nginx server configuration`_. How this default intro site is configured, +depends on the linux distribution: + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + less /etc/nginx/nginx.conf + + there is a line including site configurations from: + + .. code:: nginx + + include /etc/nginx/sites-enabled/*; + + .. group-tab:: Arch Linux + + .. code-block:: sh + + less /etc/nginx/nginx.conf + + in there is a configuration section named ``server``: + + .. code-block:: nginx + + server { + listen 80; + server_name localhost; + # ... + } + + .. group-tab:: Fedora / RHEL + + .. code-block:: sh + + less /etc/nginx/nginx.conf + + there is a line including site configurations from: + + .. code:: nginx + + include /etc/nginx/conf.d/*.conf; + +.. _nginx searx site: + +A nginx searx site +================== + +.. sidebar:: public to the internet? + + If your searx instance is public, stop here and first install :ref:`filtron + reverse proxy ` and :ref:`result proxy morty `, see + :ref:`installation scripts`. If already done, follow setup: *searx via + filtron plus morty*. + +Now you have to create a configuration for the searx site. If nginx_ is new to +you, the `nginx beginners guide`_ is a good starting point and the `Getting +Started wiki`_ is always a good resource *to keep in the pocket*. + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + Create configuration at ``/etc/nginx/sites-available/searx`` and place a + symlink to sites-enabled: + + .. code:: sh + + sudo -H ln -s /etc/nginx/sites-available/searx /etc/nginx/sites-enabled/searx + + .. group-tab:: Arch Linux + + In the ``/etc/nginx/nginx.conf`` file, replace the configuration section + named ``server``. + + .. group-tab:: Fedora / RHEL + + Create configuration at ``/etc/nginx/conf.d/searx`` and place a + symlink to sites-enabled: + +.. tabs:: + + .. group-tab:: searx via filtron plus morty + + Use this setup, if your instance is public to the internet, compare + figure: :ref:`architecture ` and :ref:`installation scripts`. + + 1. Configure a reverse proxy for :ref:`filtron `, listening on + *localhost 4004* (:ref:`filtron route request`): + + .. code:: nginx + + # https://example.org/searx + + location /searx { + proxy_pass http://127.0.0.1:4004/; + + proxy_set_header Host $http_host; + proxy_set_header Connection $http_connection; + 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_set_header X-Script-Name /searx; + } + + location /searx/static { + /usr/local/searx/searx-src/searx/static; + } + + + 2. Configure reverse proxy for :ref:`morty `, listening on + *localhost 3000*: + + .. code:: nginx + + # https://example.org/morty + + location /morty { + proxy_pass http://127.0.0.1:3000/; + + proxy_set_header Host $http_host; + proxy_set_header Connection $http_connection; + 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; + } + + Note that reverse proxy advised to be used in case of single-user or + low-traffic instances. For a fully result proxification add :ref:`morty's + ` **public URL** to your :origin:`searx/settings.yml`: + + .. code:: yaml + + result_proxy: + # replace example.org with your server's public name + url : https://example.org/morty + + server: + image_proxy : True + + + .. group-tab:: proxy or uWSGI + + Be warned, with this setup, your instance isn't :ref:`protected `. Nevertheless it is good enough for intranet usage and it is a + excellent example of; *how different services can be set up*. The next + example shows a reverse proxy configuration wrapping the :ref:`searx-uWSGI + application `, listening on ``http = + 127.0.0.1:8888``. + + .. code:: nginx + + # https://hostname.local/ + + location / { + proxy_pass http://127.0.0.1:8888; + + proxy_set_header Host $host; + proxy_set_header Connection $http_connection; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Scheme $scheme; + proxy_buffering off; + } + + Alternatively you can use the `uWSGI support from nginx`_ via unix + sockets. For socket communication, you have to activate ``socket = + /run/uwsgi/app/searx/socket`` and comment out the ``http = + 127.0.0.1:8888`` configuration in your :ref:`uwsgi ini file `. + + The example shows a nginx virtual ``server`` configuration, listening on + port 80 (IPv4 and IPv6 http://[::]:80). The uWSGI app is configured at + location ``/`` by importing the `uwsgi_params`_ and passing requests to + the uWSGI socket (``uwsgi_pass``). The ``server``\'s root points to the + :ref:`searx-src clone ` and wraps directly the + :origin:`searx/static/` content at ``location /static``. + + .. code:: nginx + + server { + # replace hostname.local with your server's name + server_name hostname.local; + + listen 80; + listen [::]:80; + + location / { + include uwsgi_params; + uwsgi_pass unix:/run/uwsgi/app/searx/socket; + } + + root /usr/local/searx/searx-src/searx; + location /static { } + } + + If not already exists, create a folder for the unix sockets, which can be + used by the searx account: + + .. code:: bash + + mkdir -p /run/uwsgi/app/searx/ + sudo -H chown -R searx:searx /run/uwsgi/app/searx/ + + .. group-tab:: \.\. at subdir URL + + Be warned, with these setups, your instance isn't :ref:`protected `. The examples are just here to demonstrate how to export the + searx application from a subdirectory URL ``https://example.org/searx/``. + + .. code:: nginx + + # https://hostname.local/searx + + location /searx { + proxy_pass http://127.0.0.1:8888; + + proxy_set_header Host $host; + proxy_set_header Connection $http_connection; + 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; + } + + location /searx/static { + alias /usr/local/searx/searx-src/searx/static; + } + + The ``X-Script-Name /searx`` is needed by the searx implementation to + calculate relative URLs correct. The next example shows a uWSGI + configuration. Since there are no HTTP headers in a (u)WSGI protocol, the + value is shipped via the SCRIPT_NAME_ in the WSGI environment. + + .. code:: nginx + + # https://hostname.local/searx + + location /searx { + uwsgi_param SCRIPT_NAME /searx; + include uwsgi_params; + uwsgi_pass unix:/run/uwsgi/app/searx/socket; + } + + location /searx/static { + alias /usr/local/searx/searx-src/searx; + } + + For searx to work correctly the ``base_url`` must be set in the + :origin:`searx/settings.yml`. + + .. code:: yaml + + server: + # replace example.org with your server's public name + base_url : https://example.org/searx/ + + +Restart service: + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + sudo -H systemctl restart nginx + sudo -H service uwsgi restart searx + + .. group-tab:: Arch Linux + + .. code:: sh + + sudo -H systemctl restart nginx + sudo -H systemctl restart uwsgi@searx + + .. group-tab:: Fedora + + .. code:: sh + + sudo -H systemctl restart nginx + sudo -H touch /etc/uwsgi.d/searx.ini + + +Disable logs +============ + +For better privacy you can disable nginx logs in ``/etc/nginx/nginx.conf``. + +.. code:: nginx + + http { + # ... + access_log /dev/null; + error_log /dev/null; + # ... + } diff --git a/_sources/admin/installation-searx.rst.txt b/_sources/admin/installation-searx.rst.txt new file mode 100644 index 00000000..d5c0063e --- /dev/null +++ b/_sources/admin/installation-searx.rst.txt @@ -0,0 +1,92 @@ +.. _installation basic: + +========================= +Step by step installation +========================= + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +Step by step installation with virtualenv. For Ubuntu, be sure to have enable +universe repository. + +.. _install packages: + +Install packages +================ + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START distro-packages + :end-before: END distro-packages + +.. hint:: + + This installs also the packages needed by :ref:`searx uwsgi` + +.. _create searx user: + +Create user +=========== + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START create user + :end-before: END create user + +.. _searx-src: + +install searx & dependencies +============================ + +Start a interactive shell from new created user and clone searx: + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START clone searx + :end-before: END clone searx + +In the same shell create *virtualenv*: + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START create virtualenv + :end-before: END create virtualenv + +To install searx's dependencies, exit the searx *bash* session you opened above +and restart a new. Before install, first check if your *virualenv* was sourced +from the login (*~/.profile*): + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START manage.sh update_packages + :end-before: END manage.sh update_packages + +.. tip:: + + Open a second terminal for the configuration tasks and left the ``(searx)$`` + terminal open for the tasks below. + +Configuration +============== + +Create a copy of the :origin:`searx/settings.yml` configuration file in system's +*/etc* folder. Configure like shown below -- replace ``searx@\$(uname -n)`` with +a name of your choice -- *and/or* edit ``/etc/searx/settings.yml`` if necessary. + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START searx config + :end-before: END searx config + +Check +===== + +To check your searx setup, optional enable debugging and start the *webapp*. +Searx looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a +configuration file. + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START check searx installation + :end-before: END check searx installation + +If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the +debug option in ``settings.yml``. You can now exit searx user bash (enter exit +command twice). At this point searx is not demonized; uwsgi allows this. + diff --git a/_sources/admin/installation-uwsgi.rst.txt b/_sources/admin/installation-uwsgi.rst.txt new file mode 100644 index 00000000..72498c0b --- /dev/null +++ b/_sources/admin/installation-uwsgi.rst.txt @@ -0,0 +1,149 @@ +.. _searx uwsgi: + +===== +uwsgi +===== + +.. sidebar:: further reading + + - `systemd.unit`_ + - `uWSGI Emperor`_ + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + + +.. _systemd.unit: https://www.freedesktop.org/software/systemd/man/systemd.unit.html +.. _One service per app in systemd: + https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd +.. _uWSGI Emperor: + https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html +.. _uwsgi ini file: + https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html#ini-files +.. _systemd unit template: + http://0pointer.de/blog/projects/instances.html + + +Origin uWSGI +============ + +How uWSGI is implemented by distributors is different. uWSGI itself +recommend two methods + +`systemd.unit`_ template files as described here `One service per app in systemd`_. + + There is one `systemd unit template`_ and one `uwsgi ini file`_ per uWSGI-app + placed at dedicated locations. Take archlinux and a searx.ini as example:: + + unit template --> /usr/lib/systemd/system/uwsgi@.service + uwsgi ini files --> /etc/uwsgi/searx.ini + + The searx app can be maintained as know from common systemd units:: + + systemctl enable uwsgi@searx + systemctl start uwsgi@searx + systemctl restart uwsgi@searx + systemctl stop uwsgi@searx + +The `uWSGI Emperor`_ mode which fits for maintaining a large range of uwsgi apps. + + The Emperor mode is a special uWSGI instance that will monitor specific + events. The Emperor mode (service) is started by a (common, not template) + systemd unit. The Emperor service will scan specific directories for `uwsgi + ini file`_\s (also know as *vassals*). If a *vassal* is added, removed or the + timestamp is modified, a corresponding action takes place: a new uWSGI + instance is started, reload or stopped. Take Fedora and a searx.ini as + example:: + + to start a new searx instance create --> /etc/uwsgi.d/searx.ini + to reload the instance edit timestamp --> touch /etc/uwsgi.d/searx.ini + to stop instance remove ini --> rm /etc/uwsgi.d/searx.ini + +Distributors +============ + +The `uWSGI Emperor`_ mode and `systemd unit template`_ is what the distributors +mostly offer their users, even if they differ in the way they implement both +modes and their defaults. Another point they might differ is the packaging of +plugins (if so, compare :ref:`install packages`) and what the default python +interpreter is (python2 vs. python3). + +Fedora starts a Emperor by default, while archlinux does not start any uwsgi +service by default. Worth to know; debian (ubuntu) follow a complete different +approach. *debian*: your are familiar with the apache infrastructure? .. they +do similar for the uWSGI infrastructure (with less comfort), the folders are:: + + /etc/uwsgi/apps-available/ + /etc/uwsgi/apps-enabled/ + +The `uwsgi ini file`_ is enabled by a symbolic link:: + + ln -s /etc/uwsgi/apps-available/searx.ini /etc/uwsgi/apps-enabled/ + +From debian's documentation (``/usr/share/doc/uwsgi/README.Debian.gz``): You +could control specific instance(s) by issuing:: + + service uwsgi ... + + sudo -H service uwsgi start searx + sudo -H service uwsgi stop searx + +My experience is, that this command is a bit buggy. + +.. _uwsgi configuration: + +Alltogether +=========== + +Create the configuration ini-file according to your distribution (see below) and +restart the uwsgi application. + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. literalinclude:: ../../build/docs/includes/searx.rst + :start-after: START searx uwsgi-description ubuntu-20.04 + :end-before: END searx uwsgi-description ubuntu-20.04 + + + .. group-tab:: Arch Linux + + .. literalinclude:: ../../build/docs/includes/searx.rst + :start-after: START searx uwsgi-description arch + :end-before: END searx uwsgi-description arch + + + .. group-tab:: Fedora / RHEL + + .. literalinclude:: ../../build/docs/includes/searx.rst + :start-after: START searx uwsgi-description fedora + :end-before: END searx uwsgi-description fedora + + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. literalinclude:: ../../build/docs/includes/searx.rst + :language: ini + :start-after: START searx uwsgi-appini ubuntu-20.04 + :end-before: END searx uwsgi-appini ubuntu-20.04 + + .. group-tab:: Arch Linux + + .. literalinclude:: ../../build/docs/includes/searx.rst + :language: ini + :start-after: START searx uwsgi-appini arch + :end-before: END searx uwsgi-appini arch + + .. group-tab:: Fedora / RHEL + + .. literalinclude:: ../../build/docs/includes/searx.rst + :language: ini + :start-after: START searx uwsgi-appini fedora + :end-before: END searx uwsgi-appini fedora + + diff --git a/_sources/admin/installation.rst.txt b/_sources/admin/installation.rst.txt index 15800fc0..bfc0742d 100644 --- a/_sources/admin/installation.rst.txt +++ b/_sources/admin/installation.rst.txt @@ -4,346 +4,59 @@ Installation ============ -.. contents:: - :depth: 3 +*You're spoilt for choice*, choose your preferred method of installation. -Basic installation -================== +- :ref:`installation docker` +- :ref:`installation scripts` +- :ref:`installation basic` -Step by step installation for Debian/Ubuntu with virtualenv. For Ubuntu, be sure -to have enable universe repository. +The :ref:`installation basic` is good enough for intranet usage and it is a +excellent illustration of *how a searx instance is build up*. If you place your +instance public to the internet you should really consider to install a +:ref:`filtron reverse proxy ` and for privacy a :ref:`result proxy +` is mandatory. -Install packages: +Therefore, if you do not have any special preferences, its recommend to use the +:ref:`installation docker` or the `Installation scripts`_ from our :ref:`tooling +box ` as described below. -.. code:: sh +.. _installation scripts: - $ sudo -H apt-get install \ - git build-essential libxslt-dev \ - python-dev python-virtualenv python-babel \ - zlib1g-dev libffi-dev libssl-dev +Installation scripts +==================== -Install searx: +The following will install a setup as shown in :ref:`architecture`. First you +need to get a clone. The clone is only needed for the installation procedure +and some maintenance tasks (alternatively you can create your own fork). -.. code:: sh +.. code:: bash - cd /usr/local - sudo -H git clone https://github.com/asciimoo/searx.git - sudo -H useradd searx -d /usr/local/searx - sudo -H chown searx:searx -R /usr/local/searx + $ cd ~/Downloads + $ git clone https://github.com/asciimoo/searx searx + $ cd searx -Install dependencies in a virtualenv: +**Install** :ref:`searx service ` -.. code:: sh +This installs searx as described in :ref:`installation basic`. - cd /usr/local/searx - sudo -H -u searx -i +.. code:: bash -.. code:: sh + $ sudo -H ./utils/searx.sh install all - (searx)$ virtualenv searx-ve - (searx)$ . ./searx-ve/bin/activate - (searx)$ ./manage.sh update_packages +**Install** :ref:`filtron reverse proxy ` -Configuration -============== +.. code:: bash -.. code:: sh + $ sudo -H ./utils/filtron.sh install all - sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml +**Install** :ref:`result proxy ` -Edit searx/settings.yml if necessary. +.. code:: bash -Check -===== + $ sudo -H ./utils/morty.sh install all -Start searx: +If all services are running fine, you can add it to your HTTP server: -.. code:: sh +- :ref:`installation apache` +- :ref:`installation nginx` - 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 -H apt-get install \ - uwsgi uwsgi-plugin-python - -Create the configuration file ``/etc/uwsgi/apps-available/searx.ini`` with this -content: - -.. code:: ini - - [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 - - # Support running the module from a webserver subdirectory. - route-run = fixpathinfo: - - # 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 -H 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/searx; - - location /static { - } - - location / { - include uwsgi_params; - uwsgi_pass unix:/run/uwsgi/app/searx/socket; - } - } - -Create a symlink to sites-enabled: - -.. code:: sh - - sudo -H ln -s /etc/nginx/sites-available/searx /etc/nginx/sites-enabled/searx - -Restart service: - -.. code:: sh - - sudo -H service nginx restart - sudo -H service uwsgi restart - -from subdirectory URL (/searx) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Add this configuration in the server config file -``/etc/nginx/sites-enabled/default``: - -.. code:: nginx - - location /searx/static { - alias /usr/local/searx/searx/static; - } - - location /searx { - uwsgi_param SCRIPT_NAME /searx; - include uwsgi_params; - 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/static { - alias /usr/local/searx/searx/static; - } - - 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`` - -.. code:: yaml - - base_url : http://your.domain.tld/searx/ - -Restart service: - -.. code:: sh - - sudo -H service nginx restart - sudo -H 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: - -.. code:: nginx - - access_log /dev/null; - error_log /dev/null; - -Restart service: - -.. code:: sh - - sudo -H service nginx restart - -with apache ------------ - -Add wsgi mod: - -.. code:: sh - - sudo -H apt-get install libapache2-mod-uwsgi - sudo -H a2enmod uwsgi - -Add this configuration in the file ``/etc/apache2/apache2.conf``: - -.. code:: apache - - - Options FollowSymLinks Indexes - SetHandler uwsgi-handler - uWSGISocket /run/uwsgi/app/searx/socket - - -Note that if your instance of searx is not at the root, you should change -```` by the location of your instance, like ````. - -Restart Apache: - -.. code:: sh - - sudo -H /etc/init.d/apache2 restart - -disable logs -~~~~~~~~~~~~ - -For better privacy you can disable Apache logs. - -.. 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 ```` add: - -.. code:: apache - - CustomLog /dev/null combined - -Restart Apache: - -.. code:: sh - - sudo -H /etc/init.d/apache2 restart - -How to update -============= - -.. code:: sh - - cd /usr/local/searx - sudo -H -u searx -i - -.. code:: sh - - (searx)$ . ./searx-ve/bin/activate - (searx)$ git stash - (searx)$ git pull origin master - (searx)$ git stash apply - (searx)$ ./manage.sh update_packages - -.. code:: sh - - sudo -H 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 - `__ diff --git a/_sources/admin/morty.rst.txt b/_sources/admin/morty.rst.txt index 7d7b3449..2858fde3 100644 --- a/_sources/admin/morty.rst.txt +++ b/_sources/admin/morty.rst.txt @@ -1,7 +1,14 @@ + +.. _searx morty: + ========================= How to setup result proxy ========================= +.. sidebar:: further reading + + - :ref:`morty.sh` + .. _morty: https://github.com/asciimoo/morty .. _morty's README: https://github.com/asciimoo/morty diff --git a/_sources/admin/settings.rst.txt b/_sources/admin/settings.rst.txt index 0bfdcc6c..59a406a2 100644 --- a/_sources/admin/settings.rst.txt +++ b/_sources/admin/settings.rst.txt @@ -4,11 +4,17 @@ ``settings.yml`` ================ +This page describe the options possibilities of the :origin:`searx/settings.yml` +file. + .. sidebar:: Further reading .. - :ref:`search API` -This page describe the options possibilities of the settings.yml file. +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry .. _settings global: diff --git a/_sources/admin/update-searx.rst.txt b/_sources/admin/update-searx.rst.txt new file mode 100644 index 00000000..c74c9568 --- /dev/null +++ b/_sources/admin/update-searx.rst.txt @@ -0,0 +1,23 @@ +.. _update searx: + +============= +How to update +============= + +.. code:: sh + + sudo -H -u searx -i + (searx)$ git stash + (searx)$ git pull origin master + (searx)$ git stash apply + (searx)$ ./manage.sh update_packages + +Restart uwsgi: + +.. tabs:: + + .. group-tab:: Ubuntu / debian + + .. code:: sh + + sudo -H systemctl restart uwsgi diff --git a/_sources/blog/index.rst.txt b/_sources/blog/index.rst.txt index 94847ad6..5a8135fd 100644 --- a/_sources/blog/index.rst.txt +++ b/_sources/blog/index.rst.txt @@ -3,7 +3,8 @@ Blog ==== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents python3 admin diff --git a/_sources/dev/contribution_guide.rst.txt b/_sources/dev/contribution_guide.rst.txt index 459dfb44..f9e9569f 100644 --- a/_sources/dev/contribution_guide.rst.txt +++ b/_sources/dev/contribution_guide.rst.txt @@ -4,6 +4,11 @@ How to contribute ================= +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + Prime directives: Privacy, Hackability ====================================== diff --git a/_sources/dev/index.rst.txt b/_sources/dev/index.rst.txt index cb913a82..ba0a25a9 100644 --- a/_sources/dev/index.rst.txt +++ b/_sources/dev/index.rst.txt @@ -3,7 +3,8 @@ Developer documentation ======================= .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents quickstart contribution_guide diff --git a/_sources/dev/makefile.rst.txt b/_sources/dev/makefile.rst.txt index f5957001..62cd0a98 100644 --- a/_sources/dev/makefile.rst.txt +++ b/_sources/dev/makefile.rst.txt @@ -11,23 +11,17 @@ Makefile Targets Before looking deeper at the targets, first read about :ref:`makefile setup` and :ref:`make pyenv`. + To install system requirements follow :ref:`buildhosts`. + With the aim to simplify development cycles, started with :pull:`1756` a ``Makefile`` based boilerplate was added. If you are not familiar with Makefiles, we recommend to read gnu-make_ introduction. The usage is simple, just type ``make {target-name}`` to *build* a target. -Calling the ``help`` target gives a first overview:: +Calling the ``help`` target gives a first overview (``make help``): + +.. program-output:: bash -c "cd ..; make --no-print-directory help" - $ make help - test - run developer tests - docs - build documentation - docs-live - autobuild HTML documentation while editing - run - run developer instance - install - developer install (./local) - uninstall - uninstall (./local) - gh-pages - build docs & deploy on gh-pages branch - clean - drop builds and environments - ... .. contents:: Contents :depth: 2 @@ -37,27 +31,33 @@ Calling the ``help`` target gives a first overview:: .. _makefile setup: -Setup -===== +Makefile setup +============== .. _git stash: https://git-scm.com/docs/git-stash -The main setup is done in the :origin:`Makefile`:: - - export GIT_URL=https://github.com/asciimoo/searx - export SEARX_URL=https://searx.me - export DOCS_URL=https://asciimoo.github.io/searx - .. sidebar:: fork & upstream Commit changes in your (local) branch, fork or whatever, but do not push them upstream / `git stash`_ is your friend. -:GIT_URL: Changes this, to point to your searx fork. +The main setup is done in the :origin:`Makefile`. -:SEARX_URL: Changes this, to point to your searx instance. +.. literalinclude:: ../../Makefile + :start-after: START Makefile setup + :end-before: END Makefile setup -:DOCS_URL: If you host your own (branded) documentation, change this URL. +:GIT_URL: Changes this, to point to your searx fork. +:GIT_BRANCH: Changes this, to point to your searx branch. +:SEARX_URL: Changes this, to point to your searx instance. +:DOCS_URL: If you host your own (*brand*) documentation, change this URL. + +If you change any of this build environment variables, you have to run ``make +buildenv``:: + + $ make buildenv + build searx/brand.py + build utils/brand.env .. _make pyenv: @@ -170,7 +170,7 @@ e.g.: .. code:: sh - $ make test.pep8 test.unit + $ make test.pep8 test.unit test.sh . ./local/py3/bin/activate; ./manage.sh pep8_check [!] Running pep8 check . ./local/py3/bin/activate; ./manage.sh unit_tests diff --git a/_sources/dev/quickstart.rst.txt b/_sources/dev/quickstart.rst.txt index e40772b3..a4fc897c 100644 --- a/_sources/dev/quickstart.rst.txt +++ b/_sources/dev/quickstart.rst.txt @@ -27,7 +27,7 @@ searx-ve virtualenv and install the required packages using ``manage.sh``. cd ~/myprojects git clone https://github.com/asciimoo/searx.git cd searx - virtualenv searx-ve + python3 -m venv searx-ve . ./searx-ve/bin/activate ./manage.sh update_dev_packages @@ -87,8 +87,8 @@ After satisfying the requirements styles can be build using ``manage.sh`` ./manage.sh styles -How to build the source of the oscar theme -========================================== +How to build the source of the themes +===================================== .. _grunt: https://gruntjs.com/ @@ -98,13 +98,13 @@ NodeJS, so first Node has to be installed. .. code:: sh sudo -H apt-get install nodejs - sudo -H npm install -g grunt-cli + make node.env After installing grunt, the files can be built using the following command: .. code:: sh - ./manage.sh grunt_build + make themes Tips for debugging/development diff --git a/_sources/dev/reST.rst.txt b/_sources/dev/reST.rst.txt index 4835cbbc..7b253d9e 100644 --- a/_sources/dev/reST.rst.txt +++ b/_sources/dev/reST.rst.txt @@ -326,7 +326,7 @@ Literal blocks The simplest form of :duref:`literal-blocks` is a indented block introduced by two colons (``::``). For highlighting use :dudir:`highlight` or :ref:`reST code` directive. To include literals from external files use directive -:dudir:`literalinclude`. +:rst:dir:`literalinclude`. .. _reST literal: @@ -1312,9 +1312,8 @@ others are basic-tabs_ and code-tabs_. Below a *group-tab* example from .. literalinclude:: ../admin/buildhosts.rst :language: reST - :start-after: .. _system requirements: - :end-before: .. _system requirements END: - + :start-after: .. SNIP sh lint requirements + :end-before: .. SNAP sh lint requirements .. _math: diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index b62f4dc5..9e590867 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -2,7 +2,14 @@ Welcome to searx ================ -Search without being tracked. + *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 Searx-instances_. If you don't trust +anyone, you can set up your own, see :ref:`installation`. .. sidebar:: Features @@ -16,19 +23,14 @@ Search without being tracked. - Hosted by organizations, such as *La Quadrature du Net*, which promote digital rights -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 Searx-instances_. If you don't trust -anyone, you can set up your own, see :ref:`installation`. - .. toctree:: :maxdepth: 2 + :caption: Contents user/index admin/index dev/index + utils/index blog/index .. _Searx-instances: https://searx.space diff --git a/_sources/user/index.rst.txt b/_sources/user/index.rst.txt index b13aca21..96d11bf8 100644 --- a/_sources/user/index.rst.txt +++ b/_sources/user/index.rst.txt @@ -3,7 +3,8 @@ User documentation ================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents search_syntax own-instance diff --git a/_sources/user/own-instance.rst.txt b/_sources/user/own-instance.rst.txt index a2f73656..4876abe9 100644 --- a/_sources/user/own-instance.rst.txt +++ b/_sources/user/own-instance.rst.txt @@ -2,8 +2,10 @@ 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. + *"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 diff --git a/_sources/user/public_instances.rst.txt b/_sources/user/public_instances.rst.txt deleted file mode 100644 index f58ab7a0..00000000 --- a/_sources/user/public_instances.rst.txt +++ /dev/null @@ -1,3 +0,0 @@ -:orphan: - -This page page has been moved to `searx.space `__ diff --git a/_sources/utils/filtron.sh.rst.txt b/_sources/utils/filtron.sh.rst.txt new file mode 100644 index 00000000..6c83bdf7 --- /dev/null +++ b/_sources/utils/filtron.sh.rst.txt @@ -0,0 +1,80 @@ + +.. _filtron.sh: + +==================== +``utils/filtron.sh`` +==================== + +.. sidebar:: further reading + + - :ref:`searx filtron` + - :ref:`architecture` + - :ref:`installation` (:ref:`nginx ` & :ref:`apache + `) + +.. _Go: https://golang.org/ +.. _filtron: https://github.com/asciimoo/filtron +.. _filtron README: https://github.com/asciimoo/filtron/blob/master/README.md + +To simplify installation and maintenance of a filtron instance you can use the +script :origin:`utils/filtron.sh`. In most cases you will install filtron_ +simply by running the command: + +.. code:: bash + + sudo -H ./utils/filtron.sh install all + +The script adds a ``${SERVICE_USER}`` (default:``filtron``) and installs filtron_ +into this user account: + +#. Create a separated user account (``filtron``). +#. Download and install Go_ binary in user's $HOME (``~filtron``). +#. Install filtron with the package management from Go_ (``go get -v -u + github.com/asciimoo/filtron``) +#. Setup a proper rule configuration :origin:`[ref] + ` (``/etc/filtron/rules.json``). +#. Setup a systemd service unit :origin:`[ref] + ` + (``/lib/systemd/system/filtron.service``). + + +Create user +=========== + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START create user + :end-before: END create user + + +Install go +========== + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START install go + :end-before: END install go + + +Install filtron +=============== + +Install :origin:`rules.json ` at +``/etc/filtron/rules.json`` (see :ref:`Sample configuration of filtron`) and +install filtron software and systemd unit: + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START install filtron + :end-before: END install filtron + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START install systemd unit + :end-before: END install systemd unit + +.. _filtron.sh overview: + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): + +.. program-output:: ../utils/filtron.sh --help diff --git a/_sources/utils/index.rst.txt b/_sources/utils/index.rst.txt new file mode 100644 index 00000000..13914af2 --- /dev/null +++ b/_sources/utils/index.rst.txt @@ -0,0 +1,53 @@ +.. _searx_utils: +.. _toolboxing: + +======================= +Tooling box ``utils/*`` +======================= + +In the folder :origin:`utils/` we maintain some tools useful for admins and +developers. + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + searx.sh + filtron.sh + morty.sh + lxc.sh + +.. _toolboxing common: + +Common commands & environment +============================= + +Scripts to maintain services often dispose of common commands and environments. + +``shell`` : command + Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for + troubleshooting. + +``inspect service`` : command + Shows status and log of the service, most often you have a option to enable + more verbose debug logs. Very helpful for debugging, but be careful not to + enable debugging in a production environment! + +``FORCE_TIMEOUT`` : environment + Sets timeout for interactive prompts. If you want to run a script in batch + job, with defaults choices, set ``FORCE_TIMEOUT=0``. By example; to install a + reverse proxy for filtron on all containers of the :ref:`searx suite + ` use :: + + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install + +.. _toolboxing setup: + +Tooling box setup +================= + +The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile +setup`). + +.. literalinclude:: ../../.config.sh + :language: bash diff --git a/_sources/utils/lxc.sh.rst.txt b/_sources/utils/lxc.sh.rst.txt new file mode 100644 index 00000000..9ca9b6bc --- /dev/null +++ b/_sources/utils/lxc.sh.rst.txt @@ -0,0 +1,148 @@ + +.. _snap: https://snapcraft.io +.. _snapcraft LXD: https://snapcraft.io/lxd +.. _LXC/LXD Image Server: https://uk.images.linuxcontainers.org/ +.. _LXC: https://linuxcontainers.org/lxc/introduction/ +.. _LXD: https://linuxcontainers.org/lxd/introduction/ +.. _`LXD@github`: https://github.com/lxc/lxd + +.. _archlinux: https://www.archlinux.org/ + +.. _lxc.sh: + +================ +``utils/lxc.sh`` +================ + +.. sidebar:: further reading + + - snap_, `snapcraft LXD`_ + - LXC_, LXD_ + - `LXC/LXD Image Server`_ + - `LXD@github`_ + +With the use of *Linux Containers* (LXC_) we can scale our tasks over a stack of +containers, what we call the: *lxc suite*. The *searx suite* +(:origin:`lxc-searx.env `) is loaded by default, every time +you start the ``lxc.sh`` script (*you do not need to care about*). + +Before you can start with containers, you need to install and initiate LXD_ +once:: + + $ snap install lxd + $ lxd init --auto + +To make use of the containers from the *searx suite*, you have to build the +:ref:`LXC suite containers ` initial. But be warned, **this might +take some time**:: + + $ sudo -H ./utils/lxc.sh build + +A cup of coffee later, your LXC suite is build up and you can run whatever task +you want / in a selected or even in all :ref:`LXC suite containers `. If you do not want to build all containers, **you can build just +one**:: + + $ sudo -H ./utils/lxc.sh build searx-ubu1804 + +*Good to know ...* + +Eeach container shares the root folder of the repository and the +command ``utils/lxc.sh cmd`` **handles relative path names transparent**, +compare output of:: + + $ sudo -H ./utils/lxc.sh cmd -- ls -la Makefile + ... + +In the containers, you can run what ever you want, e.g. to start a bash use:: + + $ sudo -H ./utils/lxc.sh cmd searx-ubu1804 bash + INFO: [searx-ubu1804] bash + root@searx-ubu1804:/share/searx# + +If there comes the time you want to **get rid off all** the containers and +**clean up local images** just type:: + + $ sudo -H ./utils/lxc.sh remove + $ sudo -H ./utils/lxc.sh remove images + + +Install suite +============= + +To install the complete :ref:`searx suite (includes searx, morty & filtron) +` into all LXC_ use:: + + $ sudo -H ./utils/lxc.sh install suite + +The command above installs a searx suite (see :ref:`installation scripts`). To +get the IP (URL) of the filtron service in the containers use ``show suite`` +command. To test instances from containers just open the URLs in your +WEB-Browser:: + + $ sudo ./utils/lxc.sh show suite | grep filtron + [searx-ubu1604] INFO: (eth0) filtron: http://n.n.n.246:4004/ http://n.n.n.246/searx + [searx-ubu1804] INFO: (eth0) filtron: http://n.n.n.147:4004/ http://n.n.n.147/searx + [searx-ubu1910] INFO: (eth0) filtron: http://n.n.n.140:4004/ http://n.n.n.140/searx + [searx-ubu2004] INFO: (eth0) filtron: http://n.n.n.18:4004/ http://n.n.n.18/searx + [searx-fedora31] INFO: (eth0) filtron: http://n.n.n.46:4004/ http://n.n.n.46/searx + [searx-archlinux] INFO: (eth0) filtron: http://n.n.n.32:4004/ http://n.n.n.32/searx + +To :ref:`install a nginx ` reverse proxy for filtron and +morty use (or alternatively use :ref:`apache `):: + + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh nginx install + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/morty.sh nginx install + + +Running commands +================ + +**Inside containers, you can use make or run scripts** from the +:ref:`toolboxing`. By example: to setup a :ref:`buildhosts` and run the +Makefile target ``test`` in the archlinux_ container:: + + sudo -H ./utils/lxc.sh cmd searx-archlinux ./utils/searx.sh buildhost + sudo -H ./utils/lxc.sh cmd searx-archlinux make test + + +Setup searx buildhost +===================== + +You can **install the searx buildhost environment** into one or all containers. +The installation procedure to set up a :ref:`build host` takes its +time. Installation in all containers will take more time (time for another cup +of coffee).:: + + sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh buildhost + +To build (live) documentation inside a archlinux_ container:: + + sudo -H ./utils/lxc.sh cmd searx-archlinux make docs-clean docs-live + ... + [I 200331 15:00:42 server:296] Serving on http://0.0.0.0:8080 + +To get IP of the container and the port number *live docs* is listening:: + + $ sudo ./utils/lxc.sh show suite | grep docs-live + ... + [searx-archlinux] INFO: (eth0) docs-live: http://n.n.n.12:8080/ + + +.. _lxc.sh help: + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory: + +.. program-output:: ../utils/lxc.sh --help + + +.. _lxc-searx.env: + +searx suite +=========== + +.. literalinclude:: ../../utils/lxc-searx.env + :language: bash diff --git a/_sources/utils/morty.sh.rst.txt b/_sources/utils/morty.sh.rst.txt new file mode 100644 index 00000000..89629bea --- /dev/null +++ b/_sources/utils/morty.sh.rst.txt @@ -0,0 +1,80 @@ + +.. _morty: https://github.com/asciimoo/morty +.. _morty's README: https://github.com/asciimoo/morty +.. _Go: https://golang.org/ + +.. _morty.sh: + +================== +``utils/morty.sh`` +================== + +.. sidebar:: further reading + + - :ref:`architecture` + - :ref:`installation` (:ref:`nginx ` & :ref:`apache + `) + - :ref:`searx morty` + +To simplify installation and maintenance of a morty_ instance you can use the +script :origin:`utils/morty.sh`. In most cases you will install morty_ simply by +running the command: + +.. code:: bash + + sudo -H ./utils/morty.sh install all + +The script adds a ``${SERVICE_USER}`` (default:``morty``) and installs morty_ +into this user account: + +#. Create a separated user account (``morty``). +#. Download and install Go_ binary in user's $HOME (``~morty``). +#. Install morty_ with the package management from Go_ (``go get -v -u + github.com/asciimoo/morty``) +#. Setup a systemd service unit :origin:`[ref] + ` + (``/lib/systemd/system/morty.service``). + +.. hint:: + + To add morty to your searx instance read chapter :ref:`searx morty`. + +Create user +=========== + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START create user + :end-before: END create user + + +Install go +========== + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install go + :end-before: END install go + + +Install morty +============= + +Install morty software and systemd unit: + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install morty + :end-before: END install morty + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install systemd unit + :end-before: END install systemd unit + +.. _morty.sh overview: + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): + +.. program-output:: ../utils/morty.sh --help + diff --git a/_sources/utils/searx.sh.rst.txt b/_sources/utils/searx.sh.rst.txt new file mode 100644 index 00000000..dd4442f9 --- /dev/null +++ b/_sources/utils/searx.sh.rst.txt @@ -0,0 +1,39 @@ + +.. _searx.sh: + +================== +``utils/searx.sh`` +================== + +.. sidebar:: further reading + + - :ref:`architecture` + - :ref:`installation` + - :ref:`installation nginx` + - :ref:`installation apache` + +To simplify installation and maintenance of a searx instance you can use the +script :origin:`utils/searx.sh`. + +Install +======= + +In most cases you will install searx simply by running the command: + +.. code:: bash + + sudo -H ./utils/searx.sh install all + +The script adds a ``${SERVICE_USER}`` (default:``searx``) and installs searx +into this user account. The installation is described in chapter +:ref:`installation basic`. + +.. _intranet reverse proxy: + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): + +.. program-output:: ../utils/searx.sh --help diff --git a/_static/documentation_options.js b/_static/documentation_options.js index be3971f5..6705cf06 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -5,6 +5,7 @@ var DOCUMENTATION_OPTIONS = { COLLAPSE_INDEX: false, BUILDER: 'html', FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt', NAVIGATION_WITH_KEYS: false diff --git a/_static/searchtools.js b/_static/searchtools.js index d11b33a7..ab564996 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -251,6 +251,7 @@ var Search = { var item = results.pop(); var listItem = $('
  • '); var requestUrl = ""; + var linkUrl = ""; if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') { // dirhtml builder var dirname = item[0] + '/'; @@ -260,13 +261,15 @@ var Search = { dirname = ''; } requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname; + linkUrl = requestUrl; } else { // normal html builders requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; + linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; } listItem.append($('').attr('href', - requestUrl + + linkUrl + highlightstring + item[2]).html(item[1])); if (item[3]) { listItem.append($(' (' + item[3] + ')')); diff --git a/_static/searx.css b/_static/searx.css index d6a664f0..ae742a4e 100644 --- a/_static/searx.css +++ b/_static/searx.css @@ -33,7 +33,7 @@ p.sidebar-title, .sidebar p { /* admonitions */ -div.admonition, div.topic { +div.admonition, div.topic, div.toctree-wrapper { background-color: #fafafa; margin: 8px 0px; padding: 1em; @@ -42,6 +42,16 @@ div.admonition, div.topic { border-right: none; border-bottom: none; border-left: 5pt solid #ccc; + list-style-type: disclosure-closed; +} + +div.toctree-wrapper p.caption { + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; + display: inline; } p.admonition-title:after { diff --git a/admin/api.html b/admin/api.html index 2dc0c1ac..e1452d55 100644 --- a/admin/api.html +++ b/admin/api.html @@ -1,7 +1,7 @@ - + @@ -184,7 +184,7 @@ HTML of the site. URL of the searx instance and values are customizable.

     diff --git a/admin/architecture.html b/admin/architecture.html index 5f8cad74..f49bf0c1 100644 --- a/admin/architecture.html +++ b/admin/architecture.html @@ -1,7 +1,7 @@ - + @@ -45,15 +45,20 @@

    Architecture

    -

    Needs work!

    -

    This article needs some work / Searx is a collaborative effort. If you have -any contribution, feel welcome to send us your PR, see -How to contribute.

    +

    Further reading

    +

    Herein you will find some hints and suggestions about typical architectures of searx infrastructures.

    We start with a contribution from @dalf. -It shows a reference setup for public searx instances.

    +It shows a reference setup for public searx instances which can build up and +maintained by the scripts from our Tooling box utils/*.

    arch_public.dot

    Fig. 1 Reference architecture of a public searx setup.

    @@ -111,7 +116,7 @@ It shows a reference setup for public searx instances.

    diff --git a/admin/buildhosts.html b/admin/buildhosts.html index 06d9a968..f0b32524 100644 --- a/admin/buildhosts.html +++ b/admin/buildhosts.html @@ -1,7 +1,7 @@ - + @@ -55,10 +55,110 @@

    If you have any contribution send us your PR, see How to contribute.

    +
    +

    Contents

    + +

    To get best results from build, its recommend to install additional packages -on build hosts.

    +on build hosts (see utils/searx.sh).:

    +
    sudo -H ./utils/searx.sh buildhost
+
    +
    +

    This will install packages needed by searx:

    +
    +
    +
    +
    +

    Ubuntu / debian

    +
    +
    +
    +
    +

    Arch Linux

    +
    +
    +
    +
    +

    Fedora / RHEL

    +
    +
    +
    +
    +
    $ sudo -H apt-get install -y \
+    virtualenv python3-dev python3-babel python3-venv \
+    uwsgi uwsgi-plugin-python3 \
+    git build-essential libxslt-dev zlib1g-dev libffi-dev libssl-dev \
+    shellcheck
+
    +
    +
    +
    +
    $ sudo -H pacman -S --noconfirm \
+    python-virtualenv python python-pip python-lxml python-babel \
+    uwsgi uwsgi-plugin-python \
+    git base-devel libxml2 \
+    shellcheck
+
    +
    +
    +
    +
    $ sudo -H dnf install -y \
+    virtualenv python python-pip python-lxml python-babel \
+    uwsgi uwsgi-plugin-python3 \
+    git @development-tools libxml2 \
+    ShellCheck
+
    +
    +
    +
    +

    and packages needed to build docuemtation and run tests:

    +
    +
    +
    +
    +

    Ubuntu / debian

    +
    +
    +
    +
    +

    Arch Linux

    +
    +
    +
    +
    +

    Fedora / RHEL

    +
    +
    +
    +
    +
    $ sudo -H apt-get install -y \
+    firefox graphviz imagemagick texlive-xetex librsvg2-bin \
+    texlive-latex-recommended texlive-extra-utils ttf-dejavu
+
    +
    +
    +
    +
    $ sudo -H pacman -S --noconfirm \
+    firefox graphviz imagemagick texlive-bin extra/librsvg \
+    texlive-core texlive-latexextra ttf-dejavu
+
    +
    +
    +
    +
    $ sudo -H dnf install -y \
+    firefox graphviz graphviz-gd ImageMagick librsvg2-tools \
+    texlive-xetex-bin texlive-collection-fontsrecommended \
+    texlive-collection-latex dejavu-sans-fonts dejavu-serif-fonts \
+    dejavu-sans-mono-fonts
+
    +
    +
    +
    -

    Build docs

    +

    Build docs

    Sphinx build needs

    @@ -33,7 +42,22 @@
    -

    This page page has been moved to searx.space

    +
    +

    Docker installation

    +

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

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

    +
    git clone https://github.com/asciimoo/searx.git
+cd searx
+docker build -t whatever/searx .
+
    +
    +
    @@ -61,7 +85,13 @@

    Navigation

    @@ -182,7 +178,7 @@ diff --git a/admin/settings.html b/admin/settings.html index 253579b4..39109ca6 100644 --- a/admin/settings.html +++ b/admin/settings.html @@ -1,7 +1,7 @@ - + @@ -16,7 +16,7 @@ - + @@ -30,7 +30,7 @@ next |
  • - previous |
  • Searx Documentation (Searx-0.16.0.tex) »
  • Administrator documentation »
    • @@ -44,15 +44,23 @@

    settings.yml

    +

    This page describe the options possibilities of the git://searx/settings.yml +file.

    Further reading ..

    -

    This page describe the options possibilities of the settings.yml file.

    +
    +

    Contents

    + +
    -

    Global Settings

    +

    Global Settings

    server:
     port : 8888
     secret_key : "ultrasecretkey" # change this!
@@ -138,7 +146,7 @@ be made.
    -

    Engine settings

    +

    Engine settings

    Further reading ..

      @@ -226,7 +234,7 @@ engines, and so won’t be described here.

      @@ -249,7 +257,7 @@ engines, and so won’t be described here.

      diff --git a/admin/update-searx.html b/admin/update-searx.html new file mode 100644 index 00000000..bac53776 --- /dev/null +++ b/admin/update-searx.html @@ -0,0 +1,134 @@ + + + + + + + + How to update — Searx Documentation (Searx-0.16.0.tex) + + + + + + + + + + + + + + + + + + + + + + +
      +
      +
      +
      + +
      +

      How to update

      +
      sudo -H -u searx -i
+(searx)$ git stash
+(searx)$ git pull origin master
+(searx)$ git stash apply
+(searx)$ ./manage.sh update_packages
+
      +
      +

      Restart uwsgi:

      +
      +
      +
      +
      +

      Ubuntu / debian

      +
      +
      +
      +
      +
      sudo -H systemctl restart uwsgi
+
      +
      +
      +
      +
      + + +
      +
      +
      + + +
      +
      + + + + + + \ No newline at end of file diff --git a/blog/admin.html b/blog/admin.html index 69ad9edf..c3802988 100644 --- a/blog/admin.html +++ b/blog/admin.html @@ -1,7 +1,7 @@ - + @@ -131,7 +131,7 @@ existing instances.

      diff --git a/blog/index.html b/blog/index.html index ff9a2d25..ddeb379f 100644 --- a/blog/index.html +++ b/blog/index.html @@ -1,7 +1,7 @@ - + @@ -16,7 +16,7 @@ - + @@ -30,7 +30,7 @@ next |
    • - previous |
    • Searx Documentation (Searx-0.16.0.tex) »
    @@ -44,11 +44,32 @@ @@ -80,7 +101,7 @@ @@ -1614,7 +1589,7 @@ gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

    diff --git a/dev/search_api.html b/dev/search_api.html index b3923749..0ae41c7c 100644 --- a/dev/search_api.html +++ b/dev/search_api.html @@ -1,7 +1,7 @@ - + @@ -192,7 +192,7 @@ instance. See the available options in the preferences page of the instance.

    diff --git a/dev/translation.html b/dev/translation.html index 424e2a6a..ee27df83 100644 --- a/dev/translation.html +++ b/dev/translation.html @@ -1,7 +1,7 @@ - + @@ -146,7 +146,7 @@ create a PR.

    diff --git a/genindex.html b/genindex.html index 4fcbca01..9ab46fcc 100644 --- a/genindex.html +++ b/genindex.html @@ -2,7 +2,7 @@ - + @@ -121,7 +121,7 @@ diff --git a/index.html b/index.html index 9898a175..273a224f 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ - + @@ -39,7 +39,14 @@

    Welcome to searx

    -

    Search without being tracked.

    +
    +

    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 Searx-instances. If you don’t trust +anyone, you can set up your own, see Installation.

    Features

      @@ -54,12 +61,8 @@ digital rights

    -

    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 Searx-instances. If you don’t trust -anyone, you can set up your own, see Installation.

    +

    Contents

    diff --git a/objects.inv b/objects.inv index b15a37ad..de78bf90 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/search.html b/search.html index cb991cb4..dc703c2c 100644 --- a/search.html +++ b/search.html @@ -1,7 +1,7 @@ - + @@ -53,10 +53,8 @@

    - From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. + Searching for multiple words only shows matches that contain + all words.

    @@ -103,7 +101,7 @@ diff --git a/searchindex.js b/searchindex.js index 04f48a93..5bd36b85 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["admin/api","admin/architecture","admin/buildhosts","admin/engines","admin/filtron","admin/index","admin/installation","admin/morty","admin/plugins","admin/settings","blog/admin","blog/index","blog/intro-offline","blog/private-engines","blog/python3","dev/contribution_guide","dev/engine_overview","dev/index","dev/makefile","dev/plugins","dev/quickstart","dev/reST","dev/search_api","dev/translation","index","user/index","user/own-instance","user/public_instances","user/search_syntax"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["admin/api.rst","admin/architecture.rst","admin/buildhosts.rst","admin/engines.rst","admin/filtron.rst","admin/index.rst","admin/installation.rst","admin/morty.rst","admin/plugins.rst","admin/settings.rst","blog/admin.rst","blog/index.rst","blog/intro-offline.rst","blog/private-engines.rst","blog/python3.rst","dev/contribution_guide.rst","dev/engine_overview.rst","dev/index.rst","dev/makefile.rst","dev/plugins.rst","dev/quickstart.rst","dev/reST.rst","dev/search_api.rst","dev/translation.rst","index.rst","user/index.rst","user/own-instance.rst","user/public_instances.rst","user/search_syntax.rst"],objects:{},objnames:{},objtypes:{},terms:{"0xa9":21,"1337x":3,"15px":21,"40px":21,"70px":21,"\u65e5\u672c\u8a9e":9,"boolean":[16,21],"break":[15,21],"byte":16,"case":[6,9,13,20,26],"default":[4,6,7,9,14,15,19,21,22,24,26,28],"espa\u00f1ol":9,"export":18,"fran\u00e7ai":9,"function":[12,16,19,21],"import":[6,12,21],"int":[4,16,21],"long":26,"new":[3,8,10,12,13,15,18,19,20,22,23],"null":[6,15],"public":[1,8,21],"return":[8,12,19,21,26],"schr\u00f6dinger":21,"short":20,"static":[6,19],"switch":15,"t\u00fcrk\u00e7e":9,"true":[0,4,6,9,12,16,19,20,21,22],"try":[18,20,26],"while":[12,18,21],And:21,But:[10,14,16,26],For:[2,4,6,13,15,18,20,21,22],IPs:4,Not:21,One:10,That:21,The:[0,2,6,9,13,16,18,21,22,26],Then:[12,14,20,23],There:[15,21],These:[16,21],Use:4,Used:9,Uses:9,With:[18,21],__dict__:21,__name__:21,_anchor:21,_chapter:21,_doc:21,_dot:21,_rest:21,_section:21,_sphinx:21,_subsect:21,_svg:21,a2enmod:6,abbrev:28,abl:[2,9,12,13,15,16,21],about:[1,6,13,15,18,24],abov:[6,15,21,22],absenc:21,abus:[4,26],academ:3,accept:[12,28],access:[4,8,10,11,12,21,24,26],access_log:6,account:23,accross:9,accusam:21,acg:3,acgsou:3,act:[7,10],action:[0,4],activ:[6,7,9,14,15,20,22],adapt:16,add:[6,7,13,15,18,19,21,28],added:[13,18,19],adding:[12,21],addit:[2,6,16,18,20,21],addition:[24,26],address:[7,9,16,26],adipisici:21,adjust:18,admin:[9,11,13,21,24],administr:[10,12,13,22,24,26],adopt:15,adorn:21,ads:26,advantag:[10,21],advertis:26,advis:[4,6],aearx:9,af2cae6:21,affect:10,after:[14,19,20,21,23],again:18,agent:[4,8,9,16],aggreg:[4,24,26],ahrefsbot:4,aim:[10,18,21],aka:18,alia:6,align:21,aliquid:21,aliquyam:21,all:[0,7,14,15,16,18,21,22],allow:[6,9,21,28],along:4,alreadi:[15,20],also:[2,6,15,18,21,26,28],alt:21,alter:15,altern:[20,21],alwai:[16,20,26],amet:21,among:[15,26],amsmath:21,ancel:21,ani:[1,2,18,21,22,24],annoi:21,anonym:[24,26],anoth:[9,10,16,21],answer:[9,21,26],anyon:24,anyth:[9,14,26],anywai:[18,21],apach:9,apache2:6,api:[5,9,13,16,17,23,24],api_kei:[9,16],apikei:9,apk:3,apkm:3,apkmirror:3,app:[3,6,21],appear:[20,21],append:12,appli:[6,9,15],applic:[4,6,9,10],apt:[2,6,20,21],arbitrari:[12,16],arch:[0,2,3,13,21],architectur:[5,24],archiv:[3,4],archlinux:[3,13],argument:[7,8,21],arrai:16,arrow:21,art:[21,22],articl:1,arx:3,arxiv:3,asciimoo:[6,15,18,20,23],ascrib:21,aspect:15,assert:15,assign:16,assum:21,asterisk:21,attach:19,attent:21,attribut:21,audienc:21,author:[15,21],auto:[21,23],autobuild:18,autocomplet:[0,22],autodoc:21,automat:[8,21],avail:[6,8,9,12,15,20,22,26],avoid:[4,8,9],awar:21,babel:6,back:6,backquot:21,backslash:21,baiduspid:4,balanc:18,ban:26,bang:9,bar:21,barrier:10,base:[9,12,16,18,22],base_url:[6,9,16],baseprofil:21,bash:[6,21],baz:21,becaus:[10,13,15,16,20,23,26],becom:21,been:[12,15,27],befor:[14,15,18,19,20,21,26],behavior:21,behaviour:[8,15,19],being:[4,9,10,14,24],below:[4,6,9,15,20,21,23],benefit:13,besid:26,best:[2,18,21,26],better:[2,6,16,18,26],between:[16,21],big:21,bigger:9,biggest:10,bii:3,bin:[2,3,6,14,18,20,21],bing:[3,9],bing_imag:3,bing_new:3,bing_video:3,bingbot:4,bit:21,bitbucket:[0,3],biv:3,black:21,blank:[9,21],block:[4,9],blog:[21,24],bodi:[15,21],boilerpl:18,bold:21,boldfac:21,born:15,bot:4,both:[13,14,15,22,26],botlimit:4,bottom:8,boundingbox:16,branch:[15,18],brand:18,bring:[18,21],broken:21,browser:[8,9,10,14,15,18,26],btdigg:3,bug:[18,20],bugreport:15,build:6,builder:21,buildhost:[5,24],built:[15,16,20,21],builtin:[5,19,24],c3tv:3,call:[10,13,18,23],callback:19,can:[0,2,4,6,7,9,10,12,13,14,15,16,18,19,20,21,24,26],cancel:21,cannot:[2,21,26],capabl:[10,15],caplabl:12,captcha:26,caption:21,cardin:15,care:[9,21],carv:13,catcher:21,categori:[0,3,8,9,12,16,21,22,28],caution:21,caveat:21,ccc:3,cdn:2,cell:21,certif:6,cfg:[3,21],chain:18,chainabl:28,chang:[6,9,14,15,18,21],chapter:[14,15,21],charact:[15,21],chdir:6,check:[2,12,15,16,18,20,23],checker:18,checkout:15,chmod:6,choic:[21,26],choos:[15,16],chown:6,chronolog:21,citi:16,classifi:21,clear:26,cli:[20,23],client:4,clita:21,clock:14,clone:[6,15,18,20],code:[3,6,9,12,18,20,22,26],codebas:10,col:21,collabor:1,colleagu:13,collect:[2,21],colon:21,colspan:21,column:21,com:[6,16,18,20,21,22,23],combin:6,come:[4,13,14,15,18,26],comfort:21,comma:[13,22],command:[2,4,6,14,20,21,23],comment:21,commit:[18,20,23],commodi:21,common:[20,26],commonli:21,commun:12,compact:21,compani:26,compat:14,compil:23,complet:[15,22],compon:19,compromis:26,comput:26,con:21,concern:15,concret:[13,21],condit:21,conf:[6,21],config:[0,6,13,16,21,23],configur:[10,12,13,21,23,26],confus:21,connect:[12,24],consectetur:21,consequ:[9,15],consequat:21,consetetur:21,construct:[16,21],consult:20,contact:9,contain:[8,9,20,21],content:26,context:[19,21],continu:21,contribut:[1,2,17,18,24],contributor:21,control:26,convent:15,convert:21,cooki:[16,24,26],copi:[15,21],copyright:21,core:[2,12,21],corner:15,correct:9,could:[9,16,21],count:[6,21],countri:[9,16],coupl:6,courgett:22,cours:21,coverag:20,cpu:6,crawler:21,creat:[6,9,12,14,20,21,22,23],creation:[2,21],creativ:13,cross:21,crossref:3,cryptic:20,cryptographi:9,cspan:21,css:[8,19],css_depend:19,csv:[4,22],csv_tabl:21,ctan:21,cthulhu:28,ctrl:18,ctx:19,curl:4,currenc:3,currency_convert:3,current:[8,9,12,15,16,23,28],custom:[9,15,21,28],customiz:[0,10],customlog:6,cycl:18,dai:[18,22],dailymot:3,dalf:1,danger:21,data:[16,21,26],databas:[13,21],date:[0,16],datetim:[16,21],daunt:10,dbpedia:22,ddd:3,ddg:[3,28],ddi:3,de_d:9,deactiv:9,debian:[2,6,21],debug:[6,9,18],decid:[10,18],decim:16,dedic:21,deeper:[18,21],deezer:3,def:[12,16,19,21],defaul:21,default_local:[0,9],default_on:19,default_them:[0,9],defin:[9,19,21],definit:3,dejavu:[2,21],delet:[9,22,23],delimit:21,demon:6,depen:4,depend:[6,8,10,12,14,16,20,21,22],deploi:[6,9,18,21],describ:[9,18,21],descript:[8,15,19,21],deserv:15,design:[12,21],desir:[16,20],detail:[9,12,21],detect:9,deutsch:[0,9],dev:[6,15,18,21],develop:[9,10,13,14,15,18,21,24],deviantart:3,dfrac:21,diam:21,dict:21,dictzon:3,didn:9,diff:21,differ:[14,15,16,21],digg:3,digit:24,digraph:21,direct:21,directli:9,directori:3,disabl:[3,8,9,18,19,21,22],disabled_engin:22,disabled_plugin:22,disadvantag:21,discoveri:[12,13],displai:[2,8,9],displaystyl:21,disrespect:15,dist:[15,18],distinguish:21,distribut:[13,21],dive:26,dnf:[2,21],doai_rewrit:22,doc:[3,21],dockerfil:6,docs_url:18,doctest:21,doctre:21,document:[12,13,18,21,24],docutil:21,doe:[10,12,16,18,21,22],doesn:9,doi:8,dolor:21,domain:[6,21],domin:15,don:[14,18,21,24],done:[18,21],dot:2,doubl:21,download:21,drop:14,duckduckgo:[3,22,28],duckduckgo_definit:3,duckduckgo_imag:3,duden:3,duo:21,duref:21,dvisvgm:2,each:[21,22],easi:24,easier:15,easili:15,ecosystem:21,edit:[6,10,15,18,21,26],effect:[15,21],effort:1,egg_info:18,eirmod:21,either:20,element:21,elimin:20,elit:21,elitr:21,emac:21,email:9,emb:21,embed:[0,6,21],emphasi:21,empti:[21,22],en_u:[9,16],enabl:[0,6,13,15,18,20,22],enabled_engin:22,enabled_plugin:22,enclos:21,encod:21,encourag:21,encrypt:24,end:[14,21],endfor:21,engin:[0,5,10,11,15,17,20,21,22,24,26,28],english:[0,9],enim:21,enough:23,enpoint:22,ensur:15,enter:[6,14],eos:21,equat:2,erat:21,erowid:3,error:[9,20,21],error_log:6,escap:21,especi:21,esperanto:0,essenti:6,est:21,etc:[4,6,15],eto:3,etool:3,etymonlin:3,evalu:21,everi:[9,15,16,26],everyon:[12,26],everyth:[6,21,26],exactli:[4,21],exampl:[0,4,6,12,13,15,20,22,26],exceed:4,except:[14,15,21],exchang:26,execut:[9,23],exercit:21,exist:[10,14,15,18],exit:6,expect:[13,15],experienc:10,explain:15,explicit:21,expos:13,ext:2,extend:[12,15,19,21],extens:[2,21],extern:[4,7,16,21,22,26],extra:[2,21],extrem:10,eye:21,face:21,fail:20,fals:[0,6,9,19,20,21,22],familiar:18,fanci:15,faq:21,faroo:3,favorit:[15,18],fdroid:3,featur:[7,10,13,15,21,26],fedora:[2,21],feedback:[15,21],feedfetch:4,feel:[1,19,21],few:[9,15,16],fieldnam:21,file:[3,6,9,10,12,13,14,15,18,19,20,23],file_filt:23,filenam:16,files:16,fill:21,filter:[0,4,22],find:[1,4,12,13],fine:6,finish:23,firewal:4,first:[10,12,14,18,20,21,26],fit:[13,19],fix:[15,18,20],fixpathinfo:6,flask:[19,21],flexibl:21,flickr:3,flickr_noapi:3,folder:[15,16,18,20,21,23],follow:[4,7,15,16,20,21,23],followsymlink:6,font:[2,21],fontsrecommend:[2,21],footer:15,fork:15,form:[0,21,26],format:[4,16,20,21,22],forward:[4,6,26],found:[2,4,10,18],foundat:[10,12,13,14],fr_fr:9,fraction:21,framalibr:3,free:[3,6,19,24],friend:[13,18,26],frinkiac:3,frk:3,frl:3,from:[1,2,4,8,9,10,12,13,14,15,18,21,23,24,26],front:21,fsd:3,full:[9,15,21],fulli:10,fund:[12,13],further:[18,20],furthermor:[16,20,22,26],gain:26,gate:18,geektim:3,gen:3,gener:[0,3,9,12,15,26],genesi:3,geniu:3,gentoo:3,geojson:16,german:0,get:[2,6,8,15,16,18,20,21,22,23,24],get_engines_stat:21,gid:6,gigablast:3,git:[2,6,15,16,18,20,21],git_url:18,github:[3,6,12,14,18,20,21,22],gitlab:3,gitmoji:15,give:[18,20],given:21,glyph:21,gnu:18,goe:18,goi:[0,3],going:[4,12,13,21,26],gon:3,good:20,googl:[0,3,22],google_imag:3,google_new:3,google_video:3,googlebot:4,gos:3,gov:3,gpa:3,gpm:3,gps:3,grant:6,graphic:10,graphviz:2,group:[21,26],grow:10,grumpi:21,grunt:20,grunt_build:20,gubergren:21,guid:[10,18,20,21],guidelin:13,guilabel:21,habr:3,habrahabr:3,hack:[10,12,13,14,15],hackerspac:28,handl:[9,21,26],handler:6,happi:[10,12,13,14,15],hard:[10,21],has:[7,12,13,15,16,20,21,26,27],hat:21,have:[1,2,6,9,10,14,15,16,18,21,26],hbar:21,header:[4,16,21],heard:21,hebrew:9,height:21,help:[8,15,18,20],helper:21,her:[13,22,26],here:[9,12,15,21],herein:1,hex:6,hidden:[0,13,26],him:13,hint:[1,21],his:[22,26],histor:14,home:23,hoogl:3,host:[2,4,10,13,18,23,24],hotkei:[0,8],hour:6,hous:16,house_numb:16,how:[1,2,5,9,17,18,21,24],howev:[12,16,22],html:[0,2,15,16,18,21],html_math_render:2,http:[0,2,4,6,7,8,9,12,15,16,18,20,21,23,24],http_host:4,https_rewrit:22,hub:6,huge:21,idea:20,imag:[0,2,3,7,9,22,28],image_proxi:[9,22],imagemagick:[2,21],img_src:16,imgmath:2,imgmath_font_s:2,imgmath_image_format:2,imgmath_latex:2,immedi:8,implement:[10,14,15,16,19],impli:13,improv:18,ina:3,inbound:9,includ:[6,13,18,21],inclus:28,increment:18,indent:21,index:6,infinit:8,infinite_scrol:[8,22],info:[9,18],inform:[4,6,7,8,9,13,15,16],infrastructur:1,inherit:21,ini:6,init:[6,12],initi:23,input:[0,13,21],insert:[21,23],insid:16,insight:26,instal:[2,4,5,7,14,15,18,20,21,23,24],instanc:[0,1,5,6,9,10,12,13,18,22,23,24,25],instance_nam:0,instead:[10,13,14,20,21],instruct:21,insuffici:12,integr:24,intent:15,interfac:[9,11,24],interfer:15,intermedi:18,intern:20,internet:[12,24],interpret:[6,21],interpretor:6,intersphinx_map:21,interv:4,introduc:[10,11,12,13,21,24],introduct:[18,20],intuit:21,inv:21,inventori:21,investig:14,invidi:3,invidunt:21,ipsum:21,iso:[9,16],issu:[12,13,14],ital:21,italiano:9,item:21,its:[2,10,15,18,21,22,26],itself:15,jame:4,japanes:9,javascript:8,jinja:21,jinja_context:21,join:21,js_depend:19,json:[4,22],json_engin:3,jump:18,just:[0,18,21,26],justo:21,kasd:21,kbd:21,keep:18,kei:[7,8,9,12,16,23],kickass:3,kind:[21,26],kiss_:21,know:[12,13,21,26],knowledg:21,known:18,kvch:[10,12,13,14],label:21,labor:21,labori:21,lack:15,lang:[0,22,23],languag:[0,3,9,16,18,21,22,23,28],language_support:[16,21],laptop:26,last:21,lat:16,latest:23,latex:2,latexextra:[2,21],latitud:16,latter:18,lazi:6,lc_messag:23,learn:21,least:14,leav:9,leech:16,leecher:16,left:21,legaci:22,length:15,less:[10,20,21,26],let:[21,26],level:[15,21],libapache2:6,libffi:6,librari:3,librsvg2:[2,21],librsvg:[2,21],libssl:6,libxslt:6,light:6,like:[0,2,6,8,9,13,15,16,18,21],like_hotkei:22,limit:[4,11,12,21,24],line:[12,15,18],link:[8,9],linkdexbot:4,lint:18,linux:[0,2,3,13,21],linuxdoc:21,list:[12,13,16,18,19,22,28],listen:[4,6],literalinclud:21,live:21,load:[8,9],lobst:3,local:[0,6,9,13,14,16,18,19,20,23],localhost:6,locat:[4,6,9,21],log:[9,20,26],logic:15,logicodev:22,lon:16,longer:18,longitud:16,look:18,lorem:21,loremlorem:21,low:6,made:9,magna:21,magnetlink:16,magyar:9,mai:[9,21],main:[8,18,23],maintain:21,make:[2,6,10,13,14,15,21,26],makefil:[15,17,24],man:21,manag:[6,10,18,20],mani:4,manipul:10,manual:[9,18,21],manuali:21,map:[0,3,21],mark:21,mass:15,master:[6,15,21],math:2,mathemat:21,mathrm:21,matter:[16,26],max:[4,16],maxim:15,maximum:[15,16],mean:[15,21,26],meaning:21,meant:21,media:[0,3,16],mediawiki:3,memori:9,mention:14,menuselect:21,messag:[4,9,15,18,20,21,23],messagespo:23,meta:21,metadata:21,metasearch:[16,24],method:[0,16,21],microsoft:3,microsoft_academ:3,might:[13,15,18,21,22,26],migrat:14,min:16,minim:21,mirror:3,misbehav:15,miss:21,mixcloud:3,mj12bot:4,mjk:3,mod:[6,21],mode:[9,21],modifi:[9,21,28],modul:[6,21],mojeek:3,monet:26,mono:[2,21],month:[0,22],more:[6,7,9,10,12,15,18,21,22,24,26],morecol:21,morerow:21,morti:7,most:[2,9,14,26],mostli:21,move:[12,15,27],movi:3,msnbot:4,much:[15,21],multibl:16,multipl:[8,9,21,26],music:3,must:[9,14,15,16,20,21],my_arg:21,my_funct:21,my_other_arg:21,mymemori:3,myproject:20,name:[0,3,4,6,8,9,13,16,18,19,23],navig:8,necessari:[6,13],nederland:9,need:[9,12,15,18,21,26],neither:24,net:24,netvib:4,network:9,never:18,newcom:10,nework:9,next:[8,21],nginx:[4,9],nightmar:21,nisi:21,nlnet:[10,12,13,14],node:20,nodej:20,non:12,none:[16,18,21,22],nonumi:21,nor:24,normal:[16,21],nostrud:21,note:[6,15,22],now:[13,14,19],npm:[3,20],number:[4,6,9,16,21,22],number_of_result:16,numer:21,numref:21,nyaa:3,oad:3,oap:3,obj:21,object:[16,19,21],obtain:9,off:[6,15],offlin:[3,11,13,16,21,24],often:[16,21],okhin:6,on_result:19,one:[9,13,15,18,21,24,26],ones:16,ongo:18,onli:[2,6,7,9,13,15,19,21,22],onlin:[12,21,24],open:[8,14,15,18,21,22,26],open_results_on_new_tab:8,openairedataset:3,openairepubl:3,openrepo:3,openssl:6,openstreetmap:[0,3],oper:[14,21,26],option:[6,7,9,10,13,15,16,18,19,20,21,22,26],order:[15,20,21],org:[2,9,16,21],org_bot:4,organ:24,origin:[6,21],oscar:[0,9,22],osm:[0,3,16],other:[9,15,16,21,26],otherwis:16,our:[10,15,18,21],out:[12,15,18,21],outgo:9,outgoing_proxi:9,output:[2,13,21,22],outstand:21,over:[21,24],overlin:21,overview:[9,17,18,22,24],overwrit:8,overwritten:16,own:[18,24,26],owner:18,packag:[2,6,18,20,21],pacman:[2,21],page:[3,4,8,9,10,13,15,16,21,22,26,27,28],pageno:[16,22],pagenumb:16,pair:12,palletsproject:21,param:[4,12,16,21],paramet:16,paramt:16,parent:21,pars:22,parse_lin:12,part:[9,10,21],parti:26,partial:21,partli:16,pass:[12,22],past:0,patch:[15,21],path:[4,6,9],paywal:8,pdb:3,pdbe:3,pdf:[2,21],peopl:[10,26],pep8:[15,18,20],pep8_check:18,pep:21,per:[15,16,21],perform:[8,12,16],phase:20,photon:3,phrase:21,piec:21,pip3:14,pip:23,pipe:12,piratebai:3,pix:22,place:[15,16,21,23,26],plai:3,plaintext:21,pleas:[6,14,15,20,21,22],plenti:15,plugin:[0,5,6,15,17,22,24],point:[6,18,21,26],pointer:21,pointhi:22,polygon:21,popen:12,popular:21,port:[4,6,9],possibl:[6,7,8,9,12,13,21,22],post:[0,6,15,22],post_search:19,postcod:16,pot:23,pov:21,power:21,practic:15,pre_search:19,prefer:[10,13,21,22,26,28],prefix:28,prepar:[11,24],prerequisit:21,present:[12,13],preserv:[15,21],press:[8,18],pretti:9,preview:16,primer:[17,24],principl:21,privaci:[6,21],privat:[12,24,25],pro:21,problem:4,proce:6,process:[2,4,12,13,18],processor:21,produc:21,product:9,profil:[18,24,26],program:18,project:[4,18,21],promot:24,proper:26,properli:14,propos:12,protect:[5,15,24],provid:[13,15,16,21],proxi:[5,6,9,22,24,26],proxifi:7,proxy_add_x_forwarded_for:[4,6],proxy_buff:6,proxy_pass:[4,6],proxy_set_head:[4,6],psi:21,pub:3,publicli:12,publish:16,publishedd:16,pubm:3,pull:[6,12,15,21,23],purpos:[9,16,20],push:[15,18],py3:18,pybabel:23,pyclean:18,pyenv:18,pygment:21,pylintrc:18,pypi:[18,21],python2:14,python3:14,python:[4,6,9,11,20,21,24],pythonpath:6,quadratur:24,qualiti:[2,18,21],queri:[8,12,13,16,22,26,28],question:[21,26],qui:21,quickstart:[15,17,18,24],quit:[15,18],qwant:3,qwer:28,qwi:3,qwn:3,qws:3,rais:12,rand:6,random:[16,26],rang:[3,16,22],rangl:21,rate:4,rather:13,raw:21,reach:21,reactiv:9,read:[12,15,18,20],readability_:21,reader:21,readlin:12,readm:7,real:4,reason:[10,14,21],rebuild:15,rebum:21,recommend:[2,15,16,18,21],reconsid:15,record:21,reddit:3,redefin:16,redirect:8,reduc:15,refer:[1,21,26],referenc:21,refnam:21,regardless:26,regular:12,rel:21,releas:[14,18],rememb:15,remote_addr:4,remov:[8,26],renam:22,render:2,replac:[10,19],repo:15,repositori:[6,10],request:[9,12,13,15,19,21,26],request_timeout:9,requir:[2,8,14,15,16,18,20,21,22],requisit:18,reset:26,respect:[15,26],respons:9,rest:[13,17,24],restart:[6,7],restrict:13,restructuredtext:21,result:[2,5,8,9,12,21,22,24,26],result_proxi:7,results_on_new_tab:22,retriev:23,return42:21,return_cod:12,revers:6,rewrit:[0,8],rfc:21,rhel:[2,21],rid:18,right:[6,13,19,21,24],rightmost:21,rigth:21,road:16,roboag:4,robot:[18,20],robotframework:14,rolenam:21,romanian:9,root:[6,18],rotat:21,round:15,rout:[6,21],row:21,rowspan:21,rspan:21,rss:[4,22],rst:[15,21],rule:[4,15],run:[2,4,6,7,9,12,13,15,16,19,21,23,26],runtimeerror:12,russian:9,sadipsc:21,safe:[3,22],safe_search:0,safesearch:[21,22],same:[4,8,9,16,21],sampl:21,san:[2,21],sanctu:21,satisfi:20,scalabl:21,scale:21,scaleabl:21,scc:3,scd:3,schedul:[12,14],scheme:[4,6],scholar:3,schroeding:21,scienc:3,scope:15,scrapi:4,scratch:2,script:[4,6,20],script_nam:6,scroll:8,sdist:18,sea:21,search:[3,4,8,9,12,13,15,16,17,21,24,25,26],search_on_category_select:[8,22],search_path:16,search_str:16,searchcod:3,searchcode_cod:3,searchcode_doc:3,searx:[0,1,4,7,9,11,12,15,16,18,19,20,21,22,23,27,28],searx_url:18,searx_userag:9,sec:4,second:[9,21],secret:[9,13],secret_kei:9,section:[9,18,21],secur:24,sed:[6,21],see:[1,2,6,7,9,12,13,15,20,21,22,24,28],seed:16,seeder:16,seedpeer:3,select:[8,18,21,26,28],selenium:20,self:[8,10,24],self_inform:22,semant:[3,15],send:[1,2,4,9,26],sens:21,sent:26,separ:[13,15,21,22],seri:18,serif:[2,21],serv:[15,26],server:[9,20],server_nam:6,servic:[4,6,7,21,22,24,26],session:20,set:[2,3,5,6,7,10,12,18,20,21,22,23,24,26,28],sethandl:6,setup:[1,2,5,6,21,24],seznam:3,seznambot:4,share:13,she:[13,26],shortcut:[0,3,9,13,16,21],should:[6,9,10,14,15,21,23],show:[1,2,21],shown:21,side:21,sign:21,signifi:21,similar:21,simpl:[18,22],simplest:21,simpli:[15,18,22],simplifi:18,sinc:[10,18,21],singl:[6,26],sit:21,site:[0,6,9,16,21,22],size:16,skeleton:12,skip:20,slow:9,slurp:4,small:16,smtbot:4,snippet:7,social:[0,3],sock:9,socket:6,softwar:3,sold:26,solut:13,solv:[4,13],some:[1,6,9,13,15,18,21],someon:26,someth:[15,18],sometim:10,soundcloud:3,sourc:[9,14,18,21,23,26],source_fil:23,source_ip:9,source_lang:23,space:[9,27],span:21,spars:21,special:16,specif:[6,9,16],specifi:[9,16,22],speu:3,sphinx:15,splinter:14,split:15,sponsor:[10,12,13,14],ssl:[6,16,24],stabl:9,stack:20,stackoverflow:3,stage:21,standalon:10,standard:[15,16],start:[1,4,6,15,16,18,24],startpag:[3,22],stash:[6,18],stat:21,statist:21,stdout:12,step:[6,15],stet:21,stone:13,stop:[4,18],store:[16,26],street:16,strict:13,string:[13,16,22,23],stroke:21,strong:21,structur:15,stub:21,stuff:21,style:22,sub:[15,21],subject:21,submit:15,subprocess:12,subrul:4,subscript:21,subsect:21,sudo:[2,6,20,21],suffix:9,suggest:[1,19],suitabl:21,sup:21,superscript:21,supervisor:10,support:[2,3,6,9,11,13,15,16,21,22,24,26],sure:[6,14],surround:21,svg:2,svg_imag:21,symlink:6,syntax:[22,24,25],system:[13,14,15,21],szn:3,tab:[8,22],tabl:12,tailor:26,take:[9,10,15,23],taken:21,takimata:21,tar:18,target:[15,17,21,24],task:21,tell:16,templat:[12,16],tempor:21,term:21,test:[8,14,15],texliv:[2,21],text:[0,16,21],textstyl:21,tfrac:21,than:[9,21,24],thei:[9,13,21,26],them:[9,18,21],theme:[9,22],themes_path:9,themselv:13,therefor:21,thi:[1,4,6,7,8,9,10,12,13,14,16,18,19,20,21,22,26,27],thing:21,think:[15,18,21],third:[21,26],those:[12,23,26],thread:6,three:[15,19,21,26],through:[9,13,21,22,26],thu:[12,14,22,26],thumbnail:16,thumbnail_src:16,time:[4,9,14,15,16,21,22,26],time_rang:[0,22],time_range_support:[16,21],timeout:[3,9,16,21],tip:21,titl:16,tld:6,todai:12,togeth:12,token:[12,13],tokyotoshokan:3,too:[4,9,21,26],tool:[2,10,15,21,23],top:21,tor:[3,24,26],torrentfil:16,torrentz:3,touch:9,tpb:3,trace:20,track:[24,26],tracker:8,tracker_url_remov:22,trademark:21,traffic:6,train:21,transform:21,transifex:15,transifexrc:23,translat:[3,9,17,24],travi:[14,20],tree:18,trust:[13,24,26],ttf:[2,21],tupl:19,turn:[15,20],twice:6,twine:18,twitter:3,two:[15,21,22],txt:[14,18,21],type:[0,15,16,18,22,23,26],typic:[1,21],typo:21,ubuntu:[2,6,21],ugli:[10,21],uid:6,ullamco:21,ultrasecretkei:[6,9],uncom:9,uncommon:15,under:[13,16],understand:[10,21],unfortun:15,uninstal:18,unit:[15,18],unit_test:[18,20],univers:6,unix:6,unknown:26,unless:13,unlik:26,unspecifi:16,unsplash:3,untouch:18,updat:[9,15],update_dev_packag:20,update_packag:6,upload:18,url:[0,7,8,9,15,16,18,26],urlencod:16,usag:[18,21],use:[6,7,9,12,13,15,16,18,20,21,24,25],used:[6,9,14,15,16,21,24,26],useful:9,user:[4,6,8,9,13,15,16,21,24,26],useradd:6,userag:4,useragent_suffix:9,uses:[9,16,21,26],using:[4,6,9,15,18,20,21,23,24],usr:6,usual:[6,14,26],utf:21,util:[2,21],uwsgi_param:6,uwsgi_pass:6,uwsgisocket:6,valid:[16,20,22],valu:[0,12,16,21,22],variabl:16,variant:21,variou:[15,19],vector:21,vendor:15,veniam:21,venv3:14,verifi:16,vero:21,version:[8,14,21],via:[10,28],video:3,view:26,viewbox:21,vim:[0,8,22],vim_hotkei:8,vimeo:3,virtual:6,virtualenv:[6,14,18,20],virualenv:18,visist:21,visit:[21,26],voat:3,voluptua:21,vpn:26,vulner:26,wai:[12,15,16,21,26],wait:[9,12],want:[9,13,14,15,18,21,22,26],warn:[2,21],watch:15,web:[9,10,18],webapp:[6,9,14,18,21],webcrawl:4,webserv:6,websit:0,weight:[9,21],weigth:[3,9],weird:15,welcom:1,well:21,were:[12,13,14],werkzeug:18,wget:4,what:21,whatev:[6,18],when:[2,8,9,14,19,20,21,26],where:[4,9,21],whether:[20,26],which:[4,9,10,12,13,15,16,18,21,22,24,26],whl:18,who:[6,10,12,26],whole:[6,19],why:[21,24,25],wide:15,widen:21,width:21,wiki:[0,3,12,13,21],wikidata:3,wikipedia:[3,9,22,28],window:8,wish:9,within:[18,21],without:[2,9,16,24,26],wolframalpha:3,wolframalpha_noapi:3,won:[9,14],wonderfal:6,word:[19,21,22],work:[6,9,15,16,18,20,26],worker:6,world:[15,21,26],worri:14,worth:26,would:13,wrong:18,wsgi:6,www1x:3,www:[2,21,23],wysiwyg:15,xdg:18,xetex:[2,21],xml:21,xmln:21,xpath:3,xxxx:21,yacybot:4,yahoo:[3,4],yahoo_new:3,yandex:3,yandexbot:4,yandexmobilebot:4,year:[14,22],yet:[15,16,18],yhn:3,yml:[3,5,6,7,10,12,18,20,22,24],you:[1,2,6,9,12,15,18,20,21,22,24,26,28],your:[1,2,6,7,8,9,10,11,14,15,18,19,21,24],your_morty_proxy_kei:7,yourself:15,youtub:3,youtube_noapi:3,yyyi:21,zero:12,zgrab:4,zlib1g:6,zzzz:21},titles:["Administration API","Architecture","Buildhosts","Engines","How to protect an instance","Administrator documentation","Installation","How to setup result proxy","Plugins builtin","settings.yml","Searx admin interface","Blog","Preparation for offline engines","Limit access to your searx engines","Introducing Python 3 support","How to contribute","Engine overview","Developer documentation","Makefile Targets","Plugins","Development Quickstart","reST primer","Search API","Translation","Welcome to searx","User documentation","Why use a private instance?","<no title>","Search syntax"],titleterms:{"default":[3,8,16],"public":26,"return":16,The:15,about:[21,26],access:13,acknowledg:[10,12,13,14],activ:18,admin:10,administr:[0,5],admonit:21,aka:21,anchor:21,apach:6,api:[0,22],architectur:1,argument:16,articl:[2,21],ascii:21,bar:0,basic:[6,21],bibliograph:21,block:21,blog:11,bug:14,build:[2,15,18,20,21],buildhost:2,built:[3,8],builtin:8,bullet:21,check:6,clean:[15,18],code:[15,16,21],commit:15,compil:20,conclus:26,configur:[0,3,4,6,8,16],consequ:26,content:[6,16,18,21],contribut:15,creat:15,csv:21,data:0,debug:20,definit:21,deploi:15,design:15,develop:[12,17,20],direct:15,disabl:6,doc:[2,15,18],docker:6,document:[5,15,17,25],doe:26,dot:21,drop:18,emb:0,engin:[3,9,12,13,16],entri:19,environ:[18,20,21],equat:21,exampl:[16,19,21,28],ext:21,extlink:21,fact:14,featur:24,field:21,figur:21,file:[16,21],filtron:4,flat:21,foo:21,fork:18,found:14,from:6,fun:14,further:[3,8,9,19,21,22],gate:21,gener:[16,21],get:0,github:15,global:9,good:15,graphviz:21,grid:21,hackabl:15,head:21,hello:21,highlight:21,hlist:21,hook:19,horizont:21,host:6,how:[4,6,7,14,15,20,26],hyperlink:21,imag:[16,21],init:23,inlin:21,instal:[6,10],instanc:[4,26],interfac:10,intersphinx:21,introduc:14,javascript:20,kernel:21,kiss:21,latex:21,limit:13,line:21,link:21,list:21,liter:21,live:[15,18],log:6,make:[16,18,20],makefil:[18,20],map:16,markup:21,math:21,matter:21,name:21,need:[1,2],nest:21,next:[12,13],nginx:6,note:21,offlin:12,ordinari:21,oscar:20,overrid:16,overview:16,page:18,paragraph:21,paramet:22,pars:16,pass:16,plugin:[8,19],point:19,post:19,pre:19,prepar:12,prime:15,primer:21,privaci:[15,26],privat:[13,26],process:21,progress:12,project:23,protect:[4,26],proxi:7,pybuild:18,pyenv:20,pylint:18,python:[14,18],quickstart:20,quot:21,read:[3,8,9,19,21,22],readabl:21,ref:21,refer:6,render:21,request:[4,16],requir:23,respons:0,rest:[15,21],result:[7,16,19],role:21,rout:4,run:[14,18,20],sampl:[0,4],search:[0,19,22,28],searx:[6,10,13,14,24,26],see:26,server:6,set:[9,16],setup:[7,18,20],sidebar:21,simpl:21,skill:21,smart:21,soft:21,some:2,sourc:[15,20],space:21,specif:21,sphinx:[2,21],step:[12,13],structur:21,style:20,subdirectori:6,substitut:21,support:14,svg:21,syntax:[21,28],tab:21,tabl:21,target:[18,20],templat:21,test:[18,20],theme:20,thi:2,through:4,time:[3,8],tip:20,titl:21,torrent:16,transifex:23,translat:[15,23],truth:21,unicod:21,unit:20,updat:[6,23],upgrad:14,upstream:18,url:[6,21],use:26,user:25,using:[14,26],uwsgi:6,video:16,view:21,web:6,welcom:24,what:26,why:26,work:[1,2],yml:[9,16],you:14,your:[13,20]}}) \ No newline at end of file +Search.setIndex({docnames:["admin/api","admin/architecture","admin/buildhosts","admin/engines","admin/filtron","admin/index","admin/installation","admin/installation-apache","admin/installation-docker","admin/installation-nginx","admin/installation-searx","admin/installation-uwsgi","admin/morty","admin/plugins","admin/settings","admin/update-searx","blog/admin","blog/index","blog/intro-offline","blog/private-engines","blog/python3","dev/contribution_guide","dev/engine_overview","dev/index","dev/makefile","dev/plugins","dev/quickstart","dev/reST","dev/search_api","dev/translation","index","user/index","user/own-instance","user/search_syntax","utils/filtron.sh","utils/index","utils/lxc.sh","utils/morty.sh","utils/searx.sh"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["admin/api.rst","admin/architecture.rst","admin/buildhosts.rst","admin/engines.rst","admin/filtron.rst","admin/index.rst","admin/installation.rst","admin/installation-apache.rst","admin/installation-docker.rst","admin/installation-nginx.rst","admin/installation-searx.rst","admin/installation-uwsgi.rst","admin/morty.rst","admin/plugins.rst","admin/settings.rst","admin/update-searx.rst","blog/admin.rst","blog/index.rst","blog/intro-offline.rst","blog/private-engines.rst","blog/python3.rst","dev/contribution_guide.rst","dev/engine_overview.rst","dev/index.rst","dev/makefile.rst","dev/plugins.rst","dev/quickstart.rst","dev/reST.rst","dev/search_api.rst","dev/translation.rst","index.rst","user/index.rst","user/own-instance.rst","user/search_syntax.rst","utils/filtron.sh.rst","utils/index.rst","utils/lxc.sh.rst","utils/morty.sh.rst","utils/searx.sh.rst"],objects:{},objnames:{},objtypes:{},terms:{"0pointer":11,"0xa9":27,"15px":27,"2ee9ab582e5ff1dfcc6c4f7f2bdd4db6":10,"40px":27,"70px":27,"800gbpciex4":38,"\u65e5\u672c\u8a9e":14,"boolean":[22,27],"break":[21,27],"byte":22,"case":[7,9,14,19,26,32,34,37,38],"class":7,"default":[4,7,9,11,12,14,20,21,24,25,27,28,30,32,33,34,35,36,37,38],"espa\u00f1ol":14,"export":[9,10,24,34,36,37],"fran\u00e7ai":14,"function":[18,22,25,27,36],"import":[9,18,27],"int":[4,22,27],"long":32,"new":[7,9,10,11,13,16,18,19,21,24,25,26,28,29],"null":[7,9,21],"public":[1,6,13,27,35,36],"return":[13,18,23,25,27,32],"schr\u00f6dinger":27,"short":26,"static":[2,4,9,25],"switch":[7,21],"t\u00fcrk\u00e7e":14,"true":[0,4,7,9,10,11,14,18,22,25,26,27,28,34,37],"try":[10,24,26,32],"var":7,"while":[11,18,24,27],And:[7,27],But:[16,20,22,32,36],DNS:[35,36],For:[2,4,7,8,9,10,11,19,21,24,26,27,28],IPs:[4,35],Not:27,One:[11,16],That:27,The:[0,2,5,6,11,14,19,22,24,27,28,32,34,35,36,37,38],Then:[18,20,26,29],There:[7,11,21,27],These:[22,27],USE:7,Use:[4,7,9],Used:[7,14],Uses:14,With:[7,24,27,36],__dict__:27,__name__:27,_anchor:27,_chapter:27,_doc:27,_dot:27,_rest:27,_section:27,_sphinx:27,_subsect:27,_svg:27,a2disconf:7,a2dismod:7,a2dissit:7,a2enconf:7,a2enmod:7,a2ensit:7,abbrev:33,abl:[2,14,18,19,21,22,27],about:[1,19,21,24,30,36],abov:[7,10,21,27,28,36],absenc:27,abus:[4,32],accept:[10,18,33],access:[4,7,13,16,17,18,27,30,32],access_log:9,accord:11,account:[7,9,29,34,35,37,38],accross:14,accusam:27,acknowledg:17,act:[12,16],action:[0,4,11],activ:[7,9,10,11,12,14,20,21,26,28,34,37,38],adapt:22,add:[6,7,9,11,12,19,21,24,25,27,33,34,35,37,38],added:[11,19,24,25],adding:[18,27,35],addit:[2,22,24,26,27],addition:[30,32],address:[12,14,22,32,35],adipisici:27,adjust:24,admin:[14,17,19,27,30,35,37],administr:[16,18,19,28,30,32],admonit:23,adopt:21,adorn:27,ads:32,advantag:[16,27],advertis:32,advis:[4,7,9],aearx:14,af2cae6:27,affect:16,after:[10,20,25,26,27,29,34,37],again:24,agent:[4,10,13,14,22],aggreg:[4,30,32],agpl:[35,36],ahrefsbot:4,aim:[16,24,27],aka:24,alia:9,align:27,aliquid:27,aliquyam:27,all:[0,6,7,12,20,21,22,24,27,28,34,35,36,37,38],allow:[7,10,14,27,33],allowoverrid:7,alltogeth:5,along:4,alreadi:[7,9,21,26],also:[2,7,8,10,11,21,24,27,32,33,35],alt:27,alter:21,altern:[6,9,26,27,36],alwai:[9,22,26,32,34,37],amd64:[34,37],amet:27,among:[21,32],amsmath:27,analysi:2,ancel:27,anchor:23,ani:[2,6,7,11,24,27,28,30,35],annoi:27,anonym:[30,32],anoth:[11,14,16,22,27,36],answer:[14,27,32],anymor:7,anyon:30,anyth:[14,20,32],anywai:[24,27],apach:[1,4,5,6,11,14,30,34,35,36,37,38],apache2:7,apache2ctl:7,api:[5,14,19,22,23,29,30,34],api_kei:[14,22],apikei:14,app:[7,9,11,27,34,37,38],appear:[26,27],append:18,appli:[14,15,21],applic:[4,9,11,14,16,38],approach:11,april:36,apt:[2,7,9,10,26,27],arbitrari:[18,22],arch:[0,2,7,9,10,11,19,27],architectur:[4,5,6,7,9,30,34,37,38],archiv:4,archlinux:[11,19,36],argument:[12,13,27],arrai:22,arrow:27,art:[27,28],articl:23,asciimoo:[6,8,10,21,24,26,29,34,37,38],ascrib:27,aspect:21,assert:21,assign:22,assum:[10,27],asterisk:27,attach:25,attent:27,attribut:27,audienc:27,author:[21,27],auto:[27,29,36],autobuild:24,autocomplet:[0,28],autodoc:27,autoindex:7,autoindex_modul:7,automat:[11,13,27],avail:[7,9,11,13,14,18,21,26,28,32,34,37,38],avoid:[4,13,14],awar:[7,27,35],babel:[2,10],backquot:27,backslash:27,backup:35,baiduspid:4,balanc:24,ban:32,bang:14,bar:[5,27,34,37],barrier:16,base:[2,10,14,18,22,24,28,36],base_url:[9,14,22],baseprofil:27,bash:[10,27,34,35,36,37],basic:[23,36],batch:35,baz:27,becaus:[16,19,21,22,26,29,32],becom:27,been:[18,21],befor:[10,11,20,21,24,25,26,27,32,35,36],beginn:9,behavior:27,behaviour:[11,13,21,25],being:[4,14,16,20,30],below:[4,6,10,11,14,21,26,27,29],benefit:19,besid:32,best:[2,24,27,32,35],better:[2,7,9,22,24,32],between:[4,22,27],big:27,bigger:14,biggest:16,bin:[2,10,11,20,24,26,34,37],binari:[34,37],bing:14,bingbot:4,bit:[11,27],bitbucket:0,black:27,blank:[14,27],block:[4,14,23],blog:[11,27,30],bodi:[10,21,27],boilerpl:24,bold:27,boldfac:27,born:21,bot:4,both:[11,19,20,21,28,32],botlimit:4,bottom:13,boundingbox:22,box:[1,6,30,36],branch:[21,24,35],brand:[24,35],bring:[24,27],broken:27,browser:[10,13,14,16,20,21,24,32,36],bug:[11,17,24,26],buggi:11,bugreport:[11,21],build:[1,5,6,8,10,23,36],buildenv:24,builder:27,buildhost:[5,24,30,35,38],built:[21,22,26,27],builtin:[5,25,30],bundl:10,calcul:9,call:[16,19,24,29,36],callback:25,can:[0,1,2,4,6,7,8,9,10,11,12,14,16,18,19,20,21,22,24,25,26,27,30,32,34,36,37,38],cancel:27,cannot:[2,27,32,34,37],capabl:[16,21],caplabl:18,captcha:32,caption:27,cardin:21,care:[14,27,35,36],carv:19,cat:[34,36,37],catcher:27,categori:[0,3,13,14,18,22,27,28,33],caution:27,caveat:27,cdn:2,cell:27,cfg:[3,27],cgi:11,chain:24,chainabl:33,chang:[11,14,20,21,24,27,35],chapter:[4,20,21,27,37,38],charact:[21,27],chdir:11,check:[2,5,18,21,22,24,26,29],checker:24,checkout:21,chmod:11,choic:[6,10,27,32,35],choos:[6,21,22],chown:[7,9,10,11,34,37],chronolog:27,citi:22,classifi:27,clean:[23,36],clear:32,cli:29,client:4,clita:27,clock:20,clone:[6,8,9,10,21,24,26,38],close:10,cmd:[35,36],code:[11,14,18,23,24,26,28,32,35,36],codebas:16,coffe:36,col:27,colleagu:19,collect:2,colon:27,colspan:27,column:27,com:[6,8,10,22,24,26,27,28,29,34,36,37,38],combin:7,come:[4,9,19,20,21,24,32,36],comfort:[11,27],comma:[19,28],command:[2,4,7,10,11,20,26,27,29,30,34,37,38],comment:[7,9,10,27,34,36,37],commit:[24,26,29],commodi:27,common:[11,26,30,32,34,37,38],commonli:27,commun:[7,9,18],compact:27,compani:32,compar:[7,9,11,36],compat:20,compil:[7,23,29],complet:[4,11,21,28,34,36,37,38],compon:[7,25,35],compromis:32,comput:32,con:27,concern:21,conclus:31,concret:[19,27],condit:27,conf:[2,7,9,27,34,37],config:[0,11,19,22,27,29,34,35,36,37,38],configur:[5,7,9,11,16,18,19,23,27,29,32,34],conflict:35,confnam:11,confus:27,connect:[4,9,10,18,30],consectetur:27,consequ:[14,21],consequat:27,consetetur:27,consid:6,construct:[22,27],consult:26,contact:14,contain:[10,13,14,26,27,35,36],content:[5,17,23,30,31,32,35],context:[25,27,36],continu:27,contribut:[1,2,23,24,30],contributor:27,control:[7,11,32],convent:21,convert:27,cooki:[22,30,32],copi:[10,21,27,36],copyright:27,core:[2,11,18],corner:21,correct:[9,14],correctli:9,correspond:11,could:[11,14,22,27],count:27,countri:[14,22],courgett:28,cours:27,coverag:26,crawler:27,creat:[5,6,7,9,11,14,18,20,26,27,28,29,35,38],creation:[2,27],creativ:19,cross:27,cryptic:26,cryptographi:14,cspan:27,css:[13,25],css_depend:25,csv:[4,28],csv_tabl:27,ctan:27,cthulhu:33,ctrl:[10,24],ctx:25,cup:36,curl:[4,10],current:[13,14,18,21,22,29,33],custom:[14,21,27,33],customiz:[0,16],customlog:7,cycl:24,daemon:[34,37,38],dai:[11,24,28],dalf:1,danger:27,data:[5,22,27,32],databas:[19,27],date:[0,22],datetim:[22,27],daunt:16,dbpedia:28,ddg:33,de_d:14,deactiv:[14,34,37,38],debian:[2,5,9,10,11,15,27],debug:[10,14,23,24,34,35,37,38],decid:[16,24],decim:22,dedic:[11,27],deeper:[24,27],def:[18,22,25,27],defaul:27,default_local:[0,14],default_on:25,default_them:[0,14],defin:[14,25,27],dejavu:2,delet:[14,28,29,36],delimit:27,demon:10,demonstr:9,deni:7,depend:[4,5,7,9,13,16,18,20,22,24,26,27,28],deploi:[8,14,24,27],describ:[4,6,7,11,14,24,27,38],descript:[13,21,25,27,34,37],deserv:21,design:[18,27],desir:[22,26],detail:[7,14,18,27],detect:14,deutsch:[0,14],dev:[2,7,9,10,21,24,27],devel:[2,10],develop:[2,10,14,16,17,19,20,21,24,27,30,35],dfrac:27,diam:27,dict:27,didn:14,diff:27,differ:[7,9,11,20,21,22,27,36],digit:30,digraph:27,dir:[10,34,37],direct:[7,23,27,34,37],directli:[9,14,36],directori:[7,11],disabl:[3,5,10,11,13,14,24,25,27,28,35,36],disabled_engin:28,disabled_plugin:28,disadvantag:27,discoveri:[18,19],discret:35,displai:[2,13,14],displaystyl:27,dispos:35,disrespect:21,dist:[21,24],distinguish:27,distribut:[7,9,11,19,27,34,37],distributor:5,dive:32,dnf:[2,7,9,10,27],doai_rewrit:28,doc:[5,7,11,23,27,36],docker:[5,6,24,30],dockerfil:8,docs_url:24,doctest:27,doctre:27,docuemt:2,document:[7,11,18,19,24,27,30,36],documentroot:7,docutil:27,doe:[7,11,16,18,22,24,27,28,31],doesn:14,doi:13,dolor:27,domain:27,domin:21,don:[7,20,24,27,30],done:[7,9,24,27,35,36],dontlog:7,dot:2,doubl:27,download:[6,24,27,34,37],drop:20,duckduckgo:[28,33],due:[34,37],duo:27,duref:27,dvisvgm:2,each:[11,27,28],easi:30,easier:21,easili:21,echo:[10,34,36,37],ecosystem:27,edit:[10,11,16,21,24,27,32,37],eeach:36,effect:[21,27],egg_info:24,eirmod:27,either:26,element:27,elimin:26,elit:27,elitr:27,els:36,emac:27,email:14,emb:[5,27],embed:[0,8,27],emperor:11,emphasi:27,empti:[7,27,28],en_u:[14,22],enabl:[0,7,9,10,11,19,21,24,26,28,35],enabled_engin:28,enabled_plugin:28,enclos:27,encod:27,encourag:27,encrypt:30,end:[20,27,36],endfor:27,engin:[0,5,10,16,17,21,23,26,27,28,30,32,33,34,37],english:[0,14],enim:27,enough:[6,7,9,29],enpoint:28,ensur:21,enter:[10,20],entri:[23,35,36],env:[7,11,24,26,35,36],environ:[9,10,23,30,34,36,37,38],eof:[34,36,37],eol:36,eos:27,equat:[2,23],erat:27,error:[14,26,27],error_log:9,escap:27,especi:27,esperanto:0,essenti:[2,10],est:27,etc:[4,7,9,10,11,21,34,38],eth0:36,evalu:[27,36],even:[11,36],event:11,ever:36,everi:[14,21,22,32,36],everyon:[18,32],everyth:[10,27,32],exactli:[4,27],exampl:[0,4,7,9,11,18,19,21,23,26,28,31,32,35,36],exceed:4,excel:[6,9],except:[7,20,21,27,35],exchang:32,execstart:[34,37],execut:[14,29],exercit:27,exist:[7,9,16,20,21,24],exit:10,expect:[19,21],experi:11,experienc:16,experiment:35,explain:21,explanatori:[34,36,37,38],explicit:27,expos:19,ext:2,extend:[18,21,25,27],extens:[2,27],extern:[4,12,22,27,28,32],extra:[2,7],extract:2,extrem:16,eye:27,face:27,fact:17,fail:26,fals:[0,10,14,25,26,27,28,37],familiar:[11,24],fanci:21,faq:27,favorit:[21,24],fd00:7,fe80:7,featur:[12,16,19,21,27,32],fedora31:36,fedora:[2,7,9,10,11,27,36],fedoraproject:36,feedback:[21,27],feedfetch:4,feel:[25,27],few:[14,21,22],fieldnam:27,figur:[7,9,23],file:[2,3,7,9,10,11,14,16,18,19,20,21,24,25,26,29,34,36,37,38],file_filt:29,filenam:22,files:22,fill:27,filter:[0,4,28],filtron:[1,5,6,7,9,11,30,35,36],filtron_api:[34,35,36],filtron_listen:[34,35,36],filtron_target:[34,35],find:[1,4,18,19],fine:[6,10],finish:[29,36],firefox:2,firewal:4,first:[6,7,9,10,16,18,20,24,26,27,32],fit:[11,19,25],fix:[21,24,26],fixm:7,flask:[25,27],flexibl:[27,35],fmt:36,folder:[7,9,10,11,21,22,24,26,27,29,35,36],follow:[4,6,7,9,11,12,21,22,24,26,27,29],followsymlink:7,font:2,fontsrecommend:2,footer:21,force_timeout:[35,36],fork:[6,21,35],form:[0,27,32],format:[4,22,26,27,28],forward:[4,9,32],found:[2,16,17,24],foundat:[16,18,19,20],fr_fr:14,fraction:27,free:[25,30],fresh:7,friend:[19,24,32],from:[1,2,4,6,7,8,9,10,11,13,14,16,18,19,20,21,24,27,29,30,32,34,35,36,37,38],front:27,full:[14,21,27,34,37],fulli:[7,9,16],fun:17,fund:[18,19],further:[24,26,35],furthermor:[22,26,28,32],futur:36,gain:32,gate:24,gener:[0,7,11,14,18,21,23,24,32],geojson:22,german:0,get:[2,4,5,6,7,9,10,13,21,22,24,26,27,28,29,30,34,36,37],get_engines_stat:27,gid:11,gil:11,git:[2,6,7,8,9,10,14,15,21,22,24,26,27,34,35,37,38],git_branch:[24,35],git_url:24,github:[6,8,10,18,20,24,26,27,28,34,36,37,38],gitmoji:21,give:[7,24,26],given:27,glob:11,global:5,global_ip:36,glyph:27,gnu:24,go1:[34,37],go_env:[34,37],goe:24,goi:0,going:[4,18,19,27,32],good:[6,7,9,26,36],googl:[0,28,34,37],googlebot:4,gopath:[34,37],grant:[7,11],graphic:16,graphviz:2,grep:36,group:[27,32,34,37],grow:16,grumpi:27,grunt:26,gubergren:27,guest:36,guid:[9,16,24,26,27],guidelin:19,guilabel:27,hack:[16,18,19,20,21],hackabl:23,hackerspac:33,handl:[14,27,32,36],handler:7,happi:[16,18,19,20,21],hard:[16,27],harden:[34,37],has:[12,18,19,21,22,26,27,32],hat:27,have:[2,6,7,8,9,10,14,16,20,21,22,24,27,32,35,36],hbar:27,head:10,header:[4,7,9,22,27],headers_modul:7,heard:27,hebrew:14,height:27,help:[13,21,24,26,34,35,36,37,38],helper:27,her:[19,28,32],here:[2,7,9,11,14,18,21,27,35],herein:1,hidden:[0,19,32],him:19,hint:[1,27,35],his:[28,32],histor:[7,20],hit:10,home:[10,29,34,35,37],host:[2,4,7,9,10,16,19,24,29,30,36],hostnam:[9,36],hotkei:[0,13],hous:22,house_numb:22,how:[1,2,5,6,7,9,11,14,17,23,24,27,30,31,34,37],howev:[18,22,28],html:[0,2,7,11,21,22,24,27,37],html_math_render:2,http:[0,2,4,5,6,8,10,11,12,13,14,18,21,22,24,26,27,29,30,34,35,36,37,38],http_connect:[4,9],http_host:[4,9],httpd:7,https_rewrit:28,hub:8,huge:27,idea:26,identifi:[35,36],ifmodul:7,illustr:6,imag:[0,2,12,14,23,24,28,33,36,37,38],image_proxi:[7,9,14,28,37],imagemagick:[2,27],img_src:22,imgmath:2,imgmath_font_s:2,imgmath_image_format:2,imgmath_latex:2,immedi:13,implement:[9,11,16,20,21,22,25,36],impli:19,improv:24,in_contain:36,inbound:14,includ:[7,9,19,24,27,36],inclus:33,incom:7,increment:24,indent:[27,36],index:7,infinit:13,infinite_scrol:[13,28],info:[14,24,36,37],info_msg:36,inform:[8,12,13,14,19,21,22,36],infrastructur:[1,11],infratructur:4,inherit:27,ini:[7,9,11],init:[11,18,23,36],initi:[11,29,36],inlin:23,input:[0,19,27],insecur:10,insert:[27,29],insid:[10,22,36],insight:32,inspect:[34,35,37,38],instal:[1,2,4,5,11,12,20,21,24,26,27,29,30,35],instanc:[0,1,5,6,7,8,9,11,14,16,18,19,24,28,29,30,31,34,35,36,37,38],instance_nam:[0,10],instead:[11,16,19,20,26,27],instruct:27,insuffici:18,integr:30,intent:21,interact:[10,34,35,37,38],interfac:[7,14,17,30],interfer:21,intermedi:24,intern:26,internet:[6,18,30],interpret:[11,27],interpretor:11,intersphinx_map:27,interv:4,intranet:[6,7,9],intro:[7,9],introduc:[16,17,18,19,27,30],introduct:[24,26],intuit:27,inv:27,inventori:27,investig:20,invidunt:27,ipsum:27,ipv4:[9,36],ipv6:[9,36],isn:[7,9],iso:[14,22],isol:4,issu:[11,18,19,20],ital:27,italiano:14,item:27,its:[2,6,16,21,24,27,28,32,36],itself:[11,21],jame:4,japanes:14,javascript:[13,23],jinja:27,jinja_context:27,job:35,join:27,js_depend:25,json:[4,28,34],juli:36,jump:24,just:[0,4,9,24,27,32,36],justo:27,kasd:27,kbd:27,keep:[7,9,24],kei:[12,13,14,18,22,29,37,38],kind:[7,27,32],kiss_:27,know:[7,11,18,19,27,32,36],knowledg:27,known:24,kvch:[16,18,19,20],label:27,labor:27,labori:27,lack:21,lang:[0,28,29],languag:[0,3,14,22,24,27,28,29,33],language_support:[22,27],laptop:32,larg:[11,34,36,37,38],last:27,lat:22,later:[35,36],latest:[11,29],latex:2,latexextra:2,latitud:22,latter:24,launch:36,layout:5,lazi:11,lc_messag:29,learn:27,least:20,leav:14,leech:22,leecher:22,left:[10,27],legaci:28,length:21,less:[7,9,11,16,26,27,32],let:[27,32,35],level:[21,27],lib:[7,11,34,37],libapache2:7,libffi:[2,10],librsvg2:2,librsvg:2,libssl:[2,10],libxml2:[2,10],libxslt:[2,10],licens:[35,36],light:9,like:[0,2,8,10,13,14,19,21,22,24,27,35],like_hotkei:28,limit:[4,7,17,18,27,30],line:[7,9,18,21,24,36],link:[11,13,14,23],linkdexbot:4,lint:[5,24],linux:[0,2,7,9,10,11,19,27,34,35,36,37],linuxcontain:36,linuxcontainers_org_nam:36,linuxdoc:27,list:[7,18,19,22,23,24,25,28,33],listen:[4,7,9,34,35,36,37],liter:23,literalinclud:27,live:[23,27,36],load:[11,13,14,36],loadmodul:7,local:[0,4,9,10,11,14,19,20,22,24,25,26,29,34,35,36,37,38],local_imag:36,localhost:[7,8,9],locat:[4,7,9,10,11,14,27],log:[4,5,11,14,26,32,34,35,37,38],logger:11,logic:21,logicodev:28,login:10,lon:22,longer:24,longitud:22,look:[7,10,24],lorem:27,loremlorem:27,low:[7,9],lsb:11,lxc:[30,35],lxc_host_prefix:36,lxc_repo_root:36,lxc_set_suite_env:36,lxc_suit:36,lxc_suite_info:36,lxc_suite_instal:36,lxc_suite_install_info:36,lxc_suite_nam:36,lxd:36,lxml:[2,10],made:14,magna:27,magnetlink:22,magyar:14,mai:[14,27,34,37],main:[7,13,24,29,35],mainlin:9,maintain:[1,11,27,35],mainten:[4,6,34,37,38],make:[2,8,16,19,20,21,23,27,32,36],makefil:[21,23,30,35,36],man:27,manag:[4,10,15,16,24,26,34,37,38],mandatori:6,mani:4,manipul:[16,36],manual:[14,24,27],manuali:27,map:[0,27],mark:[10,27],markup:23,mass:21,master:[11,15,21,24,27,35],math:[2,23],mathemat:27,mathrm:27,matter:[22,32],max:[4,22],maxim:21,maximum:[21,22],mean:[11,21,27,32],meaning:27,meant:27,media:[0,22],memori:14,mention:20,menuselect:27,messag:[4,14,21,24,26,27,29],messagespo:29,meta:27,metadata:27,metasearch:[10,22,30,34,37],method:[0,6,11,22,27],middlewar:4,might:[11,19,21,24,27,28,32,35,36],migrat:20,min:22,minim:27,misbehav:21,miss:27,mj12bot:4,mkdir:[7,9,10,11,34,37],mod:[7,27],mod_autoindex:7,mod_head:7,mod_proxi:7,mod_proxy_http:7,mod_proxy_uwsgi:7,mod_uwsgi:7,mod_wsgi:7,mode:[11,14,27,35,36],modern:7,modifi:[11,14,27,33],modul:[7,11,27],monet:32,monitor:11,mono:2,month:[0,28],more:[4,8,12,14,16,18,21,24,27,28,30,32,35,36],morecol:27,morerow:27,morti:[1,6,7,9,12,30,35,36],morty_listen:[35,36,37],most:[2,7,14,20,32,34,35,37,38],mostli:[11,27],move:[18,21],msnbot:4,much:[21,27],multi:[34,37],multibl:22,multipl:[13,14,27,32],multithread:11,multius:10,must:[9,14,20,21,22,26,27],my_arg:27,my_funct:27,my_other_arg:27,mydomain:35,myproject:26,name:[0,3,4,7,8,9,10,13,14,19,22,24,25,29,36],nativ:11,navig:13,necessari:[10,19],nederland:14,need:[4,6,7,9,10,11,14,18,21,24,27,32,34,35,36,37,38],neither:30,net:30,netvib:4,network:[14,34,37],never:24,nevertheless:[7,9],newcom:16,nework:14,next:[7,9,13,17,27],nginx:[1,4,5,6,14,30,34,36,37,38],nightmar:27,nil:36,nisi:27,nlnet:[16,18,19,20],noconfirm:[2,10],node:[24,26],nodej:26,non:18,none:[7,22,24,27,28],nonewprivileg:[34,37],nonumi:27,nor:30,normal:[7,22,27,35],nostrud:27,note:[7,9,21,28],now:[7,9,10,19,20,25],npm:[24,26],number:[4,14,22,27,28,36],number_of_result:22,numer:27,numref:27,obj:27,object:[22,25,27],obtain:14,off:[7,9,21,34,36,37,38],offer:11,offlin:[3,17,19,22,27,30],often:[22,27,35],old:7,on_result:25,onc:36,one:[7,11,14,19,21,24,27,30,32,34,35,36,37,38],ones:[22,34,37],ongo:24,onli:[2,6,7,12,14,19,21,25,27,28,35,36],onlin:[18,27,30],open:[7,10,13,20,21,24,27,28,32,35,36],open_results_on_new_tab:13,openstreetmap:0,oper:[20,27,32],option:[7,10,11,12,14,16,19,21,22,24,25,26,27,28,32,34,35,37,38],order:[7,21,26,27],org:[2,4,7,9,11,14,22,27,36],org_bot:4,organ:30,orient:7,origin:[5,15,27],oscar:[0,14,28],osm:[0,22],other:[14,21,22,27,32],otherwis:22,our:[1,4,6,16,21,24,27,36],out:[7,9,18,21,24,27,34,36,37],outgo:14,outgoing_proxi:14,output:[2,19,27,28,34,36,37,38],outstand:27,over:[27,30,36],overlin:27,overview:[4,14,23,24,28,30,35],overwrit:13,overwritten:22,own:[6,24,30,32],owner:24,packag:[2,4,5,7,9,11,24,26,27,34,36,37,38],pacman:[2,7,9,10,27],page:[3,7,9,13,14,16,19,21,22,23,27,28,32,33],pageno:[22,28],pagenumb:22,pair:18,palletsproject:27,param:[4,18,22,27],paramet:[22,23],paramt:22,parent:27,pars:28,parse_lin:18,part:[14,16,27,36],parti:32,partial:27,partli:22,pass:[7,9,18,28],past:0,patch:[21,27],path:[4,7,14,34,36,37],paywal:13,pdf:2,peopl:[16,32],pep8:[21,24,26],pep8_check:24,pep:27,per:[11,21,22,27],perform:[11,13,18,22],phase:26,phrase:27,piec:27,pip3:20,pip:[2,10,29],pipe:18,pix:28,place:[6,9,11,21,22,27,29,32],plaintext:27,pleas:[20,21,26,27,28],plenti:21,plu:[7,9],plugin:[0,2,5,10,11,21,23,28,30],pocket:[7,9],point:[9,10,11,23,24,27,32],pointer:27,pointhi:28,polygon:27,popen:18,popular:27,port:[4,8,9,10,14,36],possibl:[8,12,13,14,18,19,27,28],post:[0,21,28],post_search:25,postcod:22,pot:29,pov:27,power:27,practic:21,pre_search:25,prefer:[6,16,19,27,28,32,33],prefix:33,preinstal:4,prepar:[17,30,36],prerequisit:27,present:[18,19],preserv:[21,27],press:[13,24],pretti:14,preview:22,previou:35,primari:36,primary_ip:[35,36],prime:23,primer:[23,30],principl:27,privaci:[6,7,9,10,11,23,27,31,34,37],privat:[17,18,30,31],privatedevic:[34,37],privatetmp:[34,37],pro:27,problem:4,procedur:[6,36],process:[2,4,11,18,19,24],processor:27,produc:27,product:[14,35],profil:[10,24,30,32,34,37],program:24,progress:[17,34,37],project:[11,23,24,27],promot:30,prompt:35,proper:[32,34],properli:20,propos:18,protect:[1,5,7,9,21,30,31,34],protectsystem:[34,37],protocol:[9,11],provid:[19,21,22,27],proxi:[1,5,6,9,14,28,30,32,34,35,36,37,38],proxif:[7,9],proxifi:12,proxy_add_x_forwarded_for:[4,9],proxy_buff:9,proxy_http:7,proxy_http_modul:7,proxy_modul:7,proxy_pass:[4,9],proxy_set_head:[4,9],proxy_uwsgi_modul:7,proxypass:[7,34,37],proxypreservehost:7,psi:27,public_host:34,public_url:[34,35,36,38],public_url_morti:[36,37],public_url_path_morti:35,publicli:18,publish:22,publishedd:22,pull:[8,15,18,21,27,29],purpos:[14,22,26],push:[21,24],py3:24,pybabel:29,pybuild:23,pyclean:24,pyenv:[10,11,24,38],pygment:27,pylint:23,pylintrc:24,pypi:[24,27],python2:[11,20],python3:[2,10,11,20,26],python:[2,4,10,11,14,17,23,26,27,30,38],pythonhom:11,pythonpath:11,qout:36,quadratur:30,qualiti:[2,24,27],queri:[13,18,19,22,28,32,33],question:[27,32],qui:27,quickstart:[21,23,24,30],quiet:24,quit:[7,21,24],qwer:33,rais:18,random:[22,32],rang:[3,11,22,28],rangl:27,rate:4,rather:19,raw:27,reach:27,reactiv:14,read:[18,21,24,26,35],readability_:27,reader:27,readlin:18,readm:[4,7,11,12],readthedoc:11,real:[4,9],realli:6,reason:[7,11,16,20,24,27],rebuild:[21,24],rebum:27,recommend:[2,4,6,11,21,22,24,27,35],reconsid:21,record:27,redefin:22,redirect:13,reduc:21,ref:[34,37],refer:[1,27,32],referenc:27,refnam:27,regardless:32,regular:18,reinstal:[34,38],rel:[9,27,36],releas:[20,24,36],releng:36,reload:11,rememb:[11,21],remot:36,remote_addr:[4,9],remov:[11,13,32,34,35,36,37,38],renam:28,render:2,replac:[7,9,10,16,25],repo:21,repositori:[10,16,36],request:[5,7,9,14,18,19,21,23,25,27,32],request_timeout:14,request_uri:7,requesthead:7,requir:[2,7,13,20,21,22,23,24,26,27,28],requisit:24,reset:32,resourc:9,respect:[10,21,32,34,37],respons:14,rest:[19,23,30],restart:[5,9,10,11,12,15,34,37],restrict:19,restructuredtext:27,result:[1,2,5,6,7,9,13,14,18,23,27,28,30,32,37,38],result_proxi:[7,9,12,37],results_on_new_tab:28,retriev:29,return42:[27,38],return_cod:18,rever:7,revers:[1,5,6,9,34,35,36,37],rewrit:[0,13],rfc:27,rhel:[2,7,9,10,11,27],rid:[24,36],right:[11,19,25,27,30],rightmost:27,rigth:27,road:22,roboag:4,robot:[24,26],robotframework:20,role:23,rolenam:27,roll:36,romanian:14,root:[7,9,24,36],rotat:27,round:21,rout:[5,7,9,27],row:27,rowspan:27,rspan:27,rss:[4,28],rst:[21,27],rst_titl:36,rule:[4,21,34],run:[2,4,6,7,8,9,11,12,14,17,18,19,21,22,23,25,27,29,32,34,35,37,38],runtimeerror:18,russian:14,ryzen:10,sadipsc:27,safe:[3,28],safe_search:0,safesearch:[27,28],same:[4,10,13,14,22,27],sampl:[5,27,34],san:2,sanctu:27,satisfi:26,save:7,sc2031:36,sc2034:[35,36],scalabl:27,scale:[27,36],scaleabl:27,scan:11,schedul:[18,20],scheme:[4,9],schroeding:27,scope:21,scrapi:4,scratch:2,script:[1,4,5,7,9,10,26,34,35,36,37,38],script_nam:9,scroll:13,sdist:24,sea:27,search:[3,4,5,13,14,18,19,21,22,23,27,30,31,32],search_on_category_select:[13,28],search_path:22,search_str:22,searx:[0,1,2,4,5,6,7,8,11,12,14,15,17,18,21,22,24,25,26,27,28,29,31,33,34,35,37],searx_instance_nam:38,searx_internal_http:38,searx_internal_url:35,searx_settings_path:[10,11],searx_url:[24,35],searx_userag:14,sec:4,second:[10,14,27],secret:[14,19],secret_kei:14,section:[9,14,24,27],secur:30,sed:[10,27],see:[2,4,7,8,9,11,12,14,18,19,21,26,27,28,30,33,34,36],seed:22,seeder:22,select:[13,24,27,32,33,36],selenium:26,self:[13,16,30,34,36,37,38],self_inform:28,semant:21,send:[2,4,14,32],sens:27,sent:32,separ:[19,21,27,28,34,37],seri:24,serif:2,serv:[21,32,36],server:[4,5,6,11,14,26,36,37],server_nam:9,servic:[4,5,6,9,11,12,27,28,30,32,34,35,36,37,38],service_home_bas:35,service_us:[34,35,37,38],service_ussr:35,session:[10,26],set:[2,3,5,7,9,10,11,12,16,18,24,26,27,28,29,30,32,33,34,35,36,37,38],setenvif:7,sethandl:7,setup:[1,2,4,5,6,7,9,10,11,23,27,30,34,37],seznambot:4,share:[7,11,19,36,38],she:[19,32],shell:[5,10,34,35,36,37,38],shellcheck:[2,10,27,35,36],ship:9,shortcut:[0,3,14,19,22,27],should:[6,7,9,14,16,20,21,27,29],show:[1,2,7,9,27,34,35,36,37],shown:[6,7,10,27],side:27,sign:27,signifi:27,similar:[11,27],simpl:[24,28,34,37],simplest:27,simpli:[4,21,24,28,34,35,37,38],simplifi:[4,24,34,37,38],sinc:[9,16,24,27],singl:[7,9,11,32,36],sit:27,site:[0,4,5,7,14,22,27,28,34,37,38],size:22,skeleton:18,skill:23,skip:26,slow:14,slurp:4,small:[22,38],smtbot:4,snap:36,snapcraft:36,snippet:12,social:0,sock:14,socket:[7,9,11],soft:23,softwar:[34,37],sold:32,solut:19,solv:[4,19],some:[1,6,7,11,14,19,21,24,27,34,35,36,37,38],someon:32,someth:[21,24],sometim:16,sourc:[10,14,20,23,24,27,29,32,34,36,37],source_fil:29,source_ip:14,source_lang:29,space:14,span:27,spars:27,spdx:[35,36],speak:11,special:[6,11,22],specif:[11,14,22,36],specifi:[11,14,22,28],sphinx:21,splinter:20,split:21,spoilt:6,sponsor:[16,18,19,20],src:[4,9,10,11,38],srv:7,ssl:[22,30],stabl:14,stack:[26,36],stage:27,standalon:16,standard:[7,21,22,36],start:[1,4,7,9,10,11,21,22,24,30,34,36,37,38],startpag:28,stash:[15,24],stat:27,statist:27,statu:[34,35,37,38],stdout:18,step:[1,5,6,17,21,30,38],stet:27,stone:19,stop:[4,7,9,10,11,24,34,36,37,38],storag:36,store:[22,32],strang:11,street:22,strict:19,string:[19,22,28,29],stroke:27,strong:27,structur:[21,23],stub:27,stuff:27,style:[23,28],sub:[21,27],subdir:9,subdirectori:9,subject:27,submit:21,subnet:7,subprocess:18,subrul:4,subscript:27,subsect:27,subshel:36,substitut:23,sudo:[2,6,7,9,10,11,15,26,27,34,35,36,37,38],suffix:14,suggest:[1,25],suit:35,suitabl:27,sup:27,superscript:27,supervisor:16,support:[2,3,5,9,10,11,14,17,19,21,22,27,28,30,32,34,36,37],sure:[8,10,20],surround:27,svg:2,svg_imag:27,symbol:11,symlink:9,syntax:[28,30,31],syslog:[34,37],system:[10,11,19,20,21,24,27,34,35,37],systemctl:[7,9,11,15],systemd:[11,34,37,38],tab:[13,23,28,36],tabl:[18,23],tailor:32,take:[11,14,16,21,29,36],taken:[27,35],takimata:27,tar:[24,34,37],target:[21,23,27,30,34,36,37],task:[6,10,27,36],tcp_nodelai:10,tell:22,templat:[11,18,22,23],tempor:27,term:[7,27],termin:10,test123:38,test:[2,7,9,10,20,21,23,36,38],texliv:2,text:[0,22,27],textstyl:27,tfrac:27,than:[14,27,30],thei:[11,14,19,27,32],them:[11,14,24,27,35],theme:[14,23,24,28],themes_path:14,themselv:19,therefor:[6,27],thi:[4,6,7,8,9,10,11,12,13,14,16,18,19,20,22,24,25,26,27,28,32,34,35,36,37,38],thing:27,think:[21,24,27],third:[27,32],those:[18,29,32],thread:11,three:[21,25,27,32],through:[5,7,9,14,19,27,28,32],thu:[18,20,28,32],thumbnail:22,thumbnail_src:22,time:[4,14,20,21,22,27,28,32,36],time_rang:[0,28],time_range_support:[22,27],timeout:[3,14,22,27,35,37],timestamp:11,tip:[23,27],titl:22,todai:18,togeth:18,token:[18,19],too:[4,14,27,32],tool:[1,2,6,10,16,21,27,29,30,36],top:27,tor:[30,32],torrentfil:22,touch:[7,9,11,14],trace:26,track:[30,32],tracker:13,tracker_url_remov:28,trademark:27,traffic:[7,9],train:27,transform:27,transifex:[21,23],transifexrc:29,translat:[14,23,30],transpar:36,travi:[20,26],tree:24,troubleshoot:35,trust:[19,30,32],ttf:2,tupl:25,turn:[21,26],twice:10,twine:24,two:[11,21,27,28],txt:[20,24,27],type:[0,21,22,24,28,29,32,34,36,37],typic:[1,27],typo:27,ubu1604:36,ubu1804:36,ubu1910:36,ubu2004:36,ubuntu:[2,7,9,10,11,15,27,36],uds:7,ugli:[16,27],uid:11,ullamco:27,ultrasecretkei:[10,14],unam:[10,36],uncom:14,uncommon:21,under:[19,22],understand:[16,27],unfortun:21,unicod:23,uninstal:[24,35],unit:[11,21,24,34,37,38],unit_test:[24,26],univers:10,unix:[7,9,11],unknown:[32,34,37],unless:19,unlik:32,unspecifi:22,untouch:24,updat:[5,14,21,23,30,34,37,38],update_dev_packag:26,update_packag:[10,15],upload:24,upstream:11,url:[0,7,9,12,13,14,21,22,24,32,35,36,37,38],urlencod:22,usag:[6,7,9,24,27,34,36,37,38],use:[2,4,6,7,9,11,12,14,18,19,21,22,24,26,27,30,31,34,35,36,37,38],used:[7,9,14,20,21,22,27,30,32,35],useful:[14,35],user:[4,5,7,9,11,13,14,19,21,22,27,30,32,35,38],useradd:[10,34,37],userag:4,useragent_suffix:14,uses:[11,14,22,27,32],using:[4,7,9,11,14,17,21,24,26,27,29,30],usr:[4,7,9,10,11,34,35,37,38],usual:[20,32],utf:[27,35,36],util:[1,2,4,6,7,9,12,24,30],uwsgi:[1,2,5,9,10,15,30,38],uwsgi_param:9,uwsgi_pass:9,uwsgisocket:7,valid:[22,26,28],valu:[0,9,18,22,27,28,35],variabl:[22,24,37],variant:27,variou:[21,25],vassal:11,vector:27,vendor:21,veniam:27,venv3:20,venv:[2,10,26],verbos:[10,24,35],veri:35,verifi:22,vero:27,version:[10,13,20,27,34,37],via:[7,9,11,16,33],view:[23,32],viewbox:27,vim:[0,13,28],vim_hotkei:13,virtual:[7,9],virtualenv:[2,10,11,20,24,26,38],virualenv:[10,24],visist:27,visit:[10,27,32],voluptua:27,vpn:32,vulner:32,wai:[11,18,21,22,27,32],wait:[14,18],want:[14,19,20,21,24,27,28,32,35,36],wantedbi:[34,37],warn:[2,7,9,27,36],watch:21,web:[4,10,14,16,24,34,36,38],webapp:[10,11,14,20,24,27],webcrawl:4,webserv:9,websit:0,weight:[14,27],weigth:[3,14],weird:21,welcom:[7,9],well:27,were:[18,19,20],werkzeug:24,wget:[4,34,37],what:[11,27,36],whatev:[8,24,36],when:[2,7,13,14,20,25,26,27,32],where:[4,14,27],whether:[26,32],which:[1,4,7,9,11,14,16,18,19,21,22,24,27,28,30,32,34,37],whl:24,who:[11,16,18,32],whole:[7,25],why:[27,30,31],wide:21,widen:27,width:27,wiki:[0,9,18,19,27,36],wikipedia:[14,28,33],window:13,wish:14,within:[24,27],without:[2,14,22,30,32],won:[14,20],wonderfal:8,word:[25,27,28],work:[9,10,14,21,22,24,26,32],worker:11,workingdirectori:[34,37],world:[21,27,32],worri:20,worth:[11,32],would:19,wrap:9,wrong:24,wsgi:[9,11],www:[2,7,27,29,36],wysiwyg:21,xdg:24,xetex:2,xgd:10,xml:27,xmln:27,xxxx:27,xzf:[34,37],yacybot:4,yahoo:4,yandexbot:4,yandexmobilebot:4,year:[20,28],yes:[34,37],yet:[21,22,24],yml:[3,5,7,9,10,11,12,16,18,24,26,28,30,37,38],you:[1,2,4,6,7,8,9,10,11,14,17,18,21,24,26,27,28,30,32,33,34,35,36,37,38],your:[2,4,6,7,9,10,11,12,13,14,16,17,20,21,23,24,25,27,30,34,35,36,37,38],your_morty_proxy_kei:12,yourself:21,yyyi:27,zero:18,zgrab:4,zlib1g:[2,10],zzzz:27},titles:["Administration API","Architecture","Buildhosts","Engines","How to protect an instance","Administrator documentation","Installation","Install with apache","Docker installation","Install with nginx","Step by step installation","uwsgi","How to setup result proxy","Plugins builtin","settings.yml","How to update","Searx admin interface","Blog","Preparation for offline engines","Limit access to your searx engines","Introducing Python 3 support","How to contribute","Engine overview","Developer documentation","Makefile Targets","Plugins","Development Quickstart","reST primer","Search API","Translation","Welcome to searx","User documentation","Why use a private instance?","Search syntax","utils/filtron.sh","Tooling box utils/*","utils/lxc.sh","utils/morty.sh","utils/searx.sh"],titleterms:{"default":[3,13,22],"public":[7,9,32],"return":22,The:[7,9,21],about:[27,32],access:19,acknowledg:[16,18,19,20],activ:24,admin:16,administr:[0,5],admonit:27,aka:27,alltogeth:11,anchor:27,apach:7,api:[0,28],architectur:1,argument:22,articl:[2,27],ascii:27,bar:0,basic:27,bibliograph:27,block:27,blog:17,box:[4,35],bug:20,build:[2,21,24,26,27],buildhost:[2,36],built:[3,13],builtin:13,bullet:27,check:10,clean:[21,24],code:[21,22,27],command:[35,36],commit:21,common:35,compil:26,conclus:32,configur:[0,3,4,10,13,22],consequ:32,content:[2,4,7,9,10,11,14,21,22,24,27],contribut:21,creat:[10,21,34,37],csv:27,data:0,debian:7,debug:26,definit:27,depend:10,deploi:21,design:21,develop:[18,23,26],direct:21,disabl:[7,9],distributor:11,doc:[2,21,24],docker:8,document:[5,21,23,31],doe:32,dot:27,drop:24,emb:0,engin:[3,14,18,19,22],entri:25,environ:[24,26,27,35],equat:27,exampl:[22,25,27,33],ext:27,extlink:27,fact:20,featur:30,field:27,figur:27,file:[22,27],filtron:[4,34],flat:27,foo:27,fork:24,found:20,fun:20,further:[1,3,4,7,9,11,12,13,14,25,27,28,34,36,37,38],gate:27,gener:[22,27],get:0,github:21,global:14,good:21,graphviz:27,grid:27,hackabl:21,head:27,hello:27,highlight:27,hlist:27,hook:25,horizont:27,how:[4,12,15,20,21,26,32],http:[7,9],hyperlink:27,imag:[22,27],init:29,inlin:27,instal:[6,7,8,9,10,16,34,36,37,38],instanc:[4,32],interfac:16,internet:[7,9],intersphinx:27,introduc:20,javascript:26,kernel:27,kiss:27,latex:27,layout:7,limit:19,line:27,link:27,lint:2,list:27,liter:27,live:[21,24],log:[7,9],lxc:36,make:[22,24,26],makefil:[24,26],map:22,markup:27,math:27,matter:27,morti:37,name:27,need:2,nest:27,next:[18,19],nginx:9,note:27,offlin:18,ordinari:27,origin:11,overrid:22,overview:[22,34,36,37,38],packag:10,page:24,paragraph:27,paramet:28,pars:22,pass:22,plugin:[13,25],point:25,post:25,pre:25,prepar:18,prime:21,primer:27,privaci:[21,32],privat:[19,32],process:27,progress:18,project:29,protect:[4,32],proxi:[7,12],pybuild:24,pyenv:26,pylint:24,python:[20,24],quickstart:26,quot:27,read:[1,3,4,7,9,11,12,13,14,25,27,28,34,36,37,38],readabl:27,ref:27,render:27,request:[4,22],requir:29,respons:0,rest:[21,27],restart:7,result:[12,22,25],revers:7,role:27,rout:4,run:[20,24,26,36],sampl:[0,4],script:[2,6],search:[0,25,28,33],searx:[9,10,16,19,20,30,32,36,38],see:32,server:[7,9],servic:7,set:[14,22],setup:[12,24,26,35,36],shell:2,sidebar:27,simpl:27,site:9,skill:27,smart:27,soft:27,some:2,sourc:[21,26],space:27,specif:27,sphinx:[2,27],step:[10,18,19],structur:27,style:26,substitut:27,suit:36,support:[7,20],svg:27,syntax:[27,33],tab:27,tabl:27,target:[24,26],templat:27,test:[24,26],theme:26,thi:2,through:4,time:[3,13],tip:26,titl:27,tool:[4,35],torrent:22,transifex:29,translat:[21,29],truth:27,unicod:27,unit:26,updat:[15,29],upgrad:20,upstream:24,url:27,use:32,user:[10,31,34,37],using:[20,32],util:[34,35,36,37,38],uwsgi:[7,11],video:22,view:27,welcom:30,what:32,why:32,work:2,yml:[14,22],you:20,your:[19,26]}}) \ No newline at end of file diff --git a/user/index.html b/user/index.html index 931367a0..2fa72bde 100644 --- a/user/index.html +++ b/user/index.html @@ -1,7 +1,7 @@ - + @@ -44,9 +44,17 @@ @@ -100,7 +108,7 @@ diff --git a/user/own-instance.html b/user/own-instance.html index 9e9928ae..638dfd9c 100644 --- a/user/own-instance.html +++ b/user/own-instance.html @@ -1,7 +1,7 @@ - + @@ -44,8 +44,11 @@

    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.

    +
    +

    “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 @@ -161,7 +164,7 @@ instance, have access to a privacy respecting search service.

    diff --git a/user/search_syntax.html b/user/search_syntax.html index 1fecfccc..9467bc24 100644 --- a/user/search_syntax.html +++ b/user/search_syntax.html @@ -1,7 +1,7 @@ - + @@ -129,7 +129,7 @@ categories and languages.

    diff --git a/utils/filtron.sh.html b/utils/filtron.sh.html new file mode 100644 index 00000000..61d23b81 --- /dev/null +++ b/utils/filtron.sh.html @@ -0,0 +1,301 @@ + + + + + + + + utils/filtron.sh — Searx Documentation (Searx-0.16.0.tex) + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    utils/filtron.sh

    +
    +

    further reading

    + +
    +

    To simplify installation and maintenance of a filtron instance you can use the +script git://utils/filtron.sh. In most cases you will install filtron +simply by running the command:

    +
    sudo -H ./utils/filtron.sh install all
+
    +
    +

    The script adds a ${SERVICE_USER} (default:filtron) and installs filtron +into this user account:

    +
      +

    1. Create a separated user account (filtron).

      2. +

    2. Download and install Go binary in user’s $HOME (~filtron).

      3. +

    3. Install filtron with the package management from Go (go get -v -u +github.com/asciimoo/filtron)

      4. +

    4. Setup a proper rule configuration [ref] (/etc/filtron/rules.json).

      5. +

    5. Setup a systemd service unit [ref] +(/lib/systemd/system/filtron.service).

      6. +
    +
    +

    Create user

    +
    +
    +
    +
    +

    bash

    +
    +
    +
    +
    +
    $ sudo -H useradd --shell /bin/bash --system \
+    --home-dir /usr/local/filtron \
+    --comment Privacy-respecting metasearch engine filtron
+
+$ sudo -H mkdir /usr/local/filtron
+$ sudo -H chown -R filtron:filtron /usr/local/filtron
+
    +
    +
    +
    +
    +
    +

    Install go

    +
    +
    +
    +
    +

    bash

    +
    +
    +
    +
    +
    $ cat > /usr/local/filtron/.go_env <<EOF
+export GOPATH=/usr/local/filtron/go-apps
+export PATH=$PATH:/usr/local/filtron/local/go/bin:$GOPATH/bin
+EOF
+$ sudo -i -u filtron
+(filtron) $ echo 'source /usr/local/filtron/.go_env' >> ~/.profile
+(filtron) $ mkdir /usr/local/filtron/local
+(filtron) $ wget --progress=bar -O go1.13.5.linux-amd64.tar.gz \
+            https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz
+(filtron) $ tar -C /usr/local/filtron/local/go -xzf go1.13.5.linux-amd64.tar.gz
+(filtron) $ which go
+/usr/local/filtron/local/go/bin/go
+
    +
    +
    +
    +
    +
    +

    Install filtron

    +

    Install rules.json at +/etc/filtron/rules.json (see Sample configuration of filtron) and +install filtron software and systemd unit:

    +
    +
    +
    +
    +

    bash

    +
    +
    +
    +
    +
    $ sudo -i -u filtron
+(filtron) $ go get -v -u github.com/asciimoo/filtron
+
    +
    +
    +
    +
    +
    +
    +
    +

    systemd

    +
    +
    +
    +
    +
    [Unit]
+
+Description=filtron
+After=syslog.target
+After=network.target
+
+[Service]
+
+Type=simple
+User=filtron
+Group=filtron
+WorkingDirectory=/usr/local/filtron
+ExecStart=/usr/local/filtron/go-apps/bin/filtron -api '127.0.0.1:4005' -listen '127.0.0.1:4004' -rules '/etc/filtron/rules.json' -target '127.0.0.1:8888'
+
+Restart=always
+Environment=USER=filtron HOME=/usr/local/filtron
+
+# Some distributions may not support these hardening directives.  If you cannot
+# start the service due to an unknown option, comment out the ones not supported
+# by your version of systemd.
+
+ProtectSystem=full
+PrivateDevices=yes
+PrivateTmp=yes
+NoNewPrivileges=true
+
+[Install]
+
+WantedBy=multi-user.target
+
    +
    +
    +
    +
    +
    +

    Overview

    +

    The --help output of the script is largely self-explanatory +(Common commands & environment):

    +
    usage::
+  filtron.sh shell
+  filtron.sh install    [all|user|rules]
+  filtron.sh update     [filtron]
+  filtron.sh remove     [all]
+  filtron.sh activate   [service]
+  filtron.sh deactivate [service]
+  filtron.sh inspect    [service]
+  filtron.sh option     [debug-on|debug-off]
+  filtron.sh apache     [install|remove]
+  filtron.sh nginx      [install|remove]
+
+shell
+  start interactive shell from user filtron
+install / remove
+  :all:        complete setup of filtron service
+  :user:       add/remove service user 'filtron' (/usr/local/filtron)
+  :rules:      reinstall filtron rules /etc/filtron/rules.json
+update filtron
+  Update filtron installation (/usr/local/filtron)
+activate service
+  activate and start service daemon (systemd unit)
+deactivate service
+  stop and deactivate service daemon (systemd unit)
+inspect service
+  show service status and log
+option
+  set one of the available options
+apache (http://192.168.1.127/searx)
+  :install: apache site with a reverse proxy (ProxyPass)
+  :remove:  apache site searx.conf
+nginx (http://192.168.1.127/searx)
+  :install: nginx site with a reverse proxy (ProxyPass)
+  :remove:  nginx site searx.conf
+
+filtron rules: /etc/filtron/rules.json
+
+If needed, set PUBLIC_URL of your WEB service in the '.config.sh' file::
+  PUBLIC_URL     : http://192.168.1.127/searx
+  PUBLIC_HOST    : 192.168.1.127
+  SERVICE_USER   : filtron
+  FILTRON_TARGET : 127.0.0.1:8888
+  FILTRON_API    : 127.0.0.1:4005
+  FILTRON_LISTEN : 127.0.0.1:4004
+
    +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + \ No newline at end of file diff --git a/utils/index.html b/utils/index.html new file mode 100644 index 00000000..7ec0a711 --- /dev/null +++ b/utils/index.html @@ -0,0 +1,217 @@ + + + + + + + + Tooling box utils/* — Searx Documentation (Searx-0.16.0.tex) + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    Tooling box utils/*

    +

    In the folder git://utils/ we maintain some tools useful for admins and +developers.

    +
    +

    Contents

    + +
    +
    +

    Common commands & environment

    +

    Scripts to maintain services often dispose of common commands and environments.

    +
    +
    shellcommand

    Opens a shell from the service user ${SERVICE_USSR}, very helpful for +troubleshooting.

    +
    +
    inspect servicecommand

    Shows status and log of the service, most often you have a option to enable +more verbose debug logs. Very helpful for debugging, but be careful not to +enable debugging in a production environment!

    +
    +
    FORCE_TIMEOUTenvironment

    Sets timeout for interactive prompts. If you want to run a script in batch +job, with defaults choices, set FORCE_TIMEOUT=0. By example; to install a +reverse proxy for filtron on all containers of the searx suite use

    +
    sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install
+
    +
    +
    +
    +
    +
    +

    Tooling box setup

    +

    The main setup is done in the git://.config.sh (read also Makefile setup).

    +
    # -*- coding: utf-8; mode: sh -*-
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# shellcheck shell=bash disable=SC2034
+#
+# This environment is used by ./utils scripts like filtron.sh or searx.sh.  The
+# default values are *most flexible* and *best maintained*, you normally not
+# need to change the defaults (except PUBLIC_URL).
+#
+# Before you change any value here you have to uninstall any previous
+# installation.  Further is it recommended to backup your changes simply by
+# adding them to you local brand (git branch)::
+#
+#     git add .config
+
+# The public URL of the searx instance: PUBLIC_URL="https://mydomain.xy/searx"
+# The default is taken from ./utils/brand.env.
+
+PUBLIC_URL="${SEARX_URL}"
+
+if [[ ${PUBLIC_URL} == "https://searx.me" ]]; then
+    # hint: Linux containers do not have DNS entries, lets use IPs
+    PUBLIC_URL="http://$(primary_ip)/searx"
+fi
+
+# searx.sh
+# ---------
+
+# SEARX_INTERNAL_URL="127.0.0.1:8888"
+
+# Only change, if you maintain a searx brand in your searx fork.
+# GIT_BRANCH="${GIT_BRANCH:-master}"
+
+# filtron.sh
+# ----------
+
+# FILTRON_API="127.0.0.1:4005"
+# FILTRON_LISTEN="127.0.0.1:4004"
+# FILTRON_TARGET="127.0.0.1:8888"
+
+# morty.sh
+# --------
+
+# morty listen address
+# MORTY_LISTEN="127.0.0.1:3000"
+# PUBLIC_URL_PATH_MORTY="/morty/"
+
+# system services
+# ---------------
+
+# Common $HOME folder of the service accounts
+# SERVICE_HOME_BASE="/usr/local"
+
+# **experimental**: Set SERVICE_USER to run all services by one account, but be
+# aware that removing discrete components might conflict!
+# SERVICE_USER=searx
+
    +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + \ No newline at end of file diff --git a/utils/lxc.sh.html b/utils/lxc.sh.html new file mode 100644 index 00000000..4bcc81d8 --- /dev/null +++ b/utils/lxc.sh.html @@ -0,0 +1,361 @@ + + + + + + + + utils/lxc.sh — Searx Documentation (Searx-0.16.0.tex) + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    utils/lxc.sh

    +
    +

    further reading

    + +
    +

    With the use of Linux Containers (LXC) we can scale our tasks over a stack of +containers, what we call the: lxc suite. The searx suite +(lxc-searx.env) is loaded by default, every time +you start the lxc.sh script (you do not need to care about).

    +

    Before you can start with containers, you need to install and initiate LXD +once:

    +
    $ snap install lxd
+$ lxd init --auto
+
    +
    +

    To make use of the containers from the searx suite, you have to build the +LXC suite containers initial. But be warned, this might +take some time:

    +
    $ sudo -H ./utils/lxc.sh build
+
    +
    +

    A cup of coffee later, your LXC suite is build up and you can run whatever task +you want / in a selected or even in all LXC suite containers. If you do not want to build all containers, you can build just +one:

    +
    $ sudo -H ./utils/lxc.sh build searx-ubu1804
+
    +
    +

    Good to know …

    +

    Eeach container shares the root folder of the repository and the +command utils/lxc.sh cmd handles relative path names transparent, +compare output of:

    +
    $ sudo -H ./utils/lxc.sh cmd -- ls -la Makefile
+...
+
    +
    +

    In the containers, you can run what ever you want, e.g. to start a bash use:

    +
    $ sudo -H ./utils/lxc.sh cmd searx-ubu1804 bash
+INFO:  [searx-ubu1804] bash
+root@searx-ubu1804:/share/searx#
+
    +
    +

    If there comes the time you want to get rid off all the containers and +clean up local images just type:

    +
    $ sudo -H ./utils/lxc.sh remove
+$ sudo -H ./utils/lxc.sh remove images
+
    +
    +
    +

    Install suite

    +

    To install the complete searx suite (includes searx, morty & filtron) into all LXC use:

    +
    $ sudo -H ./utils/lxc.sh install suite
+
    +
    +

    The command above installs a searx suite (see Installation scripts). To +get the IP (URL) of the filtron service in the containers use show suite +command. To test instances from containers just open the URLs in your +WEB-Browser:

    +
    $ sudo ./utils/lxc.sh show suite | grep filtron
+[searx-ubu1604]  INFO:  (eth0) filtron:    http://n.n.n.246:4004/ http://n.n.n.246/searx
+[searx-ubu1804]  INFO:  (eth0) filtron:    http://n.n.n.147:4004/ http://n.n.n.147/searx
+[searx-ubu1910]  INFO:  (eth0) filtron:    http://n.n.n.140:4004/ http://n.n.n.140/searx
+[searx-ubu2004]  INFO:  (eth0) filtron:    http://n.n.n.18:4004/ http://n.n.n.18/searx
+[searx-fedora31]  INFO:  (eth0) filtron:    http://n.n.n.46:4004/ http://n.n.n.46/searx
+[searx-archlinux]  INFO:  (eth0) filtron:    http://n.n.n.32:4004/ http://n.n.n.32/searx
+
    +
    +

    To install a nginx reverse proxy for filtron and +morty use (or alternatively use apache):

    +
    sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh nginx install
+sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/morty.sh nginx install
+
    +
    +
    +
    +

    Running commands

    +

    Inside containers, you can use make or run scripts from the +Tooling box utils/*. By example: to setup a Buildhosts and run the +Makefile target test in the archlinux container:

    +
    sudo -H ./utils/lxc.sh cmd searx-archlinux ./utils/searx.sh buildhost
+sudo -H ./utils/lxc.sh cmd searx-archlinux make test
+
    +
    +
    +
    +

    Setup searx buildhost

    +

    You can install the searx buildhost environment into one or all containers. +The installation procedure to set up a build host takes its +time. Installation in all containers will take more time (time for another cup +of coffee).:

    +
    sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh buildhost
+
    +
    +

    To build (live) documentation inside a archlinux container:

    +
    sudo -H ./utils/lxc.sh cmd searx-archlinux make docs-clean docs-live
+...
+[I 200331 15:00:42 server:296] Serving on http://0.0.0.0:8080
+
    +
    +

    To get IP of the container and the port number live docs is listening:

    +
    $ sudo ./utils/lxc.sh show suite | grep docs-live
+...
+[searx-archlinux]  INFO:  (eth0) docs-live:  http://n.n.n.12:8080/
+
    +
    +
    +
    +

    Overview

    +

    The --help output of the script is largely self-explanatory:

    +
    usage::
+  lxc.sh build        [containers|<name>]
+  lxc.sh copy         [images]
+  lxc.sh remove       [containers|<name>|images]
+  lxc.sh [start|stop] [containers|<name>]
+  lxc.sh show         [images|suite|info|config [<name>]]
+  lxc.sh cmd          [--|<name>] '...'
+  lxc.sh install      [suite|base [<name>]]
+
+build
+  :containers:   build, launch all containers and 'install base' packages
+  :<name>:       build, launch container <name>  and 'install base' packages
+copy:
+  :images:       copy remote images of the suite into local storage
+remove
+  :containers:   delete all 'containers' or only <container-name>
+  :images:       delete local images of the suite
+start/stop
+  :containers:   start/stop all 'containers' from the suite
+  :<name>:       start/stop container <name> from suite
+show
+  :info:         show info of all (or <name>) containers from LXC suite
+  :config:       show config of all (or <name>) containers from the LXC suite
+  :suite:        show services of all (or <name>) containers from the LXC suite
+  :images:       show information of local images
+cmd
+  use single qoutes to evaluate in container's bash, e.g.: 'echo $(hostname)'
+  --             run command '...' in all containers of the LXC suite
+  :<name>:       run command '...' in container <name>
+install
+  :base:         prepare LXC; install basic packages
+  :suite:        install LXC searx suite into all (or <name>) containers
+
+LXC suite: searx --> http://192.168.1.127/searx
+  suite includes searx, morty & filtron
+suite images:
+  ubu1604 ubu1804 ubu1910 ubu2004 fedora31 archlinux
+suite containers:
+  searx-ubu1604 searx-ubu1804 searx-ubu1910 searx-ubu2004 searx-fedora31
+  searx-archlinux
+
    +
    +
    +
    +

    searx suite

    +
    # -*- coding: utf-8; mode: sh indent-tabs-mode: nil -*-
+# SPDX-License-Identifier: AGPL-3.0-or-later
+# shellcheck shell=bash
+
+# This file is a setup of a LXC suite.  It is sourced from different context, do
+# not manipulate the environment directly, implement functions and manipulate
+# environment only is subshells!
+
+# ----------------------------------------------------------------------------
+# config
+# ----------------------------------------------------------------------------
+
+# shellcheck disable=SC2034
+LXC_SUITE_NAME="searx"
+lxc_set_suite_env() {
+    # name of https://images.linuxcontainers.org
+    export LINUXCONTAINERS_ORG_NAME="${LINUXCONTAINERS_ORG_NAME:-images}"
+    export LXC_HOST_PREFIX="${LXC_SUITE_NAME:-searx}"
+    export LXC_SUITE=(
+
+        # to disable containers, comment out lines ..
+
+        # end of standard support see https://wiki.ubuntu.com/Releases
+        "$LINUXCONTAINERS_ORG_NAME:ubuntu/16.04"  "ubu1604" # April 2021
+        "$LINUXCONTAINERS_ORG_NAME:ubuntu/18.04"  "ubu1804" # April 2023
+        "$LINUXCONTAINERS_ORG_NAME:ubuntu/19.10"  "ubu1910" # July 2020
+        "$LINUXCONTAINERS_ORG_NAME:ubuntu/20.04"  "ubu2004" # future (EOL 2030)
+
+        # EOL see https://fedoraproject.org/wiki/Releases
+        "$LINUXCONTAINERS_ORG_NAME:fedora/31"     "fedora31"
+
+        # rolling releases see https://www.archlinux.org/releng/releases/
+        "$LINUXCONTAINERS_ORG_NAME:archlinux"     "archlinux"
+    )
+
+    PUBLIC_URL="${PUBLIC_URL:-http://$(uname -n)/searx}"
+    if in_container; then
+        # container hostnames do not have a DNS entry: use primary IP!
+        PUBLIC_URL="http://$(primary_ip)/searx"
+
+        # make GUEST's services public to the HOST
+        FILTRON_API="0.0.0.0:4005"
+        FILTRON_LISTEN="0.0.0.0:4004"
+        MORTY_LISTEN="0.0.0.0:3000"
+
+        # export LXC specific environment
+        export PUBLIC_URL FILTRON_API FILTRON_LISTEN MORTY_LISTEN
+    fi
+}
+
+lxc_suite_install_info() {
+    (
+        lxc_set_suite_env
+        cat <<EOF
+LXC suite: ${LXC_SUITE_NAME} --> ${PUBLIC_URL}
+  suite includes searx, morty & filtron
+suite images:
+$(echo "  ${LOCAL_IMAGES[*]}" | $FMT)
+suite containers:
+$(echo "  ${CONTAINERS[*]}" | $FMT)
+EOF
+    )
+    }
+
+lxc_suite_install() {
+    (
+        lxc_set_suite_env
+        FORCE_TIMEOUT=0
+        export FORCE_TIMEOUT
+        "${LXC_REPO_ROOT}/utils/searx.sh"   install all
+        "${LXC_REPO_ROOT}/utils/morty.sh"   install all
+        "${LXC_REPO_ROOT}/utils/filtron.sh" install all
+
+        rst_title "suite installation finished ($(hostname))" part
+        lxc_suite_info
+        echo
+    )
+}
+
+lxc_suite_info() {
+    (
+        lxc_set_suite_env
+        for ip in $(global_IPs) ; do
+            if [[ $ip =~ .*:.* ]]; then
+                info_msg "(${ip%|*}) IPv6:       http://[${ip#*|}]"
+            else
+                # IPv4:
+                # shellcheck disable=SC2034,SC2031
+                info_msg "(${ip%|*}) filtron:    http://${ip#*|}:4004/ $PUBLIC_URL"
+                info_msg "(${ip%|*}) morty:      http://${ip#*|}:3000/ $PUBLIC_URL_MORTY"
+                info_msg "(${ip%|*}) docs-live:  http://${ip#*|}:8080/"
+            fi
+        done
+    )
+}
+
    +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + \ No newline at end of file diff --git a/utils/morty.sh.html b/utils/morty.sh.html new file mode 100644 index 00000000..d9d9157d --- /dev/null +++ b/utils/morty.sh.html @@ -0,0 +1,304 @@ + + + + + + + + utils/morty.sh — Searx Documentation (Searx-0.16.0.tex) + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    utils/morty.sh

    +
    +

    further reading

    + +
    +

    To simplify installation and maintenance of a morty instance you can use the +script git://utils/morty.sh. In most cases you will install morty simply by +running the command:

    +
    sudo -H ./utils/morty.sh install all
+
    +
    +

    The script adds a ${SERVICE_USER} (default:morty) and installs morty +into this user account:

    +
      +

    1. Create a separated user account (morty).

      2. +

    2. Download and install Go binary in user’s $HOME (~morty).

      3. +

    3. Install morty with the package management from Go (go get -v -u +github.com/asciimoo/morty)

      4. +

    4. Setup a systemd service unit [ref] +(/lib/systemd/system/morty.service).

      5. +
    +
    +

    Hint

    +

    To add morty to your searx instance read chapter How to setup result proxy.

    +
    +
    +

    Create user

    +
    +
    +
    +
    +

    bash

    +
    +
    +
    +
    +
    $ sudo -H useradd --shell /bin/bash --system \
+    --home-dir /usr/local/morty \
+    --comment Privacy-respecting metasearch engine morty
+
+$ sudo -H mkdir /usr/local/morty
+$ sudo -H chown -R morty:morty /usr/local/morty
+
    +
    +
    +
    +
    +
    +

    Install go

    +
    +
    +
    +
    +

    bash

    +
    +
    +
    +
    +
    $ cat > /usr/local/morty/.go_env <<EOF
+export GOPATH=/usr/local/morty/go-apps
+export PATH=$PATH:/usr/local/morty/local/go/bin:$GOPATH/bin
+EOF
+$ sudo -i -u morty
+(morty) $ echo 'source /usr/local/morty/.go_env' >> ~/.profile
+(morty) $ mkdir /usr/local/morty/local
+(morty) $ wget --progress=bar -O go1.13.5.linux-amd64.tar.gz \
+            https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz
+(morty) $ tar -C /usr/local/morty/local/go -xzf go1.13.5.linux-amd64.tar.gz
+(morty) $ which go
+/usr/local/morty/local/go/bin/go
+
    +
    +
    +
    +
    +
    +

    Install morty

    +

    Install morty software and systemd unit:

    +
    +
    +
    +
    +

    bash

    +
    +
    +
    +
    +
    $ sudo -i -u morty
+(morty) $ go get -v -u github.com/asciimoo/morty
+
    +
    +
    +
    +
    +
    +
    +
    +

    systemd

    +
    +
    +
    +
    +
    [Unit]
+
+Description=morty
+After=syslog.target
+After=network.target
+
+[Service]
+
+Type=simple
+User=morty
+Group=morty
+WorkingDirectory=/usr/local/morty
+ExecStart=/usr/local/morty/go-apps/bin/morty -key '' -listen '127.0.0.1:3000' -timeout 5
+
+Restart=always
+Environment=USER=morty HOME=/usr/local/morty DEBUG=false
+
+# Some distributions may not support these hardening directives.  If you cannot
+# start the service due to an unknown option, comment out the ones not supported
+# by your version of systemd.
+
+ProtectSystem=full
+PrivateDevices=yes
+PrivateTmp=yes
+NoNewPrivileges=true
+
+[Install]
+
+WantedBy=multi-user.target
+
    +
    +
    +
    +
    +
    +

    Overview

    +

    The --help output of the script is largely self-explanatory +(Common commands & environment):

    +
    usage::
+  morty.sh shell
+  morty.sh install    [all|user]
+  morty.sh update     [morty]
+  morty.sh remove     [all]
+  morty.sh activate   [service]
+  morty.sh deactivate [service]
+  morty.sh inspect    [service]
+  morty.sh option     [debug-on|debug-off]
+  morty.sh apache     [install|remove]
+  morty.sh nginx      [install|remove]
+  morty.sh info       [searx]
+
+shell
+  start interactive shell from user morty
+install / remove
+  all:        complete setup of morty service
+  user:       add/remove service user 'morty' (/usr/local/morty)
+update morty
+  Update morty installation (/usr/local/morty)
+activate service
+  activate and start service daemon (systemd unit)
+deactivate service
+  stop and deactivate service daemon (systemd unit)
+inspect service
+  show service status and log
+option
+  set one of the available options
+apache : http://192.168.1.127/morty/
+  :install: apache site with a reverse proxy (ProxyPass)
+  :remove:  apache site morty.conf
+nginx (http://192.168.1.127/morty/)
+  :install: nginx site with a reverse proxy (ProxyPass)
+  :remove:  nginx site morty.conf
+
+If needed, set the environment variables in the '.config.sh' file::
+  PUBLIC_URL_MORTY:     http://192.168.1.127/morty/
+  MORTY_LISTEN:         127.0.0.1:3000
+  SERVICE_USER:         morty
+
+To activate result and image proxy in searx, edit settings.yml (read:
+https://asciimoo.github.io/searx/admin/morty.html)::
+  result_proxy:
+      url : http://192.168.1.127/morty/
+  server:
+      image_proxy : True
+
    +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + \ No newline at end of file diff --git a/utils/searx.sh.html b/utils/searx.sh.html new file mode 100644 index 00000000..683564bd --- /dev/null +++ b/utils/searx.sh.html @@ -0,0 +1,177 @@ + + + + + + + + utils/searx.sh — Searx Documentation (Searx-0.16.0.tex) + + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    utils/searx.sh

    +
    +

    further reading

    + +
    +

    To simplify installation and maintenance of a searx instance you can use the +script git://utils/searx.sh.

    +
    +

    Install

    +

    In most cases you will install searx simply by running the command:

    +
    sudo -H ./utils/searx.sh install all
+
    +
    +

    The script adds a ${SERVICE_USER} (default:searx) and installs searx +into this user account. The installation is described in chapter +Step by step installation.

    +
    +
    +

    Overview

    +

    The --help output of the script is largely self-explanatory +(Common commands & environment):

    +
    usage::
+  searx.sh shell
+  searx.sh install    [all|user|searx-src|pyenv|uwsgi|packages|buildhost]
+  searx.sh update     [searx]
+  searx.sh remove     [all|user|pyenv|searx-src]
+  searx.sh activate   [service]
+  searx.sh deactivate [service]
+  searx.sh inspect    [service]
+  searx.sh option     [debug-[on|off]|image-proxy-[on|off]|result-proxy <url> <key>]
+  searx.sh apache     [install|remove]
+
+shell
+  start interactive shell from user searx
+install / remove
+  :all:        complete (de-) installation of searx service
+  :user:       add/remove service user 'searx' (/usr/local/searx)
+  :searx-src:  clone https://github.com/asciimoo/searx
+  :pyenv:      create/remove virtualenv (python) in /usr/local/searx/searx-pyenv
+  :uwsgi:      install searx uWSGI application
+  :settings:   reinstall settings from /800GBPCIex4/share/test123/return42-searx/searx/settings.yml
+  :packages:   install needed packages from OS package manager
+  :buildhost:  install packages from OS package manager needed by buildhosts
+update searx
+  Update searx installation (/usr/local/searx)
+activate service
+  activate and start service daemon (systemd unit)
+deactivate service
+  stop and deactivate service daemon (systemd unit)
+inspect service
+  run some small tests and inspect service's status and log
+option
+  set one of the available options
+apache
+  :install: apache site with the searx uwsgi app
+  :remove:  apache site 
+
+searx settings: /etc/searx/settings.yml
+
+If needed, set PUBLIC_URL of your WEB service in the '.config.sh' file::
+  PUBLIC_URL          : http://192.168.1.127/searx
+  SEARX_INSTANCE_NAME : searx@192.168.1.127 
+  SERVICE_USER        : searx
+  SEARX_INTERNAL_HTTP : http://127.0.0.1:8888
+
    +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + \ No newline at end of file