Merge branch 'master' into bug/oscar-theme

DOC       = docs

PY_SETUP_EXTRAS ?= \[test\]

PYDIST=./dist/py

PYBUILD=./build/py

include utils/makefile.include

include utils/makefile.python

include utils/makefile.sphinx

	@echo  '  install   - developer install (./local)'

	@echo  '  uninstall - uninstall (./local)'

	@echo  '  gh-pages  - build docs & deploy on gh-pages branch'

	@echo  '  clean     - drop builds and environments'

	@echo  ''

	@$(MAKE) -s -f utils/makefile.include make-help

	@echo  ''

Without Docker

------

For all the details, follow this `step by step installation <https://asciimoo.github.io/searx/dev/install/installation.html>`__.

For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/dev/install/installation.html>`__.

Note: the documentation needs to be updated.

If you are in hurry

If you are in a hurry

------

-  clone source:

-  clone the source:

   ``git clone https://github.com/asciimoo/searx.git && cd searx``

-  install dependencies: ``./manage.sh update_packages``

-  edit your

  margin: 6pt;

}

.sidebar li {

.sidebar li,

.hlist li {

  list-style-type: disclosure-closed;

}

/* admonitions

*/

div.admonition, div.topic {

  background-color: #fafafa;

  margin: 8px 0px;

  padding: 1em;

  border-radius: 3pt 0 0 3pt;

  border-top: none;

  border-right: none;

  border-bottom: none;

  border-left: 5pt solid #ccc;

}

p.admonition-title:after {

  content: none;

}

.admonition.hint      { border-color: #416dc0b0; }

.admonition.note      { border-color: #6c856cb0; }

.admonition.tip       { border-color: #85c5c2b0; }

.admonition.attention { border-color: #ecec97b0; }

.admonition.caution   { border-color: #a6c677b0; }

.admonition.danger    { border-color: #d46262b0; }

.admonition.important { border-color: #dfa3a3b0; }

.admonition.error     { border-color: red; }

.admonition.warning   { border-color: darkred; }

.admonition.admonition-generic-admonition-title {

    border-color: #416dc0b0;

}

/* admonitions with (rendered) reST markup examples (:class: rst-example)

 *

 * .. admonition:: title of the example

 *     :class: rst-example

 *     ....

*/

div.rst-example {

  background-color: inherit;

  margin: 0;

  border-top: none;

  border-right: 1px solid #ccc;

  border-bottom: none;

  border-left: none;

  border-radius: none;

  padding: 0;

}

div.rst-example > p.admonition-title {

  font-family: Sans Serif;

  font-style: italic;

  font-size: 0.8em;

  display: block;

  border-bottom: 1px solid #ccc;

  padding: 0.5em 1em;

  text-align: right;

}

/* code block in figures

 */

div.highlight pre {

    text-align: left;

}

/* Table theme

*/

thead, tfoot {

  background-color: #fff;

}

th:hover, td:hover {

  background-color: #ffc;

}

thead th, tfoot th, tfoot td, tbody th {

  background-color: #fffaef;

}

tbody tr:nth-child(odd) {

  background-color: #fff;

}

tbody tr:nth-child(even) {

  background-color: #fafafa;

}

caption {

  font-family: Sans Serif;

  padding: 0.5em;

  margin: 0.5em 0 0.5em 0;

  caption-side: top;

  text-align: left;

}

digraph G {

  node [style=filled, shape=box, fillcolor="#ffffcc", fontname="Sans"];

  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"];

  static  [label="Static files",  href="url to configure static files"];

  uwsgi   [label="uwsgi",         href="url to configure uwsgi"]

  searx1  [label="Searx #1"];

  searx2  [label="Searx #2"];

  searx3  [label="Searx #3"];

  searx4  [label="Searx #4"];

  browser -> rp [label="HTTPS"]

  subgraph cluster_searx {

      label = "Searx instance" fontname="Sans";

      bgcolor="#fafafa";

      { rank=same; static rp };

      rp -> morty      [label="optional: images and HTML pages proxy"];

      rp -> static     [label="optional: reverse proxy serves directly static files"];

      rp -> filtron    [label="HTTP"];

      filtron -> uwsgi [label="HTTP"];

      uwsgi -> searx1;

      uwsgi -> searx2;

      uwsgi -> searx3;

      uwsgi -> searx4;

  }

}

.. _architecture:

============

Architecture

============

.. sidebar:: Needs work!

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

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.

.. _arch public:

.. kernel-figure:: arch_public.dot

   :alt: arch_public.dot

   Reference architecture of a public searx setup.