You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Alexandre Flament 269326063a Fix: don't crash when engine or name is missing in settings.yml
SearXNG crashes if the engine or name fields are missing.
With this commit, the app displays an error in the log and keeps loading.

Close #1951
2 years ago
.github chore: Set permissions for GitHub actions (#3225) 2 years ago
dockerfiles [fix] typos / reported by @kianmeng in searx PR-3366 2 years ago
docs Initialize Redis in searx/webapp.py 2 years ago
examples Fix whitespaces 8 years ago
searx Fix: don't crash when engine or name is missing in settings.yml 2 years ago
searxng_extra User agent: don't include the patch number in the Firefox version 2 years ago
src/brand [simple] ImageLayout.watch: `img_load_error.svg` if img load fails 3 years ago
tests Fix: don't crash when engine or name is missing in settings.yml 2 years ago
utils Initialize Redis in searx/webapp.py 2 years ago
.coveragerc [mod] use github actions instead of travis 4 years ago
.dir-locals.el [fix] typos / reported by @kianmeng in searx PR-3366 2 years ago
.dockerignore [fix] tidy up ignore lists .gitignore & .dockerignore 3 years ago
.gitattributes [fix] update .gitattributes 3 years ago
.gitignore Add PyCharm configuration files to .gitignore 2 years ago
.nvmrc Node: update to node 16.15.1 2 years ago
.pylintrc [fix] prepare for pylint 2.14.0 2 years ago
.weblate [translations] web integration 3 years ago
.yamllint.yml [enh] add test.yamllint - lint yaml files 3 years ago
AUTHORS.rst [mod] link to public-instances can be set to hidden 2 years ago
CHANGELOG.rst [fix] typos / reported by @kianmeng in searx PR-3366 2 years ago
CONTRIBUTING.md reference docs.searxng.org 2 years ago
Dockerfile Merge pull request #1990 from ngosang/feature/alpine 2 years ago
LICENSE [fix] full AGPLv3+ license according to #382 9 years ago
Makefile [clean up] drop obsolete searx, filtron and morty install scripts 2 years ago
PULL_REQUEST_TEMPLATE.md Add PR template and contribution guidelines 4 years ago
README.rst [README] add doc-links: disable metrics & hostname replace 2 years ago
SECURITY.md [enh] add security policy 2 years ago
babel.cfg [fix] jinja/babel: WithExtension and AutoEscapeExtension are built-in now. 2 years ago
manage [fix] pyright repported errors 2 years ago
package.json Node: update to node 16.15.1 2 years ago
pyrightconfig-ci.json [mod] add test.pyright to test & ci.test targets 2 years ago
pyrightconfig.json [fix] pyrightconfig.json include only dedicated folders in the test 2 years ago
requirements-dev.txt Bump selenium from 4.6.0 to 4.7.0 2 years ago
requirements.txt Bump redis from 4.3.4 to 4.3.5 2 years ago
setup.py [mod] replace /help by /info pages and include pages in project docs 2 years ago

README.rst

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

----

.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng.svg
   :target: https://docs.searxng.org/
   :alt: SearXNG
   :width: 100%
   :align: center

----

Privacy-respecting, hackable `metasearch engine`_

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

|SearXNG install|
|SearXNG homepage|
|SearXNG wiki|
|AGPL License|
|Issues|
|commits|
|weblate|
|SearXNG logo|

----

.. _searx.space: https://searx.space
.. _user: https://docs.searxng.org/user
.. _admin: https://docs.searxng.org/admin
.. _developer: https://docs.searxng.org/dev
.. _homepage: https://docs.searxng.org/
.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine

.. |SearXNG logo| image:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng-wordmark.svg
   :target: https://docs.searxng.org/
   :width: 5%

.. |SearXNG install| image:: https://img.shields.io/badge/-install-blue
   :target: https://docs.searxng.org/admin/installation.html

.. |SearXNG homepage| image:: https://img.shields.io/badge/-homepage-blue
   :target: https://docs.searxng.org/

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

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

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

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

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

.. |weblate| image:: https://weblate.bubu1.eu/widgets/searxng/-/searxng/svg-badge.svg
   :target: https://weblate.bubu1.eu/projects/searxng/


Contact
=======

Come join us if you have questions or just want to chat about SearXNG.

Matrix
  `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_

IRC
  `#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_
  which is bridged to Matrix.


Differences to searx
====================

SearXNG is a fork of `searx`_.  Here are some of the changes:

.. _searx: https://github.com/searx/searx


User experience
---------------

- Huge update of the simple theme:

  * usable on desktop, tablet and mobile
  * light and dark versions (you can choose in the preferences)
  * support right-to-left languages
  * `see the screenshots <https://dev.searxng.org/screenshots.html>`_

- the translations are up to date, you can contribute on `Weblate`_
- the preferences page has been updated:

  * you can see which engines are reliable or not
  * engines are grouped inside each tab
  * each engine has a description

- thanks to the anonymous metrics, it is easier to report a bug of an engine and
  thus engines get fixed more quickly

  - if you don't want any metrics to be recorded, you can `disable them on the server
    <https://docs.searxng.org/admin/engines/settings.html#general>`_

- administrator can `block and/or replace the URLs in the search results
  <https://github.com/searxng/searxng/blob/5c1c0817c3996c5670a545d05831d234d21e6217/searx/settings.yml#L191-L199>`_


Setup
-----

- you don't need `Morty`_ to proxy the images even on a public instance
- you don't need `Filtron`_ to block bots, we implemented the builtin `limiter`_
- you get a well maintained `Docker image`_, now also built for ARM64 and ARM/v7 architectures
- alternatively we have up to date installation scripts

.. _Docker image: https://github.com/searxng/searxng-docker


Contributing is easier
----------------------

- readable debug log
- contributions to the themes are made easier, check out our `Development
  Quickstart`_ guide
- a lot of code cleanup and bug fixes
- the dependencies are up to date

.. _Morty: https://github.com/asciimoo/morty
.. _Filtron: https://github.com/searxng/filtron
.. _limiter: https://docs.searxng.org/src/searx.plugins.limiter.html
.. _Weblate: https://weblate.bubu1.eu/projects/searxng/searxng/
.. _Development Quickstart: https://docs.searxng.org/dev/quickstart.html


Translations
============

We need translators, suggestions are welcome at
https://weblate.bubu1.eu/projects/searxng/searxng/

.. figure:: https://weblate.bubu1.eu/widgets/searxng/-/multi-auto.svg
   :target: https://weblate.bubu1.eu/projects/searxng/


Make a donation
===============

You can support the SearXNG project by clicking on the donation page:
https://docs.searxng.org/donate.html