Privacy-respecting metasearch engine.

dependabot[bot] 5614814fe7 Bump sphinx from 5.3.0 to 7.0.1 1 vuosi sitten
.github 260949ed48 chore: Set permissions for GitHub actions (#3225) 2 vuotta sitten
dockerfiles 629ebb426f Fix typos (#3366) 2 vuotta sitten
docs a1e2c501d2 add blogpost about private searx and fix uwsgi installation guide 2 vuotta sitten
examples d9231d173a Fix whitespaces 8 vuotta sitten
searx 75b859d2a8 Fix quoting issue in search_operator plugin (#3479) 1 vuosi sitten
searx_extra 7c6a926648 Use packaging instead of distutils (#3472) 1 vuosi sitten
tests 296e0d9cf9 Bump splinter from 0.17.0 to 0.18.1 (#3307) 2 vuotta sitten
utils 629ebb426f Fix typos (#3366) 2 vuotta sitten
.codecov.yml c12e0c39b9 codecov : update the commit status 7 vuotta sitten
.config.sh 5fc9273e23 [mod] utils/searx.sh install: create branch if not already exists 4 vuotta sitten
.coveragerc 9c25cd99c4 [mod] use github actions instead of travis 4 vuotta sitten
.dir-locals.el 1a4524e03c [mod] remove obsolete virtualenv command 4 vuotta sitten
.dockerignore 4a35975b42 [enh] update documentation about docker 4 vuotta sitten
.gitattributes 10a24bdc2c [enh] add simple theme (WIP) 7 vuotta sitten
.gitignore 3ddd0f8944 Update httpx and friends to 0.21.3 (#3121) 2 vuotta sitten
.landscape.yaml dc802b9ea8 Add landscape.io configuration 10 vuotta sitten
.pylintrc 1839721161 Bump pylint from 2.12.2 to 2.14.5 (#3293) 2 vuotta sitten
AUTHORS.rst 062deb0cbc update AUTHORS.rst 2 vuotta sitten
CHANGELOG.rst 629ebb426f Fix typos (#3366) 2 vuotta sitten
CONTRIBUTING.md 38d32337e7 [mod] documentations & comments: update http://* URL to https://*. 4 vuotta sitten
Dockerfile accba7afb2 Install searx as root in Docker 2 vuotta sitten
LICENSE a905e4e7db [fix] full AGPLv3+ license according to #382 9 vuotta sitten
Makefile f55babc23c [mod] replace makefile boilerplate by 'manage' script 3 vuotta sitten
PULL_REQUEST_TEMPLATE.md ee231637a2 fixed typo in PR template (#3425) 1 vuosi sitten
README.rst 8e943d858f Reword the TLDR as it is misleading (#3477) 1 vuosi sitten
babel.cfg a1f945d227 [enh] babel.cfg added 11 vuotta sitten
manage 6ab43d1045 Skip problematic step when installing env (#3491) 1 vuosi sitten
requirements-dev.txt 5614814fe7 Bump sphinx from 5.3.0 to 7.0.1 1 vuosi sitten
requirements.txt ffc8ce4a51 Bump requests[socks] from 2.28.1 to 2.28.2 (#3448) 1 vuosi sitten
setup.py b8cd326464 Add searx_extra package 3 vuotta sitten
tox.ini 56c15023b5 [enh] tox.ini added to rewrite standard pep8 rules 10 vuotta sitten

README.rst

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

.. figure:: https://raw.githubusercontent.com/searx/searx/master/searx/static/themes/oscar/img/logo_searx_a.png
:target: https://searx.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|

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

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

.. |searx install| image:: https://img.shields.io/badge/-install-blue
:target: https://searx.github.io/searx/admin/installation.html

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

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

.. |AGPL License| image:: https://img.shields.io/badge/license-AGPL-blue.svg
:target: https://github.com/searx/searx/blob/master/LICENSE

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

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

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

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

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


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

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

.. _searx.space: https://searx.space
.. _user: https://searx.github.io/searx/user
.. _admin: https://searx.github.io/searx/admin
.. _developer: https://searx.github.io/searx/dev
.. _homepage: https://searx.github.io/searx

contact:
openhub_ // twitter_ // IRC: #searx @ Libera (irc.libera.chat)

.. _openhub: https://www.openhub.net/p/searx
.. _twitter: https://twitter.com/Searx_engine

**************************
Frequently asked questions
**************************

Is searx in maintenance mode?
#############################

No, searx is accepting new features, including new engines. We are also adding
engine fixes or other bug fixes when needed. Also, keep in mind that searx is
maintained by volunteers who work in their free time. So some changes might take
some time to be merged.

We reject features that might violate the privacy of users. If you really want
such a feature, it must be disabled by default and warn users about the consequances
of turning it off.

What is the difference between searx and SearxNG?
#################################################

TL;DR: SearXNG is for users that want more features and bugs getting fixed quicker.
If you prefer a minimalist software and stable experience, use searx.

SearxNG is a fork of searx, created by a former maintainer of searx. The fork
was created because the majority of the maintainers at the time did not find
the new proposed features privacy respecting enough. The most significant issue is with
engine metrics.

Searx is built for privacy conscious users. It comes with a unique set of
challenges. One of the problems we face is that users rather not report bugs,
because they do not want to publicly share what engines they use or what search
query triggered a problem. It is a challenge we accepted.

The new metrics feature collects more information to make engine maintenance easier.
We could have had better and more error reports to benefit searx maintainers.
However, we believe that the users of searx must come first, not the
software. We are willing to compromise on the lack of issue reports to avoid
violating the privacy of users.

Furthermore, SearxNG is under heavy refactoring and dependencies are constantly updated, even
if it is unnecessary. It increases the risk of introducing regressions. In searx
we strive for stability, rather than moving fast and breaking things.

Is searx for me?
################

Are you privacy conscious user? Then yes.

In searx we decided to double down on being privacy respecting. We are picking
engine changes from SearxNG, but we are not implementing engine detailed
monitoring and not adding a new UI that relies on Javascript.

If you are willing to give up some privacy respecting features, we encourage you to
adopt SearxNG. Searx is targeted for privacy conscious users who run their
instances locally, instead of using public instances.

Why should I use SearxNG?
#########################

SearxNG has rolling releases, dependencies updated more frequently, and engines are fixed
faster. It is easy to set up your own public instance, and monitor its
performance and metrics. It is simple to maintain as an instance administrator.

As a user, it provides a prettier user interface and nicer experience.