Privacy-respecting metasearch engine https://searx.github.io/searx/

Adam Tauber 2222caec22 [enh] add omnom engine 6 days ago
.github 260949ed48 chore: Set permissions for GitHub actions (#3225) 4 months ago
dockerfiles 0fb423ea59 Allow overriding env vars SEARX_SETTINGS_PATH,UWSGI_SETTINGS_PATH 1 year ago
docs d004439646 Update documentation to fix blog link 1 month ago
examples d9231d173a Fix whitespaces 6 years ago
searx 2222caec22 [enh] add omnom engine 6 days ago
searx_extra d86cb95560 Bump pylint from 2.14.5 to 2.15.0 (#3353) 2 weeks ago
tests 296e0d9cf9 Bump splinter from 0.17.0 to 0.18.1 (#3307) 1 month ago
utils f199100e40 Fix typo in utils/searx.sh (#3331) 1 month ago
.codecov.yml c12e0c39b9 codecov : update the commit status 5 years ago
.config.sh 5fc9273e23 [mod] utils/searx.sh install: create branch if not already exists 1 year ago
.coveragerc 9c25cd99c4 [mod] use github actions instead of travis 1 year ago
.dir-locals.el 1a4524e03c [mod] remove obsolete virtualenv command 1 year ago
.dockerignore 4a35975b42 [enh] update documentation about docker 2 years ago
.gitattributes 10a24bdc2c [enh] add simple theme (WIP) 5 years ago
.gitignore 3ddd0f8944 Update httpx and friends to 0.21.3 (#3121) 8 months ago
.landscape.yaml dc802b9ea8 Add landscape.io configuration 8 years ago
.pylintrc 1839721161 Bump pylint from 2.12.2 to 2.14.5 (#3293) 1 month ago
AUTHORS.rst 062deb0cbc update AUTHORS.rst 1 month ago
CHANGELOG.rst 3b27131479 Update changelog for v1.1.0 1 month ago
CONTRIBUTING.md 38d32337e7 [mod] documentations & comments: update http://* URL to https://*. 1 year ago
Dockerfile accba7afb2 Install searx as root in Docker 8 months ago
LICENSE a905e4e7db [fix] full AGPLv3+ license according to #382 7 years ago
Makefile f55babc23c [mod] replace makefile boilerplate by 'manage' script 1 year ago
PULL_REQUEST_TEMPLATE.md fd80453a3a Add PR template and contribution guidelines 2 years ago
README.rst a2c7cf4b8a Reword readme again 2 months ago
babel.cfg a1f945d227 [enh] babel.cfg added 8 years ago
manage c1a611c6b9 Fix command to get git version 1 month ago
requirements-dev.txt d86cb95560 Bump pylint from 2.14.5 to 2.15.0 (#3353) 2 weeks ago
requirements.txt d471c4a3f4 Bump certifi from 2022.6.15 to 2022.9.14 (#3363) 1 week ago
setup.py b8cd326464 Add searx_extra package 1 year ago
tox.ini 56c15023b5 [enh] tox.ini added to rewrite standard pep8 rules 7 years ago

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: If you want to run a public instance, go with SearxNG. If you want to
self host your own instance, choose 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 a unique set of
challanges. 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, depencencies updated more frequently, and engines are fixed
faster. It is easy to set up your own public instance, and monitor its
perfomance and metrics. It is simple to maintain as an instance adminstrator.

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