searxng/README.rst
Markus Heiser 007a615ffa [mod] donation_url: disable by default
SearXNG's donation campaign has been ended.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-05-15 09:19:17 +02:00

5.1 KiB



Privacy-respecting, hackable metasearch engine

Searx.space lists ready-to-use running instances.

A user, admin and developer handbook is available on the homepage.

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


Contact

Ask questions or just chat about SearXNG on

IRC

#searxng on libera.chat which is bridged to Matrix.

Matrix

#searxng:matrix.org

Differences to searx

SearXNG is a fork of searx, with notable changes:

User experience

  • Reworked (and still simple) theme:
    • Usable on desktop, tablet and mobile.
    • Light and dark versions (available in the preferences).
    • Right-to-left language support.
    • Screenshots
  • The translations are up to date, you can contribute on Weblate
  • The preferences page has been updated:
    • Browse 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 malfunctioning engines, so they get fixed quicker
  • Administrators can block and/or replace the URLs in the search results

Setup

  • No need for Morty to proxy images, even on a public instance.
  • No need for Filtron to block bots, as there is now a built-in limiter.
  • A well maintained Docker image, now also built for ARM64 and ARM/v7 architectures. (Alternatively there are up to date installation scripts.)

Contributing

  • Readable debug log.
  • Contributing is easier, thanks to the Development Quickstart guide.
  • A lot of code cleanup and bugfixes.
  • Up to date list dependencies.

Translations

Help translate SearXNG at Weblate

Codespaces

You can contribute from your browser using GitHub Codespaces:

  • Fork the repository
  • Click on the <> Code green button
  • Click on the Codespaces tab instead of Local
  • Click on Create codespace on master
  • VSCode is going to start in the browser
  • Wait for git pull && make install to appears and then to disapear
  • You have 120 hours per month (see also your list of existing Codespaces)
  • You can start SearXNG using make run in the terminal or by pressing Ctrl+Shift+B.