|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html lang="en">
|
|
|
<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>Offline Engines — SearXNG Documentation (2023.1.23+522ba9a1)</title>
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/searxng.css" />
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
|
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
|
|
<script src="../_static/jquery.js"></script>
|
|
|
<script src="../_static/underscore.js"></script>
|
|
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
|
<script src="../_static/doctools.js"></script>
|
|
|
<script src="../_static/sphinx_highlight.js"></script>
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
|
<link rel="next" title="Search API" href="search_api.html" />
|
|
|
<link rel="prev" title="Engine Overview" href="engine_overview.html" />
|
|
|
</head><body>
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<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="search_api.html" title="Search API"
|
|
|
accesskey="N">next</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="engine_overview.html" title="Engine Overview"
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2023.1.23+522ba9a1)</a> »</li>
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Developer documentation</a> »</li>
|
|
|
<li class="nav-item nav-item-this"><a href="">Offline Engines</a></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
|
|
|
<div class="document">
|
|
|
<div class="documentwrapper">
|
|
|
<div class="bodywrapper">
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
<section id="offline-engines">
|
|
|
<span id="id1"></span><h1>Offline Engines<a class="headerlink" href="#offline-engines" title="Permalink to this heading">¶</a></h1>
|
|
|
<aside class="sidebar">
|
|
|
<p class="sidebar-title">offline engines</p>
|
|
|
<ul class="simple">
|
|
|
<li><p><a class="reference internal" href="../src/searx.engines.demo_offline.html#demo-offline-engine"><span class="std std-ref">Demo Offline Engine</span></a></p></li>
|
|
|
<li><p><a class="reference internal" href="../admin/engines/sql-engines.html#sql-engines"><span class="std std-ref">SQL Engines</span></a></p></li>
|
|
|
<li><p><a class="reference internal" href="../admin/engines/command-line-engines.html#engine-command"><span class="std std-ref">Command Line Engines</span></a></p></li>
|
|
|
<li><p><a class="reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/redis_server.py">Redis</a></p></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<p>To extend the functionality of SearXNG, offline engines are going to be
|
|
|
introduced. An offline engine is an engine which does not need Internet
|
|
|
connection to perform a search and does not use HTTP to communicate.</p>
|
|
|
<p>Offline engines can be configured, by adding those to the <cite>engines</cite> list of
|
|
|
<a class="reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>. An example skeleton for offline
|
|
|
engines can be found in <a class="reference internal" href="../src/searx.engines.demo_offline.html#demo-offline-engine"><span class="std std-ref">Demo Offline Engine</span></a> (<a class="reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/demo_offline.py">demo_offline.py</a>).</p>
|
|
|
<section id="programming-interface">
|
|
|
<h2>Programming Interface<a class="headerlink" href="#programming-interface" title="Permalink to this heading">¶</a></h2>
|
|
|
<dl class="simple">
|
|
|
<dt><a class="reference internal" href="../src/searx.engines.demo_offline.html#searx.engines.demo_offline.init" title="searx.engines.demo_offline.init"><code class="xref py py-func docutils literal notranslate"><span class="pre">init(engine_settings=None)</span></code></a></dt><dd><p>All offline engines can have their own init function to setup the engine before
|
|
|
accepting requests. The function gets the settings from settings.yml as a
|
|
|
parameter. This function can be omitted, if there is no need to setup anything
|
|
|
in advance.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
<p><code class="xref py py-func docutils literal notranslate"><span class="pre">search(query,</span> <span class="pre">params)</span></code></p>
|
|
|
<blockquote>
|
|
|
<div><p>Each offline engine has a function named <code class="docutils literal notranslate"><span class="pre">search</span></code>. This function is
|
|
|
responsible to perform a search and return the results in a presentable
|
|
|
format. (Where <em>presentable</em> means presentable by the selected result
|
|
|
template.)</p>
|
|
|
<p>The return value is a list of results retrieved by the engine.</p>
|
|
|
</div></blockquote>
|
|
|
<dl class="simple">
|
|
|
<dt>Engine representation in <code class="docutils literal notranslate"><span class="pre">/config</span></code></dt><dd><p>If an engine is offline, the attribute <code class="docutils literal notranslate"><span class="pre">offline</span></code> is set to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</section>
|
|
|
<section id="extra-dependencies">
|
|
|
<span id="offline-requirements"></span><h2>Extra Dependencies<a class="headerlink" href="#extra-dependencies" title="Permalink to this heading">¶</a></h2>
|
|
|
<p>If an offline engine depends on an external tool, SearXNG does not install it by
|
|
|
default. When an administrator configures such engine and starts the instance,
|
|
|
the process returns an error with the list of missing dependencies. Also,
|
|
|
required dependencies will be added to the comment/description of the engine, so
|
|
|
admins can install packages in advance.</p>
|
|
|
<p>If there is a need to install additional packages in <em>Python’s Virtual
|
|
|
Environment</em> of your SearXNG instance you need to switch into the environment
|
|
|
(<a class="reference internal" href="../admin/installation-searxng.html#searxng-src"><span class="std std-ref">Install SearXNG & dependencies</span></a>) first, for this you can use <a class="reference internal" href="../utils/searxng.sh.html#searxng-sh"><span class="std std-ref">utils/searxng.sh</span></a>:</p>
|
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo utils/searxng.sh instance cmd bash
|
|
|
(searxng-pyenv)$ pip install ...
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section id="private-engines-security">
|
|
|
<h2>Private engines (Security)<a class="headerlink" href="#private-engines-security" title="Permalink to this heading">¶</a></h2>
|
|
|
<p>To limit the access to offline engines, if an instance is available publicly,
|
|
|
administrators can set token(s) for each of the <a class="reference internal" href="../admin/engines/private-engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>. If a
|
|
|
query contains a valid token, then SearXNG performs the requested private
|
|
|
search. If not, requests from an offline engines return errors.</p>
|
|
|
</section>
|
|
|
<section id="acknowledgement">
|
|
|
<h2>Acknowledgement<a class="headerlink" href="#acknowledgement" title="Permalink to this heading">¶</a></h2>
|
|
|
<p>This development was sponsored by <a class="reference external" href="https://nlnet.nl/discovery">Search and Discovery Fund</a> of <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a> .</p>
|
|
|
</section>
|
|
|
</section>
|
|
|
|
|
|
|
|
|
<div class="clearer"></div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<span id="sidebar-top"></span>
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
|
|
|
<p class="logo"><a href="../index.html">
|
|
|
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo"/>
|
|
|
</a></p>
|
|
|
|
|
|
|
|
|
<h3><a href="../index.html">Table of Contents</a></h3>
|
|
|
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
|
|
<ul class="current">
|
|
|
<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 current"><a class="reference internal" href="index.html">Developer documentation</a><ul class="current">
|
|
|
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html">How to contribute</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Offline Engines</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="search_api.html">Search API</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="plugins.html">Plugins</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="translation.html">Translation</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="lxcdev.html">Developing in Linux Containers</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html">Makefile</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html">reST primer</a></li>
|
|
|
<li class="toctree-l2"><a class="reference internal" href="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></li>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../donate.html">Donate to searxng.org</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="../index.html">Overview</a>
|
|
|
<ul>
|
|
|
<li><a href="index.html">Developer documentation</a>
|
|
|
<ul>
|
|
|
<li>Previous: <a href="engine_overview.html" title="previous chapter">Engine Overview</a>
|
|
|
<li>Next: <a href="search_api.html" title="next chapter">Search API</a></ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<div 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>
|
|
|
</div>
|
|
|
<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/dev/offline_engines.rst.txt"
|
|
|
rel="nofollow">Show Source</a></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="clearer"></div>
|
|
|
</div>
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
|
© Copyright 2021 SearXNG team, 2015-2021 Adam Tauber, Noémi Ványi.
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
|
|
|
</div>
|
|
|
<script src="../_static/version_warning_offset.js"></script>
|
|
|
|
|
|
</body>
|
|
|
</html> |