searxng/docs/index.rst
Markus Heiser 5720844fcd [doc] rearranges Settings & Engines docs for better readability
We have built up detailed documentation of the *settings* and the *engines* over
the past few years.  However, this documentation was still spread over various
chapters and was difficult to navigate in its entirety.

This patch rearranges the Settings & Engines documentation for better
readability.

To review new ordered docs::

   make docs.clean docs.live

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-07-01 22:45:19 +02:00

55 lines
1.8 KiB
ReStructuredText

==================
Welcome to SearXNG
==================
*Search without being tracked.*
SearXNG is a free internet metasearch engine which aggregates results from more
than 70 search services. Users are neither tracked nor profiled. Additionally,
SearXNG can be used over Tor for online anonymity.
Get started with SearXNG by using one of the instances listed at searx.space_.
If you don't trust anyone, you can set up your own, see :ref:`installation`.
.. sidebar:: features
- :ref:`self hosted <installation>`
- :ref:`no user tracking / no profiling <SearXNG protect privacy>`
- script & cookies are optional
- secure, encrypted connections
- :ref:`about 130 search engines <configured engines>`
- `about 60 translations <https://translate.codeberg.org/projects/searxng/searxng/>`_
- about 100 `well maintained <https://uptime.searxng.org/>`__ instances on searx.space_
- :ref:`easy integration of search engines <demo online engine>`
- professional development: `CI <https://github.com/searxng/searxng/actions>`_,
`quality assurance <https://dev.searxng.org/>`_ &
`automated tested UI <https://dev.searxng.org/screenshots.html>`_
.. sidebar:: be a part
SearXNG is driven by an open community, come join us! Don't hesitate, no
need to be an *expert*, everyone can contribute:
- `help to improve translations <https://translate.codeberg.org/projects/searxng/searxng/>`_
- `discuss with the community <https://matrix.to/#/#searxng:matrix.org>`_
- report bugs & suggestions
- ...
.. sidebar:: the origin
SearXNG development has been started in the middle of 2021 as a fork of the
searx project.
.. toctree::
:maxdepth: 2
user/index
own-instance
admin/index
dev/index
utils/index
src/index
.. _searx.space: https://searx.space