jandieman
/
searxng
mirror of https://github.com/searxng/searxng.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
searxng/index.html

227 lines
14 KiB
HTML
Raw Normal View History

[doc] build from commit fa108c140fb8fe523e9be432f6e92c6812acc6ea
2024-10-31 12:36:39 +00:00
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Welcome to SearXNG &#8212; SearXNG Documentation (2024.10.31+fa108c140)</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
<link rel="stylesheet" type="text/css" href="_static/searxng.css?v=52e4ff28" />
<link rel="stylesheet" type="text/css" href="_static/autodoc_pydantic.css" />
<script src="_static/documentation_options.js?v=b20e5003"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2024.10.31+fa108c140" src="_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="User information" href="user/index.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="user/index.html" title="User information"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">SearXNG Documentation (2024.10.31+fa108c140)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to SearXNG</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="welcome-to-searxng">
<h1>Welcome to SearXNG<a class="headerlink" href="#welcome-to-searxng" title="Link to this heading"></a></h1>
<blockquote>
<div><p><em>Search without being tracked.</em></p>
</div></blockquote>
<p>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.</p>
<p>Get started with SearXNG by using one of the instances listed at <a class="reference external" href="https://searx.space">searx.space</a>.
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>
<aside class="sidebar">
<p class="sidebar-title">features</p>
<ul class="simple">
<li><p><a class="reference internal" href="admin/installation.html#installation"><span class="std std-ref">self hosted</span></a></p></li>
<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>
<li><p>script &amp; cookies are optional</p></li>
<li><p>secure, encrypted connections</p></li>
<li><p><a class="reference internal" href="user/configured_engines.html#configured-engines"><span class="std std-ref">about 200 search engines</span></a></p></li>
<li><p><a class="reference external" href="https://translate.codeberg.org/projects/searxng/searxng/">about 60 translations</a></p></li>
<li><p>about 100 <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>
<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>
<li><p>professional development: <a class="reference external" href="https://github.com/searxng/searxng/actions">CI</a>,
<a class="reference external" href="https://dev.searxng.org/">quality assurance</a> &amp;
<a class="reference external" href="https://dev.searxng.org/screenshots.html">automated tested UI</a></p></li>
</ul>
</aside>
<aside class="sidebar">
<p class="sidebar-title">be a part</p>
<p>SearXNG is driven by an open community, come join us! Don’t hesitate, no
need to be an <em>expert</em>, everyone can contribute:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://translate.codeberg.org/projects/searxng/searxng/">help to improve translations</a></p></li>
<li><p><a class="reference external" href="https://matrix.to/#/#searxng:matrix.org">discuss with the community</a></p></li>
<li><p>report bugs &amp; suggestions</p></li>
<li><p>…</p></li>
</ul>
</aside>
<aside class="sidebar">
<p class="sidebar-title">the origin</p>
<p>SearXNG development has been started in the middle of 2021 as a fork of the
searx project.</p>
</aside>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/index.html">User information</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/search-syntax.html">Search syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/configured_engines.html">Configured Engines</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/about.html">About SearXNG</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="own-instance.html">Why use a private instance?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="own-instance.html#how-does-searxng-protect-privacy">How does SearXNG protect privacy?</a></li>
<li class="toctree-l2"><a class="reference internal" href="own-instance.html#conclusion">Conclusion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/settings/index.html">Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation.html">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation-docker.html">Docker Container</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation-scripts.html">Installation Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation-searxng.html">Step by step installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation-uwsgi.html">uWSGI</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation-nginx.html">NGINX</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/installation-apache.html">Apache</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/update-searxng.html">SearXNG maintenance</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/searx.favicons.html">Favicons</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/searx.limiter.html">Limiter</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/api.html">Administration API</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/architecture.html">Architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/plugins.html">Plugins builtin</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/buildhosts.html">Buildhosts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Developer documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/plugins.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/lxcdev.html">Developing in Linux Containers</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="dev/reST.html">reST primer</a></li>
<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>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utils/index.html">DevOps tooling box</a><ul>
<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>
<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>
<li class="toctree-l2"><a class="reference internal" href="utils/index.html#common-command-environments">Common command environments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="src/index.html">Source-Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="src/searx.babel_extract.html">Custom message extractor (i18n)</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.botdetection.html">Bot Detection</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.exceptions.html">SearXNG Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.favicons.html">Favicons (source)</a></li>
<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>
<li class="toctree-l2"><a class="reference internal" href="src/searx.locales.html">Locales</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.plugins.hostnames.html">Hostnames plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.plugins.tor_check.html">Tor check plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.plugins.unit_converter.html">Unit converter plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.redisdb.html">Redis DB</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.redislib.html">Redis Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.search.html">Search</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.search.processors.html">Search processors</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.settings.html">Settings Loader</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.sqlitedb.html">SQLite DB</a></li>
<li class="toctree-l2"><a class="reference internal" href="src/searx.utils.html">Utility functions for the engines</a></li>
</ul>
</li>
</ul>
</div>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/index.html">Developer documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="#">Overview</a>
<ul>
<li>Next: <a href="user/index.html" title="next chapter">User information</a>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>