mirror of https://github.com/searxng/searxng.git
bab35de7b0
Suggested by Solirs |
||
|---|---|---|
| .github | ||
| dockerfiles | ||
| docs | ||
| examples | ||
| searx | ||
| searxng_extra | ||
| src/brand | ||
| tests | ||
| utils | ||
| .config.sh | ||
| .coveragerc | ||
| .dir-locals.el | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .pylintrc | ||
| .weblate | ||
| .yamllint.yml | ||
| AUTHORS.rst | ||
| CHANGELOG.rst | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| PULL_REQUEST_TEMPLATE.md | ||
| README.rst | ||
| SECURITY.md | ||
| babel.cfg | ||
| manage | ||
| package.json | ||
| pyrightconfig-ci.json | ||
| pyrightconfig.json | ||
| requirements-dev.txt | ||
| requirements.txt | ||
| setup.py | ||
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