Branded SearXNG fork for costmikuSearch
Find a file
Ivan Gabaldon 57b74beeea
[enh] docs: update information (#5185)
README should be concise, everything else goes to CONTRIBUTING, docs
page ...
2025-09-09 20:51:22 +02:00
.devcontainer [fix] devcontainers: missing Valkey package (#4997) 2025-07-11 16:51:58 +02:00
.github [upd] github-actions: Bump actions/setup-python from 5.6.0 to 6.0.0 (#5181) 2025-09-05 11:42:40 +02:00
.vscode Add GitHub Codespaces configuration 2023-03-21 20:58:13 +00:00
client/simple [upd] web-client (simple): Bump the minor group in /client/simple with 2 updates (#5179) 2025-09-05 11:38:54 +02:00
container [fix] container: change mirror (#5127) 2025-08-18 21:33:27 +02:00
docs [mod] addition of various type hints / tbc 2025-09-03 13:37:36 +02:00
searx [feat] naver engine: add video embeds 2025-09-09 17:04:21 +02:00
searxng_extra [mod] drop: from __future__ import annotations 2025-09-03 13:37:36 +02:00
tests [mod] drop: from __future__ import annotations 2025-09-03 13:37:36 +02:00
utils [mod] addition of various type hints / tbc 2025-09-03 13:37:36 +02:00
.coveragerc [mod] use github actions instead of travis 2020-11-17 15:09:06 +01:00
.dir-locals-template.el [fix] .dir-locals.el -> .dir-locals-template.el 2024-03-29 08:57:02 +01:00
.dockerignore [enh] container: tidy builds (#5086) 2025-08-07 10:46:26 +02:00
.editorconfig [mod] addition of various type hints / tbc 2025-09-03 13:37:36 +02:00
.gitattributes [fix] update .gitattributes 2021-06-22 20:34:39 +02:00
.gitignore [mod] add Golang ecosystem to the SearXNG toolchain 2025-07-28 12:53:26 +02:00
.nvmrc [mod] theme/simple: migrate codebase to TypeScript 2025-08-18 16:38:32 +02:00
.pylintrc [mod] addition of various type hints / tbc 2025-09-03 13:37:36 +02:00
.tool-versions [mod] addition of various type hints / tbc 2025-09-03 13:37:36 +02:00
.weblate weblate: migration to https://translate.codeberg.org/ 2023-01-21 15:45:12 +00:00
.yamllint.yml [enh] add test.yamllint - lint yaml files 2021-06-05 17:41:24 +02:00
AUTHORS.rst [feat] engines: add GitHub Code Search engine (#5074) 2025-08-20 07:35:31 +02:00
babel.cfg [fix] jinja/babel: WithExtension and AutoEscapeExtension are built-in now. 2022-03-25 09:42:12 +01:00
CHANGELOG.rst [releases] rolling release: commit history replaces the CHANGELOG 2023-05-06 14:49:33 +02:00
CONTRIBUTING.rst [enh] docs: update information (#5185) 2025-09-09 20:51:22 +02:00
go.mod [mod] create a Go project with the developer tools from Go 2025-07-28 12:53:26 +02:00
go.sum [mod] create a Go project with the developer tools from Go 2025-07-28 12:53:26 +02:00
LICENSE [fix] full AGPLv3+ license according to #382 2015-07-04 18:23:54 +02:00
Makefile [mod] switching from pyright to basedpyright (plus first rules) 2025-08-19 12:04:35 +02:00
manage [fix] add missing nvm environment to the "./manage dev.env" command 2025-08-18 16:38:32 +02:00
package.json [mod] switching from pyright to basedpyright (plus first rules) 2025-08-19 12:04:35 +02:00
PULL_REQUEST_TEMPLATE.md [chore] fix typo and spacing in pull request template 2023-09-15 10:46:51 +02:00
pyrightconfig.json [mod] addition of various type hints / tbc 2025-09-03 13:37:36 +02:00
README.rst [enh] docs: update information (#5185) 2025-09-09 20:51:22 +02:00
requirements-dev.txt [upd] pypi: Bump the minor group across 1 directory with 5 updates (#5184) 2025-09-05 13:23:01 +02:00
requirements-server.txt [upd] pypi: Bump the minor group across 1 directory with 5 updates (#5184) 2025-09-05 13:23:01 +02:00
requirements.txt [upd] pypi: Bump the minor group across 1 directory with 5 updates (#5184) 2025-09-05 13:23:01 +02:00
SECURITY.md [enh] add security policy 2022-01-25 00:56:20 +01:00
setup.py [mod] Revision of the favicon solution 2024-10-05 08:18:28 +02:00

.. 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://raw.githubusercontent.com/searxng/searxng/refs/heads/master/CONTRIBUTING.rst
.. _LICENSE: https://raw.githubusercontent.com/searxng/searxng/refs/heads/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://raw.githubusercontent.com/searxng/searxng/refs/heads/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,
we have two official channels:

- `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_
- `#searxng @ libera.chat <https://web.libera.chat/?channel=#searxng>`_ (bridged to Matrix)

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.