searxng/docs/index.rst

Welcome to searx
================

Search without being tracked.

Searx is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, searx can be used over Tor for online anonymity.

Get started with searx by using one of the :wiki:`Searx-instances`. If you don't trust anyone, you can set up your own, see :ref:`installation`.


Features
--------

 - Self hosted
 - No user tracking
 - No user profiling
 - About 70 supported search engines
 - Easy integration with any search engine
 - Cookies are not used by default
 - Secure, encrypted connections (HTTPS/SSL)
 - Hosted by organisations, such as La Quadrature du Net, which promote digital rights


User documentation
------------------

.. toctree::
   :maxdepth: 1

   user/search_syntax
   user/own-instance

Administrator documentation
---------------------------

.. toctree::
   :maxdepth: 1

   dev/install/installation
   admin/api
   admin/filtron
   admin/morty
   blog/blog

Developer documentation
-----------------------

.. toctree::
   :maxdepth: 1

   dev/quickstart
   dev/contribution_guide
   dev/engine_overview
   dev/search_api
   dev/plugins
   dev/translation
better API docs && more features in list 2016-07-09 22:31:21 +02:00			`Welcome to searx`
			`================`
[enh] initial structure 2015-11-17 23:13:30 +01:00
simplify index page 2016-07-15 18:41:05 +02:00			`Search without being tracked.`
[enh] initial structure 2015-11-17 23:13:30 +01:00
simplify index page 2016-07-15 18:41:05 +02:00			`Searx is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, searx can be used over Tor for online anonymity.`

doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2019-12-04 16:48:36 +01:00			Get started with searx by using one of the :wiki:`Searx-instances`. If you don't trust anyone, you can set up your own, see :ref:`installation`.
simplify index page 2016-07-15 18:41:05 +02:00
[enh] initial structure 2015-11-17 23:13:30 +01:00
			`Features`
			`--------`

			`- Self hosted`
simplify index page 2016-07-15 18:41:05 +02:00			`- No user tracking`
			`- No user profiling`
better API docs && more features in list 2016-07-09 22:31:21 +02:00			`- About 70 supported search engines`
docs: fix typos based on #653 2016-11-04 18:38:07 +01:00			`- Easy integration with any search engine`
simplify index page 2016-07-15 18:41:05 +02:00			`- Cookies are not used by default`
			`- Secure, encrypted connections (HTTPS/SSL)`
			`- Hosted by organisations, such as La Quadrature du Net, which promote digital rights`
[enh] initial structure 2015-11-17 23:13:30 +01:00

better API docs && more features in list 2016-07-09 22:31:21 +02:00			`User documentation`
			`------------------`
[enh] initial structure 2015-11-17 23:13:30 +01:00
			`.. toctree::`
			`:maxdepth: 1`

			`user/search_syntax`
generated files of parent 2016-11-05 11:49:07 +01:00			`user/own-instance`
[enh] initial structure 2015-11-17 23:13:30 +01:00
better API docs && more features in list 2016-07-09 22:31:21 +02:00			`Administrator documentation`
			`---------------------------`

			`.. toctree::`
			`:maxdepth: 1`

			`dev/install/installation`
			`admin/api`
add sample config of filtron 2016-10-30 01:01:22 +02:00			`admin/filtron`
[enh] add morty documentation 2017-08-08 15:19:02 +02:00			`admin/morty`
doc: use customized pocoo theme (pallets-sphinx-themes) The old searx theme was a copy of the flask theme. In the meantime this theme is available from the python module pallets-sphinx-themes. This patch makes pallets-sphinx-themes as a (dev) requirement and drops most of the old and obsolete searx theme settings/files. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2019-12-04 15:27:27 +01:00			`blog/blog`
[enh] initial structure 2015-11-17 23:13:30 +01:00
			`Developer documentation`
			`-----------------------`

			`.. toctree::`
			`:maxdepth: 1`

add development quickstart 2016-02-01 21:28:13 +01:00			`dev/quickstart`
[enh] initial structure 2015-11-17 23:13:30 +01:00			`dev/contribution_guide`
[doc] engines overview added 2015-11-28 19:26:45 +01:00			`dev/engine_overview`
[enh] initial structure 2015-11-17 23:13:30 +01:00			`dev/search_api`
			`dev/plugins`
			`dev/translation`