README.rst

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

.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine
.. _Installation guide: https://docs.searxng.org/admin/installation.html
.. _Configuration guide: https://docs.searxng.org/admin/settings/index.html
.. _CONTRIBUTING: https://github.com/searxng/searxng/blob/master/CONTRIBUTING.rst
.. _LICENSE: https://github.com/searxng/searxng/blob/master/LICENSE

.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/client/simple/src/brand/searxng.svg
   :target: https://searxng.org
   :alt: SearXNG
   :width: 512px


SearXNG is a `metasearch engine`_. Users are neither tracked nor profiled.

.. image:: https://img.shields.io/badge/organization-3050ff?style=flat-square&logo=searxng&logoColor=fff&cacheSeconds=86400
   :target: https://github.com/searxng
   :alt: Organization

.. image:: https://img.shields.io/badge/documentation-3050ff?style=flat-square&logo=readthedocs&logoColor=fff&cacheSeconds=86400
   :target: https://docs.searxng.org
   :alt: Documentation

.. image:: https://img.shields.io/github/license/searxng/searxng?style=flat-square&label=license&color=3050ff&cacheSeconds=86400
   :target: https://github.com/searxng/searxng/blob/master/LICENSE
   :alt: License

.. image:: https://img.shields.io/github/commit-activity/y/searxng/searxng/master?style=flat-square&label=commits&color=3050ff&cacheSeconds=3600
   :target: https://github.com/searxng/searxng/commits/master/
   :alt: Commits

.. image:: https://img.shields.io/weblate/progress/searxng?server=https%3A%2F%2Ftranslate.codeberg.org&style=flat-square&label=translated&color=3050ff&cacheSeconds=86400
   :target: https://translate.codeberg.org/projects/searxng/
   :alt: Translated

Setup
=====

To install SearXNG, see `Installation guide`_.

To fine-tune SearXNG, see `Configuration guide`_.

Further information on *how-to* can be found `here <https://docs.searxng.org/admin/index.html>`_.

Connect
=======

If you have questions or want to connect with others in the community:

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

Contributing
============

See CONTRIBUTING_ for more details.

License
=======

This project is licensed under the GNU Affero General Public License (AGPL-3.0).
See LICENSE_ for more details.
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 14:57:45 +02:00			`.. SPDX-License-Identifier: AGPL-3.0-or-later`

[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine`
			`.. _Installation guide: https://docs.searxng.org/admin/installation.html`
			`.. _Configuration guide: https://docs.searxng.org/admin/settings/index.html`
[fix] links in the README (link file in GH-UI / not the raw file) 2025-09-09 21:00:36 +02:00			`.. _CONTRIBUTING: https://github.com/searxng/searxng/blob/master/CONTRIBUTING.rst`
			`.. _LICENSE: https://github.com/searxng/searxng/blob/master/LICENSE`
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00
[README] Updated logo paths Since the commit a207f5d0353d61e43d3140db1243ce003cd0c46b, logos has been moved and README.rst needs to point to the new paths. 2025-03-07 13:37:21 +01:00			`.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/client/simple/src/brand/searxng.svg`
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`:target: https://searxng.org`
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 13:26:31 +01:00			`:alt: SearXNG`
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`:width: 512px`
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 13:26:31 +01:00
[mod] README format change - pypi compatiblity 2014-01-21 20:47:43 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			SearXNG is a `metasearch engine`_. Users are neither tracked nor profiled.
[mod] README format change - pypi compatiblity 2014-01-21 20:47:43 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`.. image:: https://img.shields.io/badge/organization-3050ff?style=flat-square&logo=searxng&logoColor=fff&cacheSeconds=86400`
			`:target: https://github.com/searxng`
			`:alt: Organization`
[mod] README format change - pypi compatiblity 2014-01-21 20:47:43 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`.. image:: https://img.shields.io/badge/documentation-3050ff?style=flat-square&logo=readthedocs&logoColor=fff&cacheSeconds=86400`
			`:target: https://docs.searxng.org`
			`:alt: Documentation`
[mod] README format change - pypi compatiblity 2014-01-21 20:47:43 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`.. image:: https://img.shields.io/github/license/searxng/searxng?style=flat-square&label=license&color=3050ff&cacheSeconds=86400`
[fix] links in the README (link file in GH-UI / not the raw file) 2025-09-09 21:00:36 +02:00			`:target: https://github.com/searxng/searxng/blob/master/LICENSE`
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`:alt: License`
[mod] README format change - pypi compatiblity 2014-01-21 20:47:43 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`.. image:: https://img.shields.io/github/commit-activity/y/searxng/searxng/master?style=flat-square&label=commits&color=3050ff&cacheSeconds=3600`
			`:target: https://github.com/searxng/searxng/commits/master/`
			`:alt: Commits`
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 14:57:45 +02:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`.. image:: https://img.shields.io/weblate/progress/searxng?server=https%3A%2F%2Ftranslate.codeberg.org&style=flat-square&label=translated&color=3050ff&cacheSeconds=86400`
weblate: migration to https://translate.codeberg.org/ 2023-01-21 14:49:46 +00:00			`:target: https://translate.codeberg.org/projects/searxng/`
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`:alt: Translated`
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00
			`Setup`
[README] revision The searx project has been archived, differentiation of the project in the README is no longer necessary. The README has been reduced to the important entry points for users, maintainers and developers. Related: https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2023-09-08 10:51:37 +02:00			`=====`
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			To install SearXNG, see `Installation guide`_.
[README] name limiter plugin / filtron no longer needed Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2022-07-04 15:13:04 +02:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			To fine-tune SearXNG, see `Configuration guide`_.
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			Further information on how-to can be found `here <https://docs.searxng.org/admin/index.html>`_.
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`Connect`
			`=======`
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00
[mod] docs: remove libera.chat channel (#5613) Internal discussion (lack of time/moderation) 2025-12-30 08:21:39 +01:00			`If you have questions or want to connect with others in the community:`
README.rst: add contact information 2021-12-14 21:53:06 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			- `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_
README.rst: add IRC #searxng 2021-12-20 23:26:02 +01:00
[README] revision The searx project has been archived, differentiation of the project in the README is no longer necessary. The README has been reduced to the important entry points for users, maintainers and developers. Related: https://github.com/searx/searx/commit/276ffd3f01cdd823f75676c51231fad4040059d3 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2023-09-08 10:51:37 +02:00			`Contributing`
[mod] update README.rst / differences to searx * add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net> 2022-01-15 16:47:25 +01:00			`============`
README.rst: add translation status Related to https://github.com/searxng/searxng/issues/540 2021-12-01 00:08:44 +01:00
[fix] links in the README (link file in GH-UI / not the raw file) 2025-09-09 21:00:36 +02:00			`See CONTRIBUTING_ for more details.`
Move donation page to docs.searxng.org and link to it from instances Close #1378 2022-06-29 17:26:19 +00:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`License`
			`=======`
Add GitHub Codespaces configuration 2023-03-15 20:04:03 +01:00
[enh] docs: update information (#5185) README should be concise, everything else goes to CONTRIBUTING, docs page ... 2025-09-09 20:51:22 +02:00			`This project is licensed under the GNU Affero General Public License (AGPL-3.0).`
[fix] links in the README (link file in GH-UI / not the raw file) 2025-09-09 21:00:36 +02:00			`See LICENSE_ for more details.`