index.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="./">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>Welcome to SearXNG &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
  8. <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="_static/searxng.css?v=52e4ff28" />
  10. <script src="_static/documentation_options.js?v=b12b0e12"></script>
  11. <script src="_static/doctools.js?v=9a2dae69"></script>
  12. <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="genindex.html" />
  15. <link rel="search" title="Search" href="search.html" />
  16. <link rel="next" title="User information" href="user/index.html" />
  17. </head><body>
  18. <div class="related" role="navigation" aria-label="Related">
  19. <h3>Navigation</h3>
  20. <ul>
  21. <li class="right" style="margin-right: 10px">
  22. <a href="genindex.html" title="General Index"
  23. accesskey="I">index</a></li>
  24. <li class="right" >
  25. <a href="py-modindex.html" title="Python Module Index"
  26. >modules</a> |</li>
  27. <li class="right" >
  28. <a href="user/index.html" title="User information"
  29. accesskey="N">next</a> |</li>
  30. <li class="nav-item nav-item-0"><a href="#">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
  31. <li class="nav-item nav-item-this"><a href="">Welcome to SearXNG</a></li>
  32. </ul>
  33. </div>
  34. <div class="document">
  35. <div class="documentwrapper">
  36. <div class="bodywrapper">
  37. <div class="body" role="main">
  38. <section id="welcome-to-searxng">
  39. <h1>Welcome to SearXNG<a class="headerlink" href="#welcome-to-searxng" title="Link to this heading">¶</a></h1>
  40. <blockquote>
  41. <div><p><em>Search without being tracked.</em></p>
  42. </div></blockquote>
  43. <p>SearXNG is a free internet metasearch engine which aggregates results from up
  44. to 246 <a class="reference internal" href="user/configured_engines.html#configured-engines"><span class="std std-ref">search services</span></a>. Users
  45. are neither tracked nor profiled. Additionally, SearXNG can be used over Tor
  46. for online anonymity.</p>
  47. <p>Get started with SearXNG by using one of the instances listed at <a class="reference external" href="https://searx.space">searx.space</a>.
  48. If you don’t trust anyone, you can set up your own, see <a class="reference internal" href="admin/installation.html#installation"><span class="std std-ref">Installation</span></a>.</p>
  49. <aside class="sidebar">
  50. <p class="sidebar-title">features</p>
  51. <ul class="simple">
  52. <li><p><a class="reference internal" href="admin/installation.html#installation"><span class="std std-ref">self hosted</span></a></p></li>
  53. <li><p><a class="reference internal" href="own-instance.html#searxng-protect-privacy"><span class="std std-ref">no user tracking / no profiling</span></a></p></li>
  54. <li><p>script &amp; cookies are optional</p></li>
  55. <li><p>secure, encrypted connections</p></li>
  56. <li><p><a class="reference internal" href="user/configured_engines.html#configured-engines"><span class="std std-ref">246 search engines</span></a></p></li>
  57. <li><p><a class="reference external" href="https://translate.codeberg.org/projects/searxng/searxng/">58 translations</a></p></li>
  58. <li><p>about 70 <a class="reference external" href="https://uptime.searxng.org/">well maintained</a> instances on <a class="reference external" href="https://searx.space">searx.space</a></p></li>
  59. <li><p><a class="reference internal" href="dev/engines/demo/demo_online.html#demo-online-engine"><span class="std std-ref">easy integration of search engines</span></a></p></li>
  60. <li><p>professional development: <a class="reference external" href="https://github.com/searxng/searxng/actions">CI</a>,
  61. <a class="reference external" href="https://dev.searxng.org/">quality assurance</a> &amp;
  62. <a class="reference external" href="https://dev.searxng.org/screenshots.html">automated tested UI</a></p></li>
  63. </ul>
  64. </aside>
  65. <aside class="sidebar">
  66. <p class="sidebar-title">be a part</p>
  67. <p>SearXNG is driven by an open community, come join us! Don’t hesitate, no
  68. need to be an <em>expert</em>, everyone can contribute:</p>
  69. <ul class="simple">
  70. <li><p><a class="reference external" href="https://translate.codeberg.org/projects/searxng/searxng/">help to improve translations</a></p></li>
  71. <li><p><a class="reference external" href="https://matrix.to/#/#searxng:matrix.org">discuss with the community</a></p></li>
  72. <li><p>report bugs &amp; suggestions</p></li>
  73. <li><p>…</p></li>
  74. </ul>
  75. </aside>
  76. <aside class="sidebar">
  77. <p class="sidebar-title">the origin</p>
  78. <p>SearXNG development has been started in the middle of 2021 as a fork of the
  79. searx project.</p>
  80. </aside>
  81. <div class="toctree-wrapper compound">
  82. <ul>
  83. <li class="toctree-l1"><a class="reference internal" href="user/index.html">User information</a><ul>
  84. <li class="toctree-l2"><a class="reference internal" href="user/search-syntax.html">Search syntax</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="user/configured_engines.html">Configured Engines</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="user/about.html">About SearXNG</a></li>
  87. </ul>
  88. </li>
  89. <li class="toctree-l1"><a class="reference internal" href="own-instance.html">Why use a private instance?</a><ul>
  90. <li class="toctree-l2"><a class="reference internal" href="own-instance.html#how-does-searxng-protect-privacy">How does SearXNG protect privacy?</a></li>
  91. <li class="toctree-l2"><a class="reference internal" href="own-instance.html#conclusion">Conclusion</a></li>
  92. </ul>
  93. </li>
  94. <li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator documentation</a><ul>
  95. <li class="toctree-l2"><a class="reference internal" href="admin/settings/index.html">Settings</a></li>
  96. <li class="toctree-l2"><a class="reference internal" href="admin/installation.html">Installation</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="admin/installation-docker.html">Docker Container</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="admin/installation-scripts.html">Installation Script</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="admin/installation-searxng.html">Step by step installation</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="admin/installation-uwsgi.html">uWSGI</a></li>
  101. <li class="toctree-l2"><a class="reference internal" href="admin/installation-nginx.html">NGINX</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="admin/installation-apache.html">Apache</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="admin/update-searxng.html">SearXNG maintenance</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="admin/answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="admin/searx.favicons.html">Favicons</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="admin/searx.limiter.html">Limiter</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="admin/api.html">Administration API</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="admin/architecture.html">Architecture</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="admin/plugins.html">List of plugins</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="admin/buildhosts.html">Buildhosts</a></li>
  111. </ul>
  112. </li>
  113. <li class="toctree-l1"><a class="reference internal" href="dev/index.html">Developer documentation</a><ul>
  114. <li class="toctree-l2"><a class="reference internal" href="dev/quickstart.html">Development Quickstart</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="dev/rtm_asdf.html">Runtime Management</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="dev/contribution_guide.html">How to contribute</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="dev/extended_types.html">Extended Types</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="dev/engines/index.html">Engine Implementations</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="dev/result_types/index.html">Result Types</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="dev/templates.html">Simple Theme Templates</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="dev/search_api.html">Search API</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="dev/plugins/index.html">Plugins</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="dev/answerers/index.html">Answerers</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="dev/translation.html">Translation</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="dev/lxcdev.html">Developing in Linux Containers</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="dev/makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
  127. <li class="toctree-l2"><a class="reference internal" href="dev/reST.html">reST primer</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
  129. </ul>
  130. </li>
  131. <li class="toctree-l1"><a class="reference internal" href="utils/index.html">DevOps tooling box</a><ul>
  132. <li class="toctree-l2"><a class="reference internal" href="utils/searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="utils/lxc.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span></code></a></li>
  134. <li class="toctree-l2"><a class="reference internal" href="utils/index.html#common-command-environments">Common command environments</a></li>
  135. </ul>
  136. </li>
  137. <li class="toctree-l1"><a class="reference internal" href="src/index.html">Source-Code</a><ul>
  138. <li class="toctree-l2"><a class="reference internal" href="src/searx.babel_extract.html">Custom message extractor (i18n)</a></li>
  139. <li class="toctree-l2"><a class="reference internal" href="src/searx.botdetection.html">Bot Detection</a></li>
  140. <li class="toctree-l2"><a class="reference internal" href="src/searx.exceptions.html">SearXNG Exceptions</a></li>
  141. <li class="toctree-l2"><a class="reference internal" href="src/searx.favicons.html">Favicons (source)</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="src/searx.infopage.html">Online <code class="docutils literal notranslate"><span class="pre">/info</span></code></a></li>
  143. <li class="toctree-l2"><a class="reference internal" href="src/searx.locales.html">Locales</a></li>
  144. <li class="toctree-l2"><a class="reference internal" href="src/searx.redisdb.html">Redis DB</a></li>
  145. <li class="toctree-l2"><a class="reference internal" href="src/searx.redislib.html">Redis Library</a></li>
  146. <li class="toctree-l2"><a class="reference internal" href="src/searx.search.html">Search</a></li>
  147. <li class="toctree-l2"><a class="reference internal" href="src/searx.search.processors.html">Search processors</a></li>
  148. <li class="toctree-l2"><a class="reference internal" href="src/searx.settings.html">Settings Loader</a></li>
  149. <li class="toctree-l2"><a class="reference internal" href="src/searx.sqlitedb.html">SQLite DB</a></li>
  150. <li class="toctree-l2"><a class="reference internal" href="src/searx.utils.html">Utility functions for the engines</a></li>
  151. </ul>
  152. </li>
  153. </ul>
  154. </div>
  155. </section>
  156. <div class="clearer"></div>
  157. </div>
  158. </div>
  159. </div>
  160. <span id="sidebar-top"></span>
  161. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  162. <div class="sphinxsidebarwrapper">
  163. <p class="logo"><a href="#">
  164. <img class="logo" src="_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  165. </a></p>
  166. <h3><a href="#">Table of Contents</a></h3>
  167. <ul>
  168. <li class="toctree-l1"><a class="reference internal" href="user/index.html">User information</a></li>
  169. <li class="toctree-l1"><a class="reference internal" href="own-instance.html">Why use a private instance?</a></li>
  170. <li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator documentation</a></li>
  171. <li class="toctree-l1"><a class="reference internal" href="dev/index.html">Developer documentation</a></li>
  172. <li class="toctree-l1"><a class="reference internal" href="utils/index.html">DevOps tooling box</a></li>
  173. <li class="toctree-l1"><a class="reference internal" href="src/index.html">Source-Code</a></li>
  174. </ul>
  175. <h3>Project Links</h3>
  176. <ul>
  177. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  178. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  179. <li><a href="https://searx.space">Public instances</a>
  180. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  181. </ul><h3>Navigation</h3>
  182. <ul>
  183. <li><a href="#">Overview</a>
  184. <ul>
  185. <li>Next: <a href="user/index.html" title="next chapter">User information</a>
  186. </ul>
  187. </li>
  188. </ul>
  189. <search id="searchbox" style="display: none" role="search">
  190. <h3 id="searchlabel">Quick search</h3>
  191. <div class="searchformwrapper">
  192. <form class="search" action="search.html" method="get">
  193. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  194. <input type="submit" value="Go" />
  195. </form>
  196. </div>
  197. </search>
  198. <script>document.getElementById('searchbox').style.display = "block"</script>
  199. <div role="note" aria-label="source link">
  200. <h3>This Page</h3>
  201. <ul class="this-page-menu">
  202. <li><a href="_sources/index.rst.txt"
  203. rel="nofollow">Show Source</a></li>
  204. </ul>
  205. </div>
  206. </div>
  207. </div>
  208. <div class="clearer"></div>
  209. </div>
  210. <div class="footer" role="contentinfo">
  211. &#169; Copyright SearXNG team.
  212. </div>
  213. </body>
  214. </html>