Merge branch 'master' into blog-dev-in-lxc

searx

.. SPDX-License-Identifier: AGPL-3.0-or-later

=====

.. figure:: https://raw.githubusercontent.com/asciimoo/searx/master/searx/static/themes/oscar/img/logo_searx_a.png

   :target: https://asciimoo.github.io/searx/

   :alt: searX

   :width: 100%

   :align: center

-------

|searx install|

|searx homepage|

|searx wiki|

|AGPL License|

|Issues|

|commits|

|OpenCollective searx backers|

|OpenCollective searx sponsors|

A privacy-respecting, hackable `metasearch

Privacy-respecting, hackable `metasearch engine`_ / *pronunciation* **səːks**.

engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.

Pronunciation: səːks

.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine

List of `running

.. |searx install| image:: https://img.shields.io/badge/-install-blue

instances <https://searx.space/>`__.

   :target: https://asciimoo.github.io/searx/admin/installation.html

See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.

.. |searx homepage| image:: https://img.shields.io/badge/-homepage-blue

   :target: https://asciimoo.github.io/searx

|OpenCollective searx backers|

.. |searx wiki| image:: https://img.shields.io/badge/-wiki-blue

|OpenCollective searx sponsors|

   :target: https://github.com/asciimoo/searx/wiki

Installation

.. |AGPL License|  image:: https://img.shields.io/badge/license-AGPL-blue.svg

~~~~~~~~~~~~

   :target: https://github.com/asciimoo/searx/blob/master/LICENSE

With Docker

.. |Issues| image:: https://img.shields.io/github/issues/asciimoo/searx?color=yellow&label=issues

-----------

   :target: https://github.com/asciimoo/searx/issues

Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project.

Without Docker

.. |PR| image:: https://img.shields.io/github/issues-pr-raw/asciimoo/searx?color=yellow&label=PR

--------------

   :target: https://github.com/asciimoo/searx/pulls

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

Note: the documentation needs to be updated.

.. |commits| image:: https://img.shields.io/github/commit-activity/y/asciimoo/searx?color=yellow&label=commits

   :target: https://github.com/asciimoo/searx/commits/master

If you are in a hurry

.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg

---------------------

   :target: https://opencollective.com/searx#backer

-  clone the source:

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

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

-  edit your

   `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__

   (set your ``secret_key``!)

-  run ``python searx/webapp.py`` to start the application

.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg

   :target: https://opencollective.com/searx#sponsor

Bugs

~~~~

Bugs or suggestions? Visit the `issue

If you are looking for running instances, ready to use, then visit searx.space_.

tracker <https://github.com/asciimoo/searx/issues>`__.

`License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__

Otherwise jump to the user_, admin_ and developer_ handbooks you will find on

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

our homepage_.

More about searx

.. _searx.space: https://searx.space

~~~~~~~~~~~~~~~~

.. _user: https://asciimoo.github.io/searx/user

.. _admin: https://asciimoo.github.io/searx/admin

.. _developer: https://asciimoo.github.io/searx/dev

.. _homepage: https://asciimoo.github.io/searx

-  `openhub <https://www.openhub.net/p/searx/>`__

contact:

-  `twitter <https://twitter.com/Searx_engine>`__

  openhub_ // twitter_ // IRC: #searx @ freenode

-  IRC: #searx @ freenode

.. _openhub: https://www.openhub.net/p/searx

.. _twitter: https://twitter.com/Searx_engine

.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg

-------

   :target: https://opencollective.com/searx#backer

|gluten free|

.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg

.. |gluten free| image:: https://forthebadge.com/images/featured/featured-gluten-free.svg

   :target: https://opencollective.com/searx#sponsor

To solve this issue private engines were introduced in :pull:`1823`.

To solve this issue private engines were introduced in :pull:`1823`.

A new option was added to engines named `tokens`. It expects a list

A new option was added to engines named `tokens`. It expects a list

of strings. If the user making a request presents one of the tokens

of strings. If the user making a request presents one of the tokens

of an engine, he/she is able to access information about the engine

of an engine, they can access information about the engine

and make search requests.

and make search requests.

Example configuration to restrict access to the Arch Linux Wiki engine:

Example configuration to restrict access to the Arch Linux Wiki engine:

  Theme of instance.

  Theme of instance.

  Please note, available themes depend on an instance.  It is possible that an

  Please note, available themes depend on an instance.  It is possible that an

  instance administrator deleted, created or renamed themes on his/her instance.

  instance administrator deleted, created or renamed themes on their instance.

  See the available options in the preferences page of the instance.

  See the available options in the preferences page of the instance.

``oscar-style`` : default ``logicodev``

``oscar-style`` : default ``logicodev``

  ``oscar``.

  ``oscar``.

  Please note, available styles depend on an instance.  It is possible that an

  Please note, available styles depend on an instance.  It is possible that an

  instance administrator deleted, created or renamed styles on his/her

  instance administrator deleted, created or renamed styles on their

  instance. See the available options in the preferences page of the instance.

  instance. See the available options in the preferences page of the instance.

``enabled_plugins`` : optional

``enabled_plugins`` : optional

What are the consequences of using public instances?

What are the consequences of using public instances?

----------------------------------------------------

----------------------------------------------------

If someone uses a public instance, he/she has to trust the administrator of that

If someone uses a public instance, they have to trust the administrator of that

instance.  This means that the user of the public instance does not know whether

instance.  This means that the user of the public instance does not know whether

his/her requests are logged, aggregated and sent or sold to a third party.

their requests are logged, aggregated and sent or sold to a third party.

Also, public instances without proper protection are more vulnerable to abusing

Also, public instances without proper protection are more vulnerable to abusing

the search service, In this case the external service in exchange returns

the search service, In this case the external service in exchange returns

results_xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' Sr ')]"

results_xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' Sr ')]"

url_xpath = './/h3/a/@href'

url_xpath = './/h3/a/@href'

title_xpath = './/h3/a'

title_xpath = './/h3/a'

content_xpath = './/div[@class="compText aAbs"]'

content_xpath = './/div[contains(@class, "compText")]'

suggestion_xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' AlsoTry ')]//a"

suggestion_xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' AlsoTry ')]//a"

time_range_dict = {'day': ['1d', 'd'],

time_range_dict = {'day': ['1d', 'd'],