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
Jeff Alyanak 0fb3f0e4ae [fix] do not show DDG IP from zero click
The zero click result from DuckDuckGo for IP should not be displayed.  It will
return the IP of the searxng server, not the user's IP, and looks a bit strange
when the `self_info` plugin is enabled as two different IPs get returned.
5 months ago
.devcontainer Add GitHub Codespaces configuration 2 years ago
.github [fix] CI YAML config files 7 months ago
.vscode Add GitHub Codespaces configuration 2 years ago
dockerfiles Add uWSGI `die-on-term` flag (#3429) 6 months ago
docs [mod] package.html template: additional links (a python dict) 5 months ago
searx [fix] do not show DDG IP from zero click 5 months ago
searxng_extra [fix] update wikidata units - remove URL prefix from Q-name 6 months ago
src/brand [simple] ImageLayout.watch: `img_load_error.svg` if img load fails 3 years ago
tests [mod] pylint all files with one profile / drop PYLINT_SEARXNG_DISABLE_OPTION 7 months ago
utils [fix] docutils dependencies (docutils>=0.21.2) 5 months ago
.coveragerc [mod] use github actions instead of travis 4 years ago
.dir-locals-template.el [fix] .dir-locals.el -> .dir-locals-template.el 7 months ago
.dockerignore [fix] tidy up ignore lists .gitignore & .dockerignore 3 years ago
.editorconfig [enh] add editorconfig rules for javascript files 6 months ago
.gitattributes [fix] update .gitattributes 3 years ago
.gitignore Update .gitignore to ignore .python-version 6 months ago
.nvmrc [mod] nodejs v16 reaached EOL / upgrade to v20.10 10 months ago
.pylintrc [fix] .pylintrc mode signature to conf-unix 7 months ago
.tool-versions [dev] manage runtime versions with asdf 11 months ago
.weblate weblate: migration to https://translate.codeberg.org/ 2 years ago
.yamllint.yml [enh] add test.yamllint - lint yaml files 3 years ago
AUTHORS.rst [feat] engine: implementation of https://hex.pm 6 months ago
CHANGELOG.rst [releases] rolling release: commit history replaces the CHANGELOG 1 year ago
CONTRIBUTING.md fix(docs): Fix development quickstart url 10 months ago
Dockerfile Docker: use Alpine 3.19 8 months ago
LICENSE [fix] full AGPLv3+ license according to #382 9 years ago
Makefile Fix make search.checker 8 months ago
PULL_REQUEST_TEMPLATE.md [chore] fix typo and spacing in pull request template 1 year ago
README.rst readme typo 1 year ago
SECURITY.md [enh] add security policy 3 years ago
babel.cfg [fix] jinja/babel: WithExtension and AutoEscapeExtension are built-in now. 3 years ago
manage [mod] pylint all files with one profile / drop PYLINT_SEARXNG_DISABLE_OPTION 7 months ago
package.json [upd] npm: Bump eslint in /searx/static/themes/simple 6 months ago
pyrightconfig-ci.json [mod] add test.pyright to test & ci.test targets 3 years ago
pyrightconfig.json [fix] pyrightconfig.json include only dedicated folders in the test 3 years ago
requirements-dev.txt [upd] pypi: Bump pylint from 3.1.0 to 3.2.2 5 months ago
requirements.txt [upd] pypi: Bump lxml from 5.2.1 to 5.2.2 5 months ago
setup.py [mod] pylint all files with one profile / drop PYLINT_SEARXNG_DISABLE_OPTION 7 months 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`_

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|

----

.. _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://translate.codeberg.org/widgets/searxng/-/searxng/svg-badge.svg
   :target: https://translate.codeberg.org/projects/searxng/


Contact
=======

Ask questions or just chat about SearXNG on

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

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


Setup
=====

- A well maintained `Docker image`_, also built for ARM64 and ARM/v7
  architectures.
- Alternatively there are *up to date* `installation scripts`_.
- For individual setup consult our detailed `Step by step`_ instructions.
- To fine-tune your instance, take a look at the `Administrator documentation`_.

.. _Administrator documentation: https://docs.searxng.org/admin/index.html
.. _Step by step: https://docs.searxng.org/admin/installation-searxng.html
.. _installation scripts: https://docs.searxng.org/admin/installation-scripts.html
.. _Docker image: https://github.com/searxng/searxng-docker

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

.. _Weblate: https://translate.codeberg.org/projects/searxng/searxng/

Help translate SearXNG at `Weblate`_

.. figure:: https://translate.codeberg.org/widgets/searxng/-/multi-auto.svg
   :target: https://translate.codeberg.org/projects/searxng/


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

.. _development quickstart: https://docs.searxng.org/dev/quickstart.html
.. _developer documentation: https://docs.searxng.org/dev/index.html

Are you a developer?  Have a look at our `development quickstart`_ guide, it's
very easy to contribute.  Additionally we have a `developer documentation`_.


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 appear and then disappear
- 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``

.. _GitHub Codespaces: https://docs.github.com/en/codespaces/overview
.. _120 hours per month: https://github.com/settings/billing
.. _list of existing Codespaces: https://github.com/codespaces