mirror of
https://github.com/searxng/searxng.git
synced 2025-12-29 07:00:02 +00:00
[doc] build from commit 45a4b8ad1c
This commit is contained in:
155
dev/answerers/builtins.html
Normal file
155
dev/answerers/builtins.html
Normal file
@@ -0,0 +1,155 @@
|
||||
<!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>Built-in Answerers — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Random" href="random.html" />
|
||||
<link rel="prev" title="Answerer Development" href="development.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="random.html" title="Random"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="development.html" title="Answerer Development"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Answerers</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Built-in Answerers</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="built-in-answerers">
|
||||
<span id="builtin-answerers"></span><h1>Built-in Answerers<a class="headerlink" href="#built-in-answerers" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="random.html">Random</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="statistics.html">Statistics</a></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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Answerers</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Built-in Answerers</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Answerers</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="development.html" title="previous chapter">Answerer Development</a>
|
||||
<li>Next: <a href="random.html" title="next chapter">Random</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/answerers/builtins.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
317
dev/answerers/development.html
Normal file
317
dev/answerers/development.html
Normal file
@@ -0,0 +1,317 @@
|
||||
<!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>Answerer Development — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Built-in Answerers" href="builtins.html" />
|
||||
<link rel="prev" title="Answerers" href="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="builtins.html" title="Built-in Answerers"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Answerers"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Answerers</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Answerer Development</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.answerers">
|
||||
<span id="answerer-development"></span><span id="dev-answerers"></span><h1>Answerer Development<a class="headerlink" href="#module-searx.answerers" title="Link to this heading">¶</a></h1>
|
||||
<p>The <em>answerers</em> give instant answers related to the search query, they
|
||||
usually provide answers of type <code class="xref py py-obj docutils literal notranslate"><span class="pre">Answer</span></code>.</p>
|
||||
<p>Here is an example of a very simple answerer that adds a “Hello” into the answer
|
||||
area:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span> <span class="k">as</span> <span class="n">_</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.answerers</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answerer</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answer</span>
|
||||
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">MyAnswerer</span><span class="p">(</span><span class="n">Answerer</span><span class="p">):</span>
|
||||
|
||||
<span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">"hello"</span><span class="p">,</span> <span class="s2">"hello world"</span> <span class="p">]</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">AnswererInfo</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s2">"Hello"</span><span class="p">),</span> <span class="n">description</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s2">"lorem .."</span><span class="p">),</span> <span class="n">keywords</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">keywords</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">answer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">[</span> <span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="s2">"Hello"</span><span class="p">)</span> <span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.answerers.Answerer">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.</span></span><span class="sig-name descname"><span class="pre">Answerer</span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#Answerer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.Answerer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Abstract base class of answerers.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.Answerer.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.Answerer.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords to which the answerer has <em>answers</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.Answerer.answer">
|
||||
<em class="property"><span class="k"><span class="pre">abstractmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">answer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#Answerer.answer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.Answerer.answer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Function that returns a list of answers to the question/query.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.Answerer.info">
|
||||
<em class="property"><span class="k"><span class="pre">abstractmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers._core.AnswererInfo"><span class="pre">AnswererInfo</span></a></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#Answerer.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.Answerer.info" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Information about the <em>answerer</em>, see <a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers.AnswererInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswererInfo">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.</span></span><span class="sig-name descname"><span class="pre">AnswererInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">examples</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswererInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswererInfo" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Object that holds information about an answerer, these infos are shown
|
||||
to the user in the Preferences menu.</p>
|
||||
<p>To be able to translate the information into other languages, the text must
|
||||
be written in English and translated with <a class="reference external" href="https://python-babel.github.io/flask-babel/index.html#flask_babel.gettext" title="(in Flask-Babel)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_babel.gettext</span></code></a>.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswererInfo.name">
|
||||
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.answerers.AnswererInfo.name" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the <em>answerer</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswererInfo.description">
|
||||
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.answerers.AnswererInfo.description" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Short description of the <em>answerer</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswererInfo.examples">
|
||||
<span class="sig-name descname"><span class="pre">examples</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.AnswererInfo.examples" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>List of short examples of the usage / of query terms.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswererInfo.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.AnswererInfo.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>See <a class="reference internal" href="#searx.answerers.Answerer.keywords" title="searx.answerers.Answerer.keywords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer.keywords</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswerStorage">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.</span></span><span class="sig-name descname"><span class="pre">AnswerStorage</span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A storage for managing the <em>answerers</em> of SearXNG. With the
|
||||
<a class="reference internal" href="#searx.answerers.AnswerStorage.ask" title="searx.answerers.AnswerStorage.ask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswerStorage.ask</span></code></a>” method, a caller can ask questions to all
|
||||
<em>answerers</em> and receives a list of the results.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswerStorage.answerer_list">
|
||||
<span class="sig-name descname"><span class="pre">answerer_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.14)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers._core.Answerer"><span class="pre">Answerer</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.AnswerStorage.answerer_list" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The list of <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers.Answerer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer</span></code></a> in this storage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswerStorage.load_builtins">
|
||||
<span class="sig-name descname"><span class="pre">load_builtins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.load_builtins"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.load_builtins" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Loads <code class="docutils literal notranslate"><span class="pre">answerer.py</span></code> modules from the python packages in
|
||||
<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/answerers">git://searx/answerers</a>. The python modules are wrapped by
|
||||
<code class="xref py py-obj docutils literal notranslate"><span class="pre">ModuleAnswerer</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswerStorage.register_by_fqn">
|
||||
<span class="sig-name descname"><span class="pre">register_by_fqn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fqn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.register_by_fqn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.register_by_fqn" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Register a <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers.Answerer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer</span></code></a> via its fully qualified class namen(FQN).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswerStorage.register">
|
||||
<span class="sig-name descname"><span class="pre">register</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">answerer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers._core.Answerer"><span class="pre">Answerer</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.register"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.register" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Register a <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers.Answerer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.AnswerStorage.ask">
|
||||
<span class="sig-name descname"><span class="pre">ask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.ask"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.ask" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>An answerer is identified via keywords, if there is a keyword at the
|
||||
first position in the <code class="docutils literal notranslate"><span class="pre">query</span></code> for which there is one or more
|
||||
answerers, then these are called, whereby the entire <code class="docutils literal notranslate"><span class="pre">query</span></code> is passed
|
||||
as argument to the answerer function.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.answerers._core.ModuleAnswerer">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers._core.</span></span><span class="sig-name descname"><span class="pre">ModuleAnswerer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mod</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#ModuleAnswerer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers._core.ModuleAnswerer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers._core.Answerer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Answerer</span></code></a></p>
|
||||
<p>A wrapper class for legacy <em>answerers</em> where the names (keywords, answer,
|
||||
info) are implemented on the module level (not in a class).</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>For internal use only!</p>
|
||||
</div>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers._core.ModuleAnswerer.answer">
|
||||
<span class="sig-name descname"><span class="pre">answer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#ModuleAnswerer.answer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers._core.ModuleAnswerer.answer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Function that returns a list of answers to the question/query.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers._core.ModuleAnswerer.info">
|
||||
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers._core.AnswererInfo"><span class="pre">AnswererInfo</span></a></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#ModuleAnswerer.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers._core.ModuleAnswerer.info" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Information about the <em>answerer</em>, see <a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers._core.AnswererInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Answerers</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Answerer Development</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.answerers.Answerer"><code class="docutils literal notranslate"><span class="pre">Answerer</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.Answerer.keywords"><code class="docutils literal notranslate"><span class="pre">Answerer.keywords</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.Answerer.answer"><code class="docutils literal notranslate"><span class="pre">Answerer.answer()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.Answerer.info"><code class="docutils literal notranslate"><span class="pre">Answerer.info()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.answerers.AnswererInfo"><code class="docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.name"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.name</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.description"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.description</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.examples"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.examples</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.keywords"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.keywords</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.answerers.AnswerStorage"><code class="docutils literal notranslate"><span class="pre">AnswerStorage</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.answerer_list"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.answerer_list</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.load_builtins"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.load_builtins()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.register_by_fqn"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.register_by_fqn()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.register"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.register()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.ask"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.ask()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.answerers._core.ModuleAnswerer"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers._core.ModuleAnswerer.answer"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer.answer()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers._core.ModuleAnswerer.info"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer.info()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="builtins.html">Built-in Answerers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Answerers</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">Answerers</a>
|
||||
<li>Next: <a href="builtins.html" title="next chapter">Built-in Answerers</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/answerers/development.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
157
dev/answerers/index.html
Normal file
157
dev/answerers/index.html
Normal file
@@ -0,0 +1,157 @@
|
||||
<!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>Answerers — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Answerer Development" href="development.html" />
|
||||
<link rel="prev" title="Time Zone" href="../plugins/time_zone.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="development.html" title="Answerer Development"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../plugins/time_zone.html" title="Time Zone"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Answerers</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="answerers">
|
||||
<h1>Answerers<a class="headerlink" href="#answerers" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="development.html">Answerer Development</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#searx.answerers.Answerer"><code class="docutils literal notranslate"><span class="pre">Answerer</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#searx.answerers.AnswererInfo"><code class="docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#searx.answerers.AnswerStorage"><code class="docutils literal notranslate"><span class="pre">AnswerStorage</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#searx.answerers._core.ModuleAnswerer"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Built-in Answerers</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="random.html">Random</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="statistics.html">Statistics</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Answerers</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="builtins.html">Built-in Answerers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="../plugins/time_zone.html" title="previous chapter">Time Zone</a>
|
||||
<li>Next: <a href="development.html" title="next chapter">Answerer Development</a></ul>
|
||||
</li>
|
||||
</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/dev/answerers/index.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
180
dev/answerers/random.html
Normal file
180
dev/answerers/random.html
Normal file
@@ -0,0 +1,180 @@
|
||||
<!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>Random — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Statistics" href="statistics.html" />
|
||||
<link rel="prev" title="Built-in Answerers" href="builtins.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="statistics.html" title="Statistics"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="builtins.html" title="Built-in Answerers"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Answerers</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Answerers</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Random</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="random">
|
||||
<span id="answerer-random"></span><h1>Random<a class="headerlink" href="#random" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.answerers.random.SXNGAnswerer">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.random.</span></span><span class="sig-name descname"><span class="pre">SXNGAnswerer</span></span><a class="reference internal" href="../../_modules/searx/answerers/random.html#SXNGAnswerer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.random.SXNGAnswerer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Random value generator</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.random.SXNGAnswerer.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['random']</span></em><a class="headerlink" href="#searx.answerers.random.SXNGAnswerer.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords to which the answerer has <em>answers</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.random.SXNGAnswerer.info">
|
||||
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/random.html#SXNGAnswerer.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.random.SXNGAnswerer.info" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Information about the <em>answerer</em>, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswererInfo</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.random.SXNGAnswerer.answer">
|
||||
<span class="sig-name descname"><span class="pre">answer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/random.html#SXNGAnswerer.answer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.random.SXNGAnswerer.answer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Function that returns a list of answers to the question/query.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Answerers</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Answerers</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Random</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.random.SXNGAnswerer"><code class="docutils literal notranslate"><span class="pre">SXNGAnswerer</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Answerers</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Answerers</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="builtins.html" title="previous chapter">Built-in Answerers</a>
|
||||
<li>Next: <a href="statistics.html" title="next chapter">Statistics</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/answerers/random.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
180
dev/answerers/statistics.html
Normal file
180
dev/answerers/statistics.html
Normal file
@@ -0,0 +1,180 @@
|
||||
<!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>Statistics — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Translation" href="../translation.html" />
|
||||
<link rel="prev" title="Random" href="random.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="../translation.html" title="Translation"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="random.html" title="Random"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Answerers</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Answerers</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Statistics</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="statistics">
|
||||
<span id="answerer-statistics"></span><h1>Statistics<a class="headerlink" href="#statistics" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.answerers.statistics.SXNGAnswerer">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.statistics.</span></span><span class="sig-name descname"><span class="pre">SXNGAnswerer</span></span><a class="reference internal" href="../../_modules/searx/answerers/statistics.html#SXNGAnswerer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.statistics.SXNGAnswerer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Statistics functions</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.answerers.statistics.SXNGAnswerer.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['min',</span> <span class="pre">'max',</span> <span class="pre">'avg',</span> <span class="pre">'sum',</span> <span class="pre">'prod',</span> <span class="pre">'range']</span></em><a class="headerlink" href="#searx.answerers.statistics.SXNGAnswerer.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords to which the answerer has <em>answers</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.statistics.SXNGAnswerer.info">
|
||||
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/statistics.html#SXNGAnswerer.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.statistics.SXNGAnswerer.info" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Information about the <em>answerer</em>, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswererInfo</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.answerers.statistics.SXNGAnswerer.answer">
|
||||
<span class="sig-name descname"><span class="pre">answer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/statistics.html#SXNGAnswerer.answer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.statistics.SXNGAnswerer.answer" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Function that returns a list of answers to the question/query.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Answerers</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Answerers</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="random.html">Random</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Statistics</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.answerers.statistics.SXNGAnswerer"><code class="docutils literal notranslate"><span class="pre">SXNGAnswerer</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Answerers</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Answerers</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="random.html" title="previous chapter">Random</a>
|
||||
<li>Next: <a href="../translation.html" title="next chapter">Translation</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/answerers/statistics.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
215
dev/commits.html
Normal file
215
dev/commits.html
Normal file
@@ -0,0 +1,215 @@
|
||||
<!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>Git Commits & Change Management — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="How to contribute" href="contribution_guide.html" />
|
||||
<link rel="prev" title="Development Quickstart" href="quickstart.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="contribution_guide.html" title="How to contribute"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="quickstart.html" title="Development Quickstart"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Git Commits & Change Management</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="git-commits-change-management">
|
||||
<span id="create-commit"></span><h1>Git Commits & Change Management<a class="headerlink" href="#git-commits-change-management" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Create good commits!</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.conventionalcommits.org/">Conventional Commits</a></p></li>
|
||||
<li><p><a class="reference external" href="https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes">Structural split of changes</a></p></li>
|
||||
<li><p><a class="reference external" href="https://wiki.openstack.org/wiki/GitCommitMessages">Git Commit Good Practice</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>A commit and its commit message are among the most important information
|
||||
available to a developer for bug fixing and further development. A commit is a
|
||||
change and changes have a context (a change request).</p>
|
||||
<p>In a SCM system (git), the change history is derived from the commit history. A
|
||||
commit message is therefore part of the documentation for change management and
|
||||
thus elementary for the traceability of changes.</p>
|
||||
<p><strong>What a commit is not</strong>: <em>A commit to an SCM system is not used to save files!</em></p>
|
||||
<p>A commit should always have a context and the commit message describes what is
|
||||
to be changed in that context, just as a function description should describe
|
||||
what the intention and the goal of the function is, a commit message should
|
||||
describe what the intention and the goal of that commit is.</p>
|
||||
<p>The commit messages form the history and are the first and therefore most
|
||||
important information a developer has when he has to research when and why a
|
||||
change had to be made and how it was made (what the goal was).</p>
|
||||
<p>Like any text, a commit message should be written for the reader and not from
|
||||
the perspective of the author.</p>
|
||||
<p>When scrolling through the history, the first thing one see is the title of the
|
||||
commit message. Therefore the title should describe the change as briefly and
|
||||
precisely as possible … followed by a blank line and then a somewhat detailed
|
||||
description of the change.</p>
|
||||
<hr class="docutils" />
|
||||
<p>The follwing rules should be in mind, when creating a commit:</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>Commit history should be read like a history book.</strong></p></li>
|
||||
<li><p><strong>Commit messages are for the reader not for the author of the commit.</strong></p></li>
|
||||
<li><p><strong>A commit is the atomic code-modification of a change in change management.</strong></p></li>
|
||||
<li><p><strong>Think about which descriptions from your PR might belong in the commit message.</strong></p></li>
|
||||
<li><p><strong>The maximum line length in a commit message is 80 characters.</strong></p></li>
|
||||
</ul>
|
||||
<hr class="docutils" />
|
||||
<p>Choose meaningful commit messages:</p>
|
||||
<blockquote>
|
||||
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="nb">type</span><span class="p">]</span> <span class="n">optional</span> <span class="n">scope</span><span class="p">:</span> <span class="n">description</span>
|
||||
|
||||
<span class="p">[</span><span class="n">body</span><span class="p">]</span>
|
||||
|
||||
<span class="p">[</span><span class="n">optional</span> <span class="n">trailers</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></blockquote>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">[type]</span></code>:</dt><dd><p>Commits MUST be prefixed with a type .. <code class="docutils literal notranslate"><span class="pre">feat</span></code>, <code class="docutils literal notranslate"><span class="pre">fix</span></code>, <code class="docutils literal notranslate"><span class="pre">refactor</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">mod</span></code>, <code class="docutils literal notranslate"><span class="pre">upd</span></code>, <code class="docutils literal notranslate"><span class="pre">doc</span></code>, <code class="docutils literal notranslate"><span class="pre">l10n</span></code>, <code class="docutils literal notranslate"><span class="pre">build</span></code> ..</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">[body]</span></code></dt><dd><p><a class="reference external" href="https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages">Information in commit messages</a></p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">[optional</span> <span class="pre">trailers]</span></code>:</dt><dd><ul class="simple">
|
||||
<li><p><a class="reference external" href="https://git-scm.com/docs/git-commit#Documentation/git-commit.txt-code--signoffcode">Signed-off-by</a>: certify that the committer has the rights to submit the
|
||||
work under the project’s license. That the developer has this right is a
|
||||
prerequisite for a merge. If the <a class="reference external" href="https://git-scm.com/docs/git-commit#Documentation/git-commit.txt-code--signoffcode">Signed-off-by</a> is not set in the
|
||||
commit, the contributor enters his <cite>Developer’s Certificate of Origin</cite> at
|
||||
the latest when creating a PR!</p></li>
|
||||
<li><p>Closes: Link to the bug report or the bug number (e.g. <code class="docutils literal notranslate"><span class="pre">Closes:</span> <span class="pre">#10</span></code>)</p></li>
|
||||
<li><p><a class="reference external" href="https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors">Co-authored-by</a>: email address of the co-author</p></li>
|
||||
<li><p>Reported-by: email address (if there is no bug report)</p></li>
|
||||
<li><p>Suggested-by: email address (if there is no bug report)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<hr class="docutils" />
|
||||
<p>To give examples at hand, here are a few commits. Follow the links to see the
|
||||
full commit messages:</p>
|
||||
<dl class="simple">
|
||||
<dt><a class="extlink-patch reference external" href="https://github.com/searxng/searxng/commit/44d941c93">#44d941c93</a></dt><dd><p><code class="docutils literal notranslate"><span class="pre">[fix]</span> <span class="pre">mojeek</span> <span class="pre">web</span> <span class="pre">engine:</span> <span class="pre">don't</span> <span class="pre">add</span> <span class="pre">empty</span> <span class="pre">fmt</span> <span class="pre">argument</span> <span class="pre">for</span> <span class="pre">web</span> <span class="pre">searches</span></code></p>
|
||||
</dd>
|
||||
<dt><a class="extlink-patch reference external" href="https://github.com/searxng/searxng/commit/feb15e387">#feb15e387</a></dt><dd><p><code class="docutils literal notranslate"><span class="pre">[fix]</span> <span class="pre">brave.news</span> <span class="pre">engine:</span> <span class="pre">response</span> <span class="pre">is</span> <span class="pre">HTML</span> <span class="pre">and</span> <span class="pre">no</span> <span class="pre">longer</span> <span class="pre">JSON</span></code></p>
|
||||
</dd>
|
||||
<dt><a class="extlink-patch reference external" href="https://github.com/searxng/searxng/commit/bdfe1c2a1">#bdfe1c2a1</a></dt><dd><p><code class="docutils literal notranslate"><span class="pre">[mod]</span> <span class="pre">engines:</span> <span class="pre">migration</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">individual</span> <span class="pre">cache</span> <span class="pre">solutions</span> <span class="pre">to</span> <span class="pre">EngineCache</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</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="../index.html">
|
||||
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<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 current"><a class="current reference internal" href="#">Git Commits & Change Management</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="extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</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="makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="quickstart.html" title="previous chapter">Development Quickstart</a>
|
||||
<li>Next: <a href="contribution_guide.html" title="next chapter">How to contribute</a></ul>
|
||||
</li>
|
||||
</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/dev/commits.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
294
dev/contribution_guide.html
Normal file
294
dev/contribution_guide.html
Normal file
@@ -0,0 +1,294 @@
|
||||
<!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>How to contribute — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Extended Types" href="extended_types.html" />
|
||||
<link rel="prev" title="Git Commits & Change Management" href="commits.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="extended_types.html" title="Extended Types"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="commits.html" title="Git Commits & Change Management"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">How to contribute</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="how-to-contribute">
|
||||
<span id="id1"></span><h1>How to contribute<a class="headerlink" href="#how-to-contribute" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#prime-directives-privacy-hackability" id="id3">Prime directives: Privacy, Hackability</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#privacy-by-design" id="id4">Privacy-by-design</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#code" id="id5">Code</a></p></li>
|
||||
<li><p><a class="reference internal" href="#translation" id="id6">Translation</a></p></li>
|
||||
<li><p><a class="reference internal" href="#documentation" id="id7">Documentation</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#live-build" id="id8">Live build</a></p></li>
|
||||
<li><p><a class="reference internal" href="#deploy-on-github-io" id="id9">deploy on github.io</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="prime-directives-privacy-hackability">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Prime directives: Privacy, Hackability</a><a class="headerlink" href="#prime-directives-privacy-hackability" title="Link to this heading">¶</a></h2>
|
||||
<p>SearXNG has two prime directives, <strong>privacy-by-design and hackability</strong> . The
|
||||
hackability comes in three levels:</p>
|
||||
<ul class="simple">
|
||||
<li><p>support of search engines</p></li>
|
||||
<li><p>plugins to alter search behaviour</p></li>
|
||||
<li><p>hacking SearXNG itself</p></li>
|
||||
</ul>
|
||||
<p>Note the lack of “world domination” among the directives. SearXNG has no
|
||||
intention of wide mass-adoption, rounded corners, etc. The prime directive
|
||||
“privacy” deserves a separate chapter, as it’s quite uncommon unfortunately.</p>
|
||||
<section id="privacy-by-design">
|
||||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Privacy-by-design</a><a class="headerlink" href="#privacy-by-design" title="Link to this heading">¶</a></h3>
|
||||
<p>SearXNG was born out of the need for a <strong>privacy-respecting</strong> search tool which
|
||||
can be extended easily to maximize both its search and its privacy protecting
|
||||
capabilities.</p>
|
||||
<p>Some widely used search engine features may work differently,
|
||||
may be turned off by default, or may not be implemented at all in SearXNG
|
||||
<strong>as a consequence of a privacy-by-design approach</strong>.</p>
|
||||
<p>Following this approach, features reducing the privacy preserving aspects of SearXNG should be
|
||||
switched off by default or should not be implemented at all. There are plenty of
|
||||
search engines already providing such features. If a feature reduces
|
||||
SearXNG’s efficacy in protecting a user’s privacy, the user must be informed about
|
||||
the effect of choosing to enable it. Features that protect privacy but differ from the
|
||||
expectations of the user should also be carefully explained to them.</p>
|
||||
<p>Also, if you think that something works weird with SearXNG, it might be because
|
||||
the tool you are using is designed in a way that interferes with SearXNG’s privacy aspects.
|
||||
Submitting a bug report to the vendor of the tool that misbehaves might be a good
|
||||
feedback for them to reconsider the disrespect to their customers (e.g., <code class="docutils literal notranslate"><span class="pre">GET</span></code> vs <code class="docutils literal notranslate"><span class="pre">POST</span></code>
|
||||
requests in various browsers).</p>
|
||||
<p>Remember the other prime directive of SearXNG is to be hackable, so if the above
|
||||
privacy concerns do not fancy you, simply fork it.</p>
|
||||
<blockquote>
|
||||
<div><p><em>Happy hacking.</em></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</section>
|
||||
<section id="code">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Code</a><a class="headerlink" href="#code" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Create good commits!</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="commits.html#create-commit"><span class="std std-ref">Git Commits & Change Management</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>In order to submit a patch, please follow the steps below:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Follow coding conventions.</p>
|
||||
<ul>
|
||||
<li><p><a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP8</a> standards apply, except the convention of line length</p></li>
|
||||
<li><p>Maximum line length is 120 characters</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p>The cardinal rule for creating good commits is to ensure there is only one
|
||||
<em>logical change</em> per commit / read <a class="reference external" href="https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes">Structural split of changes</a></p></li>
|
||||
<li><p>Check if your code breaks existing tests. If so, update the tests or fix your
|
||||
code.</p></li>
|
||||
<li><p>If your code can be unit-tested, add unit tests.</p></li>
|
||||
<li><p>Add yourself to the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/AUTHORS.rst">git://AUTHORS.rst</a> file.</p></li>
|
||||
<li><p>Choose meaningful commit messages, see <a class="reference internal" href="commits.html#create-commit"><span class="std std-ref">Git Commits & Change Management</span></a></p></li>
|
||||
<li><p>Create a pull request.</p></li>
|
||||
</ul>
|
||||
<p>For more help on getting started with SearXNG development, see <a class="reference internal" href="quickstart.html#devquickstart"><span class="std std-ref">Development Quickstart</span></a>.</p>
|
||||
</section>
|
||||
<section id="translation">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Translation</a><a class="headerlink" href="#translation" title="Link to this heading">¶</a></h2>
|
||||
<p>Translation currently takes place on <a class="reference internal" href="translation.html#translation"><span class="std std-ref">weblate</span></a>.</p>
|
||||
</section>
|
||||
<section id="documentation">
|
||||
<span id="contrib-docs"></span><h2><a class="toc-backref" href="#id7" role="doc-backlink">Documentation</a><a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">The reST sources</p>
|
||||
<p>has been moved from <code class="docutils literal notranslate"><span class="pre">gh-branch</span></code> into <code class="docutils literal notranslate"><span class="pre">master</span></code> (<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/docs">git://docs</a>).</p>
|
||||
</aside>
|
||||
<p>The documentation is built using <a class="reference external" href="https://www.sphinx-doc.org">Sphinx</a>. So in order to be able to generate
|
||||
the required files, you have to install it on your system. Much easier, use
|
||||
our <a class="reference internal" href="makefile.html#makefile"><span class="std std-ref">Makefile & ./manage</span></a>.</p>
|
||||
<p>Here is an example which makes a complete rebuild:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>docs.clean<span class="w"> </span>docs.html
|
||||
...
|
||||
The<span class="w"> </span>HTML<span class="w"> </span>pages<span class="w"> </span>are<span class="w"> </span><span class="k">in</span><span class="w"> </span>dist/docs.
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="live-build">
|
||||
<span id="make-docs-live"></span><h3><a class="toc-backref" href="#id8" role="doc-backlink">Live build</a><a class="headerlink" href="#live-build" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">docs.clean</p>
|
||||
<p>It is recommended to assert a complete rebuild before deploying (use
|
||||
<code class="docutils literal notranslate"><span class="pre">docs.clean</span></code>).</p>
|
||||
</aside>
|
||||
<p>Live build is like WYSIWYG. It’s the recommended way to go if you want to edit the documentation.
|
||||
The Makefile target <code class="docutils literal notranslate"><span class="pre">docs.live</span></code> builds the docs, opens
|
||||
URL in your favorite browser and rebuilds every time a reST file has been
|
||||
changed (<a class="reference internal" href="makefile.html#make-docs-clean"><span class="std std-ref">make docs.clean docs.live</span></a>).</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>docs.live
|
||||
...
|
||||
The<span class="w"> </span>HTML<span class="w"> </span>pages<span class="w"> </span>are<span class="w"> </span><span class="k">in</span><span class="w"> </span>dist/docs.
|
||||
...<span class="w"> </span>Serving<span class="w"> </span>on<span class="w"> </span>http://0.0.0.0:8000
|
||||
...<span class="w"> </span>Start<span class="w"> </span>watching<span class="w"> </span>changes
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Live builds are implemented by <a class="reference external" href="https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md">sphinx-autobuild</a>. Use environment
|
||||
<code class="docutils literal notranslate"><span class="pre">$(SPHINXOPTS)</span></code> to pass arguments to the <a class="reference external" href="https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md">sphinx-autobuild</a> command. You can
|
||||
pass any argument except for the <code class="docutils literal notranslate"><span class="pre">--host</span></code> option (which is always set to <code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code>).
|
||||
E.g., to find and use a free port, use:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nv">SPHINXOPTS</span><span class="o">=</span><span class="s2">"--port 0"</span><span class="w"> </span>make<span class="w"> </span>docs.live
|
||||
...
|
||||
...<span class="w"> </span>Serving<span class="w"> </span>on<span class="w"> </span>http://0.0.0.0:50593
|
||||
...
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="deploy-on-github-io">
|
||||
<span id="id2"></span><h3><a class="toc-backref" href="#id9" role="doc-backlink">deploy on github.io</a><a class="headerlink" href="#deploy-on-github-io" title="Link to this heading">¶</a></h3>
|
||||
<p>To deploy documentation at <a class="extlink-docs reference external" href="https://docs.searxng.org//.">github.io</a> use Makefile target <a class="reference internal" href="makefile.html#make-docs-gh-pages"><span class="std std-ref">make docs.gh-pages</span></a>, which builds the documentation and runs all the needed git add,
|
||||
commit and push:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>docs.clean<span class="w"> </span>docs.gh-pages
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>If you are working in your own brand, don’t forget to adjust your
|
||||
<a class="reference internal" href="../admin/settings/settings_brand.html#settings-brand"><span class="std std-ref">brand:</span></a>.</p>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</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="../index.html">
|
||||
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<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="commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">How to contribute</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#prime-directives-privacy-hackability">Prime directives: Privacy, Hackability</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#privacy-by-design">Privacy-by-design</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#code">Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#translation">Translation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#documentation">Documentation</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#live-build">Live build</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#deploy-on-github-io">deploy on github.io</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</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="makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="commits.html" title="previous chapter">Git Commits & Change Management</a>
|
||||
<li>Next: <a href="extended_types.html" title="next chapter">Extended Types</a></ul>
|
||||
</li>
|
||||
</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/dev/contribution_guide.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
217
dev/engines/demo/demo_offline.html
Normal file
217
dev/engines/demo/demo_offline.html
Normal file
@@ -0,0 +1,217 @@
|
||||
<!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>Demo Offline Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Command Line Engines" href="../offline/command-line-engines.html" />
|
||||
<link rel="prev" title="Offline Concept" href="../offline_concept.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="../offline/command-line-engines.html" title="Command Line Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../offline_concept.html" title="Offline Concept"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Demo Offline Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="demo-offline-engine">
|
||||
<span id="id1"></span><h1>Demo Offline Engine<a class="headerlink" href="#demo-offline-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.demo_offline">Within this module we implement a <em>demo offline engine</em>. Do not look to
|
||||
close to the implementation, its just a simple example.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>To get in use of this <em>demo</em> engine add the following entry to your engines list
|
||||
in <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my offline engine</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo_offline</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
|
||||
<span class="w"> </span><span class="nt">disabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_offline.CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_offline.</span></span><span class="sig-name descname"><span class="pre">CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../enginelib.html#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><span class="pre">EngineCache</span></a></em><a class="headerlink" href="#searx.engines.demo_offline.CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values after <code class="docutils literal notranslate"><span class="pre">expire</span></code>
|
||||
seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_offline.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_offline.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_offline.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_offline.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Dynamic setup of the engine settings.</p>
|
||||
<p>The origin of this demo engine is a simple json string which is loaded in
|
||||
this example while the engine is initialized.</p>
|
||||
<p>For more details see <a class="reference internal" href="../enginelib.html#searx.enginelib.Engine.setup" title="searx.enginelib.Engine.setup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.Engine.setup</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_offline.init">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_offline.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_offline.html#init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_offline.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the engine.</p>
|
||||
<p>For more details see <a class="reference internal" href="../enginelib.html#searx.enginelib.Engine.init" title="searx.enginelib.Engine.init"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.Engine.init</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_offline.search">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_offline.</span></span><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.abstract.RequestParams" title="searx.search.processors.abstract.RequestParams"><span class="pre">RequestParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_offline.html#search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_offline.search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Query (offline) engine and return results. Assemble the list of results
|
||||
from your local engine.</p>
|
||||
<p>In this demo engine we ignore the ‘query’ term, usual you would pass the
|
||||
‘query’ term to your local engine to filter out the results.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline/sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="../offline_concept.html" title="previous chapter">Offline Concept</a>
|
||||
<li>Next: <a href="../offline/command-line-engines.html" title="next chapter">Command Line Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/demo/demo_offline.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
271
dev/engines/demo/demo_online.html
Normal file
271
dev/engines/demo/demo_online.html
Normal file
@@ -0,0 +1,271 @@
|
||||
<!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>Demo Online Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="XPath Engine" href="../xpath.html" />
|
||||
<link rel="prev" title="Engine Overview" href="../engine_overview.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="../xpath.html" title="XPath Engine"
|
||||
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 (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Demo Online Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="demo-online-engine">
|
||||
<span id="id1"></span><h1>Demo Online Engine<a class="headerlink" href="#demo-online-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.demo_online">Within this module we implement a <em>demo online engine</em>. Do not look to
|
||||
close to the implementation, its just a simple example which queries <a class="reference external" href="https://www.artic.edu">The Art
|
||||
Institute of Chicago</a></p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>To get in use of this <em>demo</em> engine add the following entry to your engines
|
||||
list in <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my online engine</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo_online</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">demo</span>
|
||||
<span class="w"> </span><span class="nt">disabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_online.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_online.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams" title="searx.search.processors.online.OnlineParams"><span class="pre">OnlineParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_online.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_online.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Dynamic setup of the engine settings.</p>
|
||||
<p>For more details see <a class="reference internal" href="../enginelib.html#searx.enginelib.Engine.setup" title="searx.enginelib.Engine.setup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.Engine.setup</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_online.init">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_online.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_online.html#init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_online.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the engine.</p>
|
||||
<p>For more details see <a class="reference internal" href="../enginelib.html#searx.enginelib.Engine.init" title="searx.enginelib.Engine.init"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.Engine.init</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_online.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_online.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams" title="searx.search.processors.online.OnlineParams"><span class="pre">OnlineParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_online.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_online.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build up the <code class="docutils literal notranslate"><span class="pre">params</span></code> for the online request. In this example we build a
|
||||
URL to fetch images from <a class="reference external" href="https://artic.edu">artic.edu</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.demo_online.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.demo_online.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../extended_types.html#searx.extended_types.SXNG_Response" title="searx.extended_types.SXNG_Response"><span class="pre">SXNG_Response</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/demo_online.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.demo_online.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse out the result items from the response. In this example we parse the
|
||||
response from <a class="reference external" href="https://artic.edu">api.artic.edu</a> and filter out all
|
||||
images.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../online/zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="../engine_overview.html" title="previous chapter">Engine Overview</a>
|
||||
<li>Next: <a href="../xpath.html" title="next chapter">XPath Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/demo/demo_online.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
545
dev/engines/engine_overview.html
Normal file
545
dev/engines/engine_overview.html
Normal file
@@ -0,0 +1,545 @@
|
||||
<!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>Engine Overview — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Demo Online Engine" href="demo/demo_online.html" />
|
||||
<link rel="prev" title="SearXNG’s engines loader" href="engines.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="demo/demo_online.html" title="Demo Online Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="engines.html" title="SearXNG’s engines loader"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Engine Overview</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="engine-overview">
|
||||
<span id="engines-dev"></span><h1>Engine Overview<a class="headerlink" href="#engine-overview" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#general-engine-configuration" id="id10">General Engine Configuration</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#engine-file" id="id11">Engine File</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-settings-yml" id="id12">Engine <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#overrides" id="id13">Overrides</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#making-a-request" id="id14">Making a Request</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#passed-arguments-request" id="id15">Passed Arguments (request)</a></p></li>
|
||||
<li><p><a class="reference internal" href="#specify-request" id="id16">Specify Request</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#making-a-response" id="id17">Making a Response</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Further reading ..</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../user/configured_engines.html#configured-engines"><span class="std std-ref">Configured Engines</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">engines:</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>SearXNG is a <a class="reference external" href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch-engine</a>, so it uses different search engines to provide
|
||||
better results.</p>
|
||||
<p>Because there is no general search API which could be used for every search
|
||||
engine, an adapter has to be built between SearXNG and the external search
|
||||
engines. Adapters are stored under the folder <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines">git://searx/engines</a>.</p>
|
||||
<section id="general-engine-configuration">
|
||||
<span id="id1"></span><h2><a class="toc-backref" href="#id10" role="doc-backlink">General Engine Configuration</a><a class="headerlink" href="#general-engine-configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>It is required to tell SearXNG the type of results the engine provides. The
|
||||
arguments can be set in the engine file or in the settings file (normally
|
||||
<code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>). The arguments in the settings file override the ones in the
|
||||
engine file.</p>
|
||||
<p>It does not matter if an option is stored in the engine file or in the settings.
|
||||
However, the standard way is the following:</p>
|
||||
<section id="engine-file">
|
||||
<span id="id2"></span><h3><a class="toc-backref" href="#id11" role="doc-backlink">Engine File</a><a class="headerlink" href="#engine-file" title="Link to this heading">¶</a></h3>
|
||||
<table class="docutils align-default" id="id3" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 2 </span><span class="caption-text">Common options in the engine module</span><a class="headerlink" href="#id3" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>categories</p></td>
|
||||
<td><p>list</p></td>
|
||||
<td><p>categories, in which the engine is working</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>paging</p></td>
|
||||
<td><p>boolean</p></td>
|
||||
<td><p>support multiple pages</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>time_range_support</p></td>
|
||||
<td><p>boolean</p></td>
|
||||
<td><p>support search time range</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>engine_type</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">online</span></code> <a class="reference internal" href="index.html#online-engines"><span class="std std-ref">[ref]</span></a> by
|
||||
default, other possibles values are:</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">offline</span></code> <a class="reference internal" href="index.html#offline-engines"><span class="std std-ref">[ref]</span></a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">online_dictionary</span></code> <a class="reference internal" href="index.html#online-dictionary"><span class="std std-ref">[ref]</span></a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">online_currency</span></code> <a class="reference internal" href="index.html#online-currency"><span class="std std-ref">[ref]</span></a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">online_url_search</span></code> <a class="reference internal" href="index.html#online-url-search"><span class="std std-ref">[ref]</span></a></p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="engine-settings-yml">
|
||||
<span id="engine-settings"></span><h3><a class="toc-backref" href="#id12" role="doc-backlink">Engine <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a><a class="headerlink" href="#engine-settings-yml" title="Link to this heading">¶</a></h3>
|
||||
<p>For a more detailed description, see <a class="reference internal" href="../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">engines:</span></a> in the <a class="reference internal" href="../../admin/settings/settings.html#settings-yml"><span class="std std-ref">settings.yml</span></a>.</p>
|
||||
<table class="docutils align-default" id="id4" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 3 </span><span class="caption-text">Common options in the engine setup (<code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>)</span><a class="headerlink" href="#id4" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>name</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>name of search-engine</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>engine</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>name of searxng-engine (file name without <code class="docutils literal notranslate"><span class="pre">.py</span></code>)</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>enable_http</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>enable HTTP (by default only HTTPS is enabled).</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>shortcut</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>shortcut of search-engine</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>timeout</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>specific timeout for search-engine</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>display_error_messages</p></td>
|
||||
<td><p>boolean</p></td>
|
||||
<td><p>display error messages on the web UI</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>proxies</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p>set proxies for a specific engine
|
||||
(e.g. <code class="docutils literal notranslate"><span class="pre">proxies</span> <span class="pre">:</span> <span class="pre">{http:</span> <span class="pre">socks5://proxy:port,</span>
|
||||
<span class="pre">https:</span> <span class="pre">socks5://proxy:port}</span></code>)</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="overrides">
|
||||
<span id="engine-overrides"></span><h3><a class="toc-backref" href="#id13" role="doc-backlink">Overrides</a><a class="headerlink" href="#overrides" title="Link to this heading">¶</a></h3>
|
||||
<p>A few of the options have default values in the namespace of the engine’s python
|
||||
module, but are often overwritten by the settings. If <code class="docutils literal notranslate"><span class="pre">None</span></code> is assigned to an
|
||||
option in the engine file, it has to be redefined in the settings, otherwise
|
||||
SearXNG will not start with that engine (global names with a leading underline can
|
||||
be <code class="docutils literal notranslate"><span class="pre">None</span></code>).</p>
|
||||
<p>Here is an very simple example of the global names in the namespace of engine’s
|
||||
module:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># engine dependent config</span>
|
||||
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'general'</span><span class="p">]</span>
|
||||
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
<span class="n">_non_overwritten_global</span> <span class="o">=</span> <span class="s1">'foo'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<table class="docutils align-default" id="id5" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 4 </span><span class="caption-text">The naming of overrides is arbitrary / recommended overrides are:</span><a class="headerlink" href="#id5" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>base_url</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>base-url, can be overwritten to use same
|
||||
engine on other URL</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>number_of_results</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p>maximum number of results per request</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>language</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>ISO code of language and country like en_US</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>api_key</p></td>
|
||||
<td><p>string</p></td>
|
||||
<td><p>api-key if required by engine</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
</section>
|
||||
<section id="making-a-request">
|
||||
<span id="engine-request"></span><h2><a class="toc-backref" href="#id14" role="doc-backlink">Making a Request</a><a class="headerlink" href="#making-a-request" title="Link to this heading">¶</a></h2>
|
||||
<p>To perform a search an URL have to be specified. In addition to specifying an
|
||||
URL, arguments can be passed to the query.</p>
|
||||
<section id="passed-arguments-request">
|
||||
<span id="engine-request-arguments"></span><h3><a class="toc-backref" href="#id15" role="doc-backlink">Passed Arguments (request)</a><a class="headerlink" href="#passed-arguments-request" title="Link to this heading">¶</a></h3>
|
||||
<p>These arguments can be used to construct the search query. Furthermore,
|
||||
parameters with default value can be redefined for special purposes.</p>
|
||||
<span id="engine-request-online"></span><table class="docutils align-default" id="id6" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 5 </span><span class="caption-text">If the <code class="docutils literal notranslate"><span class="pre">engine_type</span></code> is <a class="reference internal" href="../../src/searx.search.processors.html#searx.search.processors.online.OnlineProcessor.get_params" title="searx.search.processors.online.OnlineProcessor.get_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">online</span></code></a></span><a class="headerlink" href="#id6" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>default-value, information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>url</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>method</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">'GET'</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>headers</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">{}</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>data</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">{}</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>cookies</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">{}</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>verify</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">True</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>headers.User-Agent</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>a random User-Agent</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>category</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>current category, like <code class="docutils literal notranslate"><span class="pre">'general'</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>safesearch</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, between <code class="docutils literal notranslate"><span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">2</span></code> (normal, moderate, strict)</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>time_range</p></td>
|
||||
<td><p>Optional[str]</p></td>
|
||||
<td><p><code class="docutils literal notranslate"><span class="pre">None</span></code>, can be <code class="docutils literal notranslate"><span class="pre">day</span></code>, <code class="docutils literal notranslate"><span class="pre">week</span></code>, <code class="docutils literal notranslate"><span class="pre">month</span></code>, <code class="docutils literal notranslate"><span class="pre">year</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>pageno</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p>current pagenumber</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>searxng_locale</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>SearXNG’s locale selected by user. Specific language code like
|
||||
<code class="docutils literal notranslate"><span class="pre">'en'</span></code>, <code class="docutils literal notranslate"><span class="pre">'en-US'</span></code>, or <code class="docutils literal notranslate"><span class="pre">'all'</span></code> if unspecified.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span id="engine-request-online-dictionary"></span><table class="docutils align-default" id="id7" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 6 </span><span class="caption-text">If the <code class="docutils literal notranslate"><span class="pre">engine_type</span></code> is <a class="reference internal" href="../../src/searx.search.processors.html#searx.search.processors.online_dictionary.OnlineDictionaryProcessor.get_params" title="searx.search.processors.online_dictionary.OnlineDictionaryProcessor.get_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">online_dictionary</span></code></a>,
|
||||
in addition to the <a class="reference internal" href="#engine-request-online"><span class="std std-ref">online</span></a> arguments:</span><a class="headerlink" href="#id7" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>default-value, information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>from_lang</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>specific language code like <code class="docutils literal notranslate"><span class="pre">'en_US'</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>to_lang</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>specific language code like <code class="docutils literal notranslate"><span class="pre">'en_US'</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>query</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>the text query without the languages</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span id="engine-request-online-currency"></span><table class="docutils align-default" id="id8" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 7 </span><span class="caption-text">If the <code class="docutils literal notranslate"><span class="pre">engine_type</span></code> is <a class="reference internal" href="../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrencyProcessor.get_params" title="searx.search.processors.online_currency.OnlineCurrencyProcessor.get_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">online_currency</span></code></a>,
|
||||
in addition to the <a class="reference internal" href="#engine-request-online"><span class="std std-ref">online</span></a> arguments:</span><a class="headerlink" href="#id8" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>default-value, information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>amount</p></td>
|
||||
<td><p>float</p></td>
|
||||
<td><p>the amount to convert</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>from</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>ISO 4217 code</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>to</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>ISO 4217 code</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>from_name</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>currency name</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>to_name</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>currency name</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span id="engine-request-online-url-search"></span><table class="docutils align-default" id="id9" style="width: 100%">
|
||||
<caption><span class="caption-number">Table 8 </span><span class="caption-text">If the <code class="docutils literal notranslate"><span class="pre">engine_type</span></code> is <a class="reference internal" href="../../src/searx.search.processors.html#searx.search.processors.online_url_search.OnlineUrlSearchProcessor.get_params" title="searx.search.processors.online_url_search.OnlineUrlSearchProcessor.get_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">online_url_search</span></code></a>,
|
||||
in addition to the <a class="reference internal" href="#engine-request-online"><span class="std std-ref">online</span></a> arguments:</span><a class="headerlink" href="#id9" title="Link to this table">¶</a></caption>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>default-value, information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>search_url</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p>URLs from the search query:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||||
<span class="s1">'http'</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="s1">'ftp'</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="s1">'data:image'</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="specify-request">
|
||||
<h3><a class="toc-backref" href="#id16" role="doc-backlink">Specify Request</a><a class="headerlink" href="#specify-request" title="Link to this heading">¶</a></h3>
|
||||
<p>The function <a class="reference internal" href="demo/demo_online.html#searx.engines.demo_online.request" title="searx.engines.demo_online.request"><code class="xref py py-func docutils literal notranslate"><span class="pre">def</span> <span class="pre">request(query,</span> <span class="pre">params):</span></code></a> always returns the <code class="docutils literal notranslate"><span class="pre">params</span></code> variable, the
|
||||
following parameters can be used to specify a search request:</p>
|
||||
<table class="docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>argument</p></th>
|
||||
<th class="head"><p>type</p></th>
|
||||
<th class="head"><p>information</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>url</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>requested url</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>method</p></td>
|
||||
<td><p>str</p></td>
|
||||
<td><p>HTTP request method</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>headers</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p>HTTP header information</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>data</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p>HTTP data information</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>cookies</p></td>
|
||||
<td><p>dict</p></td>
|
||||
<td><p>HTTP cookies</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>verify</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Performing SSL-Validity check</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>allow_redirects</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>Follow redirects</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>max_redirects</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p>maximum redirects, hard limit</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>soft_max_redirects</p></td>
|
||||
<td><p>int</p></td>
|
||||
<td><p>maximum redirects, soft limit. Record an error but don’t stop the engine</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>raise_for_httperror</p></td>
|
||||
<td><p>bool</p></td>
|
||||
<td><p>True by default: raise an exception if the HTTP code of response is >= 300</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
</section>
|
||||
<section id="making-a-response">
|
||||
<h2><a class="toc-backref" href="#id17" role="doc-backlink">Making a Response</a><a class="headerlink" href="#making-a-response" title="Link to this heading">¶</a></h2>
|
||||
<p>In the <code class="docutils literal notranslate"><span class="pre">response</span></code> function of the engine, the HTTP response (<code class="docutils literal notranslate"><span class="pre">resp</span></code>) is
|
||||
parsed and a list of results is returned.</p>
|
||||
<p>A engine can append result-items of different media-types and different
|
||||
result-types to the result list. The list of the result items is render to HTML
|
||||
by templates. For more details read section:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../templates.html#simple-theme-templates"><span class="std std-ref">Simple Theme Templates</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../result_types/index.html#result-types"><span class="std std-ref">Result Types</span></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Engine Overview</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#general-engine-configuration">General Engine Configuration</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#engine-file">Engine File</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#engine-settings-yml">Engine <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#overrides">Overrides</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#making-a-request">Making a Request</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#passed-arguments-request">Passed Arguments (request)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#specify-request">Specify Request</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#making-a-response">Making a Response</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#engine-types">Engine Types</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="engines.html" title="previous chapter">SearXNG’s engines loader</a>
|
||||
<li>Next: <a href="demo/demo_online.html" title="next chapter">Demo Online Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/engine_overview.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
720
dev/engines/enginelib.html
Normal file
720
dev/engines/enginelib.html
Normal file
@@ -0,0 +1,720 @@
|
||||
<!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>Engine Library — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="SearXNG’s engines loader" href="engines.html" />
|
||||
<link rel="prev" title="Engine Implementations" href="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="engines.html" title="SearXNG’s engines loader"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Engine Implementations"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Engine Library</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.enginelib">
|
||||
<span id="engine-library"></span><span id="searx-enginelib"></span><h1>Engine Library<a class="headerlink" href="#module-searx.enginelib" title="Link to this heading">¶</a></h1>
|
||||
<p>Implementations of the framework for the SearXNG engines.</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.EngineCache</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.enginelib.Engine" title="searx.enginelib.Engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.Engine</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.enginelib.traits" title="searx.enginelib.traits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.traits</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>There is a command line for developer purposes and for deeper analysis. Here is
|
||||
an example in which the command line is called in the development environment:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./manage pyenv.cmd bash --norc --noprofile
|
||||
(py3) python -m searx.enginelib --help
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>The long term goal is to modularize all implementations of the engine
|
||||
framework here in this Python package. ToDo:</p>
|
||||
<ul class="simple">
|
||||
<li><p>move implementations of the <a class="reference internal" href="engines.html#searx-engines-loader"><span class="std std-ref">SearXNG’s engines loader</span></a> to a new module in
|
||||
the <a class="reference internal" href="#module-searx.enginelib" title="searx.enginelib"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib</span></code></a> namespace.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<hr class="docutils" />
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.EngineCache">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.enginelib.</span></span><span class="sig-name descname"><span class="pre">EngineCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">expire</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib.html#EngineCache"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.EngineCache" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values again after
|
||||
<code class="docutils literal notranslate"><span class="pre">expire</span></code> seconds (default/max: <a class="reference internal" href="../../src/searx.cache.html#searx.cache.ExpireCacheCfg.MAXHOLD_TIME" title="searx.cache.ExpireCacheCfg.MAXHOLD_TIME"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MAXHOLD_TIME</span></code></a>). This class is a wrapper around
|
||||
<a class="reference internal" href="#searx.enginelib.ENGINES_CACHE" title="searx.enginelib.ENGINES_CACHE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ENGINES_CACHE</span></code></a> (<a class="reference internal" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite" title="searx.cache.ExpireCacheSQLite"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ExpireCacheSQLite</span></code></a>).</p>
|
||||
<p>In the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/demo_offline.py">git://searx/engines/demo_offline.py</a> engine you can find an
|
||||
exemplary implementation of such a cache other examples are implemented
|
||||
in:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/radio_browser.py">git://searx/engines/radio_browser.py</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/soundcloud.py">git://searx/engines/soundcloud.py</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/startpage.py">git://searx/engines/startpage.py</a></p></li>
|
||||
</ul>
|
||||
<p>For introspection of the DB, jump into developer environment and run command to
|
||||
show cache state:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./manage pyenv.cmd bash --norc --noprofile
|
||||
(py3) python -m searx.enginelib cache state
|
||||
|
||||
cache tables and key/values
|
||||
===========================
|
||||
[demo_offline ] 2025-04-22 11:32:50 count --> (int) 4
|
||||
[startpage ] 2025-04-22 12:32:30 SC_CODE --> (str) fSOBnhEMlDfE20
|
||||
[duckduckgo ] 2025-04-22 12:32:31 4dff493e.... --> (str) 4-128634958369380006627592672385352473325
|
||||
[duckduckgo ] 2025-04-22 12:40:06 3e2583e2.... --> (str) 4-263126175288871260472289814259666848451
|
||||
[radio_browser ] 2025-04-23 11:33:08 servers --> (list) ['https://de2.api.radio-browser.info', ...]
|
||||
[soundcloud ] 2025-04-29 11:40:06 guest_client_id --> (str) EjkRJG0BLNEZquRiPZYdNtJdyGtTuHdp
|
||||
[wolframalpha ] 2025-04-22 12:40:06 code --> (str) 5aa79f86205ad26188e0e26e28fb7ae7
|
||||
number of tables: 6
|
||||
number of key/value pairs: 7
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>In the “cache tables and key/values” section, the table name (engine name) is at
|
||||
first position on the second there is the calculated expire date and on the
|
||||
third and fourth position the key/value is shown.</p>
|
||||
<p>About duckduckgo: The <em>vqd coode</em> of ddg depends on the query term and therefore
|
||||
the key is a hash value of the query term (to not to store the raw query term).</p>
|
||||
<p>In the “properties of ENGINES_CACHE” section all properties of the SQLiteAppl /
|
||||
ExpireCache and their last modification date are shown:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">properties</span> <span class="n">of</span> <span class="n">ENGINES_CACHE</span>
|
||||
<span class="o">===========================</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">32</span><span class="p">:</span><span class="mi">27</span><span class="p">]</span> <span class="n">DB_SCHEMA</span> <span class="p">:</span> <span class="mi">1</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">32</span><span class="p">:</span><span class="mi">27</span><span class="p">]</span> <span class="n">LAST_MAINTENANCE</span> <span class="p">:</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">32</span><span class="p">:</span><span class="mi">27</span><span class="p">]</span> <span class="n">crypt_hash</span> <span class="p">:</span> <span class="n">ca612e3566fdfd7cf7efe</span><span class="o">...</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">32</span><span class="p">:</span><span class="mi">30</span><span class="p">]</span> <span class="n">CACHE</span><span class="o">-</span><span class="n">TABLE</span><span class="o">--</span><span class="n">demo_offline</span><span class="p">:</span> <span class="n">demo_offline</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">32</span><span class="p">:</span><span class="mi">30</span><span class="p">]</span> <span class="n">CACHE</span><span class="o">-</span><span class="n">TABLE</span><span class="o">--</span><span class="n">startpage</span><span class="p">:</span> <span class="n">startpage</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">32</span><span class="p">:</span><span class="mi">31</span><span class="p">]</span> <span class="n">CACHE</span><span class="o">-</span><span class="n">TABLE</span><span class="o">--</span><span class="n">duckduckgo</span><span class="p">:</span> <span class="n">duckduckgo</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">33</span><span class="p">:</span><span class="mi">08</span><span class="p">]</span> <span class="n">CACHE</span><span class="o">-</span><span class="n">TABLE</span><span class="o">--</span><span class="n">radio_browser</span><span class="p">:</span> <span class="n">radio_browser</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">06</span><span class="p">]</span> <span class="n">CACHE</span><span class="o">-</span><span class="n">TABLE</span><span class="o">--</span><span class="n">soundcloud</span><span class="p">:</span> <span class="n">soundcloud</span>
|
||||
<span class="p">[</span><span class="n">last</span> <span class="n">modified</span><span class="p">:</span> <span class="mi">2025</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span> <span class="mi">11</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">06</span><span class="p">]</span> <span class="n">CACHE</span><span class="o">-</span><span class="n">TABLE</span><span class="o">--</span><span class="n">wolframalpha</span><span class="p">:</span> <span class="n">wolframalpha</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>These properties provide information about the state of the ExpireCache and
|
||||
control the behavior. For example, the maintenance intervals are controlled by
|
||||
the last modification date of the LAST_MAINTENANCE property and the hash value
|
||||
of the password can be used to detect whether the password has been changed (in
|
||||
this case the DB entries can no longer be decrypted and the entire cache must be
|
||||
discarded).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.enginelib.</span></span><span class="sig-name descname"><span class="pre">Engine</span></span><a class="reference internal" href="../../_modules/searx/enginelib.html#Engine"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.Engine" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Class of engine instances build from YAML settings.</p>
|
||||
<p>Further documentation see <a class="reference internal" href="engine_overview.html#general-engine-configuration"><span class="std std-ref">General Engine Configuration</span></a>.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>This class is currently never initialized and only used for type hinting.</p>
|
||||
</div>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.engine_type">
|
||||
<span class="sig-name descname"><span class="pre">engine_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.engine_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Type of the engine (<a class="reference internal" href="../../src/searx.search.processors.html#searx-search-processors"><span class="std std-ref">Search processors</span></a>)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.paging">
|
||||
<span class="sig-name descname"><span class="pre">paging</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.paging" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports multiple pages.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.max_page">
|
||||
<span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#searx.enginelib.Engine.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If the engine supports paging, then this is the value for the last page
|
||||
that is still supported. <code class="docutils literal notranslate"><span class="pre">0</span></code> means unlimited numbers of pages.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.time_range_support">
|
||||
<span class="sig-name descname"><span class="pre">time_range_support</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.time_range_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports search time range.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.safesearch">
|
||||
<span class="sig-name descname"><span class="pre">safesearch</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.safesearch" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports SafeSearch</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.language_support">
|
||||
<span class="sig-name descname"><span class="pre">language_support</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.language_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports languages (locales) search.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.language">
|
||||
<span class="sig-name descname"><span class="pre">language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.language" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>For an engine, when there is <code class="docutils literal notranslate"><span class="pre">language:</span> <span class="pre">...</span></code> in the YAML settings the engine
|
||||
does support only this one language:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google french</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fr</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.region">
|
||||
<span class="sig-name descname"><span class="pre">region</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.region" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>For an engine, when there is <code class="docutils literal notranslate"><span class="pre">region:</span> <span class="pre">...</span></code> in the YAML settings the engine
|
||||
does support only this one region:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="n">code</span><span class="p">::</span> <span class="n">yaml</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>name: google belgium
|
||||
engine: google
|
||||
region: fr-BE</p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.fetch_traits">
|
||||
<span class="sig-name descname"><span class="pre">fetch_traits</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.Engine.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Function to to fetch engine’s traits from origin.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.traits">
|
||||
<span class="sig-name descname"><span class="pre">traits</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">traits.EngineTraits</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Traits of the engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.categories">
|
||||
<span class="sig-name descname"><span class="pre">categories</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.Engine.categories" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Specifies to which <a class="reference internal" href="../../admin/settings/settings_engines.html#engine-categories"><span class="std std-ref">categories</span></a> the engine should be added.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.name">
|
||||
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.name" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name that will be used across SearXNG to define this engine. In settings, on
|
||||
the result page ..</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.engine">
|
||||
<span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.engine" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the python file used to handle requests and responses to and from
|
||||
this search engine (file name from <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines">git://searx/engines</a> without
|
||||
<code class="docutils literal notranslate"><span class="pre">.py</span></code>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.enable_http">
|
||||
<span class="sig-name descname"><span class="pre">enable_http</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.enable_http" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Enable HTTP (by default only HTTPS is enabled).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.shortcut">
|
||||
<span class="sig-name descname"><span class="pre">shortcut</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.shortcut" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Code used to execute bang requests (<code class="docutils literal notranslate"><span class="pre">!foo</span></code>)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.timeout">
|
||||
<span class="sig-name descname"><span class="pre">timeout</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><span class="pre">float</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.timeout" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Specific timeout for search-engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.display_error_messages">
|
||||
<span class="sig-name descname"><span class="pre">display_error_messages</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.display_error_messages" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Display error messages on the web UI.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.proxies">
|
||||
<span class="sig-name descname"><span class="pre">proxies</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.Engine.proxies" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Set proxies for a specific engine (YAML):</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">proxies </span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">socks5://proxy:port</span>
|
||||
<span class="w"> </span><span class="nt">https</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">socks5://proxy:port</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.disabled">
|
||||
<span class="sig-name descname"><span class="pre">disabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.disabled" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>To disable by default the engine, but not deleting it. It will allow the
|
||||
user to manually activate it in the settings.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.inactive">
|
||||
<span class="sig-name descname"><span class="pre">inactive</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.inactive" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Remove the engine from the settings (<em>disabled & removed</em>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.about">
|
||||
<span class="sig-name descname"><span class="pre">about</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.Engine.about" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Additional fields describing the engine.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">about</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">website</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://example.com</span>
|
||||
<span class="w"> </span><span class="nt">wikidata_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Q306656</span>
|
||||
<span class="w"> </span><span class="nt">official_api_documentation</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://example.com/api-doc</span>
|
||||
<span class="w"> </span><span class="nt">use_official_api</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">require_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">results</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HTML</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.using_tor_proxy">
|
||||
<span class="sig-name descname"><span class="pre">using_tor_proxy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.using_tor_proxy" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Using tor proxy (<code class="docutils literal notranslate"><span class="pre">true</span></code>) or not (<code class="docutils literal notranslate"><span class="pre">false</span></code>) for this engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.send_accept_language_header">
|
||||
<span class="sig-name descname"><span class="pre">send_accept_language_header</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.send_accept_language_header" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>When this option is activated, the language (locale) that is selected by
|
||||
the user is used to build and send a <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header in the
|
||||
request to the origin search engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.tokens">
|
||||
<span class="sig-name descname"><span class="pre">tokens</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.Engine.tokens" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A list of secret tokens to make this engine <em>private</em>, more details see
|
||||
<a class="reference internal" href="../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.weight">
|
||||
<span class="sig-name descname"><span class="pre">weight</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></em><a class="headerlink" href="#searx.enginelib.Engine.weight" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Weighting of the results of this engine (<a class="reference internal" href="../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">weight</span></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.setup">
|
||||
<span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib.html#Engine.setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.Engine.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Dynamic setup of the engine settings.</p>
|
||||
<p>With this method, the engine’s setup is carried out. For example, to
|
||||
check or dynamically adapt the values handed over in the parameter
|
||||
<code class="docutils literal notranslate"><span class="pre">engine_settings</span></code>. The return value (True/False) indicates whether
|
||||
the setup was successful and the engine can be built or rejected.</p>
|
||||
<p>The method is optional and is called synchronously as part of the
|
||||
initialization of the service and is therefore only suitable for simple
|
||||
(local) exams/changes at the engine setting. The <a class="reference internal" href="#searx.enginelib.Engine.init" title="searx.enginelib.Engine.init"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Engine.init</span></code></a>
|
||||
method must be used for longer tasks in which values of a remote must be
|
||||
determined, for example.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.init">
|
||||
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib.html#Engine.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.Engine.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the engine.</p>
|
||||
<p>The method is optional and asynchronous (in a thread). It is suitable,
|
||||
for example, for setting up a cache (for the engine) or for querying
|
||||
values (required by the engine) from a remote.</p>
|
||||
<p>Whether the initialization was successful can be indicated by the return
|
||||
value <code class="docutils literal notranslate"><span class="pre">True</span></code> or even <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If no return value is given from this init method (<code class="docutils literal notranslate"><span class="pre">None</span></code>), this is
|
||||
equivalent to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
|
||||
<li><p>If an exception is thrown as part of the initialization, this is
|
||||
equivalent to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.search">
|
||||
<em class="property"><span class="k"><span class="pre">abstractmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">OfflineParamTypes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib.html#Engine.search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.Engine.search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Search method of the <code class="docutils literal notranslate"><span class="pre">offline</span></code> engines</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.request">
|
||||
<em class="property"><span class="k"><span class="pre">abstractmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">OnlineParamTypes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib.html#Engine.request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.Engine.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Method to build the parameters for the request of an <code class="docutils literal notranslate"><span class="pre">online</span></code>
|
||||
engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.Engine.response">
|
||||
<em class="property"><span class="k"><span class="pre">abstractmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Response" title="searx.extended_types.SXNG_Response"><span class="pre">SXNG_Response</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib.html#Engine.response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.Engine.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Method to parse the response of an <code class="docutils literal notranslate"><span class="pre">online</span></code> engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.ENGINES_CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.enginelib.</span></span><span class="sig-name descname"><span class="pre">ENGINES_CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite" title="searx.cache.ExpireCacheSQLite"><span class="pre">ExpireCacheSQLite</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><searx.cache.ExpireCacheSQLite</span> <span class="pre">object></span></em><a class="headerlink" href="#searx.enginelib.ENGINES_CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Global <a class="reference internal" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite" title="searx.cache.ExpireCacheSQLite"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.cache.ExpireCacheSQLite</span></code></a> instance where the cached
|
||||
values from all engines are stored. The <cite>MAXHOLD_TIME</cite> is 7 days and the
|
||||
<cite>MAINTENANCE_PERIOD</cite> is set to two hours.</p>
|
||||
</dd></dl>
|
||||
|
||||
<section id="module-searx.enginelib.traits">
|
||||
<span id="engine-traits"></span><span id="searx-enginelib-traits"></span><h2>Engine traits<a class="headerlink" href="#module-searx.enginelib.traits" title="Link to this heading">¶</a></h2>
|
||||
<p>Engine’s traits are fetched from the origin engines and stored in a JSON file
|
||||
in the <em>data folder</em>. Most often traits are languages and region codes and
|
||||
their mapping from SearXNG’s representation to the representation in the origin
|
||||
search engine. For new traits new properties can be added to the class
|
||||
<a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><code class="xref py py-class docutils literal notranslate"><span class="pre">EngineTraits</span></code></a>.</p>
|
||||
<p>To load traits from the persistence <a class="reference internal" href="#searx.enginelib.traits.EngineTraitsMap.from_data" title="searx.enginelib.traits.EngineTraitsMap.from_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EngineTraitsMap.from_data</span></code></a> can be
|
||||
used.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsEncoder">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.enginelib.traits.</span></span><span class="sig-name descname"><span class="pre">EngineTraitsEncoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipkeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ensure_ascii</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_circular</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_nan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separators</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraitsEncoder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsEncoder" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Encodes <a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><code class="xref py py-class docutils literal notranslate"><span class="pre">EngineTraits</span></code></a> to a serializable object, see
|
||||
<a class="reference external" href="https://docs.python.org/3/library/json.html#json.JSONEncoder" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">json.JSONEncoder</span></code></a>.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsEncoder.default">
|
||||
<span class="sig-name descname"><span class="pre">default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">o</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraitsEncoder.default"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsEncoder.default" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return dictionary of a <a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><code class="xref py py-class docutils literal notranslate"><span class="pre">EngineTraits</span></code></a> object.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.enginelib.traits.</span></span><span class="sig-name descname"><span class="pre">EngineTraits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">regions:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">languages:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_locale:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_type:</span> <span class="pre">~typing.Literal['traits_v1']</span> <span class="pre">=</span> <span class="pre">'traits_v1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">~typing.Any]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The class is intended to be instantiated for each engine.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.regions">
|
||||
<span class="sig-name descname"><span class="pre">regions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.regions" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps SearXNG’s internal representation of a region to the one of the engine.</p>
|
||||
<p>SearXNG’s internal representation can be parsed by babel and the value is
|
||||
send to the engine:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">regions</span> <span class="o">=</span><span class="p">{</span>
|
||||
<span class="s1">'fr-BE'</span> <span class="p">:</span> <span class="o"><</span><span class="n">engine</span><span class="s1">'s region name>,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">egnine_region</span> <span class="n">regions</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
<span class="n">searxng_region</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">'-'</span><span class="p">)</span>
|
||||
<span class="o">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.languages">
|
||||
<span class="sig-name descname"><span class="pre">languages</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.languages" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps SearXNG’s internal representation of a language to the one of the engine.</p>
|
||||
<p>SearXNG’s internal representation can be parsed by babel and the value is
|
||||
send to the engine:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">languages</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'ca'</span> <span class="p">:</span> <span class="o"><</span><span class="n">engine</span><span class="s1">'s language name>,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">egnine_lang</span> <span class="ow">in</span> <span class="n">languages</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
<span class="n">searxng_lang</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
||||
<span class="o">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.all_locale">
|
||||
<span class="sig-name descname"><span class="pre">all_locale</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.all_locale" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>To which locale value SearXNG’s <code class="docutils literal notranslate"><span class="pre">all</span></code> language is mapped (shown a “Default
|
||||
language”).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.data_type">
|
||||
<span class="sig-name descname"><span class="pre">data_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'traits_v1'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'traits_v1'</span></em><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.data_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Data type, default is ‘traits_v1’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.custom">
|
||||
<span class="sig-name descname"><span class="pre">custom</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.custom" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A place to store engine’s custom traits, not related to the SearXNG core.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.get_language">
|
||||
<span class="sig-name descname"><span class="pre">get_language</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">searxng_locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits.get_language"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.get_language" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return engine’s language string that <em>best fits</em> to SearXNG’s locale.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>searxng_locale</strong> – SearXNG’s internal representation of locale
|
||||
selected by the user.</p></li>
|
||||
<li><p><strong>default</strong> – engine’s default language</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The <em>best fits</em> rules are implemented in
|
||||
<a class="reference internal" href="../../src/searx.locales.html#searx.locales.get_engine_locale" title="searx.locales.get_engine_locale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.locales.get_engine_locale</span></code></a>. Except for the special value <code class="docutils literal notranslate"><span class="pre">all</span></code>
|
||||
which is determined from <a class="reference internal" href="#searx.enginelib.traits.EngineTraits.all_locale" title="searx.enginelib.traits.EngineTraits.all_locale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EngineTraits.all_locale</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.get_region">
|
||||
<span class="sig-name descname"><span class="pre">get_region</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">searxng_locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits.get_region"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.get_region" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return engine’s region string that best fits to SearXNG’s locale.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>searxng_locale</strong> – SearXNG’s internal representation of locale
|
||||
selected by the user.</p></li>
|
||||
<li><p><strong>default</strong> – engine’s default region</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The <em>best fits</em> rules are implemented in
|
||||
<a class="reference internal" href="../../src/searx.locales.html#searx.locales.get_engine_locale" title="searx.locales.get_engine_locale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.locales.get_engine_locale</span></code></a>. Except for the special value <code class="docutils literal notranslate"><span class="pre">all</span></code>
|
||||
which is determined from <a class="reference internal" href="#searx.enginelib.traits.EngineTraits.all_locale" title="searx.enginelib.traits.EngineTraits.all_locale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EngineTraits.all_locale</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.is_locale_supported">
|
||||
<span class="sig-name descname"><span class="pre">is_locale_supported</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">searxng_locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits.is_locale_supported"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.is_locale_supported" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A <em>locale</em> (SearXNG’s internal representation) is considered to be
|
||||
supported by the engine if the <em>region</em> or the <em>language</em> is supported
|
||||
by the engine.</p>
|
||||
<p>For verification the functions <a class="reference internal" href="#searx.enginelib.traits.EngineTraits.get_region" title="searx.enginelib.traits.EngineTraits.get_region"><code class="xref py py-func docutils literal notranslate"><span class="pre">EngineTraits.get_region()</span></code></a> and
|
||||
<a class="reference internal" href="#searx.enginelib.traits.EngineTraits.get_language" title="searx.enginelib.traits.EngineTraits.get_language"><code class="xref py py-func docutils literal notranslate"><span class="pre">EngineTraits.get_language()</span></code></a> are used.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.copy">
|
||||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.copy" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Create a copy of the dataclass object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.fetch_traits">
|
||||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.enginelib.Engine" title="searx.enginelib.Engine"><span class="pre">Engine</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/types.html#types.ModuleType" title="(in Python v3.14)"><span class="pre">types.ModuleType</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits.fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Call a function <code class="docutils literal notranslate"><span class="pre">fetch_traits(engine_traits)</span></code> from engines namespace to fetch
|
||||
and set properties from the origin engine in the object <code class="docutils literal notranslate"><span class="pre">engine_traits</span></code>. If
|
||||
function does not exists, <code class="docutils literal notranslate"><span class="pre">None</span></code> is returned.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraits.set_traits">
|
||||
<span class="sig-name descname"><span class="pre">set_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.enginelib.Engine" title="searx.enginelib.Engine"><span class="pre">Engine</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/types.html#types.ModuleType" title="(in Python v3.14)"><span class="pre">types.ModuleType</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraits.set_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraits.set_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Set traits from self object in a <a class="reference internal" href="#searx.enginelib.Engine" title="searx.enginelib.Engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Engine</span></code></a> namespace.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>engine</strong> – engine instance build by <a class="reference internal" href="engines.html#searx.engines.load_engine" title="searx.engines.load_engine"><code class="xref py py-func docutils literal notranslate"><span class="pre">searx.engines.load_engine()</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsMap">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.enginelib.traits.</span></span><span class="sig-name descname"><span class="pre">EngineTraitsMap</span></span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraitsMap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsMap" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A python dictionary to map <a class="reference internal" href="#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><code class="xref py py-class docutils literal notranslate"><span class="pre">EngineTraits</span></code></a> by engine name.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsMap.ENGINE_TRAITS_FILE">
|
||||
<span class="sig-name descname"><span class="pre">ENGINE_TRAITS_FILE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.14)"><span class="pre">Path</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PosixPath('/home/runner/work/searxng/searxng/searx/data/engine_traits.json')</span></em><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsMap.ENGINE_TRAITS_FILE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>File with persistence of the <a class="reference internal" href="#searx.enginelib.traits.EngineTraitsMap" title="searx.enginelib.traits.EngineTraitsMap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EngineTraitsMap</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsMap.save_data">
|
||||
<span class="sig-name descname"><span class="pre">save_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraitsMap.save_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsMap.save_data" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Store EngineTraitsMap in in file <code class="xref py py-obj docutils literal notranslate"><span class="pre">self.ENGINE_TRAITS_FILE</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsMap.from_data">
|
||||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#searx.enginelib.traits.EngineTraitsMap" title="searx.enginelib.traits.EngineTraitsMap"><span class="pre">EngineTraitsMap</span></a></span></span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraitsMap.from_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsMap.from_data" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Instantiate <a class="reference internal" href="#searx.enginelib.traits.EngineTraitsMap" title="searx.enginelib.traits.EngineTraitsMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">EngineTraitsMap</span></code></a> object from <code class="xref py py-obj docutils literal notranslate"><span class="pre">ENGINE_TRAITS</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.enginelib.traits.EngineTraitsMap.set_traits">
|
||||
<span class="sig-name descname"><span class="pre">set_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.enginelib.Engine" title="searx.enginelib.Engine"><span class="pre">Engine</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/types.html#types.ModuleType" title="(in Python v3.14)"><span class="pre">types.ModuleType</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/enginelib/traits.html#EngineTraitsMap.set_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.enginelib.traits.EngineTraitsMap.set_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Set traits in a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Engine</span></code> namespace.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>engine</strong> – engine instance build by <a class="reference internal" href="engines.html#searx.engines.load_engine" title="searx.engines.load_engine"><code class="xref py py-func docutils literal notranslate"><span class="pre">searx.engines.load_engine()</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Engine Library</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.enginelib.EngineCache"><code class="docutils literal notranslate"><span class="pre">EngineCache</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.enginelib.Engine"><code class="docutils literal notranslate"><span class="pre">Engine</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.engine_type"><code class="docutils literal notranslate"><span class="pre">Engine.engine_type</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.paging"><code class="docutils literal notranslate"><span class="pre">Engine.paging</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.max_page"><code class="docutils literal notranslate"><span class="pre">Engine.max_page</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.time_range_support"><code class="docutils literal notranslate"><span class="pre">Engine.time_range_support</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.safesearch"><code class="docutils literal notranslate"><span class="pre">Engine.safesearch</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.language_support"><code class="docutils literal notranslate"><span class="pre">Engine.language_support</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.language"><code class="docutils literal notranslate"><span class="pre">Engine.language</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.region"><code class="docutils literal notranslate"><span class="pre">Engine.region</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.fetch_traits"><code class="docutils literal notranslate"><span class="pre">Engine.fetch_traits</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.traits"><code class="docutils literal notranslate"><span class="pre">Engine.traits</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.categories"><code class="docutils literal notranslate"><span class="pre">Engine.categories</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.name"><code class="docutils literal notranslate"><span class="pre">Engine.name</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.engine"><code class="docutils literal notranslate"><span class="pre">Engine.engine</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.enable_http"><code class="docutils literal notranslate"><span class="pre">Engine.enable_http</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.shortcut"><code class="docutils literal notranslate"><span class="pre">Engine.shortcut</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.timeout"><code class="docutils literal notranslate"><span class="pre">Engine.timeout</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.display_error_messages"><code class="docutils literal notranslate"><span class="pre">Engine.display_error_messages</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.proxies"><code class="docutils literal notranslate"><span class="pre">Engine.proxies</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.disabled"><code class="docutils literal notranslate"><span class="pre">Engine.disabled</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.inactive"><code class="docutils literal notranslate"><span class="pre">Engine.inactive</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.about"><code class="docutils literal notranslate"><span class="pre">Engine.about</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.using_tor_proxy"><code class="docutils literal notranslate"><span class="pre">Engine.using_tor_proxy</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.send_accept_language_header"><code class="docutils literal notranslate"><span class="pre">Engine.send_accept_language_header</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.tokens"><code class="docutils literal notranslate"><span class="pre">Engine.tokens</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.weight"><code class="docutils literal notranslate"><span class="pre">Engine.weight</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.setup"><code class="docutils literal notranslate"><span class="pre">Engine.setup()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.init"><code class="docutils literal notranslate"><span class="pre">Engine.init()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.search"><code class="docutils literal notranslate"><span class="pre">Engine.search()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.request"><code class="docutils literal notranslate"><span class="pre">Engine.request()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.Engine.response"><code class="docutils literal notranslate"><span class="pre">Engine.response()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.enginelib.ENGINES_CACHE"><code class="docutils literal notranslate"><span class="pre">ENGINES_CACHE</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#module-searx.enginelib.traits">Engine traits</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.traits.EngineTraitsEncoder"><code class="docutils literal notranslate"><span class="pre">EngineTraitsEncoder</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.traits.EngineTraits"><code class="docutils literal notranslate"><span class="pre">EngineTraits</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.enginelib.traits.EngineTraitsMap"><code class="docutils literal notranslate"><span class="pre">EngineTraitsMap</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#engine-types">Engine Types</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">Engine Implementations</a>
|
||||
<li>Next: <a href="engines.html" title="next chapter">SearXNG’s engines loader</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/enginelib.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
226
dev/engines/engines.html
Normal file
226
dev/engines/engines.html
Normal file
File diff suppressed because one or more lines are too long
437
dev/engines/index.html
Normal file
437
dev/engines/index.html
Normal file
@@ -0,0 +1,437 @@
|
||||
<!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>Engine Implementations — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Engine Library" href="enginelib.html" />
|
||||
<link rel="prev" title="Extended Types" href="../extended_types.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="enginelib.html" title="Engine Library"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../extended_types.html" title="Extended Types"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Engine Implementations</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="engine-implementations">
|
||||
<span id="id1"></span><h1>Engine Implementations<a class="headerlink" href="#engine-implementations" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#resultlist-and-engines" id="id7">ResultList and engines</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-types" id="id8">Engine Types</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#online-engines" id="id9">Online Engines</a></p></li>
|
||||
<li><p><a class="reference internal" href="#offline-engines" id="id10">Offline Engines</a></p></li>
|
||||
<li><p><a class="reference internal" href="#online-url-search" id="id11">Online URL Search</a></p></li>
|
||||
<li><p><a class="reference internal" href="#online-currency" id="id12">Online Currency</a></p></li>
|
||||
<li><p><a class="reference internal" href="#online-dictionary" id="id13">Online Dictionary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Framework Components</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="enginelib.html">Engine Library</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="enginelib.html#searx.enginelib.EngineCache"><code class="docutils literal notranslate"><span class="pre">EngineCache</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="enginelib.html#searx.enginelib.Engine"><code class="docutils literal notranslate"><span class="pre">Engine</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="enginelib.html#searx.enginelib.ENGINES_CACHE"><code class="docutils literal notranslate"><span class="pre">ENGINES_CACHE</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="enginelib.html#module-searx.enginelib.traits">Engine traits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines.html#searx.engines.engines"><code class="docutils literal notranslate"><span class="pre">engines</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines.html#searx.engines.engine_shortcuts"><code class="docutils literal notranslate"><span class="pre">engine_shortcuts</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines.html#searx.engines.load_engine"><code class="docutils literal notranslate"><span class="pre">load_engine()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines.html#searx.engines.is_missing_required_attributes"><code class="docutils literal notranslate"><span class="pre">is_missing_required_attributes()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines.html#searx.engines.using_tor_proxy"><code class="docutils literal notranslate"><span class="pre">using_tor_proxy()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines.html#searx.engines.load_engines"><code class="docutils literal notranslate"><span class="pre">load_engines()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="engine_overview.html">Engine Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html#general-engine-configuration">General Engine Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html#making-a-request">Making a Request</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html#making-a-response">Making a Response</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<section id="resultlist-and-engines">
|
||||
<h2><a class="toc-backref" href="#id7" role="doc-backlink">ResultList and engines</a><a class="headerlink" href="#resultlist-and-engines" title="Link to this heading">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.result_types.ResultList">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types.</span></span><span class="sig-name descname"><span class="pre">ResultList</span></span><a class="reference internal" href="../../_modules/searx/result_types.html#ResultList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types.ResultList" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base class of all result lists (abstract).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.result_types.EngineResults">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types.</span></span><span class="sig-name descname"><span class="pre">EngineResults</span></span><a class="reference internal" href="../../_modules/searx/result_types.html#EngineResults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types.EngineResults" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Result list that should be used by engine developers. For convenience,
|
||||
engine developers don’t need to import types / see <code class="xref py py-obj docutils literal notranslate"><span class="pre">ResultList.types</span></code>.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span>
|
||||
<span class="o">...</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-></span> <span class="n">EngineResults</span><span class="p">:</span>
|
||||
<span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
|
||||
<span class="o">...</span>
|
||||
<span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span> <span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="s2">"lorem ipsum .."</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="s2">"https://example.org"</span><span class="p">)</span> <span class="p">)</span>
|
||||
<span class="o">...</span>
|
||||
<span class="k">return</span> <span class="n">res</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="engine-types">
|
||||
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Engine Types</a><a class="headerlink" href="#engine-types" title="Link to this heading">¶</a></h2>
|
||||
<p>The <a class="reference internal" href="enginelib.html#searx.enginelib.Engine.engine_type" title="searx.enginelib.Engine.engine_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">engine_type</span></code></a> of an engine
|
||||
determines which <a class="reference internal" href="../../src/searx.search.processors.html#searx-search-processors"><span class="std std-ref">search processor</span></a> is used by
|
||||
the engine.</p>
|
||||
<p>In this section a list of the engines that are documented is given, a complete
|
||||
list of the engines can be found in the source under: <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines">git://searx/engines</a>.</p>
|
||||
<section id="online-engines">
|
||||
<span id="id2"></span><h3><a class="toc-backref" href="#id9" role="doc-backlink">Online Engines</a><a class="headerlink" href="#online-engines" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../src/searx.search.processors.html#module-searx.search.processors.online" title="searx.search.processors.online"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processors.online</span></code></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="json_engine.html">JSON Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/core.html">CORE</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online/zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="offline-engines">
|
||||
<span id="id3"></span><h3><a class="toc-backref" href="#id10" role="doc-backlink">Offline Engines</a><a class="headerlink" href="#offline-engines" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../src/searx.search.processors.html#module-searx.search.processors.offline" title="searx.search.processors.offline"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processors.offline</span></code></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="offline/sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="online-url-search">
|
||||
<span id="id4"></span><h3><a class="toc-backref" href="#id11" role="doc-backlink">Online URL Search</a><a class="headerlink" href="#online-url-search" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../src/searx.search.processors.html#module-searx.search.processors.online_url_search" title="searx.search.processors.online_url_search"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processors.online_url_search</span></code></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="online-currency">
|
||||
<span id="id5"></span><h3><a class="toc-backref" href="#id12" role="doc-backlink">Online Currency</a><a class="headerlink" href="#online-currency" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../src/searx.search.processors.html#module-searx.search.processors.online_currency" title="searx.search.processors.online_currency"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processors.online_currency</span></code></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><em>no engine of this type is documented yet / coming soon</em></p>
|
||||
</section>
|
||||
<section id="online-dictionary">
|
||||
<span id="id6"></span><h3><a class="toc-backref" href="#id13" role="doc-backlink">Online Dictionary</a><a class="headerlink" href="#online-dictionary" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../src/searx.search.processors.html#module-searx.search.processors.online_dictionary" title="searx.search.processors.online_dictionary"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processors.online_dictionary</span></code></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><em>no engine of this type is documented yet / coming soon</em></p>
|
||||
</section>
|
||||
</section>
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Engine Implementations</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#resultlist-and-engines">ResultList and engines</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.result_types.ResultList"><code class="docutils literal notranslate"><span class="pre">ResultList</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.result_types.EngineResults"><code class="docutils literal notranslate"><span class="pre">EngineResults</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#engine-types">Engine Types</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#online-engines">Online Engines</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#offline-engines">Offline Engines</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#online-url-search">Online URL Search</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="../extended_types.html" title="previous chapter">Extended Types</a>
|
||||
<li>Next: <a href="enginelib.html" title="next chapter">Engine Library</a></ul>
|
||||
</li>
|
||||
</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/dev/engines/index.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
530
dev/engines/json_engine.html
Normal file
530
dev/engines/json_engine.html
Normal file
@@ -0,0 +1,530 @@
|
||||
<!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>JSON Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Adobe Stock" href="online/adobe_stock.html" />
|
||||
<link rel="prev" title="MediaWiki Engine" href="mediawiki.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="online/adobe_stock.html" title="Adobe Stock"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="mediawiki.html" title="MediaWiki Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">JSON Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="json-engine">
|
||||
<span id="json-engine-engine"></span><h1>JSON Engine<a class="headerlink" href="#json-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#example" id="id2">Example</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.json_engine">The JSON engine is a <em>generic</em> engine with which it is possible to configure
|
||||
engines in the settings.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>Request:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.search_url" title="searx.engines.json_engine.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.lang_all" title="searx.engines.json_engine.lang_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lang_all</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.soft_max_redirects" title="searx.engines.json_engine.soft_max_redirects"><code class="xref py py-obj docutils literal notranslate"><span class="pre">soft_max_redirects</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.method" title="searx.engines.json_engine.method"><code class="xref py py-obj docutils literal notranslate"><span class="pre">method</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.request_body" title="searx.engines.json_engine.request_body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">request_body</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.cookies" title="searx.engines.json_engine.cookies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cookies</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.headers" title="searx.engines.json_engine.headers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">headers</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Paging:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.paging" title="searx.engines.json_engine.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.page_size" title="searx.engines.json_engine.page_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_size</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.first_page_num" title="searx.engines.json_engine.first_page_num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">first_page_num</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Time Range:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.time_range_support" title="searx.engines.json_engine.time_range_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_support</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.time_range_url" title="searx.engines.json_engine.time_range_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.time_range_map" title="searx.engines.json_engine.time_range_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_map</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Safe-Search:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.safe_search_support" title="searx.engines.json_engine.safe_search_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">safe_search_support</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.safe_search_map" title="searx.engines.json_engine.safe_search_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">safe_search_map</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Response:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.title_html_to_text" title="searx.engines.json_engine.title_html_to_text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">title_html_to_text</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.content_html_to_text" title="searx.engines.json_engine.content_html_to_text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">content_html_to_text</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.no_result_for_http_status" title="searx.engines.json_engine.no_result_for_http_status"><code class="xref py py-obj docutils literal notranslate"><span class="pre">no_result_for_http_status</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>JSON query:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.results_query" title="searx.engines.json_engine.results_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_query</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.url_query" title="searx.engines.json_engine.url_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url_query</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.url_prefix" title="searx.engines.json_engine.url_prefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url_prefix</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.title_query" title="searx.engines.json_engine.title_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">title_query</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.content_query" title="searx.engines.json_engine.content_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">content_query</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.thumbnail_query" title="searx.engines.json_engine.thumbnail_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">thumbnail_query</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.thumbnail_prefix" title="searx.engines.json_engine.thumbnail_prefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">thumbnail_prefix</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.json_engine.suggestion_query" title="searx.engines.json_engine.suggestion_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">suggestion_query</span></code></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Example</a><a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
||||
<p>Here is a simple example of a JSON engine configure in the <a class="reference internal" href="../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">engines:</span></a> section, further read <a class="reference internal" href="engine_overview.html#engines-dev"><span class="std std-ref">Engine Overview</span></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mdn</span>
|
||||
<span class="w"> </span><span class="nt">engine </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">json_engine</span>
|
||||
<span class="w"> </span><span class="nt">paging </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="w"> </span><span class="nt">search_url </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://developer.mozilla.org/api/v1/search?q={query}&page={pageno}</span>
|
||||
<span class="w"> </span><span class="nt">results_query </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">documents</span>
|
||||
<span class="w"> </span><span class="nt">url_query </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mdn_url</span>
|
||||
<span class="w"> </span><span class="nt">url_prefix </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://developer.mozilla.org</span>
|
||||
<span class="w"> </span><span class="nt">title_query </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">title</span>
|
||||
<span class="w"> </span><span class="nt">content_query </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">summary</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.search_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">search_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.json_engine.search_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Search URL of the engine. Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://example.org/?search={query}&page={pageno}{time_range}{safe_search}
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Replacements are:</p>
|
||||
<dl>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{query}</span></code>:</dt><dd><p>Search terms from user.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{pageno}</span></code>:</dt><dd><p>Page number if engine supports paging <a class="reference internal" href="#searx.engines.json_engine.paging" title="searx.engines.json_engine.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a></p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{lang}</span></code>:</dt><dd><p>ISO 639-1 language code (en, de, fr ..)</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{time_range}</span></code>:</dt><dd><p><a class="reference internal" href="#searx.engines.json_engine.time_range_url" title="searx.engines.json_engine.time_range_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">URL</span> <span class="pre">parameter</span></code></a> if engine <a class="reference internal" href="#searx.engines.json_engine.time_range_support" title="searx.engines.json_engine.time_range_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">supports</span> <span class="pre">time</span>
|
||||
<span class="pre">range</span></code></a>. The value for the parameter is taken from
|
||||
<a class="reference internal" href="#searx.engines.json_engine.time_range_map" title="searx.engines.json_engine.time_range_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_map</span></code></a>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{safe_search}</span></code>:</dt><dd><p>Safe-search <a class="reference internal" href="#searx.engines.json_engine.safe_search_map" title="searx.engines.json_engine.safe_search_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">URL</span> <span class="pre">parameter</span></code></a> if engine
|
||||
<a class="reference internal" href="#searx.engines.json_engine.safe_search_support" title="searx.engines.json_engine.safe_search_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">supports</span> <span class="pre">safe-search</span></code></a>. The <code class="docutils literal notranslate"><span class="pre">{safe_search}</span></code>
|
||||
replacement is taken from the <code class="xref py py-obj docutils literal notranslate"><span class="pre">safes_search_map</span></code>. Filter results:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">0</span><span class="p">:</span> <span class="n">none</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="n">moderate</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span><span class="n">strict</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If not supported, the URL parameter is an empty string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.lang_all">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">lang_all</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'en'</span></em><a class="headerlink" href="#searx.engines.json_engine.lang_all" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Replacement <code class="docutils literal notranslate"><span class="pre">{lang}</span></code> in <a class="reference internal" href="#searx.engines.json_engine.search_url" title="searx.engines.json_engine.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a> if language <code class="docutils literal notranslate"><span class="pre">all</span></code> is
|
||||
selected.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.no_result_for_http_status">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">no_result_for_http_status</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#searx.engines.json_engine.no_result_for_http_status" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return empty result for these HTTP status codes instead of throwing an error.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">no_result_for_http_status</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.soft_max_redirects">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">soft_max_redirects</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#searx.engines.json_engine.soft_max_redirects" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maximum redirects, soft limit. Record an error but don’t stop the engine</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.method">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">method</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GET'</span></em><a class="headerlink" href="#searx.engines.json_engine.method" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Some engines might require to do POST requests for search.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.request_body">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">request_body</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.json_engine.request_body" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The body of the request. This can only be used if different <a class="reference internal" href="#searx.engines.json_engine.method" title="searx.engines.json_engine.method"><code class="xref py py-obj docutils literal notranslate"><span class="pre">method</span></code></a>
|
||||
is set, e.g. <code class="docutils literal notranslate"><span class="pre">POST</span></code>. For formatting see the documentation of <a class="reference internal" href="#searx.engines.json_engine.search_url" title="searx.engines.json_engine.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a>.</p>
|
||||
<p>Note: Curly brackets which aren’t encapsulating a replacement placeholder
|
||||
must be escaped by doubling each <code class="docutils literal notranslate"><span class="pre">{</span></code> and <code class="docutils literal notranslate"><span class="pre">}</span></code>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">request_body</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">>-</span>
|
||||
<span class="w"> </span><span class="no">{{</span>
|
||||
<span class="w"> </span><span class="no">"search": "{query}",</span>
|
||||
<span class="w"> </span><span class="no">"page": {pageno},</span>
|
||||
<span class="w"> </span><span class="no">"extra": {{</span>
|
||||
<span class="w"> </span><span class="no">"time_range": {time_range},</span>
|
||||
<span class="w"> </span><span class="no">"rating": "{safe_search}"</span>
|
||||
<span class="w"> </span><span class="no">}}</span>
|
||||
<span class="w"> </span><span class="no">}}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.cookies">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">cookies</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#searx.engines.json_engine.cookies" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Some engines might offer different result based on cookies.
|
||||
Possible use-case: To set safesearch cookie.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.headers">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#searx.engines.json_engine.headers" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Some engines might offer different result based on cookies or headers.
|
||||
Possible use-case: To set safesearch cookie or header to moderate.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.paging">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">paging</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.json_engine.paging" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports paging [True or False].</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.page_size">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">page_size</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#searx.engines.json_engine.page_size" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Number of results on each page. Only needed if the site requires not a page
|
||||
number, but an offset.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.first_page_num">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">first_page_num</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#searx.engines.json_engine.first_page_num" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Number of the first page (usually 0 or 1).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.results_query">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">results_query</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.json_engine.results_query" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>JSON query for the list of result items.</p>
|
||||
<p>The query string is a slash <cite>/</cite> separated path of JSON key names.
|
||||
Array entries can be specified using the index or can be omitted entirely,
|
||||
in which case each entry is considered -
|
||||
most implementations will default to the first entry in this case.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.url_query">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">url_query</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.json_engine.url_query" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>JSON query of result’s <code class="docutils literal notranslate"><span class="pre">url</span></code>. For the query string documentation see <a class="reference internal" href="#searx.engines.json_engine.results_query" title="searx.engines.json_engine.results_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_query</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.url_prefix">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">url_prefix</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.json_engine.url_prefix" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>String to prepend to the result’s <code class="docutils literal notranslate"><span class="pre">url</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.title_query">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">title_query</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.json_engine.title_query" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>JSON query of result’s <code class="docutils literal notranslate"><span class="pre">title</span></code>. For the query string documentation see <a class="reference internal" href="#searx.engines.json_engine.results_query" title="searx.engines.json_engine.results_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_query</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.content_query">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">content_query</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.json_engine.content_query" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>JSON query of result’s <code class="docutils literal notranslate"><span class="pre">content</span></code>. For the query string documentation see <a class="reference internal" href="#searx.engines.json_engine.results_query" title="searx.engines.json_engine.results_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_query</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.thumbnail_query">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">thumbnail_query</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.json_engine.thumbnail_query" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>JSON query of result’s <code class="docutils literal notranslate"><span class="pre">thumbnail</span></code>. For the query string documentation see <a class="reference internal" href="#searx.engines.json_engine.results_query" title="searx.engines.json_engine.results_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_query</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.thumbnail_prefix">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">thumbnail_prefix</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.json_engine.thumbnail_prefix" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>String to prepend to the result’s <code class="docutils literal notranslate"><span class="pre">thumbnail</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.suggestion_query">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">suggestion_query</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.json_engine.suggestion_query" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>JSON query of result’s <code class="docutils literal notranslate"><span class="pre">suggestion</span></code>. For the query string documentation see <a class="reference internal" href="#searx.engines.json_engine.results_query" title="searx.engines.json_engine.results_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_query</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.title_html_to_text">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">title_html_to_text</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.json_engine.title_html_to_text" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Extract text from a HTML title string</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.content_html_to_text">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">content_html_to_text</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.json_engine.content_html_to_text" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Extract text from a HTML content string</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.time_range_support">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">time_range_support</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.json_engine.time_range_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports search time range.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.time_range_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">time_range_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'&hours={time_range_val}'</span></em><a class="headerlink" href="#searx.engines.json_engine.time_range_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Time range URL parameter in the in <a class="reference internal" href="#searx.engines.json_engine.search_url" title="searx.engines.json_engine.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a>. If no time range is
|
||||
requested by the user, the URL parameter is an empty string. The
|
||||
<code class="docutils literal notranslate"><span class="pre">{time_range_val}</span></code> replacement is taken from the <a class="reference internal" href="#searx.engines.json_engine.time_range_map" title="searx.engines.json_engine.time_range_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_map</span></code></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">time_range_url </span><span class="p">:</span><span class="w"> </span><span class="s">'&days={time_range_val}'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.time_range_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">time_range_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'day':</span> <span class="pre">24,</span> <span class="pre">'month':</span> <span class="pre">720,</span> <span class="pre">'week':</span> <span class="pre">168,</span> <span class="pre">'year':</span> <span class="pre">8760}</span></em><a class="headerlink" href="#searx.engines.json_engine.time_range_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps time range value from user to <code class="docutils literal notranslate"><span class="pre">{time_range_val}</span></code> in
|
||||
<a class="reference internal" href="#searx.engines.json_engine.time_range_url" title="searx.engines.json_engine.time_range_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_url</span></code></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">time_range_map</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">day</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
|
||||
<span class="w"> </span><span class="nt">week</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7</span>
|
||||
<span class="w"> </span><span class="nt">month</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">30</span>
|
||||
<span class="w"> </span><span class="nt">year</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">365</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.safe_search_support">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">safe_search_support</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.json_engine.safe_search_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports safe-search.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.safe_search_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">safe_search_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{0:</span> <span class="pre">'&filter=none',</span> <span class="pre">1:</span> <span class="pre">'&filter=moderate',</span> <span class="pre">2:</span> <span class="pre">'&filter=strict'}</span></em><a class="headerlink" href="#searx.engines.json_engine.safe_search_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps safe-search value to <code class="docutils literal notranslate"><span class="pre">{safe_search}</span></code> in <a class="reference internal" href="#searx.engines.json_engine.search_url" title="searx.engines.json_engine.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">safesearch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="nt">safes_search_map</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">0</span><span class="p">:</span><span class="w"> </span><span class="s">'&filter=none'</span>
|
||||
<span class="w"> </span><span class="nt">1</span><span class="p">:</span><span class="w"> </span><span class="s">'&filter=moderate'</span>
|
||||
<span class="w"> </span><span class="nt">2</span><span class="p">:</span><span class="w"> </span><span class="s">'&filter=strict'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/engines/json_engine.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.json_engine.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build request parameters (see <a class="reference internal" href="engine_overview.html#engine-request"><span class="std std-ref">Making a Request</span></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.json_engine.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.json_engine.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/engines/json_engine.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.json_engine.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Scrap <em>results</em> from the response (see <a class="reference internal" href="../result_types/index.html#result-types"><span class="std std-ref">Result Types</span></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="mediawiki.html" title="previous chapter">MediaWiki Engine</a>
|
||||
<li>Next: <a href="online/adobe_stock.html" title="next chapter">Adobe Stock</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/json_engine.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
309
dev/engines/mediawiki.html
Normal file
309
dev/engines/mediawiki.html
Normal file
@@ -0,0 +1,309 @@
|
||||
<!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>MediaWiki Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="JSON Engine" href="json_engine.html" />
|
||||
<link rel="prev" title="XPath Engine" href="xpath.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="json_engine.html" title="JSON Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="xpath.html" title="XPath Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">MediaWiki Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="mediawiki-engine">
|
||||
<span id="id1"></span><h1>MediaWiki Engine<a class="headerlink" href="#mediawiki-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.mediawiki">The MediaWiki engine is a <em>generic</em> engine to <strong>query</strong> Wikimedia wikis by
|
||||
the <a class="reference external" href="https://www.mediawiki.org/wiki/API:Main_page">MediaWiki Action API</a>. For a <a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=query">query action</a> all Wikimedia wikis have
|
||||
endpoints that follow this pattern:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://{base_url}/w/api.php?action=query&list=search&format=json
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>In its actual state, this engine is implemented to parse JSON result
|
||||
(<a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=json">format=json</a>) from a search query (<a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bsearch">list=search</a>). If you need other
|
||||
<code class="docutils literal notranslate"><span class="pre">action</span></code> and <code class="docutils literal notranslate"><span class="pre">list</span></code> types ask SearXNG developers to extend the
|
||||
implementation according to your needs.</p>
|
||||
</div>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>Request:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.mediawiki.base_url" title="searx.engines.mediawiki.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.mediawiki.search_type" title="searx.engines.mediawiki.search_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_type</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.mediawiki.srenablerewrites" title="searx.engines.mediawiki.srenablerewrites"><code class="xref py py-obj docutils literal notranslate"><span class="pre">srenablerewrites</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.mediawiki.srsort" title="searx.engines.mediawiki.srsort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">srsort</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.mediawiki.srprop" title="searx.engines.mediawiki.srprop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">srprop</span></code></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.search_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">search_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'nearmatch'</span></em><a class="headerlink" href="#searx.engines.mediawiki.search_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Which type of search to perform. One of the following values: <code class="docutils literal notranslate"><span class="pre">nearmatch</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">text</span></code> or <code class="docutils literal notranslate"><span class="pre">title</span></code>.</p>
|
||||
<p>See <code class="docutils literal notranslate"><span class="pre">srwhat</span></code> argument in <a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bsearch">list=search</a> documentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.srenablerewrites">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">srenablerewrites</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.mediawiki.srenablerewrites" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Enable internal query rewriting (Type: boolean). Some search backends can
|
||||
rewrite the query into another which is thought to provide better results, for
|
||||
instance by correcting spelling errors.</p>
|
||||
<p>See <code class="docutils literal notranslate"><span class="pre">srenablerewrites</span></code> argument in <a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bsearch">list=search</a> documentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.srsort">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">srsort</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'relevance'</span></em><a class="headerlink" href="#searx.engines.mediawiki.srsort" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Set the sort order of returned results. One of the following values:
|
||||
<code class="docutils literal notranslate"><span class="pre">create_timestamp_asc</span></code>, <code class="docutils literal notranslate"><span class="pre">create_timestamp_desc</span></code>, <code class="docutils literal notranslate"><span class="pre">incoming_links_asc</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">incoming_links_desc</span></code>, <code class="docutils literal notranslate"><span class="pre">just_match</span></code>, <code class="docutils literal notranslate"><span class="pre">last_edit_asc</span></code>, <code class="docutils literal notranslate"><span class="pre">last_edit_desc</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">none</span></code>, <code class="docutils literal notranslate"><span class="pre">random</span></code>, <code class="docutils literal notranslate"><span class="pre">relevance</span></code>, <code class="docutils literal notranslate"><span class="pre">user_random</span></code>.</p>
|
||||
<p>See <code class="docutils literal notranslate"><span class="pre">srenablerewrites</span></code> argument in <a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bsearch">list=search</a> documentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.srprop">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">srprop</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sectiontitle|snippet|timestamp|categorysnippet'</span></em><a class="headerlink" href="#searx.engines.mediawiki.srprop" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Which properties to return.</p>
|
||||
<p>See <code class="docutils literal notranslate"><span class="pre">srprop</span></code> argument in <a class="reference external" href="https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bsearch">list=search</a> documentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://{language}.wikipedia.org/'</span></em><a class="headerlink" href="#searx.engines.mediawiki.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base URL of the Wikimedia wiki.</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{language}</span></code>:</dt><dd><p>ISO 639-1 language code (en, de, fr ..) of the search language.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.api_path">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">api_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'w/api.php'</span></em><a class="headerlink" href="#searx.engines.mediawiki.api_path" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The path the PHP api is listening on.</p>
|
||||
<p>The default path should work fine usually.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mediawiki.timestamp_format">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mediawiki.</span></span><span class="sig-name descname"><span class="pre">timestamp_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%Y-%m-%dT%H:%M:%SZ'</span></em><a class="headerlink" href="#searx.engines.mediawiki.timestamp_format" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The longhand version of MediaWiki time strings.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="xpath.html" title="previous chapter">XPath Engine</a>
|
||||
<li>Next: <a href="json_engine.html" title="next chapter">JSON Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/mediawiki.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
253
dev/engines/offline/command-line-engines.html
Normal file
253
dev/engines/offline/command-line-engines.html
Normal file
@@ -0,0 +1,253 @@
|
||||
<!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>Command Line Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="NoSQL databases" href="nosql-engines.html" />
|
||||
<link rel="prev" title="Demo Offline Engine" href="../demo/demo_offline.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="nosql-engines.html" title="NoSQL databases"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../demo/demo_offline.html" title="Demo Offline Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Command Line Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="command-line-engines">
|
||||
<span id="engine-command"></span><h1>Command Line Engines<a class="headerlink" href="#command-line-engines" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/command.py">command.py</a></p></li>
|
||||
<li><p><a class="reference internal" href="../index.html#offline-engines"><span class="std std-ref">Offline Engines</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#example" id="id2">Example</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial 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>
|
||||
</aside>
|
||||
<p id="module-searx.engines.command">With <em>command engines</em> administrators can run engines to integrate arbitrary
|
||||
shell commands.</p>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>When creating and enabling a <code class="docutils literal notranslate"><span class="pre">command</span></code> engine on a public instance, you
|
||||
must be careful to avoid leaking private data.</p>
|
||||
</div>
|
||||
<p>The easiest solution is to limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described
|
||||
in section <a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>. The engine base is flexible. Only your
|
||||
imagination can limit the power of this engine (and maybe security concerns).</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The following options are available:</p>
|
||||
<dl>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">command</span></code>:</dt><dd><p>A comma separated list of the elements of the command. A special token
|
||||
<code class="docutils literal notranslate"><span class="pre">{{QUERY}}</span></code> tells where to put the search terms of the user. Example:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="s">'ls'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'-l'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'-h'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'{{QUERY}}'</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">delimiter</span></code>:</dt><dd><p>A mapping containing a delimiter <code class="docutils literal notranslate"><span class="pre">char</span></code> and the <em>titles</em> of each element in
|
||||
<code class="docutils literal notranslate"><span class="pre">keys</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">parse_regex</span></code>:</dt><dd><p>A dict containing the regular expressions for each result key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">query_type</span></code>:</p>
|
||||
<blockquote>
|
||||
<div><p>The expected type of user search terms. Possible values: <code class="docutils literal notranslate"><span class="pre">path</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">enum</span></code>.</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">path</span></code>:</dt><dd><p>Checks if the user provided path is inside the working directory. If not,
|
||||
the query is not executed.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">enum</span></code>:</dt><dd><p>Is a list of allowed search terms. If the user submits something which is
|
||||
not included in the list, the query returns an error.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">query_enum</span></code>:</dt><dd><p>A list containing allowed search terms if <code class="docutils literal notranslate"><span class="pre">query_type</span></code> is set to <code class="docutils literal notranslate"><span class="pre">enum</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">working_dir</span></code>:</dt><dd><p>The directory where the command has to be executed. Default: <code class="docutils literal notranslate"><span class="pre">./</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">result_separator</span></code>:</dt><dd><p>The character that separates results. Default: <code class="docutils literal notranslate"><span class="pre">\n</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Example</a><a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
||||
<p>The example engine below can be used to find files with a specific name in the
|
||||
configured working directory:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">find</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">command</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'find'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'.'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'-name'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'{{QUERY}}'</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">query_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fnd</span>
|
||||
<span class="w"> </span><span class="nt">delimiter</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">chars</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="nv"> </span><span class="s">'</span>
|
||||
<span class="w"> </span><span class="nt">keys</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'line'</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.command.check_parsing_options">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.command.</span></span><span class="sig-name descname"><span class="pre">check_parsing_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/command.html#check_parsing_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.command.check_parsing_options" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Checks if delimiter based parsing or regex parsing is configured correctly</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Command Line Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="../demo/demo_offline.html" title="previous chapter">Demo Offline Engine</a>
|
||||
<li>Next: <a href="nosql-engines.html" title="next chapter">NoSQL databases</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/offline/command-line-engines.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
304
dev/engines/offline/nosql-engines.html
Normal file
304
dev/engines/offline/nosql-engines.html
Normal file
@@ -0,0 +1,304 @@
|
||||
<!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>NoSQL databases — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Local Search APIs" href="search-indexer-engines.html" />
|
||||
<link rel="prev" title="Command Line Engines" href="command-line-engines.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="search-indexer-engines.html" title="Local Search APIs"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="command-line-engines.html" title="Command Line Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">NoSQL databases</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="nosql-databases">
|
||||
<span id="nosql-engines"></span><h1>NoSQL databases<a class="headerlink" href="#nosql-databases" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/NoSQL">NoSQL databases</a></p></li>
|
||||
<li><p><a class="reference external" href="https://valkey.io/">valkey.io</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.mongodb.com">MongoDB</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#extra-dependencies" id="id6">Extra Dependencies</a></p></li>
|
||||
<li><p><a class="reference internal" href="#configure-the-engines" id="id7">Configure the engines</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#valkey-server" id="id8">Valkey Server</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-mongodb" id="id9">MongoDB</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial 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>
|
||||
</aside>
|
||||
<p>The following <a class="reference external" href="https://en.wikipedia.org/wiki/NoSQL">NoSQL databases</a> are supported:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#engine-valkey-server"><span class="std std-ref">Valkey Server</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-mongodb"><span class="std std-ref">MongoDB</span></a></p></li>
|
||||
</ul>
|
||||
<p>All of the engines above are just commented out in the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>, as you have to set various options and install
|
||||
dependencies before using them.</p>
|
||||
<p>By default, the engines use the <code class="docutils literal notranslate"><span class="pre">key-value</span></code> template for displaying results /
|
||||
see <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/key-value.html">simple</a>
|
||||
theme. If you are not satisfied with the original result layout, you can use
|
||||
your own template, set <code class="docutils literal notranslate"><span class="pre">result_template</span></code> attribute to <code class="docutils literal notranslate"><span class="pre">{template_name}</span></code> and
|
||||
place the templates at:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">searx</span><span class="o">/</span><span class="n">templates</span><span class="o">/</span><span class="p">{</span><span class="n">theme_name</span><span class="p">}</span><span class="o">/</span><span class="n">result_templates</span><span class="o">/</span><span class="p">{</span><span class="n">template_name</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Furthermore, if you do not wish to expose these engines on a public instance, you
|
||||
can still add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described in
|
||||
section <a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
<section id="extra-dependencies">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Extra Dependencies</a><a class="headerlink" href="#extra-dependencies" title="Link to this heading">¶</a></h2>
|
||||
<p>For using <a class="reference internal" href="#engine-valkey-server"><span class="std std-ref">Valkey Server</span></a> or <a class="reference internal" href="#engine-mongodb"><span class="std std-ref">MongoDB</span></a> you need to
|
||||
install additional packages in Python’s Virtual Environment of your SearXNG
|
||||
instance. 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>) 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="configure-the-engines">
|
||||
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Configure the engines</a><a class="headerlink" href="#configure-the-engines" title="Link to this heading">¶</a></h2>
|
||||
<p><a class="reference external" href="https://en.wikipedia.org/wiki/NoSQL">NoSQL databases</a> are used for storing arbitrary data without first defining
|
||||
their structure.</p>
|
||||
<section id="valkey-server">
|
||||
<span id="engine-valkey-server"></span><h3><a class="toc-backref" href="#id8" role="doc-backlink">Valkey Server</a><a class="headerlink" href="#valkey-server" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="https://github.com/andymccurdy/valkey-py#installation">valkey</a></p></li>
|
||||
<li><p><a class="reference external" href="https://valkey.io/">valkey.io</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/valkey_server.py">valkey_server.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.valkey_server">Valkey is an open source (BSD licensed), in-memory data structure (key value
|
||||
based) store. Before configuring the <code class="docutils literal notranslate"><span class="pre">valkey_server</span></code> engine, you must install
|
||||
the dependency <a class="reference external" href="https://github.com/andymccurdy/valkey-py#installation">valkey</a>.</p>
|
||||
<section id="configuration">
|
||||
<h4>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h4>
|
||||
<p>Select a database to search in and set its index in the option <code class="docutils literal notranslate"><span class="pre">db</span></code>. You can
|
||||
either look for exact matches or use partial keywords to find what you are
|
||||
looking for by configuring <code class="docutils literal notranslate"><span class="pre">exact_match_only</span></code>.</p>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h4>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h4>
|
||||
<p>Below is an example configuration:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># Required dependency: valkey</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myvalkey</span>
|
||||
<span class="w"> </span><span class="nt">shortcut </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">rds</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">valkey_server</span>
|
||||
<span class="w"> </span><span class="nt">exact_match_only</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
<span class="w"> </span><span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="s">'127.0.0.1'</span>
|
||||
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6379</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
|
||||
<span class="w"> </span><span class="nt">db</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h4>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
</section>
|
||||
<section id="engine-mongodb">
|
||||
<span id="id2"></span><h3><a class="toc-backref" href="#id9" role="doc-backlink">MongoDB</a><a class="headerlink" href="#engine-mongodb" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="https://github.com/mongodb/mongo-python-driver#installation">pymongo</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.mongodb.com">MongoDB</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/mongodb.py">mongodb.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.mongodb"><a class="reference external" href="https://www.mongodb.com">MongoDB</a> is a document based database program that handles JSON like data.
|
||||
Before configuring the <code class="docutils literal notranslate"><span class="pre">mongodb</span></code> engine, you must install the dependency
|
||||
<a class="reference external" href="https://github.com/mongodb/mongo-python-driver#installation">pymongo</a>.</p>
|
||||
<section id="id3">
|
||||
<h4>Configuration<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>
|
||||
<p>In order to query <a class="reference external" href="https://www.mongodb.com">MongoDB</a>, you have to select a <code class="docutils literal notranslate"><span class="pre">database</span></code> and a
|
||||
<code class="docutils literal notranslate"><span class="pre">collection</span></code>. Furthermore, you have to select a <code class="docutils literal notranslate"><span class="pre">key</span></code> that is going to be
|
||||
searched. <a class="reference external" href="https://www.mongodb.com">MongoDB</a> also supports the option <code class="docutils literal notranslate"><span class="pre">exact_match_only</span></code>, so configure
|
||||
it as you wish.</p>
|
||||
</section>
|
||||
<section id="id4">
|
||||
<h4>Example<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h4>
|
||||
<p>Below is an example configuration for using a MongoDB collection:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># MongoDB engine</span>
|
||||
<span class="c1"># Required dependency: pymongo</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mymongo</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mongodb</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">md</span>
|
||||
<span class="w"> </span><span class="nt">exact_match_only</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
<span class="w"> </span><span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="s">'127.0.0.1'</span>
|
||||
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">27017</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">results_per_page</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">20</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="s">'business'</span>
|
||||
<span class="w"> </span><span class="nt">collection</span><span class="p">:</span><span class="w"> </span><span class="s">'reviews'</span><span class="w"> </span><span class="c1"># name of the db collection</span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'name'</span><span class="w"> </span><span class="c1"># key in the collection to search for</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id5">
|
||||
<h4>Implementations<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">NoSQL databases</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="command-line-engines.html" title="previous chapter">Command Line Engines</a>
|
||||
<li>Next: <a href="search-indexer-engines.html" title="next chapter">Local Search APIs</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/offline/nosql-engines.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
294
dev/engines/offline/search-indexer-engines.html
Normal file
294
dev/engines/offline/search-indexer-engines.html
Normal file
@@ -0,0 +1,294 @@
|
||||
<!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>Local Search APIs — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="SQL Engines" href="sql-engines.html" />
|
||||
<link rel="prev" title="NoSQL databases" href="nosql-engines.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="sql-engines.html" title="SQL Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="nosql-engines.html" title="NoSQL databases"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Local Search APIs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="local-search-apis">
|
||||
<h1>Local Search APIs<a class="headerlink" href="#local-search-apis" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://docs.meilisearch.com/learn/what_is_meilisearch/comparison_to_alternatives.html">Comparison to alternatives</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.meilisearch" id="id6">MeiliSearch</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.elasticsearch" id="id7">Elasticsearch</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.solr" id="id8">Solr</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial 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>
|
||||
</aside>
|
||||
<p>Administrators might find themselves wanting to integrate locally running search
|
||||
engines. The following ones are supported for now:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.meilisearch.com">Meilisearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org">Solr</a></p></li>
|
||||
</ul>
|
||||
<p>Each search engine is powerful, capable of full-text search. All of the engines
|
||||
above are added to <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> just commented out, as you have to
|
||||
<code class="docutils literal notranslate"><span class="pre">base_url</span></code> for all them.</p>
|
||||
<p>Please note that if you are not using HTTPS to access these engines, you have to
|
||||
enable HTTP requests by setting <code class="docutils literal notranslate"><span class="pre">enable_http</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
||||
<p>Furthermore, if you do not want to expose these engines on a public instance,
|
||||
you can still add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described
|
||||
in section <a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
<section id="module-searx.engines.meilisearch">
|
||||
<span id="meilisearch"></span><span id="engine-meilisearch"></span><h2><a class="toc-backref" href="#id6" role="doc-backlink">MeiliSearch</a><a class="headerlink" href="#module-searx.engines.meilisearch" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/meilisearch.py">meilisearch.py</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.meilisearch.com">MeiliSearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://docs.meilisearch.com/">MeiliSearch Documentation</a></p></li>
|
||||
<li><p><a class="reference external" href="https://docs.meilisearch.com/learn/getting_started/installation.html">Install MeiliSearch</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://www.meilisearch.com">MeiliSearch</a> is aimed at individuals and small companies. It is designed for
|
||||
small-scale (less than 10 million documents) data collections. E.g. it is great
|
||||
for storing web pages you have visited and searching in the contents later.</p>
|
||||
<p>The engine supports faceted search, so you can search in a subset of documents
|
||||
of the collection. Furthermore, you can search in <a class="reference external" href="https://www.meilisearch.com">MeiliSearch</a> instances that
|
||||
require authentication by setting <a class="reference external" href="https://www.meilisearch.com/docs/reference/api/overview#authorization">auth_key</a>.</p>
|
||||
<section id="example">
|
||||
<h3>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h3>
|
||||
<p>Here is a simple example to query a Meilisearch instance:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">meilisearch</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">meilisearch</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mes</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:7700</span>
|
||||
<span class="w"> </span><span class="nt">index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-index</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="c1"># auth_key: Bearer XXXXX</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="module-searx.engines.elasticsearch">
|
||||
<span id="elasticsearch"></span><span id="engine-elasticsearch"></span><h2><a class="toc-backref" href="#id7" role="doc-backlink">Elasticsearch</a><a class="headerlink" href="#module-searx.engines.elasticsearch" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/elasticsearch.py">elasticsearch.py</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Elasticsearch Guide</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html">Install Elasticsearch</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a> supports numerous ways to query the data it is storing. At the
|
||||
moment the engine supports the most popular search methods (<code class="docutils literal notranslate"><span class="pre">query_type</span></code>):</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">match</span></code>,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">simple_query_string</span></code>,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">term</span></code> and</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">terms</span></code>.</p></li>
|
||||
</ul>
|
||||
<p>If none of the methods fit your use case, you can select <code class="docutils literal notranslate"><span class="pre">custom</span></code> query type
|
||||
and provide the JSON payload to submit to Elasticsearch in
|
||||
<code class="docutils literal notranslate"><span class="pre">custom_query_json</span></code>.</p>
|
||||
<section id="id3">
|
||||
<h3>Example<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h3>
|
||||
<p>The following is an example configuration for an <a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a> instance with
|
||||
authentication configured to read from <code class="docutils literal notranslate"><span class="pre">my-index</span></code> index.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">elasticsearch</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">els</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">elasticsearch</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:9200</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">elastic</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">changeme</span>
|
||||
<span class="w"> </span><span class="nt">index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-index</span>
|
||||
<span class="w"> </span><span class="nt">query_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">match</span>
|
||||
<span class="w"> </span><span class="c1"># custom_query_json: '{ ... }'</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="module-searx.engines.solr">
|
||||
<span id="solr"></span><span id="engine-solr"></span><h2><a class="toc-backref" href="#id8" role="doc-backlink">Solr</a><a class="headerlink" href="#module-searx.engines.solr" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/solr.py">solr.py</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org">Solr</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org/resources.html">Solr Resources</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org/guide/installing-solr.html">Install Solr</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://solr.apache.org">Solr</a> is a popular search engine based on Lucene, just like <a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a>. But
|
||||
instead of searching in indices, you can search in collections.</p>
|
||||
<section id="id5">
|
||||
<h3>Example<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h3>
|
||||
<p>This is an example configuration for searching in the collection
|
||||
<code class="docutils literal notranslate"><span class="pre">my-collection</span></code> and get the results in ascending order.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">solr</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">solr</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slr</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:8983</span>
|
||||
<span class="w"> </span><span class="nt">collection</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-collection</span>
|
||||
<span class="w"> </span><span class="nt">sort</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">asc</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Local Search APIs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="nosql-engines.html" title="previous chapter">NoSQL databases</a>
|
||||
<li>Next: <a href="sql-engines.html" title="next chapter">SQL Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/offline/search-indexer-engines.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
510
dev/engines/offline/sql-engines.html
Normal file
510
dev/engines/offline/sql-engines.html
Normal file
@@ -0,0 +1,510 @@
|
||||
<!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>SQL Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Tineye" href="../online_url_search/tineye.html" />
|
||||
<link rel="prev" title="Local Search APIs" href="search-indexer-engines.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="../online_url_search/tineye.html" title="Tineye"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="search-indexer-engines.html" title="Local Search APIs"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">SQL Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="sql-engines">
|
||||
<span id="id1"></span><h1>SQL Engines<a class="headerlink" href="#sql-engines" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.sqlite.org/index.html">SQLite</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.postgresql.org">PostgreSQL</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.mysql.com">MySQL</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#extra-dependencies" id="id11">Extra Dependencies</a></p></li>
|
||||
<li><p><a class="reference internal" href="#configure-the-engines" id="id12">Configure the engines</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#engine-sqlite" id="id13">SQLite</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-postgresql" id="id14">PostgreSQL</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-mysql-server" id="id15">MySQL</a></p></li>
|
||||
<li><p><a class="reference internal" href="#mariadb" id="id16">MariaDB</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial 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>
|
||||
</aside>
|
||||
<p>With the <em>SQL engines</em> you can bind SQL databases into SearXNG. The following
|
||||
Relational Database Management System (RDBMS) are supported:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#engine-sqlite"><span class="std std-ref">SQLite</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-postgresql"><span class="std std-ref">PostgreSQL</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-mysql-server"><span class="std std-ref">MySQL</span></a> & <a class="reference internal" href="#engine-mariadb-server"><span class="std std-ref">MariaDB</span></a></p></li>
|
||||
</ul>
|
||||
<p>All of the engines above are just commented out in the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>, as you have to set the required attributes for the
|
||||
engines, e.g. <code class="docutils literal notranslate"><span class="pre">database:</span></code> …</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="nv">sqlite|postgresql|mysql_server</span><span class="p p-Indicator">}</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">result_template</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="nv">template_name</span><span class="p p-Indicator">}</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>By default, the engines use the <code class="docutils literal notranslate"><span class="pre">key-value</span></code> template for displaying results /
|
||||
see <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/key-value.html">simple</a>
|
||||
theme. If you are not satisfied with the original result layout, you can use
|
||||
your own template, set <code class="docutils literal notranslate"><span class="pre">result_template</span></code> attribute to <code class="docutils literal notranslate"><span class="pre">{template_name}</span></code> and
|
||||
place the templates at:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">searx</span><span class="o">/</span><span class="n">templates</span><span class="o">/</span><span class="p">{</span><span class="n">theme_name</span><span class="p">}</span><span class="o">/</span><span class="n">result_templates</span><span class="o">/</span><span class="p">{</span><span class="n">template_name</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you do not wish to expose these engines on a public instance, you can still
|
||||
add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described in section
|
||||
<a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
<section id="extra-dependencies">
|
||||
<h2><a class="toc-backref" href="#id11" role="doc-backlink">Extra Dependencies</a><a class="headerlink" href="#extra-dependencies" title="Link to this heading">¶</a></h2>
|
||||
<p>For using <a class="reference internal" href="#engine-postgresql"><span class="std std-ref">PostgreSQL</span></a> or <a class="reference internal" href="#engine-mysql-server"><span class="std std-ref">MySQL</span></a> you need to
|
||||
install additional packages in Python’s Virtual Environment of your SearXNG
|
||||
instance. 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>) 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="configure-the-engines">
|
||||
<h2><a class="toc-backref" href="#id12" role="doc-backlink">Configure the engines</a><a class="headerlink" href="#configure-the-engines" title="Link to this heading">¶</a></h2>
|
||||
<p>The configuration of the new database engines are similar. You must put a valid
|
||||
SQL-SELECT query in <code class="docutils literal notranslate"><span class="pre">query_str</span></code>. At the moment you can only bind at most one
|
||||
parameter in your query. By setting the attribute <code class="docutils literal notranslate"><span class="pre">limit</span></code> you can define how
|
||||
many results you want from the SQL server. Basically, it is the same as the
|
||||
<code class="docutils literal notranslate"><span class="pre">LIMIT</span></code> keyword in SQL.</p>
|
||||
<p>Please, do not include <code class="docutils literal notranslate"><span class="pre">LIMIT</span></code> or <code class="docutils literal notranslate"><span class="pre">OFFSET</span></code> in your SQL query as the engines
|
||||
rely on these keywords during paging. If you want to configure the number of
|
||||
returned results use the option <code class="docutils literal notranslate"><span class="pre">limit</span></code>.</p>
|
||||
<section id="engine-sqlite">
|
||||
<span id="id2"></span><h3><a class="toc-backref" href="#id13" role="doc-backlink">SQLite</a><a class="headerlink" href="#engine-sqlite" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/sqlite.py">sqlite.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.sqlite">SQLite is a small, fast and reliable SQL database engine. It does not require
|
||||
any extra dependency.</p>
|
||||
<section id="configuration">
|
||||
<h4>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h4>
|
||||
<p>The engine has the following (additional) settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.sqlite.result_type" title="searx.engines.sqlite.result_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">result_type</span></code></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h4>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h4>
|
||||
<p>To demonstrate the power of database engines, here is a more complex example
|
||||
which reads from a <a class="reference external" href="https://mediathekview.de/">MediathekView</a> (DE) movie database. For this example of the
|
||||
SQLite engine download the database:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://liste.mediathekview.de/filmliste-v2.db.bz2">https://liste.mediathekview.de/filmliste-v2.db.bz2</a></p></li>
|
||||
</ul>
|
||||
<p>and unpack into <code class="docutils literal notranslate"><span class="pre">searx/data/filmliste-v2.db</span></code>. To search the database use e.g
|
||||
Query to test: <code class="docutils literal notranslate"><span class="pre">!mediathekview</span> <span class="pre">concert</span></code></p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mediathekview</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sqlite</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mediathekview</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">general</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">videos</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">result_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MainResult</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searx/data/filmliste-v2.db</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">>-</span>
|
||||
<span class="w"> </span><span class="no">SELECT title || ' (' || time(duration, 'unixepoch') || ')' AS title,</span>
|
||||
<span class="w"> </span><span class="no">COALESCE( NULLIF(url_video_hd,''), NULLIF(url_video_sd,''), url_video) AS url,</span>
|
||||
<span class="w"> </span><span class="no">description AS content</span>
|
||||
<span class="w"> </span><span class="no">FROM film</span>
|
||||
<span class="w"> </span><span class="no">WHERE title LIKE :wildcard OR description LIKE :wildcard</span>
|
||||
<span class="w"> </span><span class="no">ORDER BY duration DESC</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h4>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.sqlite.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filename of the SQLite DB.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.sqlite.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.result_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">result_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'MainResult'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'KeyValue'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'KeyValue'</span></em><a class="headerlink" href="#searx.engines.sqlite.result_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The result type can be <code class="xref py py-obj docutils literal notranslate"><span class="pre">MainResult</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">KeyValue</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.sqlite_cursor">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">sqlite_cursor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/sqlite.html#sqlite_cursor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.sqlite.sqlite_cursor" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Implements a <a class="reference external" href="https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Context</span> <span class="pre">Manager</span></code></a> for a
|
||||
<a class="reference external" href="https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sqlite3.Cursor</span></code></a>.</p>
|
||||
<p>Open database in read only mode: if the database doesn’t exist. The default
|
||||
mode creates an empty file on the file system. See:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://docs.python.org/3/library/sqlite3.html#sqlite3.connect">https://docs.python.org/3/library/sqlite3.html#sqlite3.connect</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.sqlite.org/uri.html">https://www.sqlite.org/uri.html</a></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="engine-postgresql">
|
||||
<span id="id3"></span><h3><a class="toc-backref" href="#id14" role="doc-backlink">PostgreSQL</a><a class="headerlink" href="#engine-postgresql" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/postgresql.py">postgresql.py</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="psycopg2">psycopg2-binary</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.postgresql">PostgreSQL is a powerful and robust open source database. Before configuring
|
||||
the PostgreSQL engine, you must install the dependency <code class="docutils literal notranslate"><span class="pre">psychopg2</span></code>.</p>
|
||||
<section id="id4">
|
||||
<h4>Example<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h4>
|
||||
<p>Below is an example configuration:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgresql</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searxng</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="s">'SELECT</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">my_table</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">my_column</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">%(query)s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id5">
|
||||
<h4>Implementations<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.host">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></em><a class="headerlink" href="#searx.engines.postgresql.host" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hostname of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.port">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'5432'</span></em><a class="headerlink" href="#searx.engines.postgresql.port" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Port of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.postgresql.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.postgresql.username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Username for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.password">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.postgresql.password" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Password for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.postgresql.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="engine-mysql-server">
|
||||
<span id="id6"></span><h3><a class="toc-backref" href="#id15" role="doc-backlink">MySQL</a><a class="headerlink" href="#engine-mysql-server" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/mysql_server.py">mysql_server.py</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="extlink-pypi reference external" href="https://pypi.org/project/mysql-connector-python">mysql-connector-python</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.mysql_server">MySQL is said to be the most popular open source database. Before enabling
|
||||
MySQL engine, you must install the package <code class="docutils literal notranslate"><span class="pre">mysql-connector-python</span></code>.</p>
|
||||
<p>The authentication plugin is configurable by setting <code class="docutils literal notranslate"><span class="pre">auth_plugin</span></code> in the
|
||||
attributes. By default it is set to <code class="docutils literal notranslate"><span class="pre">caching_sha2_password</span></code>.</p>
|
||||
<section id="id7">
|
||||
<h4>Example<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h4>
|
||||
<p>This is an example configuration for querying a MySQL server:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysql_server</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searxng</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="s">'SELECT</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">my_table</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">my_column=%(query)s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id8">
|
||||
<h4>Implementations<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.host">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></em><a class="headerlink" href="#searx.engines.mysql_server.host" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hostname of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.port">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3306</span></em><a class="headerlink" href="#searx.engines.mysql_server.port" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Port of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mysql_server.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mysql_server.username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Username for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.password">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mysql_server.password" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Password for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mysql_server.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="mariadb">
|
||||
<span id="engine-mariadb-server"></span><h3><a class="toc-backref" href="#id16" role="doc-backlink">MariaDB</a><a class="headerlink" href="#mariadb" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/mariadb_server.py">mariadb_server.py</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="extlink-pypi reference external" href="https://pypi.org/project/mariadb">mariadb</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.mariadb_server">MariaDB is a community driven fork of MySQL. Before enabling MariaDB engine,
|
||||
you must the install the pip package <code class="docutils literal notranslate"><span class="pre">mariadb</span></code> along with the necessary
|
||||
prerequities.</p>
|
||||
<p><a class="reference external" href="https://mariadb.com/docs/server/connect/programming-languages/c/install/">See the following documentation for more details</a></p>
|
||||
<section id="id9">
|
||||
<h4>Example<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h4>
|
||||
<p>This is an example configuration for querying a MariaDB server:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mariadb_server</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searxng</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="s">'SELECT</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">my_table</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">my_column=%(query)s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id10">
|
||||
<h4>Implementations<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.host">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></em><a class="headerlink" href="#searx.engines.mariadb_server.host" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hostname of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.port">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3306</span></em><a class="headerlink" href="#searx.engines.mariadb_server.port" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Port of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mariadb_server.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mariadb_server.username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Username for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.password">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mariadb_server.password" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Password for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.mariadb_server.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="search-indexer-engines.html" title="previous chapter">Local Search APIs</a>
|
||||
<li>Next: <a href="../online_url_search/tineye.html" title="next chapter">Tineye</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/offline/sql-engines.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
219
dev/engines/offline_concept.html
Normal file
219
dev/engines/offline_concept.html
Normal file
@@ -0,0 +1,219 @@
|
||||
<!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>Offline Concept — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Demo Offline Engine" href="demo/demo_offline.html" />
|
||||
<link rel="prev" title="Z-Library" href="online/zlibrary.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="demo/demo_offline.html" title="Demo Offline Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="online/zlibrary.html" title="Z-Library"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Offline Concept</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="offline-concept">
|
||||
<h1>Offline Concept<a class="headerlink" href="#offline-concept" title="Link 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="demo/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="offline/command-line-engines.html#engine-command"><span class="std std-ref">Command Line Engines</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="offline/sql-engines.html#sql-engines"><span class="std std-ref">SQL Engines</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="offline/nosql-engines.html#nosql-engines"><span class="std std-ref">NoSQL databases</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../../src/searx.search.processors.html#module-searx.search.processors.offline" title="searx.search.processors.offline"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.search.processors.offline</span></code></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="extlink-origin 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="demo/demo_offline.html#demo-offline-engine"><span class="std std-ref">Demo Offline Engine</span></a> (<a class="extlink-origin 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="Link to this heading">¶</a></h2>
|
||||
<dl>
|
||||
<dt><a class="reference internal" href="demo/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>
|
||||
<dt><a class="reference internal" href="demo/demo_offline.html#searx.engines.demo_offline.search" title="searx.engines.demo_offline.search"><code class="xref py py-func docutils literal notranslate"><span class="pre">search(query,</span> <span class="pre">params)</span></code></a></dt><dd><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>
|
||||
</dd>
|
||||
<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="Link 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="Link 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/settings/settings_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>
|
||||
|
||||
|
||||
<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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="index.html#offline-engines">Offline Engines</a><ul class="current">
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Offline Concept</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="offline/sql-engines.html">SQL Engines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="online/zlibrary.html" title="previous chapter">Z-Library</a>
|
||||
<li>Next: <a href="demo/demo_offline.html" title="next chapter">Demo Offline Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/offline_concept.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
288
dev/engines/online/adobe_stock.html
Normal file
288
dev/engines/online/adobe_stock.html
Normal file
@@ -0,0 +1,288 @@
|
||||
<!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>Adobe Stock — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Alpine Linux Packages" href="alpinelinux.html" />
|
||||
<link rel="prev" title="JSON Engine" href="../json_engine.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="alpinelinux.html" title="Alpine Linux Packages"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../json_engine.html" title="JSON Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Adobe Stock</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="adobe-stock">
|
||||
<span id="adobe-stock-engine"></span><h1>Adobe Stock<a class="headerlink" href="#adobe-stock" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementation" id="id2">Implementation</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.adobe_stock"><a class="reference internal" href="#adobe-stock">Adobe Stock</a> is a service that gives access to millions of royalty-free
|
||||
assets. Assets types include photos, vectors, illustrations, templates, 3D
|
||||
assets, videos, motion graphics templates and audio tracks.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following mandatory setting:</p>
|
||||
<ul class="simple">
|
||||
<li><p>SearXNG’s <a class="reference internal" href="../../../admin/settings/settings_engines.html#engine-categories"><span class="std std-ref">categories</span></a></p></li>
|
||||
<li><p>Adobe-Stock’s <a class="reference internal" href="#searx.engines.adobe_stock.adobe_order" title="searx.engines.adobe_stock.adobe_order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">adobe_order</span></code></a></p></li>
|
||||
<li><p>Adobe-Stock’s <a class="reference internal" href="#searx.engines.adobe_stock.adobe_content_types" title="searx.engines.adobe_stock.adobe_content_types"><code class="xref py py-obj docutils literal notranslate"><span class="pre">adobe_content_types</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">adobe stock</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">adobe_stock</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">asi</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">images</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">adobe_order</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">relevance</span>
|
||||
<span class="w"> </span><span class="nt">adobe_content_types</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"photo"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"illustration"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"zip_vector"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"template"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"3d"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"image"</span><span class="p p-Indicator">]</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">adobe stock video</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">adobe_stock</span>
|
||||
<span class="w"> </span><span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">adobe stock</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">asi</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">videos</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">adobe_order</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">relevance</span>
|
||||
<span class="w"> </span><span class="nt">adobe_content_types</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"video"</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementation">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Implementation</a><a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.adobe_stock.adobe_order">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.adobe_stock.</span></span><span class="sig-name descname"><span class="pre">adobe_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.adobe_stock.adobe_order" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Sort order, can be one of:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">relevance</span></code> or</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">featured</span></code> or</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">creation</span></code> (most recent) or</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">nb_downloads</span></code> (number of downloads)</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.adobe_stock.adobe_content_types">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.adobe_stock.</span></span><span class="sig-name descname"><span class="pre">adobe_content_types</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#searx.engines.adobe_stock.adobe_content_types" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A list of of content types. The following content types are offered:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Images: <code class="docutils literal notranslate"><span class="pre">image</span></code></p></li>
|
||||
<li><p>Videos: <code class="docutils literal notranslate"><span class="pre">video</span></code></p></li>
|
||||
<li><p>Templates: <code class="docutils literal notranslate"><span class="pre">template</span></code></p></li>
|
||||
<li><p>3D: <code class="docutils literal notranslate"><span class="pre">3d</span></code></p></li>
|
||||
<li><p>Audio <code class="docutils literal notranslate"><span class="pre">audio</span></code></p></li>
|
||||
</ul>
|
||||
<p>Additional subcategories:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Photos: <code class="docutils literal notranslate"><span class="pre">photo</span></code></p></li>
|
||||
<li><p>Illustrations: <code class="docutils literal notranslate"><span class="pre">illustration</span></code></p></li>
|
||||
<li><p>Vectors: <code class="docutils literal notranslate"><span class="pre">zip_vector</span></code> (Vectors),</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="../json_engine.html" title="previous chapter">JSON Engine</a>
|
||||
<li>Next: <a href="alpinelinux.html" title="next chapter">Alpine Linux Packages</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/adobe_stock.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
236
dev/engines/online/alpinelinux.html
Normal file
236
dev/engines/online/alpinelinux.html
Normal file
@@ -0,0 +1,236 @@
|
||||
<!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>Alpine Linux Packages — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Anna’s Archive" href="annas_archive.html" />
|
||||
<link rel="prev" title="Adobe Stock" href="adobe_stock.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="annas_archive.html" title="Anna’s Archive"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="adobe_stock.html" title="Adobe Stock"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Alpine Linux Packages</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="alpine-linux-packages">
|
||||
<span id="alpinelinux-engine"></span><h1>Alpine Linux Packages<a class="headerlink" href="#alpine-linux-packages" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.alpinelinux"><a class="reference external" href="https://pkgs.alpinelinux.org">Alpine Linux binary packages</a>. <a class="reference external" href="https://www.alpinelinux.org">Alpine Linux</a> is a Linux-based operation
|
||||
system designed to be small, simple and secure. Contrary to many other Linux
|
||||
distributions, it uses musl, BusyBox and OpenRC. Alpine is mostly used on
|
||||
servers and for Docker images.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.alpinelinux.alpine_arch">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.alpinelinux.</span></span><span class="sig-name descname"><span class="pre">alpine_arch</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'x86_64'</span></em><a class="headerlink" href="#searx.engines.alpinelinux.alpine_arch" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Kernel architecture: <code class="docutils literal notranslate"><span class="pre">x86_64</span></code>, <code class="docutils literal notranslate"><span class="pre">x86</span></code>, <code class="docutils literal notranslate"><span class="pre">aarch64</span></code>, <code class="docutils literal notranslate"><span class="pre">armhf</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">ppc64le</span></code>, <code class="docutils literal notranslate"><span class="pre">s390x</span></code>, <code class="docutils literal notranslate"><span class="pre">armv7</span></code> or <code class="docutils literal notranslate"><span class="pre">riscv64</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.alpinelinux.ARCH_RE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.alpinelinux.</span></span><span class="sig-name descname"><span class="pre">ARCH_RE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">re.compile('x86_64|x86|aarch64|armhf|ppc64le|s390x|armv7|riscv64')</span></em><a class="headerlink" href="#searx.engines.alpinelinux.ARCH_RE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Regular expression to match supported architectures in the query string.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="adobe_stock.html" title="previous chapter">Adobe Stock</a>
|
||||
<li>Next: <a href="annas_archive.html" title="next chapter">Anna’s Archive</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/alpinelinux.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
297
dev/engines/online/annas_archive.html
Normal file
297
dev/engines/online/annas_archive.html
Normal file
@@ -0,0 +1,297 @@
|
||||
<!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>Anna’s Archive — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Arch Linux" href="archlinux.html" />
|
||||
<link rel="prev" title="Alpine Linux Packages" href="alpinelinux.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="archlinux.html" title="Arch Linux"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="alpinelinux.html" title="Alpine Linux Packages"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Anna’s Archive</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="anna-s-archive">
|
||||
<span id="annas-archive-engine"></span><h1>Anna’s Archive<a class="headerlink" href="#anna-s-archive" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.annas_archive"><a class="reference external" href="https://annas-archive.org/">Anna’s Archive</a> is a free non-profit online shadow library metasearch
|
||||
engine providing access to a variety of book resources (also via IPFS), created
|
||||
by a team of anonymous archivists (<a class="reference external" href="https://annas-software.org/AnnaArchivist/annas-archive">AnnaArchivist</a>).</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.annas_archive.aa_content" title="searx.engines.annas_archive.aa_content"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aa_content</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.annas_archive.aa_ext" title="searx.engines.annas_archive.aa_ext"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aa_ext</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.annas_archive.aa_sort" title="searx.engines.annas_archive.aa_sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aa_sort</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>With this options a SearXNG maintainer is able to configure <strong>additional</strong>
|
||||
engines for specific searches in Anna’s Archive. For example a engine to search
|
||||
for <em>newest</em> articles and journals (PDF) / by shortcut <code class="docutils literal notranslate"><span class="pre">!aaa</span> <span class="pre"><search-term></span></code>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">annas articles</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">annas_archive</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">categories = ["general", "articles"]</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aaa</span>
|
||||
<span class="w"> </span><span class="nt">aa_content</span><span class="p">:</span><span class="w"> </span><span class="s">"magazine"</span>
|
||||
<span class="w"> </span><span class="nt">aa_ext</span><span class="p">:</span><span class="w"> </span><span class="s">"pdf"</span>
|
||||
<span class="w"> </span><span class="nt">aa_sort</span><span class="p">:</span><span class="w"> </span><span class="s">"newest"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.annas_archive.aa_content">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">aa_content</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.annas_archive.aa_content" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Anan’s search form field <strong>Content</strong> / possible values:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">book_fiction</span><span class="p">,</span> <span class="n">book_unknown</span><span class="p">,</span> <span class="n">book_nonfiction</span><span class="p">,</span>
|
||||
<span class="n">book_comic</span><span class="p">,</span> <span class="n">magazine</span><span class="p">,</span> <span class="n">standards_document</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To not filter use an empty string (default).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.annas_archive.aa_sort">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">aa_sort</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.annas_archive.aa_sort" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Sort Anna’s results, possible values:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">newest</span><span class="p">,</span> <span class="n">oldest</span><span class="p">,</span> <span class="n">largest</span><span class="p">,</span> <span class="n">smallest</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To sort by <em>most relevant</em> use an empty string (default).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.annas_archive.aa_ext">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">aa_ext</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.annas_archive.aa_ext" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filter Anna’s results by a file ending. Common filters for example are
|
||||
<code class="docutils literal notranslate"><span class="pre">pdf</span></code> and <code class="docutils literal notranslate"><span class="pre">epub</span></code>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Anna’s Archive is a beta release: Filter results by file extension does not
|
||||
really work on Anna’s Archive.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.annas_archive.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/annas_archive.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.annas_archive.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Check of engine’s settings.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.annas_archive.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/annas_archive.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.annas_archive.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages and other search arguments from Anna’s search form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="alpinelinux.html" title="previous chapter">Alpine Linux Packages</a>
|
||||
<li>Next: <a href="archlinux.html" title="next chapter">Arch Linux</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/annas_archive.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
251
dev/engines/online/archlinux.html
Normal file
251
dev/engines/online/archlinux.html
Normal file
@@ -0,0 +1,251 @@
|
||||
<!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>Arch Linux — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="arXiv" href="arxiv.html" />
|
||||
<link rel="prev" title="Anna’s Archive" href="annas_archive.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="arxiv.html" title="arXiv"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="annas_archive.html" title="Anna’s Archive"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Arch Linux</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="arch-linux">
|
||||
<span id="archlinux-engine"></span><h1>Arch Linux<a class="headerlink" href="#arch-linux" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#arch-linux-wiki" id="id1">Arch Linux Wiki</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="arch-linux-wiki">
|
||||
<span id="module-searx.engines.archlinux"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Arch Linux Wiki</a><a class="headerlink" href="#arch-linux-wiki" title="Link to this heading">¶</a></h2>
|
||||
<p>This implementation does not use a official API: Mediawiki provides API, but
|
||||
Arch Wiki blocks access to it.</p>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.archlinux.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.archlinux.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/archlinux.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.archlinux.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages from Archlinux-Wiki. The location of the Wiki address of a
|
||||
language is mapped in a <a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits.custom" title="searx.enginelib.traits.EngineTraits.custom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">custom</span> <span class="pre">field</span></code></a> (<code class="docutils literal notranslate"><span class="pre">wiki_netloc</span></code>). Depending
|
||||
on the location, the <code class="docutils literal notranslate"><span class="pre">title</span></code> argument in the request is translated.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="s2">"custom"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"wiki_netloc"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"de"</span><span class="p">:</span> <span class="s2">"wiki.archlinux.de"</span><span class="p">,</span>
|
||||
<span class="c1"># ...</span>
|
||||
<span class="s2">"zh"</span><span class="p">:</span> <span class="s2">"wiki.archlinuxcn.org"</span>
|
||||
<span class="p">}</span>
|
||||
<span class="s2">"title"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"de"</span><span class="p">:</span> <span class="s2">"Spezial:Suche"</span><span class="p">,</span>
|
||||
<span class="c1"># ...</span>
|
||||
<span class="s2">"zh"</span><span class="p">:</span> <span class="s2">"Special:搜索"</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">},</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="annas_archive.html" title="previous chapter">Anna’s Archive</a>
|
||||
<li>Next: <a href="arxiv.html" title="next chapter">arXiv</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/archlinux.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
236
dev/engines/online/arxiv.html
Normal file
236
dev/engines/online/arxiv.html
Normal file
@@ -0,0 +1,236 @@
|
||||
<!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>arXiv — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Astrophysics Data System (ADS)" href="astrophysics_data_system.html" />
|
||||
<link rel="prev" title="Arch Linux" href="archlinux.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="astrophysics_data_system.html" title="Astrophysics Data System (ADS)"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="archlinux.html" title="Arch Linux"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">arXiv</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.arxiv">
|
||||
<span id="arxiv"></span><span id="arxiv-engine"></span><h1>arXiv<a class="headerlink" href="#module-searx.engines.arxiv" title="Link to this heading">¶</a></h1>
|
||||
<p>arXiv is a free distribution service and an open-access archive for nearly
|
||||
2.4 million scholarly articles in the fields of physics, mathematics, computer
|
||||
science, quantitative biology, quantitative finance, statistics, electrical
|
||||
engineering and systems science, and economics.</p>
|
||||
<p>The engine uses the <a class="reference external" href="https://info.arxiv.org/help/api/user-manual.html">arXiv API</a>.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.arxiv.arxiv_search_prefix">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.arxiv.</span></span><span class="sig-name descname"><span class="pre">arxiv_search_prefix</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></em><a class="headerlink" href="#searx.engines.arxiv.arxiv_search_prefix" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Search fields, for more details see, <a class="reference external" href="https://info.arxiv.org/help/api/user-manual.html#51-details-of-query-construction">Details of Query Construction</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.arxiv.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.arxiv.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://export.arxiv.org/api/query'</span></em><a class="headerlink" href="#searx.engines.arxiv.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://info.arxiv.org/help/api/user-manual.html">arXiv API</a> URL, for more details see <a class="reference external" href="https://info.arxiv.org/help/api/user-manual.html#_query_interface">Query-Interface</a></p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="archlinux.html" title="previous chapter">Arch Linux</a>
|
||||
<li>Next: <a href="astrophysics_data_system.html" title="next chapter">Astrophysics Data System (ADS)</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/arxiv.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
278
dev/engines/online/astrophysics_data_system.html
Normal file
278
dev/engines/online/astrophysics_data_system.html
Normal file
@@ -0,0 +1,278 @@
|
||||
<!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>Astrophysics Data System (ADS) — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Azure Resources" href="azure.html" />
|
||||
<link rel="prev" title="arXiv" href="arxiv.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="azure.html" title="Azure Resources"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="arxiv.html" title="arXiv"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Astrophysics Data System (ADS)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.astrophysics_data_system">
|
||||
<span id="astrophysics-data-system-ads"></span><span id="astrophysics-data-system-engine"></span><h1>Astrophysics Data System (ADS)<a class="headerlink" href="#module-searx.engines.astrophysics_data_system" title="Link to this heading">¶</a></h1>
|
||||
<p>The Astrophysics Data System (<a class="reference external" href="https://ui.adsabs.harvard.edu">ADS</a>) is a digital library portal for
|
||||
researchers in astronomy and physics, operated by the Smithsonian Astrophysical
|
||||
Observatory (SAO) under a NASA grant. The <a class="reference external" href="https://ui.adsabs.harvard.edu">ADS</a> is a solr instance, but not with
|
||||
the standard API paths.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The <a class="reference external" href="https://ui.adsabs.harvard.edu">ADS</a> engine requires an <a class="reference internal" href="#searx.engines.astrophysics_data_system.api_key" title="searx.engines.astrophysics_data_system.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">API</span> <span class="pre">key</span></code></a>.</p>
|
||||
</div>
|
||||
<p>This engine uses the <a class="reference external" href="https://ui.adsabs.harvard.edu/help/api/api-docs.html#get-/search/query">search/query</a> API endpoint. Since the user’s search term
|
||||
is passed through, the <a class="reference external" href="https://ui.adsabs.harvard.edu/help/search/search-syntax">search syntax</a> of ADS can be used (at least to some
|
||||
extent).</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.astrophysics_data_system.api_key" title="searx.engines.astrophysics_data_system.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.astrophysics_data_system.ads_sort" title="searx.engines.astrophysics_data_system.ads_sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ads_sort</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">astrophysics data system</span>
|
||||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"..."</span>
|
||||
<span class="w"> </span><span class="nt">inactive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.astrophysics_data_system.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.astrophysics_data_system.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'unset'</span></em><a class="headerlink" href="#searx.engines.astrophysics_data_system.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get an API token as described in <a class="reference external" href="https://ui.adsabs.harvard.edu/help/api">https://ui.adsabs.harvard.edu/help/api</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.astrophysics_data_system.ads_field_list">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.astrophysics_data_system.</span></span><span class="sig-name descname"><span class="pre">ads_field_list</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['abstract',</span> <span class="pre">'author',</span> <span class="pre">'bibcode',</span> <span class="pre">'comment',</span> <span class="pre">'date',</span> <span class="pre">'doi',</span> <span class="pre">'isbn',</span> <span class="pre">'issn',</span> <span class="pre">'keyword',</span> <span class="pre">'page',</span> <span class="pre">'page_count',</span> <span class="pre">'page_range',</span> <span class="pre">'pub',</span> <span class="pre">'pubdate',</span> <span class="pre">'pubnote',</span> <span class="pre">'read_count',</span> <span class="pre">'title',</span> <span class="pre">'volume',</span> <span class="pre">'year']</span></em><a class="headerlink" href="#searx.engines.astrophysics_data_system.ads_field_list" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Set of fields to return in the response from ADS.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.astrophysics_data_system.ads_rows">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.astrophysics_data_system.</span></span><span class="sig-name descname"><span class="pre">ads_rows</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#searx.engines.astrophysics_data_system.ads_rows" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>How many records to return for the ADS request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.astrophysics_data_system.ads_sort">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.astrophysics_data_system.</span></span><span class="sig-name descname"><span class="pre">ads_sort</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'read_count</span> <span class="pre">desc'</span></em><a class="headerlink" href="#searx.engines.astrophysics_data_system.ads_sort" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The format is ‘field’ + ‘direction’ where direction is one of ‘asc’ or ‘desc’
|
||||
and field is any of the valid indexes.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.astrophysics_data_system.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.astrophysics_data_system.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/astrophysics_data_system.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.astrophysics_data_system.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the <a class="reference external" href="https://ui.adsabs.harvard.edu">ADS</a> engine, checks whether the <a class="reference internal" href="#searx.engines.astrophysics_data_system.api_key" title="searx.engines.astrophysics_data_system.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a>
|
||||
is set, otherwise the engine is inactive.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="arxiv.html" title="previous chapter">arXiv</a>
|
||||
<li>Next: <a href="azure.html" title="next chapter">Azure Resources</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/astrophysics_data_system.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
268
dev/engines/online/azure.html
Normal file
268
dev/engines/online/azure.html
Normal file
@@ -0,0 +1,268 @@
|
||||
<!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>Azure Resources — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Bing Engines" href="bing.html" />
|
||||
<link rel="prev" title="Astrophysics Data System (ADS)" href="astrophysics_data_system.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="bing.html" title="Bing Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="astrophysics_data_system.html" title="Astrophysics Data System (ADS)"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Azure Resources</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.azure">
|
||||
<span id="azure-resources"></span><span id="azure-engine"></span><h1>Azure Resources<a class="headerlink" href="#module-searx.engines.azure" title="Link to this heading">¶</a></h1>
|
||||
<p>Engine for Azure resources. This engine mimics the standard search bar in Azure
|
||||
Portal (for resources and resource groups).</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>You must <a class="reference external" href="https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app">register an application in Microsoft Entra ID</a> and assign it the
|
||||
‘Reader’ role in your subscription.</p>
|
||||
<p>To use this engine, add an entry similar to the following to your engine list in
|
||||
<code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">azure</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">azure</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">azure_tenant_id</span><span class="p">:</span><span class="w"> </span><span class="s">"your_tenant_id"</span>
|
||||
<span class="w"> </span><span class="nt">azure_client_id</span><span class="p">:</span><span class="w"> </span><span class="s">"your_client_id"</span>
|
||||
<span class="w"> </span><span class="nt">azure_client_secret</span><span class="p">:</span><span class="w"> </span><span class="s">"your_client_secret"</span>
|
||||
<span class="w"> </span><span class="nt">azure_token_expiration_seconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5000</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.azure.azure_token_expiration_seconds">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.azure.</span></span><span class="sig-name descname"><span class="pre">azure_token_expiration_seconds</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5000</span></em><a class="headerlink" href="#searx.engines.azure.azure_token_expiration_seconds" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Time for which an auth token is valid (sec.)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.azure.CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.azure.</span></span><span class="sig-name descname"><span class="pre">CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../enginelib.html#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><span class="pre">EngineCache</span></a></em><a class="headerlink" href="#searx.engines.azure.CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values after <code class="docutils literal notranslate"><span class="pre">expire</span></code>
|
||||
seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.azure.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.azure.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/azure.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.azure.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the engine.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Instantiate a cache for this engine (<a class="reference internal" href="#searx.engines.azure.CACHE" title="searx.engines.azure.CACHE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CACHE</span></code></a>).</p></li>
|
||||
<li><p>Checks whether the tenant_id, client_id and client_secret are set,
|
||||
otherwise the engine is inactive.</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.azure.authenticate">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.azure.</span></span><span class="sig-name descname"><span class="pre">authenticate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">c_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">c_secret</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/azure.html#authenticate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.azure.authenticate" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Authenticates to Azure using Oauth2 Client Credentials Flow and returns
|
||||
an access token.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="astrophysics_data_system.html" title="previous chapter">Astrophysics Data System (ADS)</a>
|
||||
<li>Next: <a href="bing.html" title="next chapter">Bing Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/azure.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
370
dev/engines/online/bing.html
Normal file
370
dev/engines/online/bing.html
Normal file
@@ -0,0 +1,370 @@
|
||||
<!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>Bing Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Bpb" href="bpb.html" />
|
||||
<link rel="prev" title="Azure Resources" href="azure.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="bpb.html" title="Bpb"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="azure.html" title="Azure Resources"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Bing Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="bing-engines">
|
||||
<span id="id1"></span><h1>Bing Engines<a class="headerlink" href="#bing-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.bing" id="id2">Bing WEB</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.bing_images" id="id3">Bing Images</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.bing_videos" id="id4">Bing Videos</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.bing_news" id="id5">Bing News</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="module-searx.engines.bing">
|
||||
<span id="bing-web"></span><span id="bing-web-engine"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Bing WEB</a><a class="headerlink" href="#module-searx.engines.bing" title="Link to this heading">¶</a></h2>
|
||||
<p>This is the implementation of the Bing-WEB engine. Some of this
|
||||
implementations are shared by other engines:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#bing-images-engine"><span class="std std-ref">Bing Images</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#bing-news-engine"><span class="std std-ref">Bing News</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#bing-videos-engine"><span class="std std-ref">Bing Videos</span></a></p></li>
|
||||
</ul>
|
||||
<p>On the <a class="reference external" href="https://www.bing.com/account/general">preference page</a> Bing offers a lot of languages an regions (see section
|
||||
LANGUAGE and COUNTRY/REGION). The Language is the language of the UI, we need
|
||||
in SearXNG to get the translations of data such as <em>“published last week”</em>.</p>
|
||||
<p>There is a description of the official <a class="reference external" href="https://learn.microsoft.com/en-us/bing/search-apis/">search-APIs</a>, unfortunately this is not
|
||||
the API we can use or that bing itself would use. You can look up some things
|
||||
in the API to get a better picture of bing, but the value specifications like
|
||||
the market codes are usually outdated or at least no longer used by bing itself.</p>
|
||||
<p>The market codes have been harmonized and are identical for web, video and
|
||||
images. The news area has also been harmonized with the other categories. Only
|
||||
political adjustments still seem to be made – for example, there is no news
|
||||
category for the Chinese market.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">200</span></em><a class="headerlink" href="#searx.engines.bing.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>200 pages maximum (<code class="docutils literal notranslate"><span class="pre">&first=1991</span></code>)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing.safesearch">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">safesearch</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.bing.safesearch" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing results are always SFW. To get NSFW links from bing some age
|
||||
verification by a cookie is needed / thats not possible in SearXNG.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://www.bing.com/search'</span></em><a class="headerlink" href="#searx.engines.bing.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing (Web) search URL</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble a Bing-Web request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages and regions from Bing-Web.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.bing_images">
|
||||
<span id="bing-images"></span><span id="bing-images-engine"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Bing Images</a><a class="headerlink" href="#module-searx.engines.bing_images" title="Link to this heading">¶</a></h2>
|
||||
<p>Bing-Images: description see <a class="reference internal" href="#module-searx.engines.bing" title="searx.engines.bing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.engines.bing</span></code></a>.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_images.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_images.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://www.bing.com/images/async'</span></em><a class="headerlink" href="#searx.engines.bing_images.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing (Images) search URL</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_images.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_images.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_images.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_images.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble a Bing-Image request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_images.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_images.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_images.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_images.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from Bing-Images</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.bing_videos">
|
||||
<span id="bing-videos"></span><span id="bing-videos-engine"></span><h2><a class="toc-backref" href="#id4" role="doc-backlink">Bing Videos</a><a class="headerlink" href="#module-searx.engines.bing_videos" title="Link to this heading">¶</a></h2>
|
||||
<p>Bing-Videos: description see <a class="reference internal" href="#module-searx.engines.bing" title="searx.engines.bing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.engines.bing</span></code></a>.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_videos.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_videos.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://www.bing.com/videos/asyncv2'</span></em><a class="headerlink" href="#searx.engines.bing_videos.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing (Videos) async search URL.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_videos.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_videos.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_videos.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_videos.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble a Bing-Video request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_videos.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_videos.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_videos.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_videos.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from Bing-Video</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.bing_news">
|
||||
<span id="bing-news"></span><span id="bing-news-engine"></span><h2><a class="toc-backref" href="#id5" role="doc-backlink">Bing News</a><a class="headerlink" href="#module-searx.engines.bing_news" title="Link to this heading">¶</a></h2>
|
||||
<p>Bing-News: description see <a class="reference internal" href="#module-searx.engines.bing" title="searx.engines.bing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.engines.bing</span></code></a>.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Bing News is <em>different</em> in some ways!</p>
|
||||
</div>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_news.paging">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_news.</span></span><span class="sig-name descname"><span class="pre">paging</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.bing_news.paging" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If go through the pages and there are actually no new results for another
|
||||
page, then bing returns the results from the last page again.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_news.time_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_news.</span></span><span class="sig-name descname"><span class="pre">time_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'day':</span> <span class="pre">'interval="4"',</span> <span class="pre">'month':</span> <span class="pre">'interval="9"',</span> <span class="pre">'week':</span> <span class="pre">'interval="7"'}</span></em><a class="headerlink" href="#searx.engines.bing_news.time_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A string ‘4’ means <em>last hour</em>. We use <em>last hour</em> for <code class="docutils literal notranslate"><span class="pre">day</span></code> here since the
|
||||
difference of <em>last day</em> and <em>last week</em> in the result list is just marginally.
|
||||
Bing does not have news range <code class="docutils literal notranslate"><span class="pre">year</span></code> / we use <code class="docutils literal notranslate"><span class="pre">month</span></code> instead.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_news.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_news.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://www.bing.com/news/infinitescrollajax'</span></em><a class="headerlink" href="#searx.engines.bing_news.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing (News) search URL</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_news.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_news.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_news.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_news.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble a Bing-News request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_news.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_news.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_news.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_news.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from Bing-Video</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing_news.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing_news.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/bing_news.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing_news.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages and regions from Bing-News.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="azure.html" title="previous chapter">Azure Resources</a>
|
||||
<li>Next: <a href="bpb.html" title="next chapter">Bpb</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/bing.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
222
dev/engines/online/bpb.html
Normal file
222
dev/engines/online/bpb.html
Normal file
@@ -0,0 +1,222 @@
|
||||
<!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>Bpb — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Brave Engines" href="brave.html" />
|
||||
<link rel="prev" title="Bing Engines" href="bing.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="brave.html" title="Brave Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="bing.html" title="Bing Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Bpb</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="bpb">
|
||||
<span id="bpb-engine"></span><h1>Bpb<a class="headerlink" href="#bpb" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.bpb">BPB refers to <code class="docutils literal notranslate"><span class="pre">Bundeszentrale</span> <span class="pre">für</span> <span class="pre">poltische</span> <span class="pre">Bildung</span></code>, which is a German
|
||||
governmental institution aiming to reduce misinformation by providing resources
|
||||
about politics and history.</p>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="bing.html" title="previous chapter">Bing Engines</a>
|
||||
<li>Next: <a href="brave.html" title="next chapter">Brave Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/bpb.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
373
dev/engines/online/brave.html
Normal file
373
dev/engines/online/brave.html
Normal file
@@ -0,0 +1,373 @@
|
||||
<!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>Brave Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="BT4G" href="bt4g.html" />
|
||||
<link rel="prev" title="Bpb" href="bpb.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="bt4g.html" title="BT4G"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="bpb.html" title="Bpb"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Brave Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="brave-engines">
|
||||
<span id="brave-engine"></span><h1>Brave Engines<a class="headerlink" href="#brave-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#brave-regions" id="id3">Brave regions</a></p></li>
|
||||
<li><p><a class="reference internal" href="#brave-goggles" id="id4">Brave Goggles</a></p></li>
|
||||
<li><p><a class="reference internal" href="#brave-languages" id="id5">Brave languages</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id6">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.brave">Brave supports the categories listed in <a class="reference internal" href="#searx.engines.brave.brave_category" title="searx.engines.brave.brave_category"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brave_category</span></code></a> (General,
|
||||
news, videos, images). The support of <a class="reference internal" href="#searx.engines.brave.paging" title="searx.engines.brave.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a> and <a class="reference internal" href="#searx.engines.brave.time_range_support" title="searx.engines.brave.time_range_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time</span> <span class="pre">range</span></code></a> is limited (see remarks).</p>
|
||||
<p>Configured <code class="docutils literal notranslate"><span class="pre">brave</span></code> engines:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">brave_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">search</span>
|
||||
<span class="w"> </span><span class="nt">time_range_support</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">paging</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave.images</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">brave_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">images</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave.videos</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">brave_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">videos</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave.news</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">brave_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">news</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave.goggles</span>
|
||||
<span class="w"> </span><span class="nt">time_range_support</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">paging</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">brave_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">goggles</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="brave-regions">
|
||||
<span id="id1"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Brave regions</a><a class="headerlink" href="#brave-regions" title="Link to this heading">¶</a></h2>
|
||||
<p>Brave uses two-digit tags for the regions like <code class="docutils literal notranslate"><span class="pre">ca</span></code> while SearXNG deals with
|
||||
locales. To get a mapping, all <em>officiat de-facto</em> languages of the Brave
|
||||
region are mapped to regions in SearXNG (see <a class="reference external" href="https://babel.readthedocs.io/en/latest/api/languages.html#babel.languages.get_official_languages" title="(in Babel v2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">babel</span></code></a>):</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="s2">"regions"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="o">..</span>
|
||||
<span class="s2">"en-CA"</span><span class="p">:</span> <span class="s2">"ca"</span><span class="p">,</span>
|
||||
<span class="s2">"fr-CA"</span><span class="p">:</span> <span class="s2">"ca"</span><span class="p">,</span>
|
||||
<span class="o">..</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The language (aka region) support of Brave’s index is limited to very basic
|
||||
languages. The search results for languages like Chinese or Arabic are of
|
||||
low quality.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="brave-goggles">
|
||||
<span id="brave-googles"></span><h2><a class="toc-backref" href="#id4" role="doc-backlink">Brave Goggles</a><a class="headerlink" href="#brave-goggles" title="Link to this heading">¶</a></h2>
|
||||
<p>Goggles allow you to choose, alter, or extend the ranking of Brave Search
|
||||
results (<a class="reference external" href="https://brave.com/static-assets/files/goggles.pdf">Goggles Whitepaper</a>). Goggles are openly developed by the community
|
||||
of Brave Search users.</p>
|
||||
<p>Select from the <a class="reference external" href="https://search.brave.com/goggles/discover">list of Goggles</a> people have published, or create your own
|
||||
(<a class="reference external" href="https://github.com/brave/goggles-quickstart">Goggles Quickstart</a>).</p>
|
||||
</section>
|
||||
<section id="brave-languages">
|
||||
<span id="id2"></span><h2><a class="toc-backref" href="#id5" role="doc-backlink">Brave languages</a><a class="headerlink" href="#brave-languages" title="Link to this heading">¶</a></h2>
|
||||
<p>Brave’s language support is limited to the UI (menus, area local notations,
|
||||
etc). Brave’s index only seems to support a locale, but it does not seem to
|
||||
support any languages in its index. The choice of available languages is very
|
||||
small (and its not clear to me where the difference in UI is when switching
|
||||
from en-us to en-ca or en-gb).</p>
|
||||
<p>In the <a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EngineTraits</span> <span class="pre">object</span></code></a> the
|
||||
UI languages are stored in a custom field named <code class="docutils literal notranslate"><span class="pre">ui_lang</span></code>:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="s2">"custom"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"ui_lang"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"ca"</span><span class="p">:</span> <span class="s2">"ca"</span><span class="p">,</span>
|
||||
<span class="s2">"de-DE"</span><span class="p">:</span> <span class="s2">"de-de"</span><span class="p">,</span>
|
||||
<span class="s2">"en-CA"</span><span class="p">:</span> <span class="s2">"en-ca"</span><span class="p">,</span>
|
||||
<span class="s2">"en-GB"</span><span class="p">:</span> <span class="s2">"en-gb"</span><span class="p">,</span>
|
||||
<span class="s2">"en-US"</span><span class="p">:</span> <span class="s2">"en-us"</span><span class="p">,</span>
|
||||
<span class="s2">"es"</span><span class="p">:</span> <span class="s2">"es"</span><span class="p">,</span>
|
||||
<span class="s2">"fr-CA"</span><span class="p">:</span> <span class="s2">"fr-ca"</span><span class="p">,</span>
|
||||
<span class="s2">"fr-FR"</span><span class="p">:</span> <span class="s2">"fr-fr"</span><span class="p">,</span>
|
||||
<span class="s2">"ja-JP"</span><span class="p">:</span> <span class="s2">"ja-jp"</span><span class="p">,</span>
|
||||
<span class="s2">"pt-BR"</span><span class="p">:</span> <span class="s2">"pt-br"</span><span class="p">,</span>
|
||||
<span class="s2">"sq-AL"</span><span class="p">:</span> <span class="s2">"sq-al"</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">},</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.brave_category">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">brave_category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'search'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'videos'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'images'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'news'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'goggles'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'search'</span></em><a class="headerlink" href="#searx.engines.brave.brave_category" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Brave supports common web-search, videos, images, news, and goggles search.</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">search</span></code>: Common WEB search</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">videos</span></code>: search for videos</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">images</span></code>: search for images</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">news</span></code>: search for news</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">goggles</span></code>: Common WEB search with custom rules, requires a <a class="reference internal" href="#searx.engines.brave.Goggles" title="searx.engines.brave.Goggles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Goggles</span></code></a> URL.</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.Goggles">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">Goggles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.brave.Goggles" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>This should be a URL ending in <code class="docutils literal notranslate"><span class="pre">.goggle</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.brave_spellcheck">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">brave_spellcheck</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.brave.brave_spellcheck" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Brave supports some kind of spell checking. When activated, Brave tries to
|
||||
fix typos, e.g. it searches for <code class="docutils literal notranslate"><span class="pre">food</span></code> when the user queries for <code class="docutils literal notranslate"><span class="pre">fooh</span></code>. In
|
||||
the UI of Brave the user gets warned about this, since we can not warn the user
|
||||
in SearXNG, the spellchecking is disabled by default.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.paging">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">paging</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.brave.paging" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Brave only supports paging in <a class="reference internal" href="#searx.engines.brave.brave_category" title="searx.engines.brave.brave_category"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brave_category</span></code></a> <code class="docutils literal notranslate"><span class="pre">search</span></code> (UI
|
||||
category All) and in the goggles category.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#searx.engines.brave.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Tested 9 pages maximum (<code class="docutils literal notranslate"><span class="pre">&offset=8</span></code>), to be save max is set to 10. Trying
|
||||
to do more won’t return any result and you will most likely be flagged as a bot.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.time_range_support">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">time_range_support</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.brave.time_range_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Brave only supports time-range in <a class="reference internal" href="#searx.engines.brave.brave_category" title="searx.engines.brave.brave_category"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brave_category</span></code></a> <code class="docutils literal notranslate"><span class="pre">search</span></code> (UI
|
||||
category All) and in the goggles category.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.brave.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.brave.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/brave.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.brave.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch <a class="reference internal" href="#brave-languages"><span class="std std-ref">languages</span></a> and <a class="reference internal" href="#brave-regions"><span class="std std-ref">regions</span></a> from Brave.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="bpb.html" title="previous chapter">Bpb</a>
|
||||
<li>Next: <a href="bt4g.html" title="next chapter">BT4G</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/brave.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
273
dev/engines/online/bt4g.html
Normal file
273
dev/engines/online/bt4g.html
Normal file
@@ -0,0 +1,273 @@
|
||||
<!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>BT4G — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="ChinaSo" href="chinaso.html" />
|
||||
<link rel="prev" title="Brave Engines" href="brave.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="chinaso.html" title="ChinaSo"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="brave.html" title="Brave Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">BT4G</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="bt4g">
|
||||
<span id="bt4g-engine"></span><h1>BT4G<a class="headerlink" href="#bt4g" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.bt4g"><a class="reference external" href="https://bt4g.com/">BT4G</a> (bt4g.com) is not a tracker and doesn’t store any content and only
|
||||
collects torrent metadata (such as file names and file sizes) and a magnet link
|
||||
(torrent identifier).</p>
|
||||
<p>This engine does not parse the HTML page because there is an API in XML (RSS).
|
||||
The RSS feed provides fewer data like amount of seeders/leechers and the files
|
||||
in the torrent file. It’s a tradeoff for a “stable” engine as the XML from RSS
|
||||
content will change way less than the HTML page.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.bt4g.bt4g_order_by" title="searx.engines.bt4g.bt4g_order_by"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bt4g_order_by</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.bt4g.bt4g_category" title="searx.engines.bt4g.bt4g_category"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bt4g_category</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>With this options a SearXNG maintainer is able to configure <strong>additional</strong>
|
||||
engines for specific torrent searches. For example a engine to search only for
|
||||
Movies and sort the result list by the count of seeders.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt4g.movie</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt4g</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bt4gv</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">video</span>
|
||||
<span class="w"> </span><span class="nt">bt4g_order_by</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">seeders</span>
|
||||
<span class="w"> </span><span class="nt">bt4g_category</span><span class="p">:</span><span class="w"> </span><span class="s">'movie'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bt4g.bt4g_order_by">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bt4g.</span></span><span class="sig-name descname"><span class="pre">bt4g_order_by</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'relevance'</span></em><a class="headerlink" href="#searx.engines.bt4g.bt4g_order_by" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Result list can be ordered by <code class="docutils literal notranslate"><span class="pre">relevance</span></code> (default), <code class="docutils literal notranslate"><span class="pre">size</span></code>, <code class="docutils literal notranslate"><span class="pre">seeders</span></code>
|
||||
or <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>When <em>time_range</em> is activate, the results always ordered by <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.bt4g.bt4g_category">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bt4g.</span></span><span class="sig-name descname"><span class="pre">bt4g_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></em><a class="headerlink" href="#searx.engines.bt4g.bt4g_category" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>BT$G offers categories: <code class="docutils literal notranslate"><span class="pre">all</span></code> (default), <code class="docutils literal notranslate"><span class="pre">audio</span></code>, <code class="docutils literal notranslate"><span class="pre">movie</span></code>, <code class="docutils literal notranslate"><span class="pre">doc</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">app</span></code> and `` other``.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="brave.html" title="previous chapter">Brave Engines</a>
|
||||
<li>Next: <a href="chinaso.html" title="next chapter">ChinaSo</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/bt4g.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
302
dev/engines/online/chinaso.html
Normal file
302
dev/engines/online/chinaso.html
Normal file
@@ -0,0 +1,302 @@
|
||||
<!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>ChinaSo — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="CORE" href="core.html" />
|
||||
<link rel="prev" title="BT4G" href="bt4g.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="core.html" title="CORE"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="bt4g.html" title="BT4G"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">ChinaSo</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.chinaso">
|
||||
<span id="chinaso"></span><span id="chinaso-engine"></span><h1>ChinaSo<a class="headerlink" href="#module-searx.engines.chinaso" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://www.chinaso.com/">ChinaSo</a>, a search engine for the chinese language area.</p>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>ChinaSo engine does not return real URL, the links from these search
|
||||
engines violate the privacy of the users!!</p>
|
||||
<p>We try to find a solution for this problem, please follow <a class="reference external" href="https://github.com/searxng/searxng/issues/4694">issue #4694</a>.</p>
|
||||
<p>As long as the problem has not been resolved, these engines are
|
||||
not active in a standard setup (<code class="docutils literal notranslate"><span class="pre">inactive:</span> <span class="pre">true</span></code>).</p>
|
||||
</div>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.chinaso.chinaso_category" title="searx.engines.chinaso.chinaso_category"><code class="xref py py-obj docutils literal notranslate"><span class="pre">chinaso_category</span></code></a> (<a class="reference internal" href="#searx.engines.chinaso.ChinasoCategoryType" title="searx.engines.chinaso.ChinasoCategoryType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChinasoCategoryType</span></code></a>)</p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.chinaso.chinaso_news_source" title="searx.engines.chinaso.chinaso_news_source"><code class="xref py py-obj docutils literal notranslate"><span class="pre">chinaso_news_source</span></code></a> (<a class="reference internal" href="#searx.engines.chinaso.ChinasoNewsSourceType" title="searx.engines.chinaso.ChinasoNewsSourceType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChinasoNewsSourceType</span></code></a>)</p></li>
|
||||
</ul>
|
||||
<p>In the example below, all three ChinaSO engines are using the <a class="reference internal" href="../../../admin/settings/settings_engines.html#engine-network"><span class="std std-ref">network</span></a> from the <code class="docutils literal notranslate"><span class="pre">chinaso</span> <span class="pre">news</span></code> engine.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso news</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">news</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">chinaso_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">news</span>
|
||||
<span class="w"> </span><span class="nt">chinaso_news_source</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">all</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso images</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso</span>
|
||||
<span class="w"> </span><span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso news</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinasoi</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">images</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">chinaso_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">images</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso videos</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso</span>
|
||||
<span class="w"> </span><span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinaso news</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">chinasov</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">videos</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">chinaso_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">videos</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.chinaso.ChinasoCategoryType">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.chinaso.</span></span><span class="sig-name descname"><span class="pre">ChinasoCategoryType</span></span><a class="headerlink" href="#searx.engines.chinaso.ChinasoCategoryType" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>ChinaSo supports news, videos, images search.</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">news</span></code>: search for news</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">videos</span></code>: search for videos</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">images</span></code>: search for images</p></li>
|
||||
</ul>
|
||||
<p>In the category <code class="docutils literal notranslate"><span class="pre">news</span></code> you can additionally filter by option
|
||||
<a class="reference internal" href="#searx.engines.chinaso.chinaso_news_source" title="searx.engines.chinaso.chinaso_news_source"><code class="xref py py-obj docutils literal notranslate"><span class="pre">chinaso_news_source</span></code></a>.</p>
|
||||
<p>alias of <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Literal</span></code></a>[‘news’, ‘videos’, ‘images’]</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.chinaso.chinaso_category">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.chinaso.</span></span><span class="sig-name descname"><span class="pre">chinaso_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'news'</span></em><a class="headerlink" href="#searx.engines.chinaso.chinaso_category" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Configure ChinaSo category (<a class="reference internal" href="#searx.engines.chinaso.ChinasoCategoryType" title="searx.engines.chinaso.ChinasoCategoryType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChinasoCategoryType</span></code></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.chinaso.ChinasoNewsSourceType">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.chinaso.</span></span><span class="sig-name descname"><span class="pre">ChinasoNewsSourceType</span></span><a class="headerlink" href="#searx.engines.chinaso.ChinasoNewsSourceType" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filtering ChinaSo-News results by source:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">CENTRAL</span></code>: central publication</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">LOCAL</span></code>: local publication</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">BUSINESS</span></code>: business publication</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">EPAPER</span></code>: E-Paper</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">all</span></code>: all sources</p></li>
|
||||
</ul>
|
||||
<p>alias of <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Literal</span></code></a>[‘CENTRAL’, ‘LOCAL’, ‘BUSINESS’, ‘EPAPER’, ‘all’]</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.chinaso.chinaso_news_source">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.chinaso.</span></span><span class="sig-name descname"><span class="pre">chinaso_news_source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'CENTRAL'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'LOCAL'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'BUSINESS'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'EPAPER'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'all'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></em><a class="headerlink" href="#searx.engines.chinaso.chinaso_news_source" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Configure ChinaSo-News type (<a class="reference internal" href="#searx.engines.chinaso.ChinasoNewsSourceType" title="searx.engines.chinaso.ChinasoNewsSourceType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChinasoNewsSourceType</span></code></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="bt4g.html" title="previous chapter">BT4G</a>
|
||||
<li>Next: <a href="core.html" title="next chapter">CORE</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/chinaso.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
261
dev/engines/online/core.html
Normal file
261
dev/engines/online/core.html
Normal file
@@ -0,0 +1,261 @@
|
||||
<!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>CORE — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Crossref" href="crossref.html" />
|
||||
<link rel="prev" title="ChinaSo" href="chinaso.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="crossref.html" title="Crossref"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="chinaso.html" title="ChinaSo"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">CORE</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="core">
|
||||
<span id="core-engine"></span><h1>CORE<a class="headerlink" href="#core" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.core"><a class="reference external" href="https://core.ac.uk/about">CORE</a> (COnnecting REpositories) provides a comprehensive bibliographic
|
||||
database of the world’s scholarly literature, collecting and indexing
|
||||
research from repositories and journals.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The CORE engine requires an <a class="reference internal" href="#searx.engines.core.api_key" title="searx.engines.core.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">API</span> <span class="pre">key</span></code></a>.</p>
|
||||
</div>
|
||||
<section id="configuration">
|
||||
<span id="core-engine-config"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.core.api_key" title="searx.engines.core.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">core.ac.uk</span>
|
||||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"..."</span>
|
||||
<span class="w"> </span><span class="nt">inactive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.core.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.core.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.core.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>For an API key register at <a class="reference external" href="https://core.ac.uk/services/api">https://core.ac.uk/services/api</a> and insert
|
||||
the API key in the engine <a class="reference internal" href="#core-engine-config"><span class="std std-ref">Configuration</span></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.core.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.core.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/core.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.core.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the <a class="reference external" href="https://core.ac.uk/about">CORE</a> engine, checks whether the <a class="reference internal" href="#searx.engines.core.api_key" title="searx.engines.core.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a>
|
||||
is set, otherwise the engine is inactive.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="chinaso.html" title="previous chapter">ChinaSo</a>
|
||||
<li>Next: <a href="crossref.html" title="next chapter">Crossref</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/core.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
229
dev/engines/online/crossref.html
Normal file
229
dev/engines/online/crossref.html
Normal file
@@ -0,0 +1,229 @@
|
||||
<!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>Crossref — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Dailymotion" href="dailymotion.html" />
|
||||
<link rel="prev" title="CORE" href="core.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="dailymotion.html" title="Dailymotion"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="core.html" title="CORE"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Crossref</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.crossref">
|
||||
<span id="crossref"></span><span id="crossref-engine"></span><h1>Crossref<a class="headerlink" href="#module-searx.engines.crossref" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://www.crossref.org/documentation/retrieve-metadata/">Crossref</a> is the sustainable source of community-owned scholarly metadata and
|
||||
is relied upon by thousands of systems across the research ecosystem and the
|
||||
globe.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.crossref.search_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.crossref.</span></span><span class="sig-name descname"><span class="pre">search_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api.crossref.org/works'</span></em><a class="headerlink" href="#searx.engines.crossref.search_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns a list of all works (journal articles, conference proceedings, books,
|
||||
components, etc), 20 per page (<a class="reference external" href="https://api.crossref.org/swagger-ui/index.html#/Works/get_works">Works/get_works</a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="core.html" title="previous chapter">CORE</a>
|
||||
<li>Next: <a href="dailymotion.html" title="next chapter">Dailymotion</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/crossref.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
283
dev/engines/online/dailymotion.html
Normal file
283
dev/engines/online/dailymotion.html
Normal file
@@ -0,0 +1,283 @@
|
||||
<!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>Dailymotion — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Discourse Forums" href="discourse.html" />
|
||||
<link rel="prev" title="Crossref" href="crossref.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="discourse.html" title="Discourse Forums"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="crossref.html" title="Crossref"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Dailymotion</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="dailymotion">
|
||||
<span id="dailymotion-engine"></span><h1>Dailymotion<a class="headerlink" href="#dailymotion" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#dailymotion-videos" id="id1">Dailymotion (Videos)</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="dailymotion-videos">
|
||||
<span id="module-searx.engines.dailymotion"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Dailymotion (Videos)</a><a class="headerlink" href="#dailymotion-videos" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.dailymotion.safesearch_params">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.dailymotion.</span></span><span class="sig-name descname"><span class="pre">safesearch_params</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{0:</span> <span class="pre">{},</span> <span class="pre">1:</span> <span class="pre">{'is_created_for_kids':</span> <span class="pre">'true'},</span> <span class="pre">2:</span> <span class="pre">{'is_created_for_kids':</span> <span class="pre">'true'}}</span></em><a class="headerlink" href="#searx.engines.dailymotion.safesearch_params" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>True if this video is “Created for Kids” / intends to target an audience
|
||||
under the age of 16 (<code class="docutils literal notranslate"><span class="pre">is_created_for_kids</span></code> in <a class="reference external" href="https://developers.dailymotion.com/api/#video-filters">Video filters API</a> )</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.dailymotion.family_filter_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.dailymotion.</span></span><span class="sig-name descname"><span class="pre">family_filter_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{0:</span> <span class="pre">'false',</span> <span class="pre">1:</span> <span class="pre">'true',</span> <span class="pre">2:</span> <span class="pre">'true'}</span></em><a class="headerlink" href="#searx.engines.dailymotion.family_filter_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>By default, the family filter is turned on. Setting this parameter to
|
||||
<code class="docutils literal notranslate"><span class="pre">false</span></code> will stop filtering-out explicit content from searches and global
|
||||
contexts (<code class="docutils literal notranslate"><span class="pre">family_filter</span></code> in <a class="reference external" href="https://developers.dailymotion.com/api/#global-parameters">Global API Parameters</a> ).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.dailymotion.result_fields">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.dailymotion.</span></span><span class="sig-name descname"><span class="pre">result_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['allow_embed',</span> <span class="pre">'description',</span> <span class="pre">'title',</span> <span class="pre">'created_time',</span> <span class="pre">'duration',</span> <span class="pre">'url',</span> <span class="pre">'thumbnail_360_url',</span> <span class="pre">'id']</span></em><a class="headerlink" href="#searx.engines.dailymotion.result_fields" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://developers.dailymotion.com/api/#fields-selection">Fields selection</a>, by default, a few fields are returned. To request more
|
||||
specific fields, the <code class="docutils literal notranslate"><span class="pre">fields</span></code> parameter is used with the list of fields
|
||||
SearXNG needs in the response to build a video result list.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.dailymotion.search_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.dailymotion.</span></span><span class="sig-name descname"><span class="pre">search_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api.dailymotion.com/videos?'</span></em><a class="headerlink" href="#searx.engines.dailymotion.search_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL to retrieve a list of videos.</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://developers.dailymotion.com/tools/">REST GET</a></p></li>
|
||||
<li><p><a class="reference external" href="https://developers.dailymotion.com/api/#global-parameters">Global API Parameters</a></p></li>
|
||||
<li><p><a class="reference external" href="https://developers.dailymotion.com/api/#video-filters">Video filters API</a></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.dailymotion.iframe_src">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.dailymotion.</span></span><span class="sig-name descname"><span class="pre">iframe_src</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://www.dailymotion.com/embed/video/{video_id}'</span></em><a class="headerlink" href="#searx.engines.dailymotion.iframe_src" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL template to embed video in SearXNG’s result list.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.dailymotion.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.dailymotion.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/dailymotion.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.dailymotion.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch locales & languages from dailymotion.</p>
|
||||
<p>Locales fetched from <a class="reference external" href="https://api.dailymotion.com/locales">api/locales</a>.
|
||||
There are duplications in the locale codes returned from Dailymotion which
|
||||
can be ignored:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">en_EN</span> <span class="o">--></span> <span class="n">en_GB</span><span class="p">,</span> <span class="n">en_US</span>
|
||||
<span class="n">ar_AA</span> <span class="o">--></span> <span class="n">ar_EG</span><span class="p">,</span> <span class="n">ar_AE</span><span class="p">,</span> <span class="n">ar_SA</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The language list <a class="reference external" href="https://api.dailymotion.com/languages">api/languages</a>
|
||||
contains over 7000 <em>languages</em> codes (see <a class="reference external" href="https://github.com/searxng/searxng/pull/1071">PR1071</a>). We use only those
|
||||
language codes that are used in the locales.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="crossref.html" title="previous chapter">Crossref</a>
|
||||
<li>Next: <a href="discourse.html" title="next chapter">Discourse Forums</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/dailymotion.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
300
dev/engines/online/discourse.html
Normal file
300
dev/engines/online/discourse.html
Normal file
@@ -0,0 +1,300 @@
|
||||
<!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>Discourse Forums — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="DuckDuckGo Engines" href="duckduckgo.html" />
|
||||
<link rel="prev" title="Dailymotion" href="dailymotion.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="duckduckgo.html" title="DuckDuckGo Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="dailymotion.html" title="Dailymotion"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Discourse Forums</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.discourse">
|
||||
<span id="discourse-forums"></span><span id="discourse-engine"></span><h1>Discourse Forums<a class="headerlink" href="#module-searx.engines.discourse" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://trends.builtwith.com/websitelist/Discourse">builtwith.com Discourse</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>Discourse is an open source Internet forum system. To search in a forum this
|
||||
engine offers some additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.discourse.base_url" title="searx.engines.discourse.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.discourse.api_order" title="searx.engines.discourse.api_order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_order</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.discourse.search_endpoint" title="searx.engines.discourse.search_endpoint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_endpoint</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.discourse.show_avatar" title="searx.engines.discourse.show_avatar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">show_avatar</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.discourse.api_key" title="searx.engines.discourse.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.discourse.api_username" title="searx.engines.discourse.api_username"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_username</span></code></a></p></li>
|
||||
</ul>
|
||||
<section id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
||||
<p>To search in your favorite Discourse forum, add a configuration like shown here
|
||||
for the <code class="docutils literal notranslate"><span class="pre">paddling.com</span></code> forum:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">paddling</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">discourse</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">paddle</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="s">'https://forums.paddling.com/'</span>
|
||||
<span class="w"> </span><span class="nt">api_order</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">views</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'social</span><span class="nv"> </span><span class="s">media'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'sports'</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">show_avatar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If the forum is private, you need to add an API key and username for the search:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">paddling</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">discourse</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">paddle</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="s">'https://forums.paddling.com/'</span>
|
||||
<span class="w"> </span><span class="nt">api_order</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">views</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'social</span><span class="nv"> </span><span class="s">media'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'sports'</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">show_avatar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="s">'<KEY>'</span>
|
||||
<span class="w"> </span><span class="nt">api_username</span><span class="p">:</span><span class="w"> </span><span class="s">'system'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.discourse.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.discourse.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.discourse.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL of the Discourse forum.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.discourse.search_endpoint">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.discourse.</span></span><span class="sig-name descname"><span class="pre">search_endpoint</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/search.json'</span></em><a class="headerlink" href="#searx.engines.discourse.search_endpoint" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL path of the <a class="reference external" href="https://docs.discourse.org/#tag/Search">search endpoint</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.discourse.api_order">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.discourse.</span></span><span class="sig-name descname"><span class="pre">api_order</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'likes'</span></em><a class="headerlink" href="#searx.engines.discourse.api_order" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Order method, valid values are: <code class="docutils literal notranslate"><span class="pre">latest</span></code>, <code class="docutils literal notranslate"><span class="pre">likes</span></code>, <code class="docutils literal notranslate"><span class="pre">views</span></code>, <code class="docutils literal notranslate"><span class="pre">latest_topic</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.discourse.show_avatar">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.discourse.</span></span><span class="sig-name descname"><span class="pre">show_avatar</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.discourse.show_avatar" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Show avatar of the user who send the post.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.discourse.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.discourse.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.discourse.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>API key of the Discourse forum.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.discourse.api_username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.discourse.</span></span><span class="sig-name descname"><span class="pre">api_username</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.discourse.api_username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>API username of the Discourse forum.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="dailymotion.html" title="previous chapter">Dailymotion</a>
|
||||
<li>Next: <a href="duckduckgo.html" title="next chapter">DuckDuckGo Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/discourse.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
366
dev/engines/online/duckduckgo.html
Normal file
366
dev/engines/online/duckduckgo.html
Normal file
@@ -0,0 +1,366 @@
|
||||
<!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>DuckDuckGo Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Geizhals" href="geizhals.html" />
|
||||
<link rel="prev" title="Discourse Forums" href="discourse.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="geizhals.html" title="Geizhals"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="discourse.html" title="Discourse Forums"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">DuckDuckGo Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="duckduckgo-engines">
|
||||
<span id="id1"></span><h1>DuckDuckGo Engines<a class="headerlink" href="#duckduckgo-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#duckduckgo-web" id="id2">DuckDuckGo WEB</a></p></li>
|
||||
<li><p><a class="reference internal" href="#duckduckgo-extra-images-videos-news" id="id3">DuckDuckGo Extra (images, videos, news)</a></p></li>
|
||||
<li><p><a class="reference internal" href="#duckduckgo-instant-answer-api" id="id4">DuckDuckGo Instant Answer API</a></p></li>
|
||||
<li><p><a class="reference internal" href="#duckduckgo-weather" id="id5">DuckDuckGo Weather</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="duckduckgo-web">
|
||||
<span id="module-searx.engines.duckduckgo"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">DuckDuckGo WEB</a><a class="headerlink" href="#duckduckgo-web" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.send_accept_language_header">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">send_accept_language_header</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.duckduckgo.send_accept_language_header" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>DuckDuckGo-Lite tries to guess user’s preferred language from the HTTP
|
||||
<code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code>. Optional the user can select a region filter (but not a
|
||||
language).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.get_vqd">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">get_vqd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo.html#get_vqd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo.get_vqd" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns the <code class="docutils literal notranslate"><span class="pre">vqd</span></code> that fits to the <em>query</em>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>query</strong> – The query term</p></li>
|
||||
<li><p><strong>region</strong> – DDG’s region code</p></li>
|
||||
<li><p><strong>force_request</strong> – force a request to get a vqd value from DDG</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>TL;DR; the <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value is needed to pass DDG’s bot protection and is used
|
||||
by all request to DDG:</p>
|
||||
<ul class="simple">
|
||||
<li><p>DuckDuckGo Lite: <code class="docutils literal notranslate"><span class="pre">https://lite.duckduckgo.com/lite</span></code> (POST form data)</p></li>
|
||||
<li><p>DuckDuckGo Web: <code class="docutils literal notranslate"><span class="pre">https://links.duckduckgo.com/d.js?q=...&vqd=...</span></code></p></li>
|
||||
<li><p>DuckDuckGo Images: <code class="docutils literal notranslate"><span class="pre">https://duckduckgo.com/i.js??q=...&vqd=...</span></code></p></li>
|
||||
<li><p>DuckDuckGo Videos: <code class="docutils literal notranslate"><span class="pre">https://duckduckgo.com/v.js??q=...&vqd=...</span></code></p></li>
|
||||
<li><p>DuckDuckGo News: <code class="docutils literal notranslate"><span class="pre">https://duckduckgo.com/news.js??q=...&vqd=...</span></code></p></li>
|
||||
</ul>
|
||||
<p>DDG’s bot detection is sensitive to the <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value. For some search terms
|
||||
(such as extremely long search terms that are often sent by bots), no <code class="docutils literal notranslate"><span class="pre">vqd</span></code>
|
||||
value can be determined.</p>
|
||||
<p>If SearXNG cannot determine a <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value, then no request should go out
|
||||
to DDG.</p>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>A request with a wrong <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value leads to DDG temporarily putting
|
||||
SearXNG’s IP on a block list.</p>
|
||||
</div>
|
||||
<p>Requests from IPs in this block list run into timeouts. Not sure, but it
|
||||
seems the block list is a sliding window: to get my IP rid from the bot list
|
||||
I had to cool down my IP for 1h (send no requests from that IP to DDG).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.get_ddg_lang">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">get_ddg_lang</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">eng_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">sxng_locale</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'en_US'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo.html#get_ddg_lang"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo.get_ddg_lang" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get DuckDuckGo’s language identifier from SearXNG’s locale.</p>
|
||||
<p>DuckDuckGo defines its languages by region codes (see
|
||||
<a class="reference internal" href="#searx.engines.duckduckgo.fetch_traits" title="searx.engines.duckduckgo.fetch_traits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fetch_traits</span></code></a>).</p>
|
||||
<p>To get region and language of a DDG service use:</p>
|
||||
<p>It might confuse, but the <code class="docutils literal notranslate"><span class="pre">l</span></code> value of the cookie is what SearXNG calls
|
||||
the <em>region</em>:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># !ddi paris :es-AR --> {'ad': 'es_AR', 'ah': 'ar-es', 'l': 'ar-es'}</span>
|
||||
<span class="n">params</span><span class="p">[</span><span class="s1">'cookies'</span><span class="p">][</span><span class="s1">'ad'</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span>
|
||||
<span class="n">params</span><span class="p">[</span><span class="s1">'cookies'</span><span class="p">][</span><span class="s1">'ah'</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
|
||||
<span class="n">params</span><span class="p">[</span><span class="s1">'cookies'</span><span class="p">][</span><span class="s1">'l'</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p><a class="reference external" href="https://lite.duckduckgo.com/lite">DDG-lite</a> and the <em>no Javascript</em>
|
||||
page <a class="reference external" href="https://html.duckduckgo.com/html">https://html.duckduckgo.com/html</a> do not offer a language selection
|
||||
to the user, only a region can be selected by the user (<code class="docutils literal notranslate"><span class="pre">eng_region</span></code>
|
||||
from the example above). DDG-lite and <em>no Javascript</em> store the selected
|
||||
region in a cookie:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">params</span><span class="p">[</span><span class="s1">'cookies'</span><span class="p">][</span><span class="s1">'kl'</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span> <span class="c1"># 'ar-es'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.is_ddg_captcha">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">is_ddg_captcha</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dom</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo.html#is_ddg_captcha"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo.is_ddg_captcha" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>In case of CAPTCHA ddg response its own <em>not a Robot</em> dialog and is not
|
||||
redirected to a CAPTCHA page.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages & regions from DuckDuckGo.</p>
|
||||
<p>SearXNG’s <code class="docutils literal notranslate"><span class="pre">all</span></code> locale maps DuckDuckGo’s “Alle regions” (<code class="docutils literal notranslate"><span class="pre">wt-wt</span></code>).
|
||||
DuckDuckGo’s language “Browsers preferred language” (<code class="docutils literal notranslate"><span class="pre">wt_WT</span></code>) makes no
|
||||
sense in a SearXNG request since SearXNG’s <code class="docutils literal notranslate"><span class="pre">all</span></code> will not add a
|
||||
<code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> HTTP header. The value in <code class="docutils literal notranslate"><span class="pre">engine_traits.all_locale</span></code>
|
||||
is <code class="docutils literal notranslate"><span class="pre">wt-wt</span></code> (the region).</p>
|
||||
<p>Beside regions DuckDuckGo also defines its languages by region codes. By
|
||||
example these are the english languages in DuckDuckGo:</p>
|
||||
<ul class="simple">
|
||||
<li><p>en_US</p></li>
|
||||
<li><p>en_AU</p></li>
|
||||
<li><p>en_CA</p></li>
|
||||
<li><p>en_GB</p></li>
|
||||
</ul>
|
||||
<p>The function <a class="reference internal" href="#searx.engines.duckduckgo.get_ddg_lang" title="searx.engines.duckduckgo.get_ddg_lang"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_ddg_lang</span></code></a> evaluates DuckDuckGo’s language from
|
||||
SearXNG’s locale.</p>
|
||||
</dd></dl>
|
||||
|
||||
<section id="duckduckgo-extra-images-videos-news">
|
||||
<span id="module-searx.engines.duckduckgo_extra"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">DuckDuckGo Extra (images, videos, news)</a><a class="headerlink" href="#duckduckgo-extra-images-videos-news" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo_extra.ddg_category">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo_extra.</span></span><span class="sig-name descname"><span class="pre">ddg_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'images'</span></em><a class="headerlink" href="#searx.engines.duckduckgo_extra.ddg_category" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The category must be any of <code class="docutils literal notranslate"><span class="pre">images</span></code>, <code class="docutils literal notranslate"><span class="pre">videos</span></code> and <code class="docutils literal notranslate"><span class="pre">news</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<section id="duckduckgo-instant-answer-api">
|
||||
<span id="module-searx.engines.duckduckgo_definitions"></span><h2><a class="toc-backref" href="#id4" role="doc-backlink">DuckDuckGo Instant Answer API</a><a class="headerlink" href="#duckduckgo-instant-answer-api" title="Link to this heading">¶</a></h2>
|
||||
<p>The <a class="reference external" href="https://duckduckgo.com/api">DDG-API</a> is no longer documented but from
|
||||
reverse engineering we can see that some services (e.g. instant answers) still
|
||||
in use from the DDG search engine.</p>
|
||||
<p>As far we can say the <em>instant answers</em> API does not support languages, or at
|
||||
least we could not find out how language support should work. It seems that
|
||||
most of the features are based on English terms.</p>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo_definitions.is_broken_text">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo_definitions.</span></span><span class="sig-name descname"><span class="pre">is_broken_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo_definitions.html#is_broken_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo_definitions.is_broken_text" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>duckduckgo may return something like <code class="docutils literal notranslate"><span class="pre"><a</span> <span class="pre">href="xxxx">http://somewhere</span> <span class="pre">Related</span> <span class="pre">website<a/></span></code></p>
|
||||
<p>The href URL is broken, the “Related website” may contains some HTML.</p>
|
||||
<p>The best solution seems to ignore these results.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo_definitions.area_to_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo_definitions.</span></span><span class="sig-name descname"><span class="pre">area_to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">area</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo_definitions.html#area_to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo_definitions.area_to_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>parse <code class="docutils literal notranslate"><span class="pre">{'unit':</span> <span class="pre">'https://www.wikidata.org/entity/Q712226',</span> <span class="pre">'amount':</span> <span class="pre">'+20.99'}</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<section id="duckduckgo-weather">
|
||||
<span id="module-searx.engines.duckduckgo_weather"></span><h2><a class="toc-backref" href="#id5" role="doc-backlink">DuckDuckGo Weather</a><a class="headerlink" href="#duckduckgo-weather" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="discourse.html" title="previous chapter">Discourse Forums</a>
|
||||
<li>Next: <a href="geizhals.html" title="next chapter">Geizhals</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/duckduckgo.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
229
dev/engines/online/geizhals.html
Normal file
229
dev/engines/online/geizhals.html
Normal file
@@ -0,0 +1,229 @@
|
||||
<!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>Geizhals — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Gitea" href="gitea.html" />
|
||||
<link rel="prev" title="DuckDuckGo Engines" href="duckduckgo.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="gitea.html" title="Gitea"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="duckduckgo.html" title="DuckDuckGo Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Geizhals</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.geizhals">
|
||||
<span id="geizhals"></span><span id="gitea-geizhals"></span><h1>Geizhals<a class="headerlink" href="#module-searx.engines.geizhals" title="Link to this heading">¶</a></h1>
|
||||
<p>Geizhals is a German website to compare the price of a product on the
|
||||
most common German shopping sites and find the lowest price.</p>
|
||||
<p>The sorting of the search results can be influenced by the following additions
|
||||
to the search term:</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">asc</span></code> or <code class="docutils literal notranslate"><span class="pre">price</span></code></dt><dd><p>To sort by price in ascending order.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">desc</span></code></dt><dd><p>To sort by price in descending order.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="duckduckgo.html" title="previous chapter">DuckDuckGo Engines</a>
|
||||
<li>Next: <a href="gitea.html" title="next chapter">Gitea</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/geizhals.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
284
dev/engines/online/gitea.html
Normal file
284
dev/engines/online/gitea.html
Normal file
@@ -0,0 +1,284 @@
|
||||
<!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>Gitea — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Github Code" href="github_code.html" />
|
||||
<link rel="prev" title="Geizhals" href="geizhals.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="github_code.html" title="Github Code"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="geizhals.html" title="Geizhals"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Gitea</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.gitea">
|
||||
<span id="gitea"></span><span id="gitea-engine"></span><h1>Gitea<a class="headerlink" href="#module-searx.engines.gitea" title="Link to this heading">¶</a></h1>
|
||||
<p>Engine to search in collaborative software platforms based on <a class="reference external" href="https://about.gitea.com/">Gitea</a> or <a class="reference external" href="https://forgejo.org/">Forgejo</a>.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following mandatory setting:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.gitea.base_url" title="searx.engines.gitea.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Optional settings are:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.gitea.sort" title="searx.engines.gitea.sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sort</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.gitea.order" title="searx.engines.gitea.order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">order</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.gitea.page_size" title="searx.engines.gitea.page_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_size</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea.com</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://gitea.com</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">forgejo.com</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://code.forgejo.org</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">forgejo</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you would like to use additional instances, just configure new engines in the
|
||||
<a class="reference internal" href="../../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">settings</span></a> and set the <code class="docutils literal notranslate"><span class="pre">base_url</span></code>.</p>
|
||||
</section>
|
||||
<section id="implementation">
|
||||
<h2>Implementation<a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.gitea.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.gitea.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL of the <a class="reference external" href="https://about.gitea.com/">Gitea</a> instance.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.gitea.sort">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">sort</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'updated'</span></em><a class="headerlink" href="#searx.engines.gitea.sort" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Sort criteria, possible values:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">updated</span></code> (default)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">alpha</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">created</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">size</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">id</span></code></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.gitea.order">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'desc'</span></em><a class="headerlink" href="#searx.engines.gitea.order" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Sort order, possible values:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">desc</span></code> (default)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">asc</span></code></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.gitea.page_size">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">page_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#searx.engines.gitea.page_size" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maximum number of results per page (default 10).</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="geizhals.html" title="previous chapter">Geizhals</a>
|
||||
<li>Next: <a href="github_code.html" title="next chapter">Github Code</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/gitea.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
346
dev/engines/online/github_code.html
Normal file
346
dev/engines/online/github_code.html
Normal file
@@ -0,0 +1,346 @@
|
||||
<!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>Github Code — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="GitLab" href="gitlab.html" />
|
||||
<link rel="prev" title="Gitea" href="gitea.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="gitlab.html" title="GitLab"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="gitea.html" title="Gitea"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Github Code</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.github_code">
|
||||
<span id="github-code"></span><span id="github-code-engine"></span><h1>Github Code<a class="headerlink" href="#module-searx.engines.github_code" title="Link to this heading">¶</a></h1>
|
||||
<p>GitHub code search with <a class="reference external" href="https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax">search syntax</a> as described in <a class="reference external" href="https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#constructing-a-search-query">Constructing a
|
||||
search query</a> in the documentation of GitHub’s REST API.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following mandatory setting:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.github_code.ghc_auth" title="searx.engines.github_code.ghc_auth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ghc_auth</span></code></a>
|
||||
Change the authentication method used when using the API, defaults to none.</p></li>
|
||||
</ul>
|
||||
<p>Optional settings are:</p>
|
||||
<ul class="simple">
|
||||
<li><dl class="simple">
|
||||
<dt><a class="reference internal" href="#searx.engines.github_code.ghc_highlight_matching_lines" title="searx.engines.github_code.ghc_highlight_matching_lines"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ghc_highlight_matching_lines</span></code></a></dt><dd><p>Control the highlighting of the matched text (turns off/on).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="simple">
|
||||
<dt><a class="reference internal" href="#searx.engines.github_code.ghc_strip_new_lines" title="searx.engines.github_code.ghc_strip_new_lines"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ghc_strip_new_lines</span></code></a></dt><dd><p>Strip new lines at the start or end of each code fragment.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="simple">
|
||||
<dt><a class="reference internal" href="#searx.engines.github_code.ghc_strip_whitespace" title="searx.engines.github_code.ghc_strip_whitespace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ghc_strip_whitespace</span></code></a></dt><dd><p>Strip any whitespace at the start or end of each code fragment.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="simple">
|
||||
<dt><a class="reference internal" href="#searx.engines.github_code.ghc_insert_block_separator" title="searx.engines.github_code.ghc_insert_block_separator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ghc_insert_block_separator</span></code></a></dt><dd><p>Add a <cite>…</cite> between each code fragment before merging them.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github code</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github_code</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghc</span>
|
||||
<span class="w"> </span><span class="nt">ghc_auth</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="s">"none"</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github code</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github_code</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghc</span>
|
||||
<span class="w"> </span><span class="nt">ghc_auth</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="s">"personal_access_token"</span>
|
||||
<span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">"<token>"</span>
|
||||
<span class="w"> </span><span class="nt">ghc_highlight_matching_lines</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">ghc_strip_whitespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">ghc_strip_new_lines</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github code</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github_code</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghc</span>
|
||||
<span class="w"> </span><span class="nt">ghc_auth</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="s">"bearer"</span>
|
||||
<span class="w"> </span><span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="s">"<token>"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementation">
|
||||
<h2>Implementation<a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h2>
|
||||
<p>GitHub does not return the code line indices alongside the code fragment in the
|
||||
search API. Since these are not super important for the user experience all the
|
||||
code lines are just relabeled (starting from 1) and appended (a disjoint set of
|
||||
code blocks in a single file might be returned from the API).</p>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.ghc_auth">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">ghc_auth</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'token':</span> <span class="pre">'',</span> <span class="pre">'type':</span> <span class="pre">'none'}</span></em><a class="headerlink" href="#searx.engines.github_code.ghc_auth" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Change the method of authenticating to the github API.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">type</span></code> needs to be one of <code class="docutils literal notranslate"><span class="pre">none</span></code>, <code class="docutils literal notranslate"><span class="pre">personal_access_token</span></code>, or <code class="docutils literal notranslate"><span class="pre">bearer</span></code>.
|
||||
When type is not <cite>none</cite> a token is expected to be passed as well in
|
||||
<code class="docutils literal notranslate"><span class="pre">auth.token</span></code>.</p>
|
||||
<p>If there is any privacy concerns about generating a token, one can use the API
|
||||
without authentication. The calls will be heavily rate limited, this is what the
|
||||
API returns on such calls:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">API</span> <span class="n">rate</span> <span class="n">limit</span> <span class="n">exceeded</span> <span class="k">for</span> <span class="o"><</span><span class="n">redacted</span> <span class="n">ip</span><span class="o">>.</span>
|
||||
<span class="p">(</span><span class="n">But</span> <span class="n">here</span><span class="s1">'s the good news: Authenticated requests get a higher rate limit)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The personal access token or a bearer for an org or a group can be generated [in
|
||||
the <a class="reference external" href="https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-code--fine-grained-access-tokens">GitHub settings</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.ghc_highlight_matching_lines">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">ghc_highlight_matching_lines</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.github_code.ghc_highlight_matching_lines" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Highlight the matching code lines.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.ghc_strip_new_lines">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">ghc_strip_new_lines</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.github_code.ghc_strip_new_lines" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Strip leading and trailing newlines for each returned fragment.
|
||||
Single file might return multiple code fragments.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.ghc_strip_whitespace">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">ghc_strip_whitespace</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.github_code.ghc_strip_whitespace" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Strip all leading and trailing whitespace for each returned fragment.
|
||||
Single file might return multiple code fragments. Enabling this might break
|
||||
code indentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.ghc_api_version">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">ghc_api_version</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'2022-11-28'</span></em><a class="headerlink" href="#searx.engines.github_code.ghc_api_version" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The version of the GitHub REST API.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.ghc_insert_block_separator">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">ghc_insert_block_separator</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.github_code.ghc_insert_block_separator" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Each file possibly consists of more than one code block that matches the
|
||||
search, if this is set to true, the blocks will be separated with <code class="docutils literal notranslate"><span class="pre">...</span></code> line.
|
||||
This might break the lexer and thus result in the lack of code highlighting.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.github_code.extract_code">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.github_code.</span></span><span class="sig-name descname"><span class="pre">extract_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code_matches</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.14)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/github_code.html#extract_code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.github_code.extract_code" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Iterate over multiple possible matches, for each extract a code fragment.
|
||||
Github additionally sends context for _word_ highlights; pygments supports
|
||||
highlighting lines, as such we calculate which lines to highlight while
|
||||
traversing the text.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="gitea.html" title="previous chapter">Gitea</a>
|
||||
<li>Next: <a href="gitlab.html" title="next chapter">GitLab</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/github_code.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
265
dev/engines/online/gitlab.html
Normal file
265
dev/engines/online/gitlab.html
Normal file
@@ -0,0 +1,265 @@
|
||||
<!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>GitLab — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Google Engines" href="google.html" />
|
||||
<link rel="prev" title="Github Code" href="github_code.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="google.html" title="Google Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="github_code.html" title="Github Code"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">GitLab</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.gitlab">
|
||||
<span id="gitlab"></span><span id="gitlab-engine"></span><h1>GitLab<a class="headerlink" href="#module-searx.engines.gitlab" title="Link to this heading">¶</a></h1>
|
||||
<p>Engine to search in collaborative software platforms based on <a class="reference external" href="https://about.gitlab.com/install/">GitLab</a> with
|
||||
the <a class="reference external" href="https://docs.gitlab.com/ee/api/">GitLab REST API</a>.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following mandatory setting:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.gitlab.base_url" title="searx.engines.gitlab.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Optional settings are:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.gitlab.api_path" title="searx.engines.gitlab.api_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_path</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://gitlab.com</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gl</span>
|
||||
<span class="w"> </span><span class="nt">about</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">website</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://gitlab.com/</span>
|
||||
<span class="w"> </span><span class="nt">wikidata_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Q16639197</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gnome</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitlab</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://gitlab.gnome.org</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gn</span>
|
||||
<span class="w"> </span><span class="nt">about</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">website</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://gitlab.gnome.org</span>
|
||||
<span class="w"> </span><span class="nt">wikidata_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Q44316</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.gitlab.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.gitlab.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.gitlab.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base URL of the GitLab host.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.gitlab.api_path">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.gitlab.</span></span><span class="sig-name descname"><span class="pre">api_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'api/v4/projects'</span></em><a class="headerlink" href="#searx.engines.gitlab.api_path" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The path the <a class="reference external" href="https://docs.gitlab.com/ee/api/projects.html">project API</a>.</p>
|
||||
<p>The default path should work fine usually.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="github_code.html" title="previous chapter">Github Code</a>
|
||||
<li>Next: <a href="google.html" title="next chapter">Google Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/gitlab.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
533
dev/engines/online/google.html
Normal file
533
dev/engines/online/google.html
Normal file
@@ -0,0 +1,533 @@
|
||||
<!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>Google Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Hugging Face" href="huggingface.html" />
|
||||
<link rel="prev" title="GitLab" href="gitlab.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="huggingface.html" title="Hugging Face"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="gitlab.html" title="GitLab"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Google Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="google-engines">
|
||||
<span id="id1"></span><h1>Google Engines<a class="headerlink" href="#google-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#google-api" id="id6">Google API</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.google" id="id7">Google WEB</a></p></li>
|
||||
<li><p><a class="reference internal" href="#google-autocomplete" id="id8">Google Autocomplete</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.google_images" id="id9">Google Images</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.google_videos" id="id10">Google Videos</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.google_news" id="id11">Google News</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.google_scholar" id="id12">Google Scholar</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#configuration" id="id13">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id14">Implementations</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="google-api">
|
||||
<span id="id2"></span><h2><a class="toc-backref" href="#id6" role="doc-backlink">Google API</a><a class="headerlink" href="#google-api" title="Link to this heading">¶</a></h2>
|
||||
<p>SearXNG’s implementation of the Google API is mainly done in
|
||||
<a class="reference internal" href="#searx.engines.google.get_google_info" title="searx.engines.google.get_google_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_google_info</span></code></a>.</p>
|
||||
<p>For detailed description of the <em>REST-full</em> API see: <a class="reference external" href="https://developers.google.com/custom-search/docs/xml_results#WebSearch_Query_Parameter_Definitions">Query Parameter
|
||||
Definitions</a>. The linked API documentation can sometimes be helpful during
|
||||
reverse engineering. However, we cannot use it in the freely accessible WEB
|
||||
services; not all parameters can be applied and some engines are more <em>special</em>
|
||||
than other (e.g. <a class="reference internal" href="#google-news-engine"><span class="std std-ref">Google News</span></a>).</p>
|
||||
</section>
|
||||
<section id="module-searx.engines.google">
|
||||
<span id="google-web"></span><span id="google-web-engine"></span><h2><a class="toc-backref" href="#id7" role="doc-backlink">Google WEB</a><a class="headerlink" href="#module-searx.engines.google" title="Link to this heading">¶</a></h2>
|
||||
<p>This is the implementation of the Google WEB engine. Some of this
|
||||
implementations (manly the <a class="reference internal" href="#searx.engines.google.get_google_info" title="searx.engines.google.get_google_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_google_info</span></code></a>) are shared by other
|
||||
engines:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#google-images-engine"><span class="std std-ref">Google Images</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#google-news-engine"><span class="std std-ref">Google News</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#google-videos-engine"><span class="std std-ref">Google Videos</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#google-scholar-engine"><span class="std std-ref">Google Scholar</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#google-autocomplete"><span class="std std-ref">Google Autocomplete</span></a></p></li>
|
||||
</ul>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.google.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></em><a class="headerlink" href="#searx.engines.google.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://github.com/searxng/searxng/issues/2982">Google max 50 pages</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google.ui_async">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google.</span></span><span class="sig-name descname"><span class="pre">ui_async</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/google.html#ui_async"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google.ui_async" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Format of the response from UI’s async request.</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">arc_id:<...>,use_ac:true,_fmt:prog</span></code></p></li>
|
||||
</ul>
|
||||
<p>The arc_id is random generated every hour.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google.get_google_info">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google.</span></span><span class="sig-name descname"><span class="pre">get_google_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams" title="searx.search.processors.online.OnlineParams"><span class="pre">OnlineParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">eng_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/google.html#get_google_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google.get_google_info" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Composing various (language) properties for the google engines (<a class="reference internal" href="#google-api"><span class="std std-ref">Google API</span></a>).</p>
|
||||
<p>This function is called by the various google engines (<a class="reference internal" href="#google-web-engine"><span class="std std-ref">Google WEB</span></a>, <a class="reference internal" href="#google-images-engine"><span class="std std-ref">Google Images</span></a>, <a class="reference internal" href="#google-news-engine"><span class="std std-ref">Google News</span></a> and
|
||||
<a class="reference internal" href="#google-videos-engine"><span class="std std-ref">Google Videos</span></a>).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>param</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – Request parameters of the engine. At least
|
||||
a <code class="docutils literal notranslate"><span class="pre">searxng_locale</span></code> key should be in the dictionary.</p></li>
|
||||
<li><p><strong>eng_traits</strong> – Engine’s traits fetched from google preferences
|
||||
(<a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.enginelib.traits.EngineTraits</span></code></a>)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)">dict</a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><p>Py-Dictionary with the key/value pairs:</p>
|
||||
<dl class="simple">
|
||||
<dt>language:</dt><dd><p>The language code that is used by google (e.g. <code class="docutils literal notranslate"><span class="pre">lang_en</span></code> or
|
||||
<code class="docutils literal notranslate"><span class="pre">lang_zh-TW</span></code>)</p>
|
||||
</dd>
|
||||
<dt>country:</dt><dd><p>The country code that is used by google (e.g. <code class="docutils literal notranslate"><span class="pre">US</span></code> or <code class="docutils literal notranslate"><span class="pre">TW</span></code>)</p>
|
||||
</dd>
|
||||
<dt>locale:</dt><dd><p>A instance of <a class="reference external" href="https://babel.readthedocs.io/en/latest/api/core.html#babel.core.Locale" title="(in Babel v2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">babel.core.Locale</span></code></a> build from the
|
||||
<code class="docutils literal notranslate"><span class="pre">searxng_locale</span></code> value.</p>
|
||||
</dd>
|
||||
<dt>subdomain:</dt><dd><p>Google subdomain <code class="xref py py-obj docutils literal notranslate"><span class="pre">google_domains</span></code> that fits to the country
|
||||
code.</p>
|
||||
</dd>
|
||||
<dt>params:</dt><dd><p>Py-Dictionary with additional request arguments (can be passed to
|
||||
<a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlencode" title="(in Python v3.14)"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.urlencode()</span></code></a>).</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">hl</span></code> parameter: specifies the interface language of user interface.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">lr</span></code> parameter: restricts search results to documents written in
|
||||
a particular language.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">cr</span></code> parameter: restricts search results to documents
|
||||
originating in a particular country.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">ie</span></code> parameter: sets the character encoding scheme that should
|
||||
be used to interpret the query string (‘utf8’).</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">oe</span></code> parameter: sets the character encoding scheme that should
|
||||
be used to decode the XML result (‘utf8’).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>headers:</dt><dd><p>Py-Dictionary with additional HTTP headers (can be passed to
|
||||
request’s headers)</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">Accept:</span> <span class="pre">'*/*</span></code></p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams" title="searx.search.processors.online.OnlineParams"><span class="pre">OnlineParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/google.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Google search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../extended_types.html#searx.extended_types.SXNG_Response" title="searx.extended_types.SXNG_Response"><span class="pre">SXNG_Response</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from google’s search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_domains</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages from Google.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="google-autocomplete">
|
||||
<span id="id3"></span><h2><a class="toc-backref" href="#id8" role="doc-backlink">Google Autocomplete</a><a class="headerlink" href="#google-autocomplete" title="Link to this heading">¶</a></h2>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.autocomplete.google_complete">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.autocomplete.</span></span><span class="sig-name descname"><span class="pre">google_complete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">sxng_locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/autocomplete.html#google_complete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.autocomplete.google_complete" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Autocomplete from Google. Supports Google’s languages and subdomains
|
||||
(<a class="reference internal" href="#searx.engines.google.get_google_info" title="searx.engines.google.get_google_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.engines.google.get_google_info</span></code></a>) by using the async REST
|
||||
API:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://{subdomain}/complete/search?{args}
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.google_images">
|
||||
<span id="google-images"></span><span id="google-images-engine"></span><h2><a class="toc-backref" href="#id9" role="doc-backlink">Google Images</a><a class="headerlink" href="#module-searx.engines.google_images" title="Link to this heading">¶</a></h2>
|
||||
<p>This is the implementation of the Google Images engine using the internal
|
||||
Google API used by the Google Go Android app.</p>
|
||||
<p>This internal API offer results in</p>
|
||||
<ul class="simple">
|
||||
<li><p>JSON (<code class="docutils literal notranslate"><span class="pre">_fmt:json</span></code>)</p></li>
|
||||
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Protocol_Buffers">Protobuf</a> (<code class="docutils literal notranslate"><span class="pre">_fmt:pb</span></code>)</p></li>
|
||||
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Protocol_Buffers">Protobuf</a> compressed? (<code class="docutils literal notranslate"><span class="pre">_fmt:pc</span></code>)</p></li>
|
||||
<li><p>HTML (<code class="docutils literal notranslate"><span class="pre">_fmt:html</span></code>)</p></li>
|
||||
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Protocol_Buffers">Protobuf</a> encoded in JSON (<code class="docutils literal notranslate"><span class="pre">_fmt:jspb</span></code>).</p></li>
|
||||
</ul>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_images.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_images.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></em><a class="headerlink" href="#searx.engines.google_images.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://github.com/searxng/searxng/issues/2982">Google max 50 pages</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_images.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_images.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_images.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_images.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Google-Image search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_images.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_images.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_images.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_images.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from google’s search request</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.google_videos">
|
||||
<span id="google-videos"></span><span id="google-videos-engine"></span><h2><a class="toc-backref" href="#id10" role="doc-backlink">Google Videos</a><a class="headerlink" href="#module-searx.engines.google_videos" title="Link to this heading">¶</a></h2>
|
||||
<p>This is the implementation of the Google Videos engine.</p>
|
||||
<div class="admonition-content-security-policy-csp admonition">
|
||||
<p class="admonition-title">Content-Security-Policy (CSP)</p>
|
||||
<p>This engine needs to allow images from the <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs">data URLs</a> (prefixed with the
|
||||
<code class="docutils literal notranslate"><span class="pre">data:</span></code> scheme):</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Header</span> <span class="nb">set</span> <span class="n">Content</span><span class="o">-</span><span class="n">Security</span><span class="o">-</span><span class="n">Policy</span> <span class="s2">"img-src 'self' data: ;"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_videos.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_videos.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_videos.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_videos.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Google-Video search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_videos.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_videos.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_videos.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_videos.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from google’s search request</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.google_news">
|
||||
<span id="google-news"></span><span id="google-news-engine"></span><h2><a class="toc-backref" href="#id11" role="doc-backlink">Google News</a><a class="headerlink" href="#module-searx.engines.google_news" title="Link to this heading">¶</a></h2>
|
||||
<p>This is the implementation of the Google News engine.</p>
|
||||
<p>Google News has a different region handling compared to Google WEB.</p>
|
||||
<ul class="simple">
|
||||
<li><p>the <code class="docutils literal notranslate"><span class="pre">ceid</span></code> argument has to be set (<a class="reference internal" href="#searx.engines.google_news.ceid_list" title="searx.engines.google_news.ceid_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ceid_list</span></code></a>)</p></li>
|
||||
<li><p>the <a class="reference external" href="https://developers.google.com/custom-search/docs/xml_results#hlsp">hl</a> argument has to be set correctly (and different to Google WEB)</p></li>
|
||||
<li><p>the <a class="reference external" href="https://developers.google.com/custom-search/docs/xml_results#glsp">gl</a> argument is mandatory</p></li>
|
||||
</ul>
|
||||
<p>If one of this argument is not set correctly, the request is redirected to
|
||||
CONSENT dialog:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://consent.google.com/m?continue=
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The google news API ignores some parameters from the common <a class="reference internal" href="#google-api"><span class="std std-ref">Google API</span></a>:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://developers.google.com/custom-search/docs/xml_results#numsp">num</a> : the number of search results is ignored / there is no paging all
|
||||
results for a query term are in the first response.</p></li>
|
||||
<li><p><a class="reference external" href="https://developers.google.com/custom-search/docs/xml_results#safesp">save</a> : is ignored / Google-News results are always <em>SafeSearch</em></p></li>
|
||||
</ul>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_news.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_news.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_news.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_news.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Google-News search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_news.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_news.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_news.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_news.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from google’s search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_news.ceid_list">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_news.</span></span><span class="sig-name descname"><span class="pre">ceid_list</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['AE:ar',</span> <span class="pre">'AR:es-419',</span> <span class="pre">'AT:de',</span> <span class="pre">'AU:en',</span> <span class="pre">'BD:bn',</span> <span class="pre">'BE:fr',</span> <span class="pre">'BE:nl',</span> <span class="pre">'BG:bg',</span> <span class="pre">'BR:pt-419',</span> <span class="pre">'BW:en',</span> <span class="pre">'CA:en',</span> <span class="pre">'CA:fr',</span> <span class="pre">'CH:de',</span> <span class="pre">'CH:fr',</span> <span class="pre">'CL:es-419',</span> <span class="pre">'CN:zh-Hans',</span> <span class="pre">'CO:es-419',</span> <span class="pre">'CU:es-419',</span> <span class="pre">'CZ:cs',</span> <span class="pre">'DE:de',</span> <span class="pre">'EG:ar',</span> <span class="pre">'ES:es',</span> <span class="pre">'ET:en',</span> <span class="pre">'FR:fr',</span> <span class="pre">'GB:en',</span> <span class="pre">'GH:en',</span> <span class="pre">'GR:el',</span> <span class="pre">'HK:zh-Hant',</span> <span class="pre">'HU:hu',</span> <span class="pre">'ID:en',</span> <span class="pre">'ID:id',</span> <span class="pre">'IE:en',</span> <span class="pre">'IL:en',</span> <span class="pre">'IL:he',</span> <span class="pre">'IN:bn',</span> <span class="pre">'IN:en',</span> <span class="pre">'IN:hi',</span> <span class="pre">'IN:ml',</span> <span class="pre">'IN:mr',</span> <span class="pre">'IN:ta',</span> <span class="pre">'IN:te',</span> <span class="pre">'IT:it',</span> <span class="pre">'JP:ja',</span> <span class="pre">'KE:en',</span> <span class="pre">'KR:ko',</span> <span class="pre">'LB:ar',</span> <span class="pre">'LT:lt',</span> <span class="pre">'LV:en',</span> <span class="pre">'LV:lv',</span> <span class="pre">'MA:fr',</span> <span class="pre">'MX:es-419',</span> <span class="pre">'MY:en',</span> <span class="pre">'NA:en',</span> <span class="pre">'NG:en',</span> <span class="pre">'NL:nl',</span> <span class="pre">'NO:no',</span> <span class="pre">'NZ:en',</span> <span class="pre">'PE:es-419',</span> <span class="pre">'PH:en',</span> <span class="pre">'PK:en',</span> <span class="pre">'PL:pl',</span> <span class="pre">'PT:pt-150',</span> <span class="pre">'RO:ro',</span> <span class="pre">'RS:sr',</span> <span class="pre">'RU:ru',</span> <span class="pre">'SA:ar',</span> <span class="pre">'SE:sv',</span> <span class="pre">'SG:en',</span> <span class="pre">'SI:sl',</span> <span class="pre">'SK:sk',</span> <span class="pre">'SN:fr',</span> <span class="pre">'TH:th',</span> <span class="pre">'TR:tr',</span> <span class="pre">'TW:zh-Hant',</span> <span class="pre">'TZ:en',</span> <span class="pre">'UA:ru',</span> <span class="pre">'UA:uk',</span> <span class="pre">'UG:en',</span> <span class="pre">'US:en',</span> <span class="pre">'US:es-419',</span> <span class="pre">'VE:es-419',</span> <span class="pre">'VN:vi',</span> <span class="pre">'ZA:en',</span> <span class="pre">'ZW:en']</span></em><a class="headerlink" href="#searx.engines.google_news.ceid_list" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>List of region/language combinations supported by Google News. Values of the
|
||||
<code class="docutils literal notranslate"><span class="pre">ceid</span></code> argument of the Google News REST API.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.google_scholar">
|
||||
<span id="google-scholar"></span><span id="google-scholar-engine"></span><h2><a class="toc-backref" href="#id12" role="doc-backlink">Google Scholar</a><a class="headerlink" href="#module-searx.engines.google_scholar" title="Link to this heading">¶</a></h2>
|
||||
<p>Google Scholar is a freely accessible web search engine that indexes the full
|
||||
text or metadata of scholarly literature across an array of publishing formats
|
||||
and disciplines.</p>
|
||||
<p>Compared to other Google services the Scholar engine has a simple GET REST-API
|
||||
and there does not exists <code class="docutils literal notranslate"><span class="pre">async</span></code> API. Even though the API slightly vintage
|
||||
we can make use of the <a class="reference internal" href="#google-api"><span class="std std-ref">Google API</span></a> to assemble the arguments of the GET
|
||||
request.</p>
|
||||
<section id="configuration">
|
||||
<h3><a class="toc-backref" href="#id13" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google scholar</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google_scholar</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gos</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h3><a class="toc-backref" href="#id14" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h3>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_scholar.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_scholar.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></em><a class="headerlink" href="#searx.engines.google_scholar.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://github.com/searxng/searxng/issues/2982">Google max 50 pages</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_scholar.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_scholar.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams" title="searx.search.processors.online.OnlineParams"><span class="pre">OnlineParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/google_scholar.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_scholar.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Google-Scholar search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_scholar.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_scholar.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../extended_types.html#searx.extended_types.SXNG_Response" title="searx.extended_types.SXNG_Response"><span class="pre">SXNG_Response</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/google_scholar.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_scholar.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse response from Google Scholar</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_scholar.time_range_args">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_scholar.</span></span><span class="sig-name descname"><span class="pre">time_range_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams" title="searx.search.processors.online.OnlineParams"><span class="pre">OnlineParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/google_scholar.html#time_range_args"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_scholar.time_range_args" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns a dictionary with a time range arguments based on
|
||||
<code class="docutils literal notranslate"><span class="pre">params["time_range"]</span></code>.</p>
|
||||
<p>Google Scholar supports a detailed search by year. Searching by <em>last
|
||||
month</em> or <em>last week</em> (as offered by SearXNG) is uncommon for scientific
|
||||
publications and is not supported by Google Scholar.</p>
|
||||
<p>To limit the result list when the users selects a range, all the SearXNG
|
||||
ranges (<em>day</em>, <em>week</em>, <em>month</em>, <em>year</em>) are mapped to <em>year</em>. If no range
|
||||
is set an empty dictionary of arguments is returned.</p>
|
||||
<p>Example; when user selects a time range and we find ourselves in the year
|
||||
2025 (current year minus one):</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"as_ylo"</span> <span class="p">:</span> <span class="mi">2024</span> <span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_scholar.detect_google_captcha">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_scholar.</span></span><span class="sig-name descname"><span class="pre">detect_google_captcha</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dom</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://lxml.de/apidoc/lxml.etree.html#lxml.etree.ElementBase" title="(in lxml v6.0.0)"><span class="pre">ElementBase</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://lxml.de/apidoc/lxml.etree.html#lxml.etree._Element" title="(in lxml v6.0.0)"><span class="pre">_Element</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/google_scholar.html#detect_google_captcha"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_scholar.detect_google_captcha" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>In case of CAPTCHA Google Scholar open its own <em>not a Robot</em> dialog and is
|
||||
not redirected to <code class="docutils literal notranslate"><span class="pre">sorry.google.com</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.google_scholar.parse_gs_a">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.google_scholar.</span></span><span class="sig-name descname"><span class="pre">parse_gs_a</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.14)"><span class="pre">datetime</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/google_scholar.html#parse_gs_a"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.google_scholar.parse_gs_a" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse the text written in green.</p>
|
||||
<p>Possible formats:
|
||||
* “{authors} - {journal}, {year} - {publisher}”
|
||||
* “{authors} - {year} - {publisher}”
|
||||
* “{authors} - {publisher}”</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="gitlab.html" title="previous chapter">GitLab</a>
|
||||
<li>Next: <a href="huggingface.html" title="next chapter">Hugging Face</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/google.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
257
dev/engines/online/huggingface.html
Normal file
257
dev/engines/online/huggingface.html
Normal file
@@ -0,0 +1,257 @@
|
||||
<!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>Hugging Face — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Lemmy" href="lemmy.html" />
|
||||
<link rel="prev" title="Google Engines" href="google.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="lemmy.html" title="Lemmy"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="google.html" title="Google Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Hugging Face</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.huggingface">
|
||||
<span id="hugging-face"></span><span id="huggingface-engine"></span><h1>Hugging Face<a class="headerlink" href="#module-searx.engines.huggingface" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://huggingface.co">Hugging Face</a> search engine for SearXNG.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.huggingface.huggingface_endpoint" title="searx.engines.huggingface.huggingface_endpoint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">huggingface_endpoint</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Configurations for endpoints:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">huggingface</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">huggingface</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hf</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">huggingface datasets</span>
|
||||
<span class="w"> </span><span class="nt">huggingface_endpoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">datasets</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">huggingface</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hfd</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">huggingface spaces</span>
|
||||
<span class="w"> </span><span class="nt">huggingface_endpoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">spaces</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">huggingface</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hfs</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.huggingface.huggingface_endpoint">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.huggingface.</span></span><span class="sig-name descname"><span class="pre">huggingface_endpoint</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'models'</span></em><a class="headerlink" href="#searx.engines.huggingface.huggingface_endpoint" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hugging Face supports datasets, models, spaces as search endpoint.</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">datasets</span></code>: search for datasets</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">models</span></code>: search for models</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">spaces</span></code>: search for spaces</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="google.html" title="previous chapter">Google Engines</a>
|
||||
<li>Next: <a href="lemmy.html" title="next chapter">Lemmy</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/huggingface.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
269
dev/engines/online/lemmy.html
Normal file
269
dev/engines/online/lemmy.html
Normal file
@@ -0,0 +1,269 @@
|
||||
<!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>Lemmy — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Library of Congress" href="loc.html" />
|
||||
<link rel="prev" title="Hugging Face" href="huggingface.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="loc.html" title="Library of Congress"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="huggingface.html" title="Hugging Face"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Lemmy</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="lemmy">
|
||||
<span id="lemmy-engine"></span><h1>Lemmy<a class="headerlink" href="#lemmy" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id2">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.lemmy">This engine uses the Lemmy API (<a class="reference external" href="https://lemmy.ml/api/v3/search">https://lemmy.ml/api/v3/search</a>), which is
|
||||
documented at <a class="reference external" href="https://join-lemmy.org/api/modules.html">lemmy-js-client</a> / <a class="reference external" href="https://join-lemmy.org/api/interfaces/Search.html">Interface Search</a>. Since Lemmy is
|
||||
federated, results are from many different, independent lemmy instances, and not
|
||||
only the official one.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.lemmy.base_url" title="searx.engines.lemmy.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.lemmy.lemmy_type" title="searx.engines.lemmy.lemmy_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lemmy_type</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>This implementation is used by different lemmy engines in the <a class="reference internal" href="../../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">settings.yml</span></a>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">lemmy communities</span>
|
||||
<span class="w"> </span><span class="nt">lemmy_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Communities</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">lemmy users</span>
|
||||
<span class="w"> </span><span class="nt">lemmy_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Users</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">lemmy posts</span>
|
||||
<span class="w"> </span><span class="nt">lemmy_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Posts</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">lemmy comments</span>
|
||||
<span class="w"> </span><span class="nt">lemmy_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Comments</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.lemmy.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.lemmy.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://lemmy.ml/'</span></em><a class="headerlink" href="#searx.engines.lemmy.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>By default, <a class="reference external" href="https://lemmy.ml">https://lemmy.ml</a> is used for providing the results. If you want
|
||||
to use a different lemmy instance, you can specify <code class="docutils literal notranslate"><span class="pre">base_url</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.lemmy.lemmy_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.lemmy.</span></span><span class="sig-name descname"><span class="pre">lemmy_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Communities'</span></em><a class="headerlink" href="#searx.engines.lemmy.lemmy_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Any of <code class="docutils literal notranslate"><span class="pre">Communities</span></code>, <code class="docutils literal notranslate"><span class="pre">Users</span></code>, <code class="docutils literal notranslate"><span class="pre">Posts</span></code>, <code class="docutils literal notranslate"><span class="pre">Comments</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="huggingface.html" title="previous chapter">Hugging Face</a>
|
||||
<li>Next: <a href="loc.html" title="next chapter">Library of Congress</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/lemmy.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
226
dev/engines/online/loc.html
Normal file
226
dev/engines/online/loc.html
Normal file
@@ -0,0 +1,226 @@
|
||||
<!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>Library of Congress — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Marginalia Search" href="marginalia.html" />
|
||||
<link rel="prev" title="Lemmy" href="lemmy.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="marginalia.html" title="Marginalia Search"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="lemmy.html" title="Lemmy"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Library of Congress</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="library-of-congress">
|
||||
<span id="loc-engine"></span><h1>Library of Congress<a class="headerlink" href="#library-of-congress" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.loc">Library of Congress: query Photo, Print and Drawing from API <a class="reference external" href="https://www.loc.gov/apis/json-and-yaml/requests/endpoints/">endpoint</a>
|
||||
<code class="docutils literal notranslate"><span class="pre">photos</span></code>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Beside the <code class="docutils literal notranslate"><span class="pre">photos</span></code> <a class="reference external" href="https://www.loc.gov/apis/json-and-yaml/requests/endpoints/">endpoint</a> there are more endpoints available / we are
|
||||
looking forward for contributions implementing more endpoints.</p>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="lemmy.html" title="previous chapter">Lemmy</a>
|
||||
<li>Next: <a href="marginalia.html" title="next chapter">Marginalia Search</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/loc.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
257
dev/engines/online/marginalia.html
Normal file
257
dev/engines/online/marginalia.html
Normal file
@@ -0,0 +1,257 @@
|
||||
<!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>Marginalia Search — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Mastodon" href="mastodon.html" />
|
||||
<link rel="prev" title="Library of Congress" href="loc.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="mastodon.html" title="Mastodon"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="loc.html" title="Library of Congress"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Marginalia Search</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.marginalia">
|
||||
<span id="marginalia-search"></span><span id="marginalia-engine"></span><h1>Marginalia Search<a class="headerlink" href="#module-searx.engines.marginalia" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://about.marginalia-search.com/">Marginalia Search</a> is an independent open source Internet search engine
|
||||
operating out of Sweden. It is principally developed and operated by Viktor
|
||||
Lofgren .</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following required settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.marginalia.api_key" title="searx.engines.marginalia.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>You can configure a Marginalia engine by:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">marginalia</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">marginalia</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mar</span>
|
||||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.marginalia.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.marginalia.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.marginalia.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>To get an API key, please follow the instructions from <a class="reference external" href="https://about.marginalia-search.com/article/api/">Key and license</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.engines.marginalia.ApiSearchResult">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.engines.marginalia.</span></span><span class="sig-name descname"><span class="pre">ApiSearchResult</span></span><a class="reference internal" href="../../../_modules/searx/engines/marginalia.html#ApiSearchResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.marginalia.ApiSearchResult" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Marginalia’s <a class="reference external" href="https://github.com/MarginaliaSearch/MarginaliaSearch/blob/master/code/services-application/api-service/java/nu/marginalia/api/model/ApiSearchResult.java">ApiSearchResult</a> class definition.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.engines.marginalia.ApiSearchResults">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.engines.marginalia.</span></span><span class="sig-name descname"><span class="pre">ApiSearchResults</span></span><a class="reference internal" href="../../../_modules/searx/engines/marginalia.html#ApiSearchResults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.marginalia.ApiSearchResults" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Marginalia’s <a class="reference external" href="https://github.com/MarginaliaSearch/MarginaliaSearch/blob/master/code/services-application/api-service/java/nu/marginalia/api/model/ApiSearchResults.java">ApiSearchResults</a> class definition.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="loc.html" title="previous chapter">Library of Congress</a>
|
||||
<li>Next: <a href="mastodon.html" title="next chapter">Mastodon</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/marginalia.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
227
dev/engines/online/mastodon.html
Normal file
227
dev/engines/online/mastodon.html
Normal file
@@ -0,0 +1,227 @@
|
||||
<!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>Mastodon — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Moviepilot" href="moviepilot.html" />
|
||||
<link rel="prev" title="Marginalia Search" href="marginalia.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="moviepilot.html" title="Moviepilot"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="marginalia.html" title="Marginalia Search"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Mastodon</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="mastodon">
|
||||
<span id="mastodon-engine"></span><h1>Mastodon<a class="headerlink" href="#mastodon" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.mastodon"><a class="reference external" href="https://mastodon.social">Mastodon</a> is an open source alternative to large social media platforms like
|
||||
Twitter/X, Facebook, …</p>
|
||||
<p>Since it’s federated and self-hostable, there’s a large amount of available
|
||||
instances, which can be chosen instead by modifying <code class="docutils literal notranslate"><span class="pre">base_url</span></code>.</p>
|
||||
<p>We use their official <a class="reference external" href="https://docs.joinmastodon.org/api/">API</a> for searching, but unfortunately, their Search <a class="reference external" href="https://docs.joinmastodon.org/api/">API</a>
|
||||
forbids pagination without OAuth.</p>
|
||||
<p>That’s why we use tootfinder.ch for finding posts, which doesn’t support searching
|
||||
for users, accounts or other types of content on Mastodon however.</p>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="marginalia.html" title="previous chapter">Marginalia Search</a>
|
||||
<li>Next: <a href="moviepilot.html" title="next chapter">Moviepilot</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/mastodon.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
242
dev/engines/online/moviepilot.html
Normal file
242
dev/engines/online/moviepilot.html
Normal file
@@ -0,0 +1,242 @@
|
||||
<!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>Moviepilot — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Matrix Rooms Search (MRS)" href="mrs.html" />
|
||||
<link rel="prev" title="Mastodon" href="mastodon.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="mrs.html" title="Matrix Rooms Search (MRS)"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="mastodon.html" title="Mastodon"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Moviepilot</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="moviepilot">
|
||||
<span id="moviepilot-engine"></span><h1>Moviepilot<a class="headerlink" href="#moviepilot" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.moviepilot">Moviepilot is a German movie database, similar to IMDB or TMDB. It doesn’t
|
||||
have any official API, but it uses JSON requests internally to fetch search
|
||||
results and suggestions, that’s being used in this implementation.</p>
|
||||
<p>Moviepilot additionally allows to discover movies by certain categories
|
||||
or filters, hence we provide the following syntax:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Any normal search query -> Fetch search results by the query</p></li>
|
||||
<li><p>A query containing one of the category identifiers <code class="docutils literal notranslate"><span class="pre">fsk</span></code>, <code class="docutils literal notranslate"><span class="pre">genre</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">jahr</span></code>, <code class="docutils literal notranslate"><span class="pre">jahrzent</span></code>, <code class="docutils literal notranslate"><span class="pre">land</span></code>, <code class="docutils literal notranslate"><span class="pre">online</span></code>, <code class="docutils literal notranslate"><span class="pre">stimmung</span></code> will be used to
|
||||
search trending items by the provided filters, which are appended to the
|
||||
filter category after a <code class="docutils literal notranslate"><span class="pre">-</span></code>.</p></li>
|
||||
</ul>
|
||||
<p>Search examples:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Normal: <code class="docutils literal notranslate"><span class="pre">!mp</span> <span class="pre">Tom</span> <span class="pre">Cruise</span></code></p></li>
|
||||
<li><p>By filter: <code class="docutils literal notranslate"><span class="pre">!mp</span> <span class="pre">person-Ryan-Gosling</span></code></p></li>
|
||||
<li><p>By filter: <code class="docutils literal notranslate"><span class="pre">!mp</span> <span class="pre">fsk-0</span> <span class="pre">land-deutschland</span> <span class="pre">genre-actionfilm</span></code></p></li>
|
||||
<li><p>By filter: <code class="docutils literal notranslate"><span class="pre">!mp</span> <span class="pre">jahrzehnt-2020er</span> <span class="pre">online-netflix</span></code></p></li>
|
||||
</ul>
|
||||
<p>For a list of all public filters, observe the url path when browsing</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.moviepilot.de/filme/beste">https://www.moviepilot.de/filme/beste</a>.</p></li>
|
||||
</ul>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="mastodon.html" title="previous chapter">Mastodon</a>
|
||||
<li>Next: <a href="mrs.html" title="next chapter">Matrix Rooms Search (MRS)</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/moviepilot.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
250
dev/engines/online/mrs.html
Normal file
250
dev/engines/online/mrs.html
Normal file
@@ -0,0 +1,250 @@
|
||||
<!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>Matrix Rooms Search (MRS) — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Mullvad-Leta" href="mullvad_leta.html" />
|
||||
<link rel="prev" title="Moviepilot" href="moviepilot.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="mullvad_leta.html" title="Mullvad-Leta"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="moviepilot.html" title="Moviepilot"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Matrix Rooms Search (MRS)</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="matrix-rooms-search-mrs">
|
||||
<span id="mrs-engine"></span><h1>Matrix Rooms Search (MRS)<a class="headerlink" href="#matrix-rooms-search-mrs" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementation" id="id2">Implementation</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.mrs">Matrix Rooms Search - a fully-featured, standalone, matrix rooms search service.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following mandatory settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MRS</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mrs</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://mrs-host</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementation">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Implementation</a><a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.mrs.init">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mrs.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/mrs.html#init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.mrs.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The <code class="docutils literal notranslate"><span class="pre">base_url</span></code> must be set in the configuration, if <code class="docutils literal notranslate"><span class="pre">base_url</span></code> is not
|
||||
set, a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised during initialization.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="moviepilot.html" title="previous chapter">Moviepilot</a>
|
||||
<li>Next: <a href="mullvad_leta.html" title="next chapter">Mullvad-Leta</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/mrs.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
282
dev/engines/online/mullvad_leta.html
Normal file
282
dev/engines/online/mullvad_leta.html
Normal file
@@ -0,0 +1,282 @@
|
||||
<!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>Mullvad-Leta — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Mwmbl Engine" href="mwmbl.html" />
|
||||
<link rel="prev" title="Matrix Rooms Search (MRS)" href="mrs.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="mwmbl.html" title="Mwmbl Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="mrs.html" title="Matrix Rooms Search (MRS)"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Mullvad-Leta</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.mullvad_leta">
|
||||
<span id="mullvad-leta"></span><span id="voidlinux-mullvad-leta"></span><h1>Mullvad-Leta<a class="headerlink" href="#module-searx.engines.mullvad_leta" title="Link to this heading">¶</a></h1>
|
||||
<p>Mullvad Leta is a search engine proxy. Currently Leta only offers text
|
||||
search results not image, news or any other types of search result. Leta acts
|
||||
as a proxy to Google and Brave search results. You can select which backend
|
||||
search engine you wish to use, see (<a class="reference internal" href="#searx.engines.mullvad_leta.leta_engine" title="searx.engines.mullvad_leta.leta_engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">leta_engine</span></code></a>).</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Leta caches each search for up to 30 days. For example, if you use search
|
||||
terms like <code class="docutils literal notranslate"><span class="pre">news</span></code>, contrary to your intention you’ll get very old results!</p>
|
||||
</div>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.mullvad_leta.leta_engine" title="searx.engines.mullvad_leta.leta_engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">leta_engine</span></code></a> (<a class="reference internal" href="#searx.engines.mullvad_leta.LetaEnginesType" title="searx.engines.mullvad_leta.LetaEnginesType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LetaEnginesType</span></code></a>)</p></li>
|
||||
</ul>
|
||||
<p>You can configure one Leta engine for Google and one for Brave:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mullvadleta</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mullvad_leta</span>
|
||||
<span class="w"> </span><span class="nt">leta_engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ml</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mullvadleta brave</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mullvad_leta</span>
|
||||
<span class="w"> </span><span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mullvadleta</span><span class="w"> </span><span class="c1"># use network from engine "mullvadleta" configured above</span>
|
||||
<span class="w"> </span><span class="nt">leta_engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">brave</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mlb</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mullvad_leta.LetaEnginesType">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mullvad_leta.</span></span><span class="sig-name descname"><span class="pre">LetaEnginesType</span></span><a class="headerlink" href="#searx.engines.mullvad_leta.LetaEnginesType" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine types supported by mullvadleta.</p>
|
||||
<p>alias of <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Literal</span></code></a>[‘google’, ‘brave’]</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mullvad_leta.leta_engine">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mullvad_leta.</span></span><span class="sig-name descname"><span class="pre">leta_engine</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'google'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'brave'</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'google'</span></em><a class="headerlink" href="#searx.engines.mullvad_leta.leta_engine" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Select Leta’s engine type from <a class="reference internal" href="#searx.engines.mullvad_leta.LetaEnginesType" title="searx.engines.mullvad_leta.LetaEnginesType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LetaEnginesType</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.engines.mullvad_leta.DataNodeQueryMetaDataIndices">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.engines.mullvad_leta.</span></span><span class="sig-name descname"><span class="pre">DataNodeQueryMetaDataIndices</span></span><a class="reference internal" href="../../../_modules/searx/engines/mullvad_leta.html#DataNodeQueryMetaDataIndices"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.mullvad_leta.DataNodeQueryMetaDataIndices" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Indices into query metadata.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.engines.mullvad_leta.DataNodeResultIndices">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.engines.mullvad_leta.</span></span><span class="sig-name descname"><span class="pre">DataNodeResultIndices</span></span><a class="reference internal" href="../../../_modules/searx/engines/mullvad_leta.html#DataNodeResultIndices"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.mullvad_leta.DataNodeResultIndices" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Indices into query resultsdata.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.mullvad_leta.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mullvad_leta.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/mullvad_leta.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.mullvad_leta.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages and regions from Mullvad-Leta</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="mrs.html" title="previous chapter">Matrix Rooms Search (MRS)</a>
|
||||
<li>Next: <a href="mwmbl.html" title="next chapter">Mwmbl Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/mullvad_leta.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
246
dev/engines/online/mwmbl.html
Normal file
246
dev/engines/online/mwmbl.html
Normal file
@@ -0,0 +1,246 @@
|
||||
<!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>Mwmbl Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Odysee" href="odysee.html" />
|
||||
<link rel="prev" title="Mullvad-Leta" href="mullvad_leta.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="odysee.html" title="Odysee"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="mullvad_leta.html" title="Mullvad-Leta"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Mwmbl Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="mwmbl-engine">
|
||||
<span id="id1"></span><h1>Mwmbl Engine<a class="headerlink" href="#mwmbl-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.mwmbl" id="id3">Mwmbl WEB</a></p></li>
|
||||
<li><p><a class="reference internal" href="#mwmbl-autocomplete" id="id4">Mwmbl Autocomplete</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="module-searx.engines.mwmbl">
|
||||
<span id="mwmbl-web"></span><span id="mwmbl-web-engine"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Mwmbl WEB</a><a class="headerlink" href="#module-searx.engines.mwmbl" title="Link to this heading">¶</a></h2>
|
||||
<p><a class="reference external" href="https://github.com/mwmbl/mwmbl">Mwmbl</a> is a non-profit, ad-free, free-libre and free-lunch search engine with
|
||||
a focus on useability and speed.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>At the moment it is little more than an idea together with a proof of concept
|
||||
implementation of the web front-end and search technology on a small index.
|
||||
<a class="reference external" href="https://github.com/mwmbl/mwmbl">Mwmbl</a> does not support regions, languages, safe-search or time range.
|
||||
search.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="mwmbl-autocomplete">
|
||||
<span id="id2"></span><h2><a class="toc-backref" href="#id4" role="doc-backlink">Mwmbl Autocomplete</a><a class="headerlink" href="#mwmbl-autocomplete" title="Link to this heading">¶</a></h2>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.autocomplete.mwmbl">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.autocomplete.</span></span><span class="sig-name descname"><span class="pre">mwmbl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">_sxng_locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/autocomplete.html#mwmbl"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.autocomplete.mwmbl" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Autocomplete from <a class="reference external" href="https://github.com/mwmbl/mwmbl">Mwmbl</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="mullvad_leta.html" title="previous chapter">Mullvad-Leta</a>
|
||||
<li>Next: <a href="odysee.html" title="next chapter">Odysee</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/mwmbl.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
226
dev/engines/online/odysee.html
Normal file
226
dev/engines/online/odysee.html
Normal file
@@ -0,0 +1,226 @@
|
||||
<!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>Odysee — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="OpenAlex" href="openalex.html" />
|
||||
<link rel="prev" title="Mwmbl Engine" href="mwmbl.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="openalex.html" title="OpenAlex"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="mwmbl.html" title="Mwmbl Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Odysee</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="odysee">
|
||||
<span id="odysee-engine"></span><h1>Odysee<a class="headerlink" href="#odysee" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.odysee"><a class="reference external" href="https://github.com/OdyseeTeam/odysee-frontend">Odysee</a> is a decentralized video hosting platform.</p>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.odysee.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.odysee.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/odysee.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.odysee.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages from Odysee’s source code.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="mwmbl.html" title="previous chapter">Mwmbl Engine</a>
|
||||
<li>Next: <a href="openalex.html" title="next chapter">OpenAlex</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/odysee.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
298
dev/engines/online/openalex.html
Normal file
298
dev/engines/online/openalex.html
Normal file
@@ -0,0 +1,298 @@
|
||||
<!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>OpenAlex — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Open Library" href="openlibrary.html" />
|
||||
<link rel="prev" title="Odysee" href="odysee.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="openlibrary.html" title="Open Library"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="odysee.html" title="Odysee"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">OpenAlex</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.openalex">
|
||||
<span id="openalex"></span><span id="openalex-engine"></span><h1>OpenAlex<a class="headerlink" href="#module-searx.engines.openalex" title="Link to this heading">¶</a></h1>
|
||||
<p>The OpenAlex engine integrates the <a class="reference external" href="https://openalex.org">OpenAlex</a> Works API to return scientific
|
||||
paper results using the <a class="reference internal" href="../../result_types/main/paper.html#result-types-paper"><span class="std std-ref">Paper Results</span></a> class. It is an “online” JSON
|
||||
engine that uses the official public API and does not require an API key.</p>
|
||||
<section id="key-features">
|
||||
<h2>Key features<a class="headerlink" href="#key-features" title="Link to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Uses the official Works endpoint (JSON)</p></li>
|
||||
<li><p>Paging support via <code class="docutils literal notranslate"><span class="pre">page</span></code> and <code class="docutils literal notranslate"><span class="pre">per-page</span></code></p></li>
|
||||
<li><p>Relevance sorting (<code class="docutils literal notranslate"><span class="pre">sort=relevance_score:desc</span></code>)</p></li>
|
||||
<li><p>Language filter support (maps SearXNG language to <code class="docutils literal notranslate"><span class="pre">filter=language:<iso2></span></code>)</p></li>
|
||||
<li><p>Maps fields commonly used in scholarly results: title, authors, abstract
|
||||
(reconstructed from inverted index), journal/venue, publisher, DOI, tags
|
||||
(concepts), PDF/HTML links, pages, volume, issue, published date, and a short
|
||||
citations comment</p></li>
|
||||
<li><p>Supports OpenAlex “polite pool” by adding a <code class="docutils literal notranslate"><span class="pre">mailto</span></code> parameter</p></li>
|
||||
</ul>
|
||||
<section id="configuration">
|
||||
<h3>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h3>
|
||||
<p>Minimal example for <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openalex</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openalex</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oa</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">science, scientific publications</span>
|
||||
<span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5.0</span>
|
||||
<span class="w"> </span><span class="c1"># Recommended by OpenAlex: join the polite pool with an email address</span>
|
||||
<span class="w"> </span><span class="nt">mailto</span><span class="p">:</span><span class="w"> </span><span class="s">"[email</span><span class="nv"> </span><span class="s">protected]"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2>Notes<a class="headerlink" href="#notes" title="Link to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">mailto</span></code> key is optional but recommended by OpenAlex for better service.</p></li>
|
||||
<li><p>Language is inherited from the user’s UI language; when it is not <code class="docutils literal notranslate"><span class="pre">all</span></code>, the
|
||||
engine adds <code class="docutils literal notranslate"><span class="pre">filter=language:<iso2></span></code> (e.g. <code class="docutils literal notranslate"><span class="pre">language:fr</span></code>). If OpenAlex has
|
||||
few results for that language, you may see fewer items.</p></li>
|
||||
<li><p>Results typically include a main link. When the primary landing page from
|
||||
OpenAlex is a DOI resolver, the engine will use that stable link. When an open
|
||||
access link is available, it is exposed via the <code class="docutils literal notranslate"><span class="pre">PDF</span></code> and/or <code class="docutils literal notranslate"><span class="pre">HTML</span></code> links
|
||||
in the result footer.</p></li>
|
||||
</ul>
|
||||
<section id="what-is-returned">
|
||||
<h3>What is returned<a class="headerlink" href="#what-is-returned" title="Link to this heading">¶</a></h3>
|
||||
<p>Each result uses the <a class="reference internal" href="../../result_types/main/paper.html#result-types-paper"><span class="std std-ref">Paper Results</span></a> class and may include:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">title</span></code> and <code class="docutils literal notranslate"><span class="pre">content</span></code> (abstract; reconstructed from the inverted index)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">authors</span></code> (display names)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">journal</span></code> (host venue display name) and <code class="docutils literal notranslate"><span class="pre">publisher</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">doi</span></code> (normalized to the plain DOI, without the <code class="docutils literal notranslate"><span class="pre">https://doi.org/</span></code> prefix)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">tags</span></code> (OpenAlex concepts display names)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pdf_url</span></code> (Open access PDF if available) and <code class="docutils literal notranslate"><span class="pre">html_url</span></code> (landing page)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">publishedDate</span></code> (parsed from <code class="docutils literal notranslate"><span class="pre">publication_date</span></code>)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pages</span></code>, <code class="docutils literal notranslate"><span class="pre">volume</span></code>, <code class="docutils literal notranslate"><span class="pre">number</span></code> (issue)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> and a brief <code class="docutils literal notranslate"><span class="pre">comments</span></code> string with citation count</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="rate-limits-polite-pool">
|
||||
<h3>Rate limits & polite pool<a class="headerlink" href="#rate-limits-polite-pool" title="Link to this heading">¶</a></h3>
|
||||
<p>OpenAlex offers a free public API with generous daily limits. For extra courtesy
|
||||
and improved service quality, include a contact email in each request via
|
||||
<code class="docutils literal notranslate"><span class="pre">mailto</span></code>. You can set it directly in the engine configuration as shown above.
|
||||
See: <a class="reference external" href="https://docs.openalex.org/how-to-use-the-api/api-overview">OpenAlex API overview</a>.</p>
|
||||
</section>
|
||||
<section id="troubleshooting">
|
||||
<h3>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Few or no results in a non-English UI language:
|
||||
Ensure the selected language has sufficient coverage at OpenAlex, or set the
|
||||
UI language to English and retry.</p></li>
|
||||
<li><p>Preference changes fail while testing locally:
|
||||
Make sure your <code class="docutils literal notranslate"><span class="pre">server.secret_key</span></code> and <code class="docutils literal notranslate"><span class="pre">server.base_url</span></code> are set in your
|
||||
instance settings so signed cookies work; see <a class="reference internal" href="../../../admin/settings/settings_server.html#settings-server"><span class="std std-ref">server:</span></a>.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="implementation">
|
||||
<h3>Implementation<a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h3>
|
||||
</section>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="odysee.html" title="previous chapter">Odysee</a>
|
||||
<li>Next: <a href="openlibrary.html" title="next chapter">Open Library</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/openalex.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
241
dev/engines/online/openlibrary.html
Normal file
241
dev/engines/online/openlibrary.html
Normal file
@@ -0,0 +1,241 @@
|
||||
<!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>Open Library — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Peertube Engines" href="peertube.html" />
|
||||
<link rel="prev" title="OpenAlex" href="openalex.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="peertube.html" title="Peertube Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="openalex.html" title="OpenAlex"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Open Library</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.openlibrary">
|
||||
<span id="open-library"></span><span id="openlibrary-engine"></span><h1>Open Library<a class="headerlink" href="#module-searx.engines.openlibrary" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://openlibrary.org">Open Library</a> is an open, editable library catalog, building towards a web
|
||||
page for every book ever published.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The service sometimes takes a very long time to respond, the <code class="docutils literal notranslate"><span class="pre">timeout</span></code> may
|
||||
need to be adjusted.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openlibrary</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openlibrary</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ol</span>
|
||||
<span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.openlibrary.search_api">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.openlibrary.</span></span><span class="sig-name descname"><span class="pre">search_api</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://openlibrary.org/search.json'</span></em><a class="headerlink" href="#searx.engines.openlibrary.search_api" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The engine uses the API at the endpoint <a class="reference external" href="https://openlibrary.org/dev/docs/api/search">search.json</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="openalex.html" title="previous chapter">OpenAlex</a>
|
||||
<li>Next: <a href="peertube.html" title="next chapter">Peertube Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/openlibrary.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
269
dev/engines/online/peertube.html
Normal file
269
dev/engines/online/peertube.html
Normal file
@@ -0,0 +1,269 @@
|
||||
<!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>Peertube Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Piped" href="piped.html" />
|
||||
<link rel="prev" title="Open Library" href="openlibrary.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="piped.html" title="Piped"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="openlibrary.html" title="Open Library"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Peertube Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="peertube-engines">
|
||||
<span id="id1"></span><h1>Peertube Engines<a class="headerlink" href="#peertube-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.peertube" id="id2">Peertube Video</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.sepiasearch" id="id3">SepiaSearch</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="module-searx.engines.peertube">
|
||||
<span id="peertube-video"></span><span id="peertube-video-engine"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Peertube Video</a><a class="headerlink" href="#module-searx.engines.peertube" title="Link to this heading">¶</a></h2>
|
||||
<p>Peertube and <a class="reference internal" href="#module-searx.engines.sepiasearch" title="searx.engines.sepiasearch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SepiaSearch</span></code></a> do share
|
||||
(more or less) the same REST API and the schema of the JSON result is identical.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.peertube.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.peertube.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://peer.tube'</span></em><a class="headerlink" href="#searx.engines.peertube.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base URL of the Peertube instance. A list of instances is available at:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://instances.joinpeertube.org/instances">https://instances.joinpeertube.org/instances</a></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.peertube.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.peertube.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/peertube.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.peertube.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble request for the Peertube API</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.peertube.video_response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.peertube.</span></span><span class="sig-name descname"><span class="pre">video_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/peertube.html#video_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.peertube.video_response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse video response from SepiaSearch and Peertube instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.peertube.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.peertube.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/peertube.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.peertube.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages from peertube’s search-index source code.</p>
|
||||
<p>See <a class="reference external" href="https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729#3d8747f9a60695c367c70bb64efba8f403721fad_0_291">videoLanguages</a> in commit <a class="reference external" href="https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729">8ed5c729 - Refactor and redesign client</a></p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.sepiasearch">
|
||||
<span id="sepiasearch"></span><span id="sepiasearch-engine"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">SepiaSearch</a><a class="headerlink" href="#module-searx.engines.sepiasearch" title="Link to this heading">¶</a></h2>
|
||||
<p>SepiaSearch uses the same languages as <a class="reference internal" href="#module-searx.engines.peertube" title="searx.engines.peertube"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Peertube</span></code></a> and the response is identical to the response from the
|
||||
peertube engines.</p>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.sepiasearch.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sepiasearch.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/sepiasearch.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.sepiasearch.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble request for the SepiaSearch API</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="openlibrary.html" title="previous chapter">Open Library</a>
|
||||
<li>Next: <a href="piped.html" title="next chapter">Piped</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/peertube.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
288
dev/engines/online/piped.html
Normal file
288
dev/engines/online/piped.html
Normal file
@@ -0,0 +1,288 @@
|
||||
<!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>Piped — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Presearch Engine" href="presearch.html" />
|
||||
<link rel="prev" title="Peertube Engines" href="peertube.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="presearch.html" title="Presearch Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="peertube.html" title="Peertube Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Piped</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="piped">
|
||||
<span id="piped-engine"></span><h1>Piped<a class="headerlink" href="#piped" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#known-quirks" id="id2">Known Quirks</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.piped">An alternative privacy-friendly YouTube frontend which is efficient by
|
||||
design. <a class="reference external" href="https://docs.piped.video/docs/architecture/">Piped’s architecture</a> consists of 3 components:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.piped.backend_url" title="searx.engines.piped.backend_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.piped.frontend_url" title="searx.engines.piped.frontend_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">frontend</span></code></a></p></li>
|
||||
<li><p>proxy</p></li>
|
||||
</ul>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The <a class="reference internal" href="#searx.engines.piped.backend_url" title="searx.engines.piped.backend_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_url</span></code></a> and <a class="reference internal" href="#searx.engines.piped.frontend_url" title="searx.engines.piped.frontend_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">frontend_url</span></code></a> has to be set in the engine
|
||||
named <cite>piped</cite> and are used by all <code class="docutils literal notranslate"><span class="pre">piped</span></code> engines (unless an individual values
|
||||
for <code class="docutils literal notranslate"><span class="pre">backend_url</span></code> and <code class="docutils literal notranslate"><span class="pre">frontend_url</span></code> are configured for the engine).</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">piped</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">piped</span>
|
||||
<span class="w"> </span><span class="nt">piped_filter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">videos</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">frontend_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://..</span>
|
||||
<span class="w"> </span><span class="nt">backend_url</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://..</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://..</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">piped.music</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">piped</span>
|
||||
<span class="w"> </span><span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">piped</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ppdm</span>
|
||||
<span class="w"> </span><span class="nt">piped_filter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">music_songs</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="known-quirks">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Known Quirks</a><a class="headerlink" href="#known-quirks" title="Link to this heading">¶</a></h2>
|
||||
<p>The implementation to support <a class="reference internal" href="../enginelib.html#searx.enginelib.Engine.paging" title="searx.enginelib.Engine.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a>
|
||||
is based on the <em>nextpage</em> method of Piped’s REST API / the <a class="reference internal" href="#searx.engines.piped.frontend_url" title="searx.engines.piped.frontend_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">frontend</span>
|
||||
<span class="pre">API</span></code></a>. This feature is <em>next page driven</em> and plays well with the
|
||||
<a class="reference internal" href="../../../admin/settings/settings_ui.html#settings-ui"><span class="std std-ref">infinite_scroll</span></a> setting in SearXNG but it does not really
|
||||
fit into SearXNG’s UI to select a page by number.</p>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.piped.backend_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.piped.</span></span><span class="sig-name descname"><span class="pre">backend_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.piped.backend_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://github.com/TeamPiped/Piped-Backend">Piped-Backend</a>: The core component behind Piped. The value is an URL or a
|
||||
list of URLs. In the latter case instance will be selected randomly. For a
|
||||
complete list of official instances see Piped-Instances (<a class="reference external" href="https://piped-instances.kavin.rocks/">JSON</a>)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.piped.frontend_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.piped.</span></span><span class="sig-name descname"><span class="pre">frontend_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.piped.frontend_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://github.com/TeamPiped/Piped">Piped-Frontend</a>: URL to use as link and for embeds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.piped.piped_filter">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.piped.</span></span><span class="sig-name descname"><span class="pre">piped_filter</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></em><a class="headerlink" href="#searx.engines.piped.piped_filter" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Content filter <code class="docutils literal notranslate"><span class="pre">music_songs</span></code> or <code class="docutils literal notranslate"><span class="pre">videos</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="peertube.html" title="previous chapter">Peertube Engines</a>
|
||||
<li>Next: <a href="presearch.html" title="next chapter">Presearch Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/piped.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
292
dev/engines/online/presearch.html
Normal file
292
dev/engines/online/presearch.html
Normal file
@@ -0,0 +1,292 @@
|
||||
<!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>Presearch Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="PubMed" href="pubmed.html" />
|
||||
<link rel="prev" title="Piped" href="piped.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="pubmed.html" title="PubMed"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="piped.html" title="Piped"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Presearch Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="presearch-engine">
|
||||
<span id="engine-presearch"></span><h1>Presearch Engine<a class="headerlink" href="#presearch-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#search-type-video" id="id1">Search type <code class="docutils literal notranslate"><span class="pre">video</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#languages-regions" id="id2">Languages & Regions</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.presearch">Presearch supports the search types listed in <a class="reference internal" href="#searx.engines.presearch.search_type" title="searx.engines.presearch.search_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_type</span></code></a> (general,
|
||||
images, videos, news).</p>
|
||||
<p>Configured <code class="docutils literal notranslate"><span class="pre">presarch</span></code> engines:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">presearch</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">presearch</span>
|
||||
<span class="w"> </span><span class="nt">search_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">search</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">general</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">web</span><span class="p p-Indicator">]</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">presearch images</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">search_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">images</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">images</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">web</span><span class="p p-Indicator">]</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">presearch videos</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">search_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">videos</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">general</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">web</span><span class="p p-Indicator">]</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">presearch news</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">search_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">news</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">news</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">web</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>By default Presearch’s video category is intentionally placed into:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">categories</span><span class="p">:</span> <span class="p">[</span><span class="n">general</span><span class="p">,</span> <span class="n">web</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<section id="search-type-video">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Search type <code class="docutils literal notranslate"><span class="pre">video</span></code></a><a class="headerlink" href="#search-type-video" title="Link to this heading">¶</a></h2>
|
||||
<p>The results in the video category are most often links to pages that contain a
|
||||
video, for instance many links from Preasearch’s video category link content
|
||||
from facebook (aka Meta) or Twitter (aka X). Since these are not real links to
|
||||
video streams SearXNG can’t use the video template for this and if SearXNG can’t
|
||||
use this template, then the user doesn’t want to see these hits in the videos
|
||||
category.</p>
|
||||
</section>
|
||||
<section id="languages-regions">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Languages & Regions</a><a class="headerlink" href="#languages-regions" title="Link to this heading">¶</a></h2>
|
||||
<p>In Presearch there are languages for the UI and regions for narrowing down the
|
||||
search. If we set “auto” for the region in the WEB-UI of Presearch and cookie
|
||||
<code class="docutils literal notranslate"><span class="pre">use_local_search_results=false</span></code>, then the defaults are set for both (the
|
||||
language and the region) from the <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header.</p>
|
||||
<p>Since the region is already “auto” by default, we only need to set the
|
||||
<code class="docutils literal notranslate"><span class="pre">use_local_search_results</span></code> cookie and send the <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header. We
|
||||
have to set these values in both requests we send to Presearch; in the first
|
||||
request to get the request-ID from Presearch and in the final request to get the
|
||||
result list (see <code class="docutils literal notranslate"><span class="pre">send_accept_language_header</span></code>).</p>
|
||||
<p>The time format returned by Presearch varies depending on the language set.
|
||||
Multiple different formats can be supported by using <code class="docutils literal notranslate"><span class="pre">dateutil</span></code> parser, but
|
||||
it doesn’t support formats such as “N time ago”, “vor N time” (German),
|
||||
“Hace N time” (Spanish). Because of this, the dates are simply joined together
|
||||
with the rest of other metadata.</p>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.presearch.search_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.presearch.</span></span><span class="sig-name descname"><span class="pre">search_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'search'</span></em><a class="headerlink" href="#searx.engines.presearch.search_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>must be any of <code class="docutils literal notranslate"><span class="pre">search</span></code>, <code class="docutils literal notranslate"><span class="pre">images</span></code>, <code class="docutils literal notranslate"><span class="pre">videos</span></code>, <code class="docutils literal notranslate"><span class="pre">news</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="piped.html" title="previous chapter">Piped</a>
|
||||
<li>Next: <a href="pubmed.html" title="next chapter">PubMed</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/presearch.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
233
dev/engines/online/pubmed.html
Normal file
233
dev/engines/online/pubmed.html
Normal file
@@ -0,0 +1,233 @@
|
||||
<!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>PubMed — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Qwant" href="qwant.html" />
|
||||
<link rel="prev" title="Presearch Engine" href="presearch.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="qwant.html" title="Qwant"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="presearch.html" title="Presearch Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">PubMed</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.pubmed">
|
||||
<span id="pubmed"></span><span id="pubmed-engine"></span><h1>PubMed<a class="headerlink" href="#module-searx.engines.pubmed" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://pubmed.ncbi.nlm.nih.gov/">PubMed</a> comprises more than 39 million citations for biomedical literature
|
||||
from MEDLINE, life science journals, and online books. Citations may include
|
||||
links to full text content from PubMed Central and publisher web sites.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pubmed</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pubmed</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pub</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="presearch.html" title="previous chapter">Presearch Engine</a>
|
||||
<li>Next: <a href="qwant.html" title="next chapter">Qwant</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/pubmed.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
302
dev/engines/online/qwant.html
Normal file
302
dev/engines/online/qwant.html
Normal file
@@ -0,0 +1,302 @@
|
||||
<!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>Qwant — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="RadioBrowser" href="radio_browser.html" />
|
||||
<link rel="prev" title="PubMed" href="pubmed.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="radio_browser.html" title="RadioBrowser"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="pubmed.html" title="PubMed"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Qwant</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="qwant">
|
||||
<span id="qwant-engine"></span><h1>Qwant<a class="headerlink" href="#qwant" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id2">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.qwant">This engine uses the Qwant API (<a class="reference external" href="https://api.qwant.com/v3">https://api.qwant.com/v3</a>) to implement Qwant
|
||||
-Web, -News, -Images and -Videos. The API is undocumented but can be reverse
|
||||
engineered by reading the network log of <a class="reference external" href="https://www.qwant.com/">https://www.qwant.com/</a> queries.</p>
|
||||
<p>For Qwant’s <em>web-search</em> two alternatives are implemented:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">web</span></code>: uses the <a class="reference internal" href="#searx.engines.qwant.api_url" title="searx.engines.qwant.api_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_url</span></code></a> which returns a JSON structure</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">web-lite</span></code>: uses the <a class="reference internal" href="#searx.engines.qwant.web_lite_url" title="searx.engines.qwant.web_lite_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">web_lite_url</span></code></a> which returns a HTML page</p></li>
|
||||
</ul>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.qwant.qwant_categ" title="searx.engines.qwant.qwant_categ"><code class="xref py py-obj docutils literal notranslate"><span class="pre">qwant_categ</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>This implementation is used by different qwant engines in the <a class="reference internal" href="../../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">settings.yml</span></a>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">qwant</span>
|
||||
<span class="w"> </span><span class="nt">qwant_categ</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">web-lite</span><span class="w"> </span><span class="c1"># alternatively use 'web'</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">qwant news</span>
|
||||
<span class="w"> </span><span class="nt">qwant_categ</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">news</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">qwant images</span>
|
||||
<span class="w"> </span><span class="nt">qwant_categ</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">images</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">qwant videos</span>
|
||||
<span class="w"> </span><span class="nt">qwant_categ</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">videos</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#searx.engines.qwant.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>5 pages maximum (<code class="docutils literal notranslate"><span class="pre">&p=5</span></code>): Trying to do more just results in an improper
|
||||
redirect</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.qwant_categ">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">qwant_categ</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.qwant.qwant_categ" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>One of <code class="docutils literal notranslate"><span class="pre">web-lite</span></code> (or <code class="docutils literal notranslate"><span class="pre">web</span></code>), <code class="docutils literal notranslate"><span class="pre">news</span></code>, <code class="docutils literal notranslate"><span class="pre">images</span></code> or <code class="docutils literal notranslate"><span class="pre">videos</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.api_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">api_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api.qwant.com/v3/search/'</span></em><a class="headerlink" href="#searx.engines.qwant.api_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL of Qwant’s API (JSON)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.web_lite_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">web_lite_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://lite.qwant.com/'</span></em><a class="headerlink" href="#searx.engines.qwant.web_lite_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL of Qwant-Lite (HTML)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/qwant.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.qwant.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Qwant search request</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.parse_web_lite">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">parse_web_lite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/qwant.html#parse_web_lite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.qwant.parse_web_lite" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse results from Qwant-Lite</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.qwant.parse_web_api">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.qwant.</span></span><span class="sig-name descname"><span class="pre">parse_web_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/qwant.html#parse_web_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.qwant.parse_web_api" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse results from Qwant’s API</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="pubmed.html" title="previous chapter">PubMed</a>
|
||||
<li>Next: <a href="radio_browser.html" title="next chapter">RadioBrowser</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/qwant.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
259
dev/engines/online/radio_browser.html
Normal file
259
dev/engines/online/radio_browser.html
Normal file
@@ -0,0 +1,259 @@
|
||||
<!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>RadioBrowser — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Recoll Engine" href="recoll.html" />
|
||||
<link rel="prev" title="Qwant" href="qwant.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="recoll.html" title="Recoll Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="qwant.html" title="Qwant"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">RadioBrowser</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="radiobrowser">
|
||||
<span id="radiobrowser-engine"></span><h1>RadioBrowser<a class="headerlink" href="#radiobrowser" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.radio_browser">Search radio stations from RadioBrowser by <a class="reference external" href="https://de1.api.radio-browser.info/#Advanced_station_search">Advanced station search API</a>.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.radio_browser.station_filters">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.radio_browser.</span></span><span class="sig-name descname"><span class="pre">station_filters</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#searx.engines.radio_browser.station_filters" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A list of filters to be applied to the search of radio stations. By default
|
||||
none filters are applied. Valid filters are:</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">language</span></code></dt><dd><p>Filter stations by selected language. For instance the <code class="docutils literal notranslate"><span class="pre">de</span></code> from <code class="docutils literal notranslate"><span class="pre">:de-AU</span></code>
|
||||
will be translated to <cite>german</cite> and used in the argument <code class="docutils literal notranslate"><span class="pre">language=</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">countrycode</span></code></dt><dd><p>Filter stations by selected country. The 2-digit countrycode of the station
|
||||
comes from the region the user selected. For instance <code class="docutils literal notranslate"><span class="pre">:de-AU</span></code> will filter
|
||||
out all stations not in <code class="docutils literal notranslate"><span class="pre">AU</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>RadioBrowser has registered a lot of languages and countrycodes unknown to
|
||||
<code class="xref py py-obj docutils literal notranslate"><span class="pre">babel</span></code> and note that when searching for radio stations, users are
|
||||
more likely to search by name than by region or language.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.radio_browser.CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.radio_browser.</span></span><span class="sig-name descname"><span class="pre">CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../enginelib.html#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><span class="pre">EngineCache</span></a></em><a class="headerlink" href="#searx.engines.radio_browser.CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values after <code class="docutils literal notranslate"><span class="pre">expire</span></code>
|
||||
seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.radio_browser.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.radio_browser.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/radio_browser.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.radio_browser.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages and countrycodes from RadioBrowser</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">traits.languages</span></code>: <a class="reference external" href="https://de1.api.radio-browser.info/#List_of_languages">list of languages API</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">traits.custom['countrycodes']</span></code>: <a class="reference external" href="https://de1.api.radio-browser.info/#List_of_countries">list of countries API</a></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="qwant.html" title="previous chapter">Qwant</a>
|
||||
<li>Next: <a href="recoll.html" title="next chapter">Recoll Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/radio_browser.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
292
dev/engines/online/recoll.html
Normal file
292
dev/engines/online/recoll.html
Normal file
@@ -0,0 +1,292 @@
|
||||
<!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>Recoll Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Repology" href="repology.html" />
|
||||
<link rel="prev" title="RadioBrowser" href="radio_browser.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="repology.html" title="Repology"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="radio_browser.html" title="RadioBrowser"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Recoll Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="recoll-engine">
|
||||
<span id="engine-recoll"></span><h1>Recoll Engine<a class="headerlink" href="#recoll-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id2">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<aside class="sidebar" id="module-searx.engines.recoll">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a></p></li>
|
||||
<li><p><a class="reference external" href="https://framagit.org/medoc92/recollwebui.git">recoll-webui</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/recoll.py">git://searx/engines/recoll.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a> is a desktop full-text search tool based on Xapian. By itself <a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a>
|
||||
does not offer WEB or API access, this can be achieved using <a class="reference external" href="https://framagit.org/medoc92/recollwebui.git">recoll-webui</a></p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>You must configure the following settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.recoll.base_url" title="searx.engines.recoll.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.recoll.mount_prefix" title="searx.engines.recoll.mount_prefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mount_prefix</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.recoll.dl_prefix" title="searx.engines.recoll.dl_prefix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dl_prefix</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.recoll.search_dir" title="searx.engines.recoll.search_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_dir</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Example scenario:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Recoll indexes a local filesystem mounted in <code class="docutils literal notranslate"><span class="pre">/export/documents/reference</span></code>,</p></li>
|
||||
<li><p>the Recoll search interface can be reached at <a class="reference external" href="https://recoll.example.org/">https://recoll.example.org/</a> and</p></li>
|
||||
<li><p>the contents of this filesystem can be reached though <a class="reference external" href="https://download.example.org/reference">https://download.example.org/reference</a></p></li>
|
||||
</ol>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org</span>
|
||||
<span class="nt">mount_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/export/documents</span>
|
||||
<span class="nt">dl_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://download.example.org</span>
|
||||
<span class="nt">search_dir</span><span class="p">:</span><span class="w"> </span><span class="s">""</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.recoll.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.recoll.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.recoll.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Location where recoll-webui can be reached.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.recoll.mount_prefix">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.recoll.</span></span><span class="sig-name descname"><span class="pre">mount_prefix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.recoll.mount_prefix" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Location where the file hierarchy is mounted on your <em>local</em> filesystem.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.recoll.dl_prefix">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.recoll.</span></span><span class="sig-name descname"><span class="pre">dl_prefix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.recoll.dl_prefix" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Location where the file hierarchy as indexed by recoll can be reached.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.recoll.search_dir">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.recoll.</span></span><span class="sig-name descname"><span class="pre">search_dir</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.recoll.search_dir" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Part of the indexed file hierarchy to be search, if empty the full domain is
|
||||
searched.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.recoll.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.recoll.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/recoll.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.recoll.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the Recoll engine, checks if the mandatory values are
|
||||
configured.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="radio_browser.html" title="previous chapter">RadioBrowser</a>
|
||||
<li>Next: <a href="repology.html" title="next chapter">Repology</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/recoll.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
233
dev/engines/online/repology.html
Normal file
233
dev/engines/online/repology.html
Normal file
@@ -0,0 +1,233 @@
|
||||
<!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>Repology — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Reuters" href="reuters.html" />
|
||||
<link rel="prev" title="Recoll Engine" href="recoll.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="reuters.html" title="Reuters"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="recoll.html" title="Recoll Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Repology</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.repology">
|
||||
<span id="repology"></span><span id="repology-engine"></span><h1>Repology<a class="headerlink" href="#module-searx.engines.repology" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://repology.org/docs/about">Repology</a> monitors a huge number of package repositories and other sources
|
||||
comparing packages versions across them and gathering other information.</p>
|
||||
<p><a class="reference external" href="https://repology.org/docs/about">Repology</a> shows you in which repositories a given project is packaged, which
|
||||
version is the latest and which needs updating, who maintains the package, and
|
||||
other related information.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine is inactive by default, meaning it is not available in the service.
|
||||
If you want to offer the engine, the <code class="docutils literal notranslate"><span class="pre">inactive</span></code> flag must be set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">repology</span>
|
||||
<span class="w"> </span><span class="nt">inactive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="recoll.html" title="previous chapter">Recoll Engine</a>
|
||||
<li>Next: <a href="reuters.html" title="next chapter">Reuters</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/repology.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
271
dev/engines/online/reuters.html
Normal file
271
dev/engines/online/reuters.html
Normal file
@@ -0,0 +1,271 @@
|
||||
<!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>Reuters — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Seekr Engines" href="seekr.html" />
|
||||
<link rel="prev" title="Repology" href="repology.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="seekr.html" title="Seekr Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="repology.html" title="Repology"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Reuters</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.reuters">
|
||||
<span id="reuters"></span><span id="reuters-engine"></span><h1>Reuters<a class="headerlink" href="#module-searx.engines.reuters" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://www.reuters.com">Reuters</a> (news) is an international news agency.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.reuters.sort_order" title="searx.engines.reuters.sort_order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sort_order</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">reuters</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">reuters</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">reu</span>
|
||||
<span class="w"> </span><span class="nt">sort_order</span><span class="p">:</span><span class="w"> </span><span class="s">"relevance"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.reuters.sort_order">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.reuters.</span></span><span class="sig-name descname"><span class="pre">sort_order</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'relevance'</span></em><a class="headerlink" href="#searx.engines.reuters.sort_order" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Sort order, one of <code class="docutils literal notranslate"><span class="pre">relevance</span></code>, <code class="docutils literal notranslate"><span class="pre">display_date:desc</span></code> or <code class="docutils literal notranslate"><span class="pre">display_data:asc</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.reuters.resize_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.reuters.</span></span><span class="sig-name descname"><span class="pre">resize_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">thumbnail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/reuters.html#resize_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.reuters.resize_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Generates a URL for Reuter’s thumbnail with the dimensions <em>width</em> and
|
||||
<em>height</em>. If no URL can be generated from the <em>thumbnail data</em>, an empty
|
||||
string will be returned.</p>
|
||||
<dl class="simple">
|
||||
<dt>width: default is <em>unset</em> (<code class="docutils literal notranslate"><span class="pre">0</span></code>)</dt><dd><p>Image width in pixels (negative values are ignored). If only width is
|
||||
specified, the height matches the original aspect ratio.</p>
|
||||
</dd>
|
||||
<dt>height: default is <em>unset</em> (<code class="docutils literal notranslate"><span class="pre">0</span></code>)</dt><dd><p>Image height in pixels (negative values are ignored). If only height is
|
||||
specified, the width matches the original aspect ratio.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The file size of a full-size image is usually several MB; when reduced to a
|
||||
height of, for example, 80 points, only a few KB remain!</p>
|
||||
<p>Fields of the <em>thumbnail data</em> (<code class="docutils literal notranslate"><span class="pre">result.articles.[<int>].thumbnail</span></code>):</p>
|
||||
<dl class="simple">
|
||||
<dt>thumbnail.url:</dt><dd><p>Is a full-size image (>MB).</p>
|
||||
</dd>
|
||||
<dt>thumbnail.width & .height:</dt><dd><p>Dimensions of the full-size image.</p>
|
||||
</dd>
|
||||
<dt>thumbnail.resizer_url:</dt><dd><p>Reuters has a <em>resizer</em> <a class="reference external" href="https://dev.arcxp.com/photo-center/image-resizer/resizer-v2-how-to-transform-images/#query-parameters">REST-API for the images</a>, this is the URL of the
|
||||
service. This URL includes the <code class="docutils literal notranslate"><span class="pre">&auth</span></code> argument, other arguments are
|
||||
<code class="docutils literal notranslate"><span class="pre">&width=<int></span></code> and <code class="docutils literal notranslate"><span class="pre">&height=<int></span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="repology.html" title="previous chapter">Repology</a>
|
||||
<li>Next: <a href="seekr.html" title="next chapter">Seekr Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/reuters.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
273
dev/engines/online/seekr.html
Normal file
273
dev/engines/online/seekr.html
Normal file
@@ -0,0 +1,273 @@
|
||||
<!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>Seekr Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Semantic Scholar" href="semantic_scholar.html" />
|
||||
<link rel="prev" title="Reuters" href="reuters.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="semantic_scholar.html" title="Semantic Scholar"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="reuters.html" title="Reuters"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Seekr Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="seekr-engines">
|
||||
<span id="seekr-engine"></span><h1>Seekr Engines<a class="headerlink" href="#seekr-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#known-quirks" id="id2">Known Quirks</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.seekr">seekr.com Seeker Score</p>
|
||||
<p>Seekr is a privately held search and content evaluation engine that prioritizes
|
||||
credibility over popularity.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.seekr.seekr_category" title="searx.engines.seekr.seekr_category"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seekr_category</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.seekr.api_key" title="searx.engines.seekr.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>This implementation is used by seekr engines in the <a class="reference internal" href="../../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">settings.yml</span></a>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">seekr news</span>
|
||||
<span class="w"> </span><span class="nt">seekr_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">news</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">seekr images</span>
|
||||
<span class="w"> </span><span class="nt">seekr_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">images</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">seekr videos</span>
|
||||
<span class="w"> </span><span class="nt">seekr_category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">videos</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="known-quirks">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Known Quirks</a><a class="headerlink" href="#known-quirks" title="Link to this heading">¶</a></h2>
|
||||
<p>The implementation to support <a class="reference internal" href="../enginelib.html#searx.enginelib.Engine.paging" title="searx.enginelib.Engine.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a>
|
||||
is based on the <em>nextpage</em> method of Seekr’s REST API. This feature is <em>next
|
||||
page driven</em> and plays well with the <a class="reference internal" href="../../../admin/settings/settings_ui.html#settings-ui"><span class="std std-ref">infinite_scroll</span></a>
|
||||
setting in SearXNG but it does not really fit into SearXNG’s UI to select a page
|
||||
by number.</p>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.seekr.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.seekr.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'srh1-22fb-sekr'</span></em><a class="headerlink" href="#searx.engines.seekr.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>API key / reversed engineered / is still the same one since 2022.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.seekr.seekr_category">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.seekr.</span></span><span class="sig-name descname"><span class="pre">seekr_category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'unset'</span></em><a class="headerlink" href="#searx.engines.seekr.seekr_category" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Search category, any of <code class="docutils literal notranslate"><span class="pre">news</span></code>, <code class="docutils literal notranslate"><span class="pre">videos</span></code> or <code class="docutils literal notranslate"><span class="pre">images</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="reuters.html" title="previous chapter">Reuters</a>
|
||||
<li>Next: <a href="semantic_scholar.html" title="next chapter">Semantic Scholar</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/seekr.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
243
dev/engines/online/semantic_scholar.html
Normal file
243
dev/engines/online/semantic_scholar.html
Normal file
@@ -0,0 +1,243 @@
|
||||
<!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>Semantic Scholar — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Soundcloud" href="soundcloud.html" />
|
||||
<link rel="prev" title="Seekr Engines" href="seekr.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="soundcloud.html" title="Soundcloud"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="seekr.html" title="Seekr Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Semantic Scholar</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.semantic_scholar">
|
||||
<span id="semantic-scholar"></span><span id="semantic-scholar-engine"></span><h1>Semantic Scholar<a class="headerlink" href="#module-searx.engines.semantic_scholar" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://www.semanticscholar.org/about">Semantic Scholar</a> provides free, AI-driven search and discovery tools, and
|
||||
open resources for the global research community. <a class="reference external" href="https://www.semanticscholar.org/about">Semantic Scholar</a> index
|
||||
over 200 million academic papers sourced from publisher partnerships, data
|
||||
providers, and web crawls.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>To get in use of this engine add the following entry to your engines list in
|
||||
<code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">semantic scholar</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">semantic_scholar</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">se</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.semantic_scholar.CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.semantic_scholar.</span></span><span class="sig-name descname"><span class="pre">CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../enginelib.html#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><span class="pre">EngineCache</span></a></em><a class="headerlink" href="#searx.engines.semantic_scholar.CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values after <code class="docutils literal notranslate"><span class="pre">expire</span></code>
|
||||
seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="seekr.html" title="previous chapter">Seekr Engines</a>
|
||||
<li>Next: <a href="soundcloud.html" title="next chapter">Soundcloud</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/semantic_scholar.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
234
dev/engines/online/soundcloud.html
Normal file
234
dev/engines/online/soundcloud.html
Normal file
@@ -0,0 +1,234 @@
|
||||
<!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>Soundcloud — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Sourcehut" href="sourcehut.html" />
|
||||
<link rel="prev" title="Semantic Scholar" href="semantic_scholar.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="sourcehut.html" title="Sourcehut"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="semantic_scholar.html" title="Semantic Scholar"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Soundcloud</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="soundcloud">
|
||||
<span id="soundcloud-engine"></span><h1>Soundcloud<a class="headerlink" href="#soundcloud" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.soundcloud">SoundCloud is a German audio streaming service.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.soundcloud.search_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.soundcloud.</span></span><span class="sig-name descname"><span class="pre">search_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api-v2.soundcloud.com/search'</span></em><a class="headerlink" href="#searx.engines.soundcloud.search_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>This is not the official (developer) url, it is the API which is used by the
|
||||
HTML frontend of the common WEB site.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.soundcloud.CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.soundcloud.</span></span><span class="sig-name descname"><span class="pre">CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../enginelib.html#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><span class="pre">EngineCache</span></a></em><a class="headerlink" href="#searx.engines.soundcloud.CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values after <code class="docutils literal notranslate"><span class="pre">expire</span></code>
|
||||
seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="semantic_scholar.html" title="previous chapter">Semantic Scholar</a>
|
||||
<li>Next: <a href="sourcehut.html" title="next chapter">Sourcehut</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/soundcloud.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
252
dev/engines/online/sourcehut.html
Normal file
252
dev/engines/online/sourcehut.html
Normal file
@@ -0,0 +1,252 @@
|
||||
<!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>Sourcehut — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Springer Nature" href="springer.html" />
|
||||
<link rel="prev" title="Soundcloud" href="soundcloud.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="springer.html" title="Springer Nature"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="soundcloud.html" title="Soundcloud"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Sourcehut</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.sourcehut">
|
||||
<span id="sourcehut"></span><span id="sourcehut-engine"></span><h1>Sourcehut<a class="headerlink" href="#module-searx.engines.sourcehut" title="Link to this heading">¶</a></h1>
|
||||
<p>Engine to search in the collaborative software platform <a class="reference external" href="https://sourcehut.org/">SourceHut</a>.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>You can configure the following setting:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.sourcehut.sourcehut_sort_order" title="searx.engines.sourcehut.sourcehut_sort_order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sourcehut_sort_order</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sourcehut</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">srht</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sourcehut</span>
|
||||
<span class="w"> </span><span class="c1"># sourcehut_sort_order: longest-active</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sourcehut.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sourcehut.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://sr.ht/projects'</span></em><a class="headerlink" href="#searx.engines.sourcehut.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Browse public projects.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sourcehut.sourcehut_sort_order">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sourcehut.</span></span><span class="sig-name descname"><span class="pre">sourcehut_sort_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'recently-updated'</span></em><a class="headerlink" href="#searx.engines.sourcehut.sourcehut_sort_order" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The sort order of the results. Possible values:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">recently-updated</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">longest-active</span></code></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="soundcloud.html" title="previous chapter">Soundcloud</a>
|
||||
<li>Next: <a href="springer.html" title="next chapter">Springer Nature</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/sourcehut.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
281
dev/engines/online/springer.html
Normal file
281
dev/engines/online/springer.html
Normal file
@@ -0,0 +1,281 @@
|
||||
<!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>Springer Nature — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Startpage Engines" href="startpage.html" />
|
||||
<link rel="prev" title="Sourcehut" href="sourcehut.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="startpage.html" title="Startpage Engines"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="sourcehut.html" title="Sourcehut"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Springer Nature</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.springer">
|
||||
<span id="springer-nature"></span><span id="springer-engine"></span><h1>Springer Nature<a class="headerlink" href="#module-searx.engines.springer" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://www.springernature.com/">Springer Nature</a> is a global publisher dedicated to providing service to
|
||||
research community with official <a class="reference external" href="https://dev.springernature.com/docs/introduction/">Springer-API</a> (<a class="reference external" href="https://dev.springernature.com/docs/live-documentation/">API-Playground</a>).</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The Springer engine requires an API key, which can be obtained via the
|
||||
<a class="reference external" href="https://dev.springernature.com/subscription/">Springer subscription</a>.</p>
|
||||
</div>
|
||||
<p>Since the search term is passed 1:1 to the API, SearXNG users can use the
|
||||
<a class="reference external" href="https://dev.springernature.com/docs/supported-query-params/">Supported Query Parameters</a>.</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!springer</span> <span class="pre">(doi:10.1007/s10948-025-07019-1</span> <span class="pre">OR</span> <span class="pre">doi:10.1007/s10948-025-07035-1)</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!springer</span> <span class="pre">keyword:ybco</span></code></p></li>
|
||||
</ul>
|
||||
<p>However, please note that the available options depend on the subscription type.</p>
|
||||
<p>For example, the <code class="docutils literal notranslate"><span class="pre">year:</span></code> filter requires a <em>Premium Plan</em> subscription.</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!springer</span> <span class="pre">keyword:ybco</span> <span class="pre">year:2024</span></code></p></li>
|
||||
</ul>
|
||||
<p>The engine uses the REST <a class="reference external" href="https://dev.springernature.com/docs/api-endpoints/meta-api/">Meta-API</a> <cite>v2</cite> endpoint, but there is also a <a class="reference external" href="https://pypi.org/project/springernature-api-client/">Python
|
||||
API Wrapper</a>.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.springer.api_key" title="searx.engines.springer.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">springer nature</span>
|
||||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="s">"..."</span>
|
||||
<span class="w"> </span><span class="nt">inactive</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.springer.nb_per_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">nb_per_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#searx.engines.springer.nb_per_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Number of results to return in the request, see <a class="reference external" href="https://dev.springernature.com/docs/advanced-querying/pagination-limits/">Pagination and Limits</a> for
|
||||
more details.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.springer.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.springer.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Key used for the <a class="reference external" href="https://dev.springernature.com/docs/api-endpoints/meta-api/">Meta-API</a>. Get your API key from: <a class="reference external" href="https://dev.springernature.com/subscription/">Springer subscription</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.springer.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api.springernature.com/meta/v2/json'</span></em><a class="headerlink" href="#searx.engines.springer.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>An enhanced endpoint with additional metadata fields and optimized queries
|
||||
for more efficient and comprehensive retrieval (<a class="reference external" href="https://dev.springernature.com/docs/api-endpoints/meta-api/">Meta-API</a> <cite>v2</cite>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.springer.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.springer.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/springer.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.springer.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the Springer engine, checks whether the
|
||||
<a class="reference internal" href="#searx.engines.springer.api_key" title="searx.engines.springer.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a> is set, otherwise the engine is inactive.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="sourcehut.html" title="previous chapter">Sourcehut</a>
|
||||
<li>Next: <a href="startpage.html" title="next chapter">Startpage Engines</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/springer.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
372
dev/engines/online/startpage.html
Normal file
372
dev/engines/online/startpage.html
Normal file
@@ -0,0 +1,372 @@
|
||||
<!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>Startpage Engines — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Tagesschau API" href="tagesschau.html" />
|
||||
<link rel="prev" title="Springer Nature" href="springer.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="tagesschau.html" title="Tagesschau API"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="springer.html" title="Springer Nature"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Startpage Engines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="startpage-engines">
|
||||
<span id="id1"></span><h1>Startpage Engines<a class="headerlink" href="#startpage-engines" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#startpage-regions" id="id9">Startpage regions</a></p></li>
|
||||
<li><p><a class="reference internal" href="#startpage-languages" id="id10">Startpage languages</a></p></li>
|
||||
<li><p><a class="reference internal" href="#startpage-categories" id="id11">Startpage categories</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.startpage">Startpage’s language & region selectors are a mess ..</p>
|
||||
<section id="startpage-regions">
|
||||
<span id="id2"></span><h2><a class="toc-backref" href="#id9" role="doc-backlink">Startpage regions</a><a class="headerlink" href="#startpage-regions" title="Link to this heading">¶</a></h2>
|
||||
<p>In the list of regions there are tags we need to map to common region tags:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pt</span><span class="o">-</span><span class="n">BR_BR</span> <span class="o">--></span> <span class="n">pt_BR</span>
|
||||
<span class="n">zh</span><span class="o">-</span><span class="n">CN_CN</span> <span class="o">--></span> <span class="n">zh_Hans_CN</span>
|
||||
<span class="n">zh</span><span class="o">-</span><span class="n">TW_TW</span> <span class="o">--></span> <span class="n">zh_Hant_TW</span>
|
||||
<span class="n">zh</span><span class="o">-</span><span class="n">TW_HK</span> <span class="o">--></span> <span class="n">zh_Hant_HK</span>
|
||||
<span class="n">en</span><span class="o">-</span><span class="n">GB_GB</span> <span class="o">--></span> <span class="n">en_GB</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>and there is at least one tag with a three letter language tag (ISO 639-2):</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fil_PH</span> <span class="o">--></span> <span class="n">fil_PH</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The locale code <code class="docutils literal notranslate"><span class="pre">no_NO</span></code> from Startpage does not exists and is mapped to
|
||||
<code class="docutils literal notranslate"><span class="pre">nb-NO</span></code>:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">babel</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span> <span class="n">unknown</span> <span class="n">locale</span> <span class="s1">'no_NO'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>For reference see languages-subtag at iana; <code class="docutils literal notranslate"><span class="pre">no</span></code> is the macrolanguage <a class="footnote-reference brackets" href="#id5" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> and
|
||||
W3C recommends subtag over macrolanguage <a class="footnote-reference brackets" href="#id6" id="id4" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a>.</p>
|
||||
<aside class="footnote-list brackets">
|
||||
<aside class="footnote brackets" id="id5" role="doc-footnote">
|
||||
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">1</a><span class="fn-bracket">]</span></span>
|
||||
<p><a class="reference external" href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">iana: language-subtag-registry</a></p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">:</span> <span class="n">language</span>
|
||||
<span class="n">Subtag</span><span class="p">:</span> <span class="n">nb</span>
|
||||
<span class="n">Description</span><span class="p">:</span> <span class="n">Norwegian</span> <span class="n">Bokmål</span>
|
||||
<span class="n">Added</span><span class="p">:</span> <span class="mi">2005</span><span class="o">-</span><span class="mi">10</span><span class="o">-</span><span class="mi">16</span>
|
||||
<span class="n">Suppress</span><span class="o">-</span><span class="n">Script</span><span class="p">:</span> <span class="n">Latn</span>
|
||||
<span class="n">Macrolanguage</span><span class="p">:</span> <span class="n">no</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</aside>
|
||||
<aside class="footnote brackets" id="id6" role="doc-footnote">
|
||||
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id4">2</a><span class="fn-bracket">]</span></span>
|
||||
<p>Use macrolanguages with care. Some language subtags have a Scope field set to
|
||||
macrolanguage, i.e. this primary language subtag encompasses a number of more
|
||||
specific primary language subtags in the registry. … As we recommended for
|
||||
the collection subtags mentioned above, in most cases you should try to use
|
||||
the more specific subtags … <a class="reference external" href="https://www.w3.org/International/questions/qa-choosing-language-tags#langsubtag">W3: The primary language subtag</a></p>
|
||||
</aside>
|
||||
</aside>
|
||||
</section>
|
||||
<section id="startpage-languages">
|
||||
<span id="id7"></span><h2><a class="toc-backref" href="#id10" role="doc-backlink">Startpage languages</a><a class="headerlink" href="#startpage-languages" title="Link to this heading">¶</a></h2>
|
||||
<dl>
|
||||
<dt><a class="reference internal" href="#searx.engines.startpage.send_accept_language_header" title="searx.engines.startpage.send_accept_language_header"><code class="xref py py-obj docutils literal notranslate"><span class="pre">send_accept_language_header</span></code></a>:</dt><dd><p>The displayed name in Startpage’s settings page depend on the location of the
|
||||
IP when <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> HTTP header is unset. In <a class="reference internal" href="#searx.engines.startpage.fetch_traits" title="searx.engines.startpage.fetch_traits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fetch_traits</span></code></a>
|
||||
we use:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">'Accept-Language'</span><span class="p">:</span> <span class="s2">"en-US,en;q=0.5"</span><span class="p">,</span>
|
||||
<span class="o">..</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>to get uniform names independent from the IP).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="startpage-categories">
|
||||
<span id="id8"></span><h2><a class="toc-backref" href="#id11" role="doc-backlink">Startpage categories</a><a class="headerlink" href="#startpage-categories" title="Link to this heading">¶</a></h2>
|
||||
<p>Startpage’s category (for Web-search, News, Videos, ..) is set by
|
||||
<a class="reference internal" href="#searx.engines.startpage.startpage_categ" title="searx.engines.startpage.startpage_categ"><code class="xref py py-obj docutils literal notranslate"><span class="pre">startpage_categ</span></code></a> in settings.yml:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span> <span class="n">name</span><span class="p">:</span> <span class="n">startpage</span>
|
||||
<span class="n">engine</span><span class="p">:</span> <span class="n">startpage</span>
|
||||
<span class="n">startpage_categ</span><span class="p">:</span> <span class="n">web</span>
|
||||
<span class="o">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Supported categories are <code class="docutils literal notranslate"><span class="pre">web</span></code>, <code class="docutils literal notranslate"><span class="pre">news</span></code> and <code class="docutils literal notranslate"><span class="pre">images</span></code>.</p>
|
||||
</div>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.startpage_categ">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">startpage_categ</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'web'</span></em><a class="headerlink" href="#searx.engines.startpage.startpage_categ" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Startpage’s category, visit <a class="reference internal" href="#startpage-categories"><span class="std std-ref">Startpage categories</span></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.send_accept_language_header">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">send_accept_language_header</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.startpage.send_accept_language_header" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Startpage tries to guess user’s language and territory from the HTTP
|
||||
<code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code>. Optional the user can select a search-language (can be
|
||||
different to the UI language) and a region filter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.max_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">max_page</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">18</span></em><a class="headerlink" href="#searx.engines.startpage.max_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Tested 18 pages maximum (argument <code class="docutils literal notranslate"><span class="pre">page</span></code>), to be save max is set to 20.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.search_form_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">search_form_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'//form[@id="search"]'</span></em><a class="headerlink" href="#searx.engines.startpage.search_form_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>XPath of Startpage’s origin search form</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.CACHE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">CACHE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="../enginelib.html#searx.enginelib.EngineCache" title="searx.enginelib.EngineCache"><span class="pre">EngineCache</span></a></em><a class="headerlink" href="#searx.engines.startpage.CACHE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Persistent (SQLite) key/value cache that deletes its values after <code class="docutils literal notranslate"><span class="pre">expire</span></code>
|
||||
seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.sc_code_cache_sec">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">sc_code_cache_sec</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3600</span></em><a class="headerlink" href="#searx.engines.startpage.sc_code_cache_sec" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Time in seconds the sc-code is cached in memory <a class="reference internal" href="#searx.engines.startpage.get_sc_code" title="searx.engines.startpage.get_sc_code"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_sc_code</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.get_sc_code">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">get_sc_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">searxng_locale</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/startpage.html#get_sc_code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.startpage.get_sc_code" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get an actual <code class="docutils literal notranslate"><span class="pre">sc</span></code> argument from Startpage’s search form (HTML page).</p>
|
||||
<p>Startpage puts a <code class="docutils literal notranslate"><span class="pre">sc</span></code> argument on every HTML <a class="reference internal" href="#searx.engines.startpage.search_form_xpath" title="searx.engines.startpage.search_form_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search</span> <span class="pre">form</span></code></a>. Without this argument Startpage considers the request
|
||||
is from a bot. We do not know what is encoded in the value of the <code class="docutils literal notranslate"><span class="pre">sc</span></code>
|
||||
argument, but it seems to be a kind of a <em>timestamp</em>.</p>
|
||||
<p>Startpage’s search form generates a new sc-code on each request. This
|
||||
function scrapes a new sc-code from Startpage’s home page every
|
||||
<a class="reference internal" href="#searx.engines.startpage.sc_code_cache_sec" title="searx.engines.startpage.sc_code_cache_sec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sc_code_cache_sec</span></code></a> seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/startpage.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.startpage.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble a Startpage request.</p>
|
||||
<p>To avoid CAPTCHAs we need to send a well formed HTTP POST request with a
|
||||
cookie. We need to form a request that is identical to the request built by
|
||||
Startpage’s search form:</p>
|
||||
<ul class="simple">
|
||||
<li><p>in the cookie the <strong>region</strong> is selected</p></li>
|
||||
<li><p>in the HTTP POST data the <strong>language</strong> is selected</p></li>
|
||||
</ul>
|
||||
<p>Additionally the arguments form Startpage’s search form needs to be set in
|
||||
HTML POST data / compare <code class="docutils literal notranslate"><span class="pre"><input></span></code> elements: <a class="reference internal" href="#searx.engines.startpage.search_form_xpath" title="searx.engines.startpage.search_form_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_form_xpath</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.startpage.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.startpage.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/startpage.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.startpage.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch <a class="reference internal" href="#startpage-languages"><span class="std std-ref">languages</span></a> and <a class="reference internal" href="#startpage-regions"><span class="std std-ref">regions</span></a> from Startpage.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="springer.html" title="previous chapter">Springer Nature</a>
|
||||
<li>Next: <a href="tagesschau.html" title="next chapter">Tagesschau API</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/startpage.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
237
dev/engines/online/tagesschau.html
Normal file
237
dev/engines/online/tagesschau.html
Normal file
@@ -0,0 +1,237 @@
|
||||
<!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>Tagesschau API — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Torznab WebAPI" href="torznab.html" />
|
||||
<link rel="prev" title="Startpage Engines" href="startpage.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="torznab.html" title="Torznab WebAPI"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="startpage.html" title="Startpage Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Tagesschau API</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="tagesschau-api">
|
||||
<span id="tagesschau-engine"></span><h1>Tagesschau API<a class="headerlink" href="#tagesschau-api" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.tagesschau">ARD: <a class="reference external" href="https://github.com/AndreasFischer1985/tagesschau-api/blob/main/README_en.md">Tagesschau API</a></p>
|
||||
<p>The Tagesschau is a news program of the ARD. Via the <a class="reference external" href="https://github.com/AndreasFischer1985/tagesschau-api/blob/main/README_en.md">Tagesschau API</a>, current
|
||||
news and media reports are available in JSON format. The <a class="reference external" href="https://github.com/bundesAPI">Bundesstelle für Open
|
||||
Data</a> offers a <a class="reference external" href="https://swagger.io/specification/">OpenAPI</a> portal at <a class="reference external" href="https://bund.dev/apis">bundDEV</a> where APIs are documented an can
|
||||
be tested.</p>
|
||||
<p>This SearXNG engine uses the <a class="reference external" href="http://tagesschau.api.bund.dev/">/api2u/search</a> API.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tagesschau.use_source_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tagesschau.</span></span><span class="sig-name descname"><span class="pre">use_source_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.tagesschau.use_source_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>When set to false, display URLs from Tagesschau, and not the actual source
|
||||
(e.g. NDR, WDR, SWR, HR, …)</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The actual source may contain additional content, such as commentary, that is
|
||||
not displayed in the Tagesschau.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="startpage.html" title="previous chapter">Startpage Engines</a>
|
||||
<li>Next: <a href="torznab.html" title="next chapter">Torznab WebAPI</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/tagesschau.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
291
dev/engines/online/torznab.html
Normal file
291
dev/engines/online/torznab.html
Normal file
@@ -0,0 +1,291 @@
|
||||
<!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>Torznab WebAPI — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Tube Archivist" href="tubearchivist.html" />
|
||||
<link rel="prev" title="Tagesschau API" href="tagesschau.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="tubearchivist.html" title="Tube Archivist"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="tagesschau.html" title="Tagesschau API"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Torznab WebAPI</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="torznab-webapi">
|
||||
<span id="torznab-engine"></span><h1>Torznab WebAPI<a class="headerlink" href="#torznab-webapi" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id2">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.torznab"><a class="reference external" href="https://torznab.github.io/spec-1.3-draft/index.html">Torznab</a> is an API specification that provides a standardized way to query
|
||||
torrent site for content. It is used by a number of torrent applications,
|
||||
including <a class="reference external" href="https://github.com/Prowlarr/Prowlarr">Prowlarr</a> and <a class="reference external" href="https://github.com/Jackett/Jackett">Jackett</a>.</p>
|
||||
<p>Using this engine together with <a class="reference external" href="https://github.com/Prowlarr/Prowlarr">Prowlarr</a> or <a class="reference external" href="https://github.com/Jackett/Jackett">Jackett</a> allows you to search
|
||||
a huge number of torrent sites which are not directly supported.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following settings:</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code>:</dt><dd><p>Torznab endpoint URL.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">api_key</span></code>:</dt><dd><p>The API key to use for authentication.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">torznab_categories</span></code>:</dt><dd><p>The categories to use for searching. This is a list of category IDs. See
|
||||
<a class="reference external" href="https://wiki.servarr.com/en/prowlarr/cardigann-yml-definition#categories">Prowlarr-categories</a> or <a class="reference external" href="https://github.com/Jackett/Jackett/wiki/Jackett-Categories">Jackett-categories</a> for more information.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">show_torrent_files</span></code>:</dt><dd><p>Whether to show the torrent file in the search results. Be careful as using
|
||||
this with <a class="reference external" href="https://github.com/Prowlarr/Prowlarr">Prowlarr</a> or <a class="reference external" href="https://github.com/Jackett/Jackett">Jackett</a> leaks the API key. This should be used only
|
||||
if you are querying a Torznab endpoint without authentication or if the
|
||||
instance is private. Be aware that private trackers may ban you if you share
|
||||
the torrent file. Defaults to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">show_magnet_links</span></code>:</dt><dd><p>Whether to show the magnet link in the search results. Be aware that private
|
||||
trackers may ban you if you share the magnet link. Defaults to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.torznab.init">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.torznab.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/torznab.html#init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.torznab.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialize the engine.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.torznab.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.torznab.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/torznab.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.torznab.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build the request params.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.torznab.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.torznab.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../extended_types.html#searx.extended_types.SXNG_Response" title="searx.extended_types.SXNG_Response"><span class="pre">SXNG_Response</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/torznab.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.torznab.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse the XML response and return a list of results.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.torznab.build_result">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.torznab.</span></span><span class="sig-name descname"><span class="pre">build_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://lxml.de/apidoc/lxml.etree.html#lxml.etree.Element" title="(in lxml v6.0.0)"><span class="pre">Element</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../_modules/searx/engines/torznab.html#build_result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.torznab.build_result" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build a result from a XML item.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.torznab.get_attribute">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.torznab.</span></span><span class="sig-name descname"><span class="pre">get_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://lxml.de/apidoc/lxml.etree.html#lxml.etree.Element" title="(in lxml v6.0.0)"><span class="pre">Element</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">property_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/torznab.html#get_attribute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.torznab.get_attribute" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get attribute from item.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.torznab.get_torznab_attribute">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.torznab.</span></span><span class="sig-name descname"><span class="pre">get_torznab_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://lxml.de/apidoc/lxml.etree.html#lxml.etree.Element" title="(in lxml v6.0.0)"><span class="pre">Element</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/torznab.html#get_torznab_attribute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.torznab.get_torznab_attribute" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get torznab special attribute from item.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="tagesschau.html" title="previous chapter">Tagesschau API</a>
|
||||
<li>Next: <a href="tubearchivist.html" title="next chapter">Tube Archivist</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/torznab.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
310
dev/engines/online/tubearchivist.html
Normal file
310
dev/engines/online/tubearchivist.html
Normal file
@@ -0,0 +1,310 @@
|
||||
<!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>Tube Archivist — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Void Linux binary packages" href="void.html" />
|
||||
<link rel="prev" title="Torznab WebAPI" href="torznab.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="void.html" title="Void Linux binary packages"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="torznab.html" title="Torznab WebAPI"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Tube Archivist</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.tubearchivist">
|
||||
<span id="tube-archivist"></span><span id="tubearchivist-engine"></span><h1>Tube Archivist<a class="headerlink" href="#module-searx.engines.tubearchivist" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference external" href="https://www.tubearchivist.com">Tube Archivist</a> - <em>Your self hosted YouTube media server.</em></p>
|
||||
<p>This engine connects with a self-hosted instance of <a class="reference external" href="https://www.tubearchivist.com">Tube Archivist</a> to allow
|
||||
searching for your hosted videos.</p>
|
||||
<p><a class="reference external" href="https://www.tubearchivist.com">Tube Archivist</a> (TA) requires authentication for all image loads via cookie
|
||||
authentication. What this means is that by default, SearXNG will have no way to
|
||||
pull images from TA (as there is no way to pass cookies in a URL string only).</p>
|
||||
<p>In the meantime while work is done on the TA side, this can be worked around by
|
||||
bypassing auth for images in TA by altering the default TA nginx file.</p>
|
||||
<p>This is located in the main tubearchivist docker container at:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">nginx</span><span class="o">/</span><span class="n">sites</span><span class="o">-</span><span class="n">available</span><span class="o">/</span><span class="n">default</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>It is <strong>strongly</strong> recommended first setting up the intial connection and
|
||||
verying searching works first with broken images, and then attempting this
|
||||
change. This will limit any debugging to only images, rather than
|
||||
tokens/networking.</p>
|
||||
<p>Steps to enable <strong>unauthenticated</strong> metadata access for channels and videos:</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Perform any backups of TA before editing core configurations.</p></li>
|
||||
<li><p>Copy the contents of the file <code class="docutils literal notranslate"><span class="pre">/etc/nginx/sites-available/default</span></code> in the
|
||||
TA docker container</p></li>
|
||||
<li><p>Edit <code class="docutils literal notranslate"><span class="pre">location</span> <span class="pre">/cache/videos</span></code> and <code class="docutils literal notranslate"><span class="pre">location</span> <span class="pre">/cache/channels</span></code>. Comment
|
||||
out the line <code class="docutils literal notranslate"><span class="pre">auth_request</span> <span class="pre">/api/ping/;</span></code> to <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">auth_request</span> <span class="pre">/api/ping/;</span></code>.</p></li>
|
||||
<li><p>Save the file to wherever you normally store your docker configuration.</p></li>
|
||||
<li><p>Mount this new configuration over the default configuration. With <code class="docutils literal notranslate"><span class="pre">docker</span>
|
||||
<span class="pre">run</span></code>, this would be:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">v</span> <span class="o">./</span><span class="n">your</span><span class="o">-</span><span class="n">new</span><span class="o">-</span><span class="n">config</span><span class="o">.</span><span class="n">yml</span><span class="p">:</span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">nginx</span><span class="o">/</span><span class="n">sites</span><span class="o">-</span><span class="n">available</span><span class="o">/</span><span class="n">default</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>With <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">compose</span></code>, this would be:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span> <span class="s2">"./your-new-config.yml:/etc/nginx/sites-available/default:ro"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Start the TA container.</p></li>
|
||||
</ol>
|
||||
<p>After these steps, double check that TA works as normal (nothing should be
|
||||
different on the TA side). Searching again should now show images.</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following required settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.tubearchivist.base_url" title="searx.engines.tubearchivist.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.tubearchivist.ta_token" title="searx.engines.tubearchivist.ta_token"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ta_token</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Optional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.tubearchivist.ta_link_to_mp4" title="searx.engines.tubearchivist.ta_link_to_mp4"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ta_link_to_mp4</span></code></a></p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tubearchivist</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tubearchivist</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tuba</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ta_token</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ta_link_to_mp4</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tubearchivist.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tubearchivist.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.tubearchivist.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base URL of the Tube Archivist instance. Fill this in with your own
|
||||
Tube Archivist URL (<code class="docutils literal notranslate"><span class="pre">http://your-instance:port</span></code>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tubearchivist.ta_token">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tubearchivist.</span></span><span class="sig-name descname"><span class="pre">ta_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.tubearchivist.ta_token" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The API key to use for <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Authorization">Authorization</a> header. Can be found under:</p>
|
||||
<blockquote>
|
||||
<div><p><span class="menuselection">Settings ‣ User ‣ Admin Interface</span>.</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tubearchivist.ta_link_to_mp4">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tubearchivist.</span></span><span class="sig-name descname"><span class="pre">ta_link_to_mp4</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.tubearchivist.ta_link_to_mp4" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Optional, if true SearXNG will link directly to the mp4 of the video to play
|
||||
in the browser. The default behavior is to link into TubeArchivist’s interface
|
||||
directly.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.tubearchivist.video_response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tubearchivist.</span></span><span class="sig-name descname"><span class="pre">video_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/tubearchivist.html#video_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.tubearchivist.video_response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse video response from Tubearchivist instances.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="torznab.html" title="previous chapter">Torznab WebAPI</a>
|
||||
<li>Next: <a href="void.html" title="next chapter">Void Linux binary packages</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/tubearchivist.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
244
dev/engines/online/void.html
Normal file
244
dev/engines/online/void.html
Normal file
@@ -0,0 +1,244 @@
|
||||
<!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>Void Linux binary packages — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Wallhaven" href="wallhaven.html" />
|
||||
<link rel="prev" title="Tube Archivist" href="tubearchivist.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="wallhaven.html" title="Wallhaven"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="tubearchivist.html" title="Tube Archivist"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Void Linux binary packages</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="void-linux-binary-packages">
|
||||
<span id="voidlinux-engine"></span><h1>Void Linux binary packages<a class="headerlink" href="#void-linux-binary-packages" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.voidlinux">SearXNG engine for <a class="reference external" href="https://voidlinux.org/packages/">Void Linux binary packages</a>. Void is a general purpose
|
||||
operating system, based on the monolithic Linux kernel. Its package system
|
||||
allows you to quickly install, update and remove software; software is provided
|
||||
in binary packages or can be built directly from sources with the help of the
|
||||
XBPS source packages collection.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.voidlinux.void_arch">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.voidlinux.</span></span><span class="sig-name descname"><span class="pre">void_arch</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'x86_64'</span></em><a class="headerlink" href="#searx.engines.voidlinux.void_arch" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Default architecture to search for. For valid values see <a class="reference internal" href="#searx.engines.voidlinux.ARCH_RE" title="searx.engines.voidlinux.ARCH_RE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ARCH_RE</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.voidlinux.ARCH_RE">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.voidlinux.</span></span><span class="sig-name descname"><span class="pre">ARCH_RE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">re.compile('aarch64-musl|armv6l-musl|armv7l-musl|x86_64-musl|aarch64|armv6l|armv7l|i686|x86_64')</span></em><a class="headerlink" href="#searx.engines.voidlinux.ARCH_RE" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Regular expression that match a architecture in the query string.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.voidlinux.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.voidlinux.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/voidlinux.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.voidlinux.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>At Void Linux, several packages sometimes share the same source code
|
||||
(template) and therefore also have the same URL. Results with identical
|
||||
URLs are merged as one result for SearXNG.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="tubearchivist.html" title="previous chapter">Tube Archivist</a>
|
||||
<li>Next: <a href="wallhaven.html" title="next chapter">Wallhaven</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/void.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
242
dev/engines/online/wallhaven.html
Normal file
242
dev/engines/online/wallhaven.html
Normal file
@@ -0,0 +1,242 @@
|
||||
<!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>Wallhaven — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Wikimedia" href="wikipedia.html" />
|
||||
<link rel="prev" title="Void Linux binary packages" href="void.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="wikipedia.html" title="Wikimedia"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="void.html" title="Void Linux binary packages"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Wallhaven</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="wallhaven">
|
||||
<span id="wallhaven-engine"></span><h1>Wallhaven<a class="headerlink" href="#wallhaven" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.wallhaven"><a class="reference external" href="https://wallhaven.cc/about#Copyright">Wallhaven</a> is a site created by and for people who like wallpapers.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wallhaven.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wallhaven.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.wallhaven.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If you own an API key you can add it here, further read <a class="reference external" href="https://wallhaven.cc/help/api#limits">Rate Limiting and
|
||||
Errors</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wallhaven.safesearch_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wallhaven.</span></span><span class="sig-name descname"><span class="pre">safesearch_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{0:</span> <span class="pre">'111',</span> <span class="pre">1:</span> <span class="pre">'110',</span> <span class="pre">2:</span> <span class="pre">'100'}</span></em><a class="headerlink" href="#searx.engines.wallhaven.safesearch_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Turn purities on(1) or off(0) NSFW requires a valid API key.</p>
|
||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>100/110/111 <-- Bits stands for: SFW, Sketchy and NSFW
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><a class="reference external" href="https://wallhaven.cc/faq#What-are-SFW-Sketchy-and-NSFW-all-about">What are SFW, Sketchy and NSFW all about?</a>:</p>
|
||||
<ul class="simple">
|
||||
<li><p>SFW = “Safe for work” wallpapers. <em>Grandma approves.</em></p></li>
|
||||
<li><p>Sketchy = Not quite SFW not quite NSFW. <em>Grandma might be uncomfortable.</em></p></li>
|
||||
<li><p>NSFW = “Not safe for work”. <em>Grandma isn’t sure who you are anymore.</em></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="void.html" title="previous chapter">Void Linux binary packages</a>
|
||||
<li>Next: <a href="wikipedia.html" title="next chapter">Wikimedia</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/wallhaven.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
394
dev/engines/online/wikipedia.html
Normal file
394
dev/engines/online/wikipedia.html
Normal file
@@ -0,0 +1,394 @@
|
||||
<!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>Wikimedia — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Yacy" href="yacy.html" />
|
||||
<link rel="prev" title="Wallhaven" href="wallhaven.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="yacy.html" title="Yacy"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="wallhaven.html" title="Wallhaven"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Wikimedia</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="wikimedia">
|
||||
<span id="wikimedia-engines"></span><h1>Wikimedia<a class="headerlink" href="#wikimedia" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.wikipedia" id="id1">Wikipedia</a></p></li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.wikidata" id="id2">Wikidata</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="module-searx.engines.wikipedia">
|
||||
<span id="wikipedia"></span><span id="wikipedia-engine"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Wikipedia</a><a class="headerlink" href="#module-searx.engines.wikipedia" title="Link to this heading">¶</a></h2>
|
||||
<p>This module implements the Wikipedia engine. Some of this implementations
|
||||
are shared by other engines:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#wikidata-engine"><span class="std std-ref">Wikidata</span></a></p></li>
|
||||
</ul>
|
||||
<p>The list of supported languages is <a class="reference internal" href="#searx.engines.wikipedia.fetch_wikimedia_traits" title="searx.engines.wikipedia.fetch_wikimedia_traits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fetched</span></code></a> from
|
||||
the article linked by <a class="reference internal" href="#searx.engines.wikipedia.list_of_wikipedias" title="searx.engines.wikipedia.list_of_wikipedias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_of_wikipedias</span></code></a>.</p>
|
||||
<p>Unlike traditional search engines, wikipedia does not support one Wikipedia for
|
||||
all languages, but there is one Wikipedia for each supported language. Some of
|
||||
these Wikipedias have a <a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a> enabled
|
||||
(<a class="reference internal" href="#searx.engines.wikipedia.rest_v1_summary_url" title="searx.engines.wikipedia.rest_v1_summary_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rest_v1_summary_url</span></code></a>).</p>
|
||||
<p>A <a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a> (LC) is a system based on language variants that
|
||||
automatically converts the content of a page into a different variant. A variant
|
||||
is mostly the same language in a different script.</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://meta.wikimedia.org/wiki/Wikipedias_in_multiple_writing_systems">Wikipedias in multiple writing systems</a></p></li>
|
||||
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Chinese_Wikipedia#Automatic_conversion_between_traditional_and_simplified_Chinese_characters">Automatic conversion between traditional and simplified Chinese characters</a></p></li>
|
||||
</ul>
|
||||
<dl class="simple">
|
||||
<dt><a class="reference external" href="https://github.com/searx/searx/pull/2554">PR-2554</a>:</dt><dd><p>The Wikipedia link returned by the API is still the same in all cases
|
||||
(<a class="reference external" href="https://zh.wikipedia.org/wiki/%E5%87%BA%E7%A7%9F%E8%BB%8A">https://zh.wikipedia.org/wiki/出租車</a>) but if your browser’s
|
||||
<code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> is set to any of <code class="docutils literal notranslate"><span class="pre">zh</span></code>, <code class="docutils literal notranslate"><span class="pre">zh-CN</span></code>, <code class="docutils literal notranslate"><span class="pre">zh-TW</span></code>, <code class="docutils literal notranslate"><span class="pre">zh-HK</span></code>
|
||||
or .. Wikipedia’s LC automatically returns the desired script in their
|
||||
web-page.</p>
|
||||
<ul class="simple">
|
||||
<li><p>You can test the API here: <a class="reference external" href="https://reqbin.com/gesg2kvx">https://reqbin.com/gesg2kvx</a></p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>To support Wikipedia’s <a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a>, a SearXNG request to Wikipedia uses
|
||||
<a class="reference internal" href="#searx.engines.wikipedia.get_wiki_params" title="searx.engines.wikipedia.get_wiki_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_wiki_params</span></code></a> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">wiki_lc_locale_variants'</span> <span class="pre">in</span> <span class="pre">the</span>
|
||||
<span class="pre">:py:obj:`fetch_wikimedia_traits</span></code> function.</p>
|
||||
<p>To test in SearXNG, query for <code class="docutils literal notranslate"><span class="pre">!wp</span> <span class="pre">出租車</span></code> with each of the available Chinese
|
||||
options:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!wp</span> <span class="pre">出租車</span> <span class="pre">:zh</span></code> should show 出租車</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!wp</span> <span class="pre">出租車</span> <span class="pre">:zh-CN</span></code> should show 出租车</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!wp</span> <span class="pre">出租車</span> <span class="pre">:zh-TW</span></code> should show 計程車</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!wp</span> <span class="pre">出租車</span> <span class="pre">:zh-HK</span></code> should show 的士</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">!wp</span> <span class="pre">出租車</span> <span class="pre">:zh-SG</span></code> should show 德士</p></li>
|
||||
</ul>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.display_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">display_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['infobox']</span></em><a class="headerlink" href="#searx.engines.wikipedia.display_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A list of display types composed from <code class="docutils literal notranslate"><span class="pre">infobox</span></code> and <code class="docutils literal notranslate"><span class="pre">list</span></code>. The latter
|
||||
one will add a hit to the result list. The first one will show a hit in the
|
||||
info box. Both values can be set, or one of the two can be set.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.send_accept_language_header">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">send_accept_language_header</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#searx.engines.wikipedia.send_accept_language_header" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The HTTP <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header is needed for wikis where
|
||||
<a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a> is enabled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.list_of_wikipedias">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">list_of_wikipedias</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://meta.wikimedia.org/wiki/List_of_Wikipedias'</span></em><a class="headerlink" href="#searx.engines.wikipedia.list_of_wikipedias" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://meta.wikimedia.org/wiki/List_of_Wikipedias">List of all wikipedias</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.wikipedia_article_depth">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">wikipedia_article_depth</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://meta.wikimedia.org/wiki/Wikipedia_article_depth'</span></em><a class="headerlink" href="#searx.engines.wikipedia.wikipedia_article_depth" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The <em>editing depth</em> of Wikipedia is one of several possible rough indicators
|
||||
of the encyclopedia’s collaborative quality, showing how frequently its articles
|
||||
are updated. The measurement of depth was introduced after some limitations of
|
||||
the classic measurement of article count were realized.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.rest_v1_summary_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">rest_v1_summary_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://{wiki_netloc}/api/rest_v1/page/summary/{title}'</span></em><a class="headerlink" href="#searx.engines.wikipedia.rest_v1_summary_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><dl class="simple">
|
||||
<dt><a class="reference external" href="https://en.wikipedia.org/api/rest_v1/#/Page%20content/get_page_summary__title_">wikipedia rest_v1 summary API</a>:</dt><dd><p>The summary response includes an extract of the first paragraph of the page in
|
||||
plain text and HTML as well as the type of page. This is useful for page
|
||||
previews (fka. Hovercards, aka. Popups) on the web and link previews in the
|
||||
apps.</p>
|
||||
</dd>
|
||||
<dt>HTTP <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header (<a class="reference internal" href="#searx.engines.wikipedia.send_accept_language_header" title="searx.engines.wikipedia.send_accept_language_header"><code class="xref py py-obj docutils literal notranslate"><span class="pre">send_accept_language_header</span></code></a>):</dt><dd><p>The desired language variant code for wikis where <a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a> is
|
||||
enabled.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.wiki_lc_locale_variants">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">wiki_lc_locale_variants</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'zh':</span> <span class="pre">('zh-CN',</span> <span class="pre">'zh-HK',</span> <span class="pre">'zh-MO',</span> <span class="pre">'zh-MY',</span> <span class="pre">'zh-SG',</span> <span class="pre">'zh-TW'),</span> <span class="pre">'zh-classical':</span> <span class="pre">('zh-classical',)}</span></em><a class="headerlink" href="#searx.engines.wikipedia.wiki_lc_locale_variants" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Mapping rule of the <a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a> to map a language and its variants to
|
||||
a Locale (used in the HTTP <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header). For example see <a class="reference external" href="https://meta.wikimedia.org/wiki/Wikipedias_in_multiple_writing_systems#Chinese">LC
|
||||
Chinese</a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.get_wiki_params">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">get_wiki_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sxng_locale</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eng_traits</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/wikipedia.html#get_wiki_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.wikipedia.get_wiki_params" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns the Wikipedia language tag and the netloc that fits to the
|
||||
<code class="docutils literal notranslate"><span class="pre">sxng_locale</span></code>. To support <a class="reference external" href="https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter">LanguageConverter</a> this function rates a locale
|
||||
(region) higher than a language (compare <a class="reference internal" href="#searx.engines.wikipedia.wiki_lc_locale_variants" title="searx.engines.wikipedia.wiki_lc_locale_variants"><code class="xref py py-obj docutils literal notranslate"><span class="pre">wiki_lc_locale_variants</span></code></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/wikipedia.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.wikipedia.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Assemble a request (<a class="reference external" href="https://en.wikipedia.org/api/rest_v1/#/Page%20content/get_page_summary__title_">wikipedia rest_v1 summary API</a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikipedia.fetch_wikimedia_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikipedia.</span></span><span class="sig-name descname"><span class="pre">fetch_wikimedia_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/wikipedia.html#fetch_wikimedia_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.wikipedia.fetch_wikimedia_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages from Wikipedia. Not all languages from the
|
||||
<a class="reference internal" href="#searx.engines.wikipedia.list_of_wikipedias" title="searx.engines.wikipedia.list_of_wikipedias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_of_wikipedias</span></code></a> are supported by SearXNG locales, only those
|
||||
known from <a class="reference internal" href="../../../src/searx.locales.html#searx.locales.LOCALE_NAMES" title="searx.locales.LOCALE_NAMES"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.locales.LOCALE_NAMES</span></code></a> or those with a minimal
|
||||
<a class="reference internal" href="#searx.engines.wikipedia.wikipedia_article_depth" title="searx.engines.wikipedia.wikipedia_article_depth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">editing</span> <span class="pre">depth</span></code></a>.</p>
|
||||
<p>The location of the Wikipedia address of a language is mapped in a
|
||||
<a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits.custom" title="searx.enginelib.traits.EngineTraits.custom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">custom</span> <span class="pre">field</span></code></a>
|
||||
(<code class="docutils literal notranslate"><span class="pre">wiki_netloc</span></code>). Here is a reduced example:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">'wiki_netloc'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"en"</span><span class="p">:</span> <span class="s2">"en.wikipedia.org"</span><span class="p">,</span>
|
||||
<span class="o">..</span>
|
||||
<span class="s2">"gsw"</span><span class="p">:</span> <span class="s2">"als.wikipedia.org"</span><span class="p">,</span>
|
||||
<span class="o">..</span>
|
||||
<span class="s2">"zh"</span><span class="p">:</span> <span class="s2">"zh.wikipedia.org"</span><span class="p">,</span>
|
||||
<span class="s2">"zh-classical"</span><span class="p">:</span> <span class="s2">"zh-classical.wikipedia.org"</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-searx.engines.wikidata">
|
||||
<span id="wikidata"></span><span id="wikidata-engine"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Wikidata</a><a class="headerlink" href="#module-searx.engines.wikidata" title="Link to this heading">¶</a></h2>
|
||||
<p>This module implements the Wikidata engine. Some implementations are shared
|
||||
from <a class="reference internal" href="#wikipedia-engine"><span class="std std-ref">Wikipedia</span></a>.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikidata.display_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikidata.</span></span><span class="sig-name descname"><span class="pre">display_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['infobox']</span></em><a class="headerlink" href="#searx.engines.wikidata.display_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A list of display types composed from <code class="docutils literal notranslate"><span class="pre">infobox</span></code> and <code class="docutils literal notranslate"><span class="pre">list</span></code>. The latter
|
||||
one will add a hit to the result list. The first one will show a hit in the
|
||||
info box. Both values can be set, or one of the two can be set.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikidata.get_thumbnail">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikidata.</span></span><span class="sig-name descname"><span class="pre">get_thumbnail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">img_src</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/wikidata.html#get_thumbnail"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.wikidata.get_thumbnail" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get Thumbnail image from wikimedia commons</p>
|
||||
<p>Images from commons.wikimedia.org are (HTTP) redirected to
|
||||
upload.wikimedia.org. The redirected URL can be calculated by this
|
||||
function.</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://stackoverflow.com/a/33691240">https://stackoverflow.com/a/33691240</a></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.wikidata.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.wikidata.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/wikidata.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.wikidata.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Uses languages evaluated from <a class="reference internal" href="#searx.engines.wikipedia.fetch_wikimedia_traits" title="searx.engines.wikipedia.fetch_wikimedia_traits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">wikipedia.fetch_wikimedia_traits</span></code></a> and removes</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">traits.custom['wiki_netloc']</span></code>: wikidata does not have net-locations for
|
||||
the languages and the list of all</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">traits.custom['WIKIPEDIA_LANGUAGES']</span></code>: not used in the wikipedia engine</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="wallhaven.html" title="previous chapter">Wallhaven</a>
|
||||
<li>Next: <a href="yacy.html" title="next chapter">Yacy</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/wikipedia.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
308
dev/engines/online/yacy.html
Normal file
308
dev/engines/online/yacy.html
Normal file
@@ -0,0 +1,308 @@
|
||||
<!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>Yacy — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Yahoo Engine" href="yahoo.html" />
|
||||
<link rel="prev" title="Wikimedia" href="wikipedia.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="yahoo.html" title="Yahoo Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="wikipedia.html" title="Wikimedia"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Yacy</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="yacy">
|
||||
<span id="yacy-engine"></span><h1>Yacy<a class="headerlink" href="#yacy" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.yacy"><a class="reference external" href="https://yacy.net/">YaCy</a> is a free distributed search engine, built on the principles of
|
||||
peer-to-peer (P2P) networks.</p>
|
||||
<p>API: <a class="reference external" href="https://wiki.yacy.net/index.php/Dev:APIyacysearch">Dev:APIyacysearch</a></p>
|
||||
<p>Releases:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/yacy/yacy_search_server/tags">https://github.com/yacy/yacy_search_server/tags</a></p></li>
|
||||
<li><p><a class="reference external" href="https://download.yacy.net/">https://download.yacy.net/</a></p></li>
|
||||
</ul>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following (additional) settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.yacy.http_digest_auth_user" title="searx.engines.yacy.http_digest_auth_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">http_digest_auth_user</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.yacy.http_digest_auth_pass" title="searx.engines.yacy.http_digest_auth_pass"><code class="xref py py-obj docutils literal notranslate"><span class="pre">http_digest_auth_pass</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.yacy.search_mode" title="searx.engines.yacy.search_mode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_mode</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.yacy.search_type" title="searx.engines.yacy.search_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_type</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>The <a class="reference internal" href="#searx.engines.yacy.base_url" title="searx.engines.yacy.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a> has to be set in the engine named <cite>yacy</cite> and is used by
|
||||
all yacy engines (unless an individual value for <code class="docutils literal notranslate"><span class="pre">base_url</span></code> is configured for
|
||||
the engine).</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yacy</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yacy</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">general</span>
|
||||
<span class="w"> </span><span class="nt">search_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">text</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ya</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://yacy.searchlab.eu</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://search.lomig.me</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://yacy.ecosys.eu</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://search.webproject.link</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yacy images</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yacy</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">images</span>
|
||||
<span class="w"> </span><span class="nt">search_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">image</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yai</span>
|
||||
<span class="w"> </span><span class="nt">disabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yacy.http_digest_auth_user">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yacy.</span></span><span class="sig-name descname"><span class="pre">http_digest_auth_user</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.yacy.http_digest_auth_user" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>HTTP digest user for the local YACY instance</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yacy.http_digest_auth_pass">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yacy.</span></span><span class="sig-name descname"><span class="pre">http_digest_auth_pass</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.yacy.http_digest_auth_pass" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>HTTP digest password for the local YACY instance</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yacy.search_mode">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yacy.</span></span><span class="sig-name descname"><span class="pre">search_mode</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'global'</span></em><a class="headerlink" href="#searx.engines.yacy.search_mode" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Yacy search mode <code class="docutils literal notranslate"><span class="pre">global</span></code> or <code class="docutils literal notranslate"><span class="pre">local</span></code>. By default, Yacy operates in <code class="docutils literal notranslate"><span class="pre">global</span></code>
|
||||
mode.</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">global</span></code></dt><dd><p>Peer-to-Peer search</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">local</span></code></dt><dd><p>Privacy or Stealth mode, restricts the search to local yacy instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yacy.search_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yacy.</span></span><span class="sig-name descname"><span class="pre">search_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'text'</span></em><a class="headerlink" href="#searx.engines.yacy.search_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>One of <code class="docutils literal notranslate"><span class="pre">text</span></code>, <code class="docutils literal notranslate"><span class="pre">image</span></code> / The search-types <code class="docutils literal notranslate"><span class="pre">app</span></code>, <code class="docutils literal notranslate"><span class="pre">audio</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">video</span></code> are not yet implemented (Pull-Requests are welcome).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yacy.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yacy.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.yacy.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The value is an URL or a list of URLs. In the latter case instance will be
|
||||
selected randomly.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="wikipedia.html" title="previous chapter">Wikimedia</a>
|
||||
<li>Next: <a href="yahoo.html" title="next chapter">Yahoo Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/yacy.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
277
dev/engines/online/yahoo.html
Normal file
277
dev/engines/online/yahoo.html
Normal file
@@ -0,0 +1,277 @@
|
||||
<!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>Yahoo Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Z-Library" href="zlibrary.html" />
|
||||
<link rel="prev" title="Yacy" href="yacy.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="zlibrary.html" title="Z-Library"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="yacy.html" title="Yacy"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Yahoo Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="yahoo-engine">
|
||||
<span id="id1"></span><h1>Yahoo Engine<a class="headerlink" href="#yahoo-engine" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.yahoo">Yahoo Search (Web)</p>
|
||||
<p>Languages are supported by mapping the language to a domain. If domain is not
|
||||
found in <a class="reference internal" href="#searx.engines.yahoo.lang2domain" title="searx.engines.yahoo.lang2domain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lang2domain</span></code></a> URL <code class="docutils literal notranslate"><span class="pre"><lang>.search.yahoo.com</span></code> is used.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yahoo.region2domain">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yahoo.</span></span><span class="sig-name descname"><span class="pre">region2domain</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'AR':</span> <span class="pre">'ar.search.yahoo.com',</span> <span class="pre">'BR':</span> <span class="pre">'br.search.yahoo.com',</span> <span class="pre">'CA':</span> <span class="pre">'ca.search.yahoo.com',</span> <span class="pre">'CL':</span> <span class="pre">'cl.search.yahoo.com',</span> <span class="pre">'CO':</span> <span class="pre">'co.search.yahoo.com',</span> <span class="pre">'DE':</span> <span class="pre">'de.search.yahoo.com',</span> <span class="pre">'ES':</span> <span class="pre">'espanol.search.yahoo.com',</span> <span class="pre">'FR':</span> <span class="pre">'fr.search.yahoo.com',</span> <span class="pre">'GB':</span> <span class="pre">'uk.search.yahoo.com',</span> <span class="pre">'HK':</span> <span class="pre">'hk.search.yahoo.com',</span> <span class="pre">'IN':</span> <span class="pre">'in.search.yahoo.com',</span> <span class="pre">'MX':</span> <span class="pre">'mx.search.yahoo.com',</span> <span class="pre">'PE':</span> <span class="pre">'pe.search.yahoo.com',</span> <span class="pre">'PH':</span> <span class="pre">'ph.search.yahoo.com',</span> <span class="pre">'SG':</span> <span class="pre">'sg.search.yahoo.com',</span> <span class="pre">'TH':</span> <span class="pre">'th.search.yahoo.com',</span> <span class="pre">'TW':</span> <span class="pre">'tw.search.yahoo.com',</span> <span class="pre">'UK':</span> <span class="pre">'uk.search.yahoo.com',</span> <span class="pre">'VE':</span> <span class="pre">'ve.search.yahoo.com'}</span></em><a class="headerlink" href="#searx.engines.yahoo.region2domain" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Map regions to domain</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.yahoo.lang2domain">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yahoo.</span></span><span class="sig-name descname"><span class="pre">lang2domain</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'any':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'bg':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'cs':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'da':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'el':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'en':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'et':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'he':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'hr':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'ja':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'ko':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'sk':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'sl':</span> <span class="pre">'search.yahoo.com',</span> <span class="pre">'zh_chs':</span> <span class="pre">'hk.search.yahoo.com',</span> <span class="pre">'zh_cht':</span> <span class="pre">'tw.search.yahoo.com'}</span></em><a class="headerlink" href="#searx.engines.yahoo.lang2domain" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Map language to domain</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.yahoo.build_sb_cookie">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yahoo.</span></span><span class="sig-name descname"><span class="pre">build_sb_cookie</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cookie_params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/yahoo.html#build_sb_cookie"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.yahoo.build_sb_cookie" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build sB cookie parameter from provided parameters.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>cookie_params</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – Dictionary of cookie parameters</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>Formatted cookie string</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)">str</a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl>
|
||||
<dt>Example:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">cookie_params</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'v'</span><span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span> <span class="s1">'vm'</span><span class="p">:</span> <span class="s1">'p'</span><span class="p">,</span> <span class="s1">'fl'</span><span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span> <span class="s1">'vl'</span><span class="p">:</span> <span class="s1">'lang_fr'</span><span class="p">}</span>
|
||||
<span class="gp">>>> </span><span class="n">build_sb_cookie</span><span class="p">(</span><span class="n">cookie_params</span><span class="p">)</span>
|
||||
<span class="go">'v=1&vm=p&fl=1&vl=lang_fr'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.yahoo.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yahoo.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/yahoo.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.yahoo.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build Yahoo search request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.yahoo.parse_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yahoo.</span></span><span class="sig-name descname"><span class="pre">parse_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url_string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/yahoo.html#parse_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.yahoo.parse_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>remove yahoo-specific tracking-url</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.yahoo.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.yahoo.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/yahoo.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.yahoo.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>parse response</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="yacy.html" title="previous chapter">Yacy</a>
|
||||
<li>Next: <a href="zlibrary.html" title="next chapter">Z-Library</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/yahoo.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
284
dev/engines/online/zlibrary.html
Normal file
284
dev/engines/online/zlibrary.html
Normal file
@@ -0,0 +1,284 @@
|
||||
<!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>Z-Library — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Offline Concept" href="../offline_concept.html" />
|
||||
<link rel="prev" title="Yahoo Engine" href="yahoo.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="../offline_concept.html" title="Offline Concept"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="yahoo.html" title="Yahoo Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Z-Library</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="z-library">
|
||||
<span id="zlibrary-engine"></span><h1>Z-Library<a class="headerlink" href="#z-library" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.zlibrary"><a class="reference external" href="https://zlibrary-global.se/">Z-Library</a> (abbreviated as z-lib, formerly BookFinder) is a shadow library
|
||||
project for file-sharing access to scholarly journal articles, academic texts
|
||||
and general-interest books. It began as a mirror of Library Genesis, from which
|
||||
most of its books originate.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The engine has the following additional settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.zlibrary.zlib_year_from" title="searx.engines.zlibrary.zlib_year_from"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zlib_year_from</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.zlibrary.zlib_year_to" title="searx.engines.zlibrary.zlib_year_to"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zlib_year_to</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.zlibrary.zlib_ext" title="searx.engines.zlibrary.zlib_ext"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zlib_ext</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>With this options a SearXNG maintainer is able to configure <strong>additional</strong>
|
||||
engines for specific searches in Z-Library. For example a engine to search
|
||||
only for EPUB from 2010 to 2020.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">z-library 2010s epub</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">zlibrary</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">zlib2010s</span>
|
||||
<span class="w"> </span><span class="nt">zlib_year_from</span><span class="p">:</span><span class="w"> </span><span class="s">'2010'</span>
|
||||
<span class="w"> </span><span class="nt">zlib_year_to</span><span class="p">:</span><span class="w"> </span><span class="s">'2020'</span>
|
||||
<span class="w"> </span><span class="nt">zlib_ext</span><span class="p">:</span><span class="w"> </span><span class="s">'EPUB'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.zlibrary.zlib_year_from">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.zlibrary.</span></span><span class="sig-name descname"><span class="pre">zlib_year_from</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.zlibrary.zlib_year_from" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filter z-library’s results by year from. E.g ‘2010’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.zlibrary.zlib_year_to">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.zlibrary.</span></span><span class="sig-name descname"><span class="pre">zlib_year_to</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.zlibrary.zlib_year_to" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filter z-library’s results by year to. E.g. ‘2010’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.zlibrary.zlib_ext">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.zlibrary.</span></span><span class="sig-name descname"><span class="pre">zlib_ext</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.zlibrary.zlib_ext" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filter z-library’s results by a file ending. Common filters for example are
|
||||
<code class="docutils literal notranslate"><span class="pre">PDF</span></code> and <code class="docutils literal notranslate"><span class="pre">EPUB</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.zlibrary.setup">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.zlibrary.</span></span><span class="sig-name descname"><span class="pre">setup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/zlibrary.html#setup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.zlibrary.setup" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Check of engine’s settings.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.zlibrary.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.zlibrary.</span></span><span class="sig-name descname"><span class="pre">fetch_traits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_traits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../enginelib.html#searx.enginelib.traits.EngineTraits" title="searx.enginelib.traits.EngineTraits"><span class="pre">EngineTraits</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/zlibrary.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.zlibrary.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch languages and other search arguments from zlibrary’s search form.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="yahoo.html" title="previous chapter">Yahoo Engine</a>
|
||||
<li>Next: <a href="../offline_concept.html" title="next chapter">Offline Concept</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online/zlibrary.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
233
dev/engines/online_url_search/tineye.html
Normal file
233
dev/engines/online_url_search/tineye.html
Normal file
@@ -0,0 +1,233 @@
|
||||
<!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>Tineye — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Result Types" href="../../result_types/index.html" />
|
||||
<link rel="prev" title="SQL Engines" href="../offline/sql-engines.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="../../result_types/index.html" title="Result Types"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../offline/sql-engines.html" title="SQL Engines"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Tineye</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="tineye">
|
||||
<span id="tineye-engine"></span><h1>Tineye<a class="headerlink" href="#tineye" title="Link to this heading">¶</a></h1>
|
||||
<p id="module-searx.engines.tineye">This engine implements <em>Tineye - reverse image search</em></p>
|
||||
<p>Using TinEye, you can search by image or perform what we call a reverse image
|
||||
search. You can do that by uploading an image or searching by URL. You can also
|
||||
simply drag and drop your images to start your search. TinEye constantly crawls
|
||||
the web and adds images to its index. Today, the TinEye index is over 50.2
|
||||
billion images <a class="reference external" href="https://tineye.com/how">[tineye.com]</a>.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>This SearXNG engine only supports <em>‘searching by URL’</em> and it does not use
|
||||
the official API <a class="reference external" href="https://api.tineye.com/python/docs/">[api.tineye.com]</a>.</p>
|
||||
</div>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.engine_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">engine_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'online_url_search'</span></em><a class="headerlink" href="#searx.engines.tineye.engine_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference internal" href="../../../src/searx.search.processors.html#module-searx.search.processors.online_url_search" title="searx.search.processors.online_url_search"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.search.processors.online_url_search</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.FORMAT_NOT_SUPPORTED">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">FORMAT_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Could</span> <span class="pre">not</span> <span class="pre">read</span> <span class="pre">that</span> <span class="pre">image</span> <span class="pre">url.</span> <span class="pre">This</span> <span class="pre">may</span> <span class="pre">be</span> <span class="pre">due</span> <span class="pre">to</span> <span class="pre">an</span> <span class="pre">unsupported</span> <span class="pre">file</span> <span class="pre">format.</span> <span class="pre">TinEye</span> <span class="pre">only</span> <span class="pre">supports</span> <span class="pre">images</span> <span class="pre">that</span> <span class="pre">are</span> <span class="pre">JPEG,</span> <span class="pre">PNG,</span> <span class="pre">GIF,</span> <span class="pre">BMP,</span> <span class="pre">TIFF</span> <span class="pre">or</span> <span class="pre">WebP.'</span></em><a class="headerlink" href="#searx.engines.tineye.FORMAT_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>TinEye error message</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.NO_SIGNATURE_ERROR">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">NO_SIGNATURE_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'The</span> <span class="pre">image</span> <span class="pre">is</span> <span class="pre">too</span> <span class="pre">simple</span> <span class="pre">to</span> <span class="pre">find</span> <span class="pre">matches.</span> <span class="pre">TinEye</span> <span class="pre">requires</span> <span class="pre">a</span> <span class="pre">basic</span> <span class="pre">level</span> <span class="pre">of</span> <span class="pre">visual</span> <span class="pre">detail</span> <span class="pre">to</span> <span class="pre">successfully</span> <span class="pre">identify</span> <span class="pre">matches.'</span></em><a class="headerlink" href="#searx.engines.tineye.NO_SIGNATURE_ERROR" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>TinEye error message</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.DOWNLOAD_ERROR">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">DOWNLOAD_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'The</span> <span class="pre">image</span> <span class="pre">could</span> <span class="pre">not</span> <span class="pre">be</span> <span class="pre">downloaded.'</span></em><a class="headerlink" href="#searx.engines.tineye.DOWNLOAD_ERROR" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>TinEye error message</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/tineye.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.tineye.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build TinEye HTTP request using <code class="docutils literal notranslate"><span class="pre">search_urls</span></code> of a <a class="reference internal" href="#searx.engines.tineye.engine_type" title="searx.engines.tineye.engine_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">engine_type</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.parse_tineye_match">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">parse_tineye_match</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">match_json</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/tineye.html#parse_tineye_match"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.tineye.parse_tineye_match" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Takes parsed JSON from the API server and turns it into a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></a>
|
||||
object.</p>
|
||||
<p>Attributes <a class="reference external" href="https://github.com/TinEye/pytineye/blob/main/pytineye/api.py">(class Match)</a></p>
|
||||
<ul class="simple">
|
||||
<li><p><cite>image_url</cite>, link to the result image.</p></li>
|
||||
<li><p><cite>domain</cite>, domain this result was found on.</p></li>
|
||||
<li><p><cite>score</cite>, a number (0 to 100) that indicates how closely the images match.</p></li>
|
||||
<li><p><cite>width</cite>, image width in pixels.</p></li>
|
||||
<li><p><cite>height</cite>, image height in pixels.</p></li>
|
||||
<li><p><cite>size</cite>, image area in pixels.</p></li>
|
||||
<li><p><cite>format</cite>, image format.</p></li>
|
||||
<li><p><cite>filesize</cite>, image size in bytes.</p></li>
|
||||
<li><p><cite>overlay</cite>, overlay URL.</p></li>
|
||||
<li><p><cite>tags</cite>, whether this match belongs to a collection or stock domain.</p></li>
|
||||
<li><p><cite>backlinks</cite>, a list of Backlink objects pointing to the original websites
|
||||
and image URLs. List items are instances of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></a>, (<a class="reference external" href="https://github.com/TinEye/pytineye/blob/main/pytineye/api.py">Backlink</a>):</p>
|
||||
<ul>
|
||||
<li><p><cite>url</cite>, the image URL to the image.</p></li>
|
||||
<li><p><cite>backlink</cite>, the original website URL.</p></li>
|
||||
<li><p><cite>crawl_date</cite>, the date the image was crawled.</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.tineye.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.tineye.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/tineye.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.tineye.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Parse HTTP response from TinEye.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../../index.html">
|
||||
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
||||
<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="../../commits.html">Git Commits & Change Management</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="../../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-engines">Online Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a><ul class="current">
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</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="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="../index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="../offline/sql-engines.html" title="previous chapter">SQL Engines</a>
|
||||
<li>Next: <a href="../../result_types/index.html" title="next chapter">Result Types</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/online_url_search/tineye.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
486
dev/engines/xpath.html
Normal file
486
dev/engines/xpath.html
Normal file
@@ -0,0 +1,486 @@
|
||||
<!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>XPath Engine — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="MediaWiki Engine" href="mediawiki.html" />
|
||||
<link rel="prev" title="Demo Online Engine" href="demo/demo_online.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="mediawiki.html" title="MediaWiki Engine"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="demo/demo_online.html" title="Demo Online Engine"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Engine Implementations</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">XPath Engine</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="xpath-engine">
|
||||
<span id="id1"></span><h1>XPath Engine<a class="headerlink" href="#xpath-engine" title="Link to this heading">¶</a></h1>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#configuration" id="id2">Configuration</a></p></li>
|
||||
<li><p><a class="reference internal" href="#example" id="id3">Example</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id4">Implementations</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p id="module-searx.engines.xpath">The XPath engine is a <em>generic</em> engine with which it is possible to configure
|
||||
engines in the settings.</p>
|
||||
<section id="configuration">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>Request:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.search_url" title="searx.engines.xpath.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.lang_all" title="searx.engines.xpath.lang_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lang_all</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.soft_max_redirects" title="searx.engines.xpath.soft_max_redirects"><code class="xref py py-obj docutils literal notranslate"><span class="pre">soft_max_redirects</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.method" title="searx.engines.xpath.method"><code class="xref py py-obj docutils literal notranslate"><span class="pre">method</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.request_body" title="searx.engines.xpath.request_body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">request_body</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.cookies" title="searx.engines.xpath.cookies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cookies</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.headers" title="searx.engines.xpath.headers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">headers</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Paging:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.paging" title="searx.engines.xpath.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.page_size" title="searx.engines.xpath.page_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_size</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.first_page_num" title="searx.engines.xpath.first_page_num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">first_page_num</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Time Range:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.time_range_support" title="searx.engines.xpath.time_range_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_support</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.time_range_url" title="searx.engines.xpath.time_range_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_url</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.time_range_map" title="searx.engines.xpath.time_range_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_map</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Safe-Search:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.safe_search_support" title="searx.engines.xpath.safe_search_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">safe_search_support</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.safe_search_map" title="searx.engines.xpath.safe_search_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">safe_search_map</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Response:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.no_result_for_http_status" title="searx.engines.xpath.no_result_for_http_status"><code class="xref py py-obj docutils literal notranslate"><span class="pre">no_result_for_http_status</span></code></a></p></li>
|
||||
</ul>
|
||||
<p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a>:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.results_xpath" title="searx.engines.xpath.results_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_xpath</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.url_xpath" title="searx.engines.xpath.url_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url_xpath</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.title_xpath" title="searx.engines.xpath.title_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">title_xpath</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.content_xpath" title="searx.engines.xpath.content_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">content_xpath</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.thumbnail_xpath" title="searx.engines.xpath.thumbnail_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">thumbnail_xpath</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.engines.xpath.suggestion_xpath" title="searx.engines.xpath.suggestion_xpath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">suggestion_xpath</span></code></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Example</a><a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
||||
<p>Here is a simple example of a XPath engine configured in the <a class="reference internal" href="../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">engines:</span></a> section, further read <a class="reference internal" href="engine_overview.html#engines-dev"><span class="std std-ref">Engine Overview</span></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bitbucket</span>
|
||||
<span class="w"> </span><span class="nt">engine </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">xpath</span>
|
||||
<span class="w"> </span><span class="nt">paging </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="w"> </span><span class="nt">search_url </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://bitbucket.org/repo/all/{pageno}?name={query}</span>
|
||||
<span class="w"> </span><span class="nt">url_xpath </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">//article[@class="repo-summary"]//a[@class="repo-link"]/@href</span>
|
||||
<span class="w"> </span><span class="nt">title_xpath </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">//article[@class="repo-summary"]//a[@class="repo-link"]</span>
|
||||
<span class="w"> </span><span class="nt">content_xpath </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">//article[@class="repo-summary"]/p</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.search_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">search_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.xpath.search_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Search URL of the engine. Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://example.org/?search={query}&page={pageno}{time_range}{safe_search}
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Replacements are:</p>
|
||||
<dl>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{query}</span></code>:</dt><dd><p>Search terms from user.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{pageno}</span></code>:</dt><dd><p>Page number if engine supports paging <a class="reference internal" href="#searx.engines.xpath.paging" title="searx.engines.xpath.paging"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paging</span></code></a></p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{lang}</span></code>:</dt><dd><p>ISO 639-1 language code (en, de, fr ..)</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{time_range}</span></code>:</dt><dd><p><a class="reference internal" href="#searx.engines.xpath.time_range_url" title="searx.engines.xpath.time_range_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">URL</span> <span class="pre">parameter</span></code></a> if engine <a class="reference internal" href="#searx.engines.xpath.time_range_support" title="searx.engines.xpath.time_range_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">supports</span> <span class="pre">time</span>
|
||||
<span class="pre">range</span></code></a>. The value for the parameter is taken from
|
||||
<a class="reference internal" href="#searx.engines.xpath.time_range_map" title="searx.engines.xpath.time_range_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_map</span></code></a>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">{safe_search}</span></code>:</dt><dd><p>Safe-search <a class="reference internal" href="#searx.engines.xpath.safe_search_map" title="searx.engines.xpath.safe_search_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">URL</span> <span class="pre">parameter</span></code></a> if engine
|
||||
<a class="reference internal" href="#searx.engines.xpath.safe_search_support" title="searx.engines.xpath.safe_search_support"><code class="xref py py-obj docutils literal notranslate"><span class="pre">supports</span> <span class="pre">safe-search</span></code></a>. The <code class="docutils literal notranslate"><span class="pre">{safe_search}</span></code>
|
||||
replacement is taken from the <code class="xref py py-obj docutils literal notranslate"><span class="pre">safes_search_map</span></code>. Filter results:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">0</span><span class="p">:</span> <span class="n">none</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="n">moderate</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span><span class="n">strict</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If not supported, the URL parameter is an empty string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.lang_all">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">lang_all</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'en'</span></em><a class="headerlink" href="#searx.engines.xpath.lang_all" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Replacement <code class="docutils literal notranslate"><span class="pre">{lang}</span></code> in <a class="reference internal" href="#searx.engines.xpath.search_url" title="searx.engines.xpath.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a> if language <code class="docutils literal notranslate"><span class="pre">all</span></code> is
|
||||
selected.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.no_result_for_http_status">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">no_result_for_http_status</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#searx.engines.xpath.no_result_for_http_status" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Return empty result for these HTTP status codes instead of throwing an error.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">no_result_for_http_status</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.soft_max_redirects">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">soft_max_redirects</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#searx.engines.xpath.soft_max_redirects" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maximum redirects, soft limit. Record an error but don’t stop the engine</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.results_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">results_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.xpath.results_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a> for the list of result items</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.url_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">url_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.xpath.url_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a> of result’s <code class="docutils literal notranslate"><span class="pre">url</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.content_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">content_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.xpath.content_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a> of result’s <code class="docutils literal notranslate"><span class="pre">content</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.title_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">title_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#searx.engines.xpath.title_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a> of result’s <code class="docutils literal notranslate"><span class="pre">title</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.thumbnail_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">thumbnail_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.xpath.thumbnail_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a> of result’s <code class="docutils literal notranslate"><span class="pre">thumbnail</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.suggestion_xpath">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">suggestion_xpath</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.xpath.suggestion_xpath" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://quickref.me/xpath.html#xpath-selectors">XPath selector</a> of result’s <code class="docutils literal notranslate"><span class="pre">suggestion</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.cookies">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">cookies</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#searx.engines.xpath.cookies" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Some engines might offer different result based on cookies.
|
||||
Possible use-case: To set safesearch cookie.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.headers">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#searx.engines.xpath.headers" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Some engines might offer different result based headers. Possible use-case:
|
||||
To set header to moderate.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.method">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">method</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GET'</span></em><a class="headerlink" href="#searx.engines.xpath.method" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Some engines might require to do POST requests for search.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.request_body">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">request_body</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.xpath.request_body" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The body of the request. This can only be used if different <a class="reference internal" href="#searx.engines.xpath.method" title="searx.engines.xpath.method"><code class="xref py py-obj docutils literal notranslate"><span class="pre">method</span></code></a>
|
||||
is set, e.g. <code class="docutils literal notranslate"><span class="pre">POST</span></code>. For formatting see the documentation of <a class="reference internal" href="#searx.engines.xpath.search_url" title="searx.engines.xpath.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a>:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">search</span><span class="o">=</span><span class="p">{</span><span class="n">query</span><span class="p">}</span><span class="o">&</span><span class="n">page</span><span class="o">=</span><span class="p">{</span><span class="n">pageno</span><span class="p">}{</span><span class="n">time_range</span><span class="p">}{</span><span class="n">safe_search</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.paging">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">paging</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.xpath.paging" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports paging [True or False].</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.page_size">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">page_size</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#searx.engines.xpath.page_size" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Number of results on each page. Only needed if the site requires not a page
|
||||
number, but an offset.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.first_page_num">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">first_page_num</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#searx.engines.xpath.first_page_num" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Number of the first page (usually 0 or 1).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.time_range_support">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">time_range_support</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.xpath.time_range_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports search time range.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.time_range_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">time_range_url</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'&hours={time_range_val}'</span></em><a class="headerlink" href="#searx.engines.xpath.time_range_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Time range URL parameter in the in <a class="reference internal" href="#searx.engines.xpath.search_url" title="searx.engines.xpath.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a>. If no time range is
|
||||
requested by the user, the URL parameter is an empty string. The
|
||||
<code class="docutils literal notranslate"><span class="pre">{time_range_val}</span></code> replacement is taken from the <a class="reference internal" href="#searx.engines.xpath.time_range_map" title="searx.engines.xpath.time_range_map"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_map</span></code></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">time_range_url </span><span class="p">:</span><span class="w"> </span><span class="s">'&days={time_range_val}'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.time_range_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">time_range_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'day':</span> <span class="pre">24,</span> <span class="pre">'month':</span> <span class="pre">720,</span> <span class="pre">'week':</span> <span class="pre">168,</span> <span class="pre">'year':</span> <span class="pre">8760}</span></em><a class="headerlink" href="#searx.engines.xpath.time_range_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps time range value from user to <code class="docutils literal notranslate"><span class="pre">{time_range_val}</span></code> in
|
||||
<a class="reference internal" href="#searx.engines.xpath.time_range_url" title="searx.engines.xpath.time_range_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_range_url</span></code></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">time_range_map</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">day</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
|
||||
<span class="w"> </span><span class="nt">week</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7</span>
|
||||
<span class="w"> </span><span class="nt">month</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">30</span>
|
||||
<span class="w"> </span><span class="nt">year</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">365</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.safe_search_support">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">safe_search_support</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.engines.xpath.safe_search_support" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Engine supports safe-search.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.safe_search_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">safe_search_map</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{0:</span> <span class="pre">'&filter=none',</span> <span class="pre">1:</span> <span class="pre">'&filter=moderate',</span> <span class="pre">2:</span> <span class="pre">'&filter=strict'}</span></em><a class="headerlink" href="#searx.engines.xpath.safe_search_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maps safe-search value to <code class="docutils literal notranslate"><span class="pre">{safe_search}</span></code> in <a class="reference internal" href="#searx.engines.xpath.search_url" title="searx.engines.xpath.search_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">search_url</span></code></a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">safesearch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="nt">safes_search_map</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">0</span><span class="p">:</span><span class="w"> </span><span class="s">'&filter=none'</span>
|
||||
<span class="w"> </span><span class="nt">1</span><span class="p">:</span><span class="w"> </span><span class="s">'&filter=moderate'</span>
|
||||
<span class="w"> </span><span class="nt">2</span><span class="p">:</span><span class="w"> </span><span class="s">'&filter=strict'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/engines/xpath.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.xpath.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Build request parameters (see <a class="reference internal" href="engine_overview.html#engine-request"><span class="std std-ref">Making a Request</span></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.xpath.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.xpath.</span></span><span class="sig-name descname"><span class="pre">response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resp</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/engines/xpath.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.xpath.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Scrap <em>results</em> from the response (see <a class="reference internal" href="../result_types/index.html#result-types"><span class="std std-ref">Result Types</span></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Engine Implementations</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="index.html#engine-types">Engine Types</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="reference internal" href="index.html#online-engines">Online Engines</a><ul class="current">
|
||||
<li class="toctree-l5"><a class="reference internal" href="demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l5 current"><a class="current reference internal" href="#">XPath Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/core.html">CORE</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mullvad_leta.html">Mullvad-Leta</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/seekr.html">Seekr Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="online/zlibrary.html">Z-Library</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#offline-engines">Offline Engines</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-url-search">Online URL Search</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-currency">Online Currency</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="index.html#online-dictionary">Online Dictionary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Engine Implementations</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="demo/demo_online.html" title="previous chapter">Demo Online Engine</a>
|
||||
<li>Next: <a href="mediawiki.html" title="next chapter">MediaWiki Engine</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/engines/xpath.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
231
dev/extended_types.html
Normal file
231
dev/extended_types.html
Normal file
File diff suppressed because one or more lines are too long
231
dev/index.html
Normal file
231
dev/index.html
Normal file
@@ -0,0 +1,231 @@
|
||||
<!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>Developer documentation — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Development Quickstart" href="quickstart.html" />
|
||||
<link rel="prev" title="Buildhosts" href="../admin/buildhosts.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="quickstart.html" title="Development Quickstart"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../admin/buildhosts.html" title="Buildhosts"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Developer documentation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="developer-documentation">
|
||||
<h1>Developer documentation<a class="headerlink" href="#developer-documentation" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="contribution_guide.html">How to contribute</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#prime-directives-privacy-hackability">Prime directives: Privacy, Hackability</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#code">Code</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#translation">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#documentation">Documentation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="extended_types.html">Extended Types</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="extended_types.html#searx.extended_types.sxng_request"><code class="docutils literal notranslate"><span class="pre">sxng_request</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="extended_types.html#searx.extended_types.SXNG_Request"><code class="docutils literal notranslate"><span class="pre">SXNG_Request</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="extended_types.html#searx.extended_types.SXNG_Response"><code class="docutils literal notranslate"><span class="pre">SXNG_Response</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="engines/index.html">Engine Implementations</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html#resultlist-and-engines">ResultList and engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html#engine-types">Engine Types</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="result_types/index.html">Result Types</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/main_result.html">Main Search Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="templates.html">Simple Theme Templates</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html#result-template-macros">Result template macros</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html#main-result-list">Main Result List</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html#answer-results">Answer results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html#suggestion-results">Suggestion results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html#correction-results">Correction results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html#infobox-results">Infobox results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="search_api.html">Search API</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="search_api.html#parameters">Parameters</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugins</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/builtins.html">Built-in Plugins</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="answerers/index.html">Answerers</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/builtins.html">Built-in Answerers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="translation.html#id2">wlc</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#python-environment-make-install">Python environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#node-js-environment-make-node-env">Node.js environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">node.env</span></code>)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-run"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-format"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">format</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-clean"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-docs"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-test"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-search-checker-engine-name"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">search.checker.{engine</span> <span class="pre">name}</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-themes"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">themes.*</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-static-build"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">static.build.*</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile.html#manage-go-help"><code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">go.help</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reST.html">reST primer</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#soft-skills">Soft skills</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#basic-inline-markup">Basic inline markup</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#basic-article-structure">Basic article structure</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#anchors-links">Anchors & Links</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#literal-blocks">Literal blocks</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#unicode-substitution">Unicode substitution</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#roles">Roles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#figures-images">Figures & Images</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#list-markups">List markups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#admonitions">Admonitions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#tables">Tables</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#templating">Templating</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#tabbed-views">Tabbed views</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reST.html#math-equations">Math equations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="searxng_extra/update.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/update/</span></code></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="../index.html">
|
||||
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<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="current reference internal" href="#">Developer documentation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="commits.html">Git Commits & Change Management</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="extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</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="makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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>Previous: <a href="../admin/buildhosts.html" title="previous chapter">Buildhosts</a>
|
||||
<li>Next: <a href="quickstart.html" title="next chapter">Development Quickstart</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/dev/index.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
566
dev/makefile.html
Normal file
566
dev/makefile.html
Normal file
@@ -0,0 +1,566 @@
|
||||
<!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>Makefile & ./manage — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" />
|
||||
<script src="../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" src="../_static/describe_version.js?v=fa7f30d0"></script>
|
||||
<script src="../_static/tabs.js?v=3030b3cb"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="reST primer" href="reST.html" />
|
||||
<link rel="prev" title="Translation" href="translation.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="reST.html" title="reST primer"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="translation.html" title="Translation"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="makefile-manage">
|
||||
<span id="makefile"></span><h1>Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code><a class="headerlink" href="#makefile-manage" title="Link to this heading">¶</a></h1>
|
||||
<p>All relevant build and development tasks are implemented in the
|
||||
<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/manage">./manage</a> script and for CI or IDE integration a small
|
||||
<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/Makefile">git://Makefile</a> wrapper is available. If you are not familiar with
|
||||
Makefiles, we recommend to read <a class="reference external" href="https://www.gnu.org/software/make/manual/make.html#Introduction">gnu-make</a> introduction.</p>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">build environment</p>
|
||||
<p>Before looking deeper at the targets, first read about <a class="reference internal" href="#make-install"><span class="std std-ref">Python environment (make install)</span></a>.</p>
|
||||
<p>To install developer requirements follow <a class="reference internal" href="../admin/buildhosts.html#buildhosts"><span class="std std-ref">Buildhosts</span></a>.</p>
|
||||
</aside>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#python-environment-make-install" id="id13">Python environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>)</a></p></li>
|
||||
<li><p><a class="reference internal" href="#node-js-environment-make-node-env" id="id14">Node.js environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">node.env</span></code>)</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#nvm-make-nvm-install-nvm-status" id="id15">NVM <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.install</span> <span class="pre">nvm.status</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-nvm-nodejs" id="id16"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.nodejs</span></code></a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#make-run" id="id17"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-format" id="id18"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">format</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-clean" id="id19"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-docs" id="id20"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span></code></a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#make-docs-clean-docs-live" id="id21"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.clean</span> <span class="pre">docs.live</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-docs-gh-pages" id="id22"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.gh-pages</span></code></a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#make-test" id="id23"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#make-test-shell" id="id24"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.shell</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-test-pylint" id="id25"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.pylint</span></code></a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#make-search-checker-engine-name" id="id26"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">search.checker.{engine</span> <span class="pre">name}</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-themes" id="id27"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">themes.*</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#make-static-build" id="id28"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">static.build.*</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#manage-go-help" id="id29"><code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">go.help</span></code></a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p>The usage is simple, just type <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">{target-name}</span></code> to <em>build</em> a target.
|
||||
Calling the <code class="docutils literal notranslate"><span class="pre">help</span></code> target gives a first overview (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">help</span></code>):</p>
|
||||
<div class="sphinx-tabs docutils container">
|
||||
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-YGBtYWtlYGA=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-0-YGBtYWtlYGA=" name="YGBtYWtlYGA=" role="tab" tabindex="0"><code class="docutils literal notranslate"><span class="pre">make</span></code></button><button aria-controls="panel-0-YGAuL21hbmFnZWBg" aria-selected="false" class="sphinx-tabs-tab group-tab" id="tab-0-YGAuL21hbmFnZWBg" name="YGAuL21hbmFnZWBg" role="tab" tabindex="-1"><code class="docutils literal notranslate"><span class="pre">./manage</span></code></button></div><div aria-labelledby="tab-0-YGBtYWtlYGA=" class="sphinx-tabs-panel group-tab" id="panel-0-YGBtYWtlYGA=" name="YGBtYWtlYGA=" role="tabpanel" tabindex="0"><div class="highlight-text notranslate"><div class="highlight"><pre><span></span>INFO: sourced NVM environment from /home/runner/.nvm
|
||||
nvm.: use nvm (without dot) to execute nvm commands directly
|
||||
install : install NVM locally at /home/runner/work/searxng/searxng/.nvm
|
||||
clean : remove NVM installation
|
||||
status : prompt some status information about nvm & node
|
||||
nodejs : install latest Node.js
|
||||
cmd ... : run command ... in NVM environment
|
||||
bash : start bash interpreter with NVM environment sourced
|
||||
webapp.:
|
||||
run : run developer instance
|
||||
docs.:
|
||||
html : build HTML documentation
|
||||
live : autobuild HTML documentation while editing
|
||||
gh-pages : deploy on gh-pages branch
|
||||
prebuild : build reST include files (./build/docs/includes)
|
||||
clean : clean documentation build
|
||||
gecko.driver:
|
||||
download & install geckodriver if not already installed (required for
|
||||
robot_tests)
|
||||
valkey:
|
||||
install : create user () and install systemd service ()
|
||||
py.:
|
||||
build : Build python packages at ./dist
|
||||
clean : delete virtualenv and intermediate py files
|
||||
pyenv.:
|
||||
install : developer install of SearXNG into virtualenv
|
||||
uninstall : uninstall developer installation
|
||||
cmd ... : run command ... in virtualenv
|
||||
OK : test if virtualenv is OK
|
||||
format.:
|
||||
python : format Python code source using black
|
||||
shell : format Shell scripts using shfmt
|
||||
go: GOROOT=/home/runner/work/searxng/searxng/.govm/go1.24.5
|
||||
install : compiles and installs packages
|
||||
node.:
|
||||
env : download & install SearXNG's npm dependencies locally
|
||||
env.dev : download & install developer and CI tools
|
||||
clean : drop locally npm installations
|
||||
weblate.:
|
||||
push.translations: push translation changes from SearXNG to Weblate's counterpart
|
||||
to.translations: Update 'translations' branch with last additions from Weblate.
|
||||
container.:
|
||||
build : build container image
|
||||
data.:
|
||||
all : update searx/sxng_locales.py and searx/data/*
|
||||
traits : update searx/data/engine_traits.json & searx/sxng_locales.py
|
||||
useragents: update searx/data/useragents.json with the most recent versions of Firefox
|
||||
locales : update searx/data/locales.json from babel
|
||||
currencies: update searx/data/currencies.json from wikidata
|
||||
test.:
|
||||
yamllint : lint YAML files (YAMLLINT_FILES)
|
||||
pylint : lint ./searx, ./searxng_extra and ./tests
|
||||
pyright : check Python types
|
||||
black : check Python code format
|
||||
shfmt : check Shell script code format
|
||||
unit : run unit tests
|
||||
coverage : run unit tests with coverage
|
||||
robot : run robot test
|
||||
rst : test .rst files incl. README.rst
|
||||
clean : clean intermediate test stuff
|
||||
themes.:
|
||||
all : test & build all themes
|
||||
simple : test & build simple theme
|
||||
lint : lint JS & CSS (LESS) files
|
||||
fix : fix JS & CSS (LESS) files
|
||||
test : test all themes
|
||||
static.build.: [build] /static
|
||||
commit : build & commit /static folder
|
||||
drop : drop last commit if it was previously done by static.build.commit
|
||||
restore : git restore of the /static folder (after themes.all)
|
||||
vite.: .. to be done ..
|
||||
simple.:
|
||||
build: build static files of the simple theme
|
||||
fix: run prettiers on simple theme
|
||||
lint: run linters on simple theme
|
||||
dev: start development server
|
||||
dev.:
|
||||
env: enter developer environment (or exec a command in)
|
||||
environment ...
|
||||
SEARXNG_VALKEY_URL :
|
||||
----
|
||||
run - run developer instance
|
||||
install - developer install of SearxNG into virtualenv
|
||||
uninstall - uninstall developer installation
|
||||
clean - clean up working tree
|
||||
search.checker - check search engines
|
||||
test - run shell & CI tests
|
||||
test.shell - test shell scripts
|
||||
ci.test - run CI tests
|
||||
</pre></div>
|
||||
</div>
|
||||
</div><div aria-labelledby="tab-0-YGAuL21hbmFnZWBg" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-0-YGAuL21hbmFnZWBg" name="YGAuL21hbmFnZWBg" role="tabpanel" tabindex="0"><p>The Makefile targets are implemented for comfort, if you can do without
|
||||
tab-completion and need to have a more granular control, use
|
||||
<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/manage">git://manage</a> without the Makefile wrappers.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>./manage<span class="w"> </span><span class="nb">help</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></div>
|
||||
<section id="python-environment-make-install">
|
||||
<span id="make-install"></span><h2><a class="toc-backref" href="#id13" role="doc-backlink">Python environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>)</a><a class="headerlink" href="#python-environment-make-install" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">activate environment</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">source</span> <span class="pre">./local/py3/bin/activate</span></code></p>
|
||||
</aside>
|
||||
<p>We do no longer need to build up the virtualenv manually. Jump into your git
|
||||
working tree and release a <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> to get a virtualenv with a
|
||||
<em>developer install</em> of SearXNG (<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/setup.py">git://setup.py</a>).</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd ~/searxng-clone
|
||||
$ make install
|
||||
PYENV [virtualenv] installing ./requirements*.txt into local/py3
|
||||
...
|
||||
PYENV [install] pip install --use-pep517 --no-build-isolation -e 'searx[test]'
|
||||
...
|
||||
Successfully installed searxng-2023.7.19+a446dea1b
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you release <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> multiple times the installation will only
|
||||
rebuild if the sha256 sum of the <em>requirement files</em> fails. With other words:
|
||||
the check fails if you edit the requirements listed in
|
||||
<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/requirements-dev.txt">git://requirements-dev.txt</a> and <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/requirements.txt">git://requirements.txt</a>).</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make install
|
||||
PYENV OK
|
||||
PYENV [virtualenv] requirements.sha256 failed
|
||||
[virtualenv] - 6cea6eb6def9e14a18bf32f8a3e... ./requirements-dev.txt
|
||||
[virtualenv] - 471efef6c73558e391c3adb35f4... ./requirements.txt
|
||||
...
|
||||
PYENV [virtualenv] installing ./requirements*.txt into local/py3
|
||||
...
|
||||
PYENV [install] pip install --use-pep517 --no-build-isolation -e 'searx[test]'
|
||||
...
|
||||
Successfully installed searxng-2023.7.19+a446dea1b
|
||||
</pre></div>
|
||||
</div>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">drop environment</p>
|
||||
<p>To get rid of the existing environment before re-build use <a class="reference internal" href="#make-clean"><span class="std std-ref">clean target</span></a> first.</p>
|
||||
</aside>
|
||||
<p>If you think, something goes wrong with your ./local environment or you change
|
||||
the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/setup.py">git://setup.py</a> file, you have to call <a class="reference internal" href="#make-clean"><span class="std std-ref">make clean</span></a>.</p>
|
||||
</section>
|
||||
<section id="node-js-environment-make-node-env">
|
||||
<span id="make-node-env"></span><h2><a class="toc-backref" href="#id14" role="doc-backlink">Node.js environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">node.env</span></code>)</a><a class="headerlink" href="#node-js-environment-make-node-env" title="Link to this heading">¶</a></h2>
|
||||
<p><a class="reference external" href="https://nodejs.org/">Node.js</a> version 24.3.0 or higher is required to build the themes.
|
||||
If the requirement is not met, the build chain uses <a class="reference external" href="https://github.com/nvm-sh">nvm</a> (Node Version
|
||||
Manager) to install <a class="reference external" href="https://nodejs.org/">Node.js</a> locally: there is no need to install
|
||||
<a class="reference external" href="https://github.com/nvm-sh">nvm</a> or <a class="reference external" href="https://www.npmjs.com/">npm</a> on your system.</p>
|
||||
<p>To install <a class="reference external" href="https://github.com/nvm-sh">NVM</a> and <a class="reference external" href="https://nodejs.org/">Node.js</a> in once you can use <a class="reference internal" href="#make-nvm-nodejs"><span class="std std-ref">make nvm.nodejs</span></a>.</p>
|
||||
<section id="nvm-make-nvm-install-nvm-status">
|
||||
<span id="make-nvm"></span><h3><a class="toc-backref" href="#id15" role="doc-backlink">NVM <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.install</span> <span class="pre">nvm.status</span></code></a><a class="headerlink" href="#nvm-make-nvm-install-nvm-status" title="Link to this heading">¶</a></h3>
|
||||
<p>Use <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.status</span></code> to get the current status of your <a class="reference external" href="https://nodejs.org/">Node.js</a> and <a class="reference external" href="https://github.com/nvm-sh">nvm</a>
|
||||
setup.</p>
|
||||
<div class="sphinx-tabs docutils container">
|
||||
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-bnZtLmluc3RhbGw=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-1-bnZtLmluc3RhbGw=" name="bnZtLmluc3RhbGw=" role="tab" tabindex="0">nvm.install</button><button aria-controls="panel-1-bnZtLnN0YXR1cyAodWJ1MjAwNCk=" aria-selected="false" class="sphinx-tabs-tab group-tab" id="tab-1-bnZtLnN0YXR1cyAodWJ1MjAwNCk=" name="bnZtLnN0YXR1cyAodWJ1MjAwNCk=" role="tab" tabindex="-1">nvm.status (ubu2004)</button></div><div aria-labelledby="tab-1-bnZtLmluc3RhbGw=" class="sphinx-tabs-panel group-tab" id="panel-1-bnZtLmluc3RhbGw=" name="bnZtLmluc3RhbGw=" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nv">LANG</span><span class="o">=</span>C<span class="w"> </span>make<span class="w"> </span>nvm.install
|
||||
INFO:<span class="w"> </span>install<span class="w"> </span><span class="o">(</span>update<span class="o">)</span><span class="w"> </span>NVM<span class="w"> </span>at<span class="w"> </span>./searxng/.nvm
|
||||
INFO:<span class="w"> </span>clone:<span class="w"> </span>https://github.com/nvm-sh/nvm.git
|
||||
<span class="w"> </span><span class="o">||</span><span class="w"> </span>Cloning<span class="w"> </span>into<span class="w"> </span><span class="s1">'./searxng/.nvm'</span>...
|
||||
INFO:<span class="w"> </span>checkout<span class="w"> </span>v0.39.4
|
||||
<span class="w"> </span><span class="o">||</span><span class="w"> </span>HEAD<span class="w"> </span>is<span class="w"> </span>now<span class="w"> </span>at<span class="w"> </span>8fbf8ab<span class="w"> </span>v0.39.4
|
||||
</pre></div>
|
||||
</div>
|
||||
</div><div aria-labelledby="tab-1-bnZtLnN0YXR1cyAodWJ1MjAwNCk=" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-1-bnZtLnN0YXR1cyAodWJ1MjAwNCk=" name="bnZtLnN0YXR1cyAodWJ1MjAwNCk=" role="tabpanel" tabindex="0"><p>Here is the output you will typically get on a Ubuntu 20.04 system which
|
||||
serves only a <a class="reference external" href="https://nodejs.org/en/about/releases/">no longer active</a>
|
||||
Release <a class="reference external" href="https://packages.ubuntu.com/focal/nodejs">Node.js v10.19.0</a>.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>nvm.status
|
||||
INFO:<span class="w"> </span>Node.js<span class="w"> </span>is<span class="w"> </span>installed<span class="w"> </span>at<span class="w"> </span>/usr/bin/node
|
||||
INFO:<span class="w"> </span>Node.js<span class="w"> </span>is<span class="w"> </span>version<span class="w"> </span>v10.19.0
|
||||
WARN:<span class="w"> </span>minimal<span class="w"> </span>Node.js<span class="w"> </span>version<span class="w"> </span>is<span class="w"> </span><span class="m">16</span>.13.0
|
||||
INFO:<span class="w"> </span>npm<span class="w"> </span>is<span class="w"> </span>installed<span class="w"> </span>at<span class="w"> </span>/usr/bin/npm
|
||||
INFO:<span class="w"> </span>npm<span class="w"> </span>is<span class="w"> </span>version<span class="w"> </span><span class="m">6</span>.14.4
|
||||
WARN:<span class="w"> </span>NVM<span class="w"> </span>is<span class="w"> </span>not<span class="w"> </span>installed
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></div>
|
||||
</section>
|
||||
<section id="make-nvm-nodejs">
|
||||
<span id="id1"></span><h3><a class="toc-backref" href="#id16" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.nodejs</span></code></a><a class="headerlink" href="#make-nvm-nodejs" title="Link to this heading">¶</a></h3>
|
||||
<p>Install latest <a class="reference external" href="https://nodejs.org/">Node.js</a> locally (uses <a class="reference external" href="https://github.com/nvm-sh">nvm</a>):</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make nvm.nodejs
|
||||
INFO: install (update) NVM at /share/searxng/.nvm
|
||||
INFO: clone: https://github.com/nvm-sh/nvm.git
|
||||
...
|
||||
Downloading and installing node v16.13.0...
|
||||
...
|
||||
INFO: Node.js is installed at searxng/.nvm/versions/node/v16.13.0/bin/node
|
||||
INFO: Node.js is version v16.13.0
|
||||
INFO: npm is installed at searxng/.nvm/versions/node/v16.13.0/bin/npm
|
||||
INFO: npm is version 8.1.0
|
||||
INFO: NVM is installed at searxng/.nvm
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="make-run">
|
||||
<span id="id2"></span><h2><a class="toc-backref" href="#id17" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code></a><a class="headerlink" href="#make-run" title="Link to this heading">¶</a></h2>
|
||||
<p>To get up a running a developer instance simply call <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code>. This enables
|
||||
<em>debug</em> option in <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">git://searx/settings.yml</a>, starts a <code class="docutils literal notranslate"><span class="pre">./searx/webapp.py</span></code>
|
||||
instance and opens the URL in your favorite WEB browser (<a class="extlink-man reference external" href="https://manpages.debian.org/jump?q=xdg-open">xdg-open</a>):</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make run
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Changes to theme’s HTML templates (jinja2) are instant. Changes to the CSS & JS
|
||||
sources of the theme need to be rebuild. You can do that by running:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make themes.all
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="make-format">
|
||||
<span id="id3"></span><h2><a class="toc-backref" href="#id18" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">format</span></code></a><a class="headerlink" href="#make-format" title="Link to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Format Python source code using <a class="reference external" href="https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html">Black code style</a>. See <code class="docutils literal notranslate"><span class="pre">$BLACK_OPTIONS</span></code>
|
||||
and <code class="docutils literal notranslate"><span class="pre">$BLACK_TARGETS</span></code> in <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/Makefile">git://Makefile</a>.</p></li>
|
||||
<li><p>Format Shell scripts using <a class="reference external" href="https://github.com/mvdan/sh?tab=readme-ov-file#shfmt">shfmt</a>. The formatter <code class="docutils literal notranslate"><span class="pre">shfmt</span></code> reads the rules
|
||||
from the <a class="reference external" href="https://github.com/patrickvane/shfmt?tab=readme-ov-file#description">EditorConfig</a> files.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="make-clean">
|
||||
<span id="id4"></span><h2><a class="toc-backref" href="#id19" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code></a><a class="headerlink" href="#make-clean" title="Link to this heading">¶</a></h2>
|
||||
<p>Drops all intermediate files, all builds, but keep sources untouched. Before
|
||||
calling <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code> stop all processes using the <a class="reference internal" href="#make-install"><span class="std std-ref">Python environment (make install)</span></a> or
|
||||
<a class="reference internal" href="#make-node-env"><span class="std std-ref">Node.js environment (make node.env)</span></a>.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make clean
|
||||
CLEAN pyenv
|
||||
PYENV [virtualenv] drop local/py3
|
||||
CLEAN docs -- build/docs dist/docs
|
||||
CLEAN themes -- locally installed npm dependencies
|
||||
...
|
||||
CLEAN test stuff
|
||||
CLEAN common files
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="make-docs">
|
||||
<span id="id5"></span><h2><a class="toc-backref" href="#id20" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span></code></a><a class="headerlink" href="#make-docs" title="Link to this heading">¶</a></h2>
|
||||
<p>Target <code class="docutils literal notranslate"><span class="pre">docs</span></code> builds the documentation:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>make<span class="w"> </span>docs
|
||||
HTML<span class="w"> </span>./docs<span class="w"> </span>--><span class="w"> </span>file://
|
||||
DOCS<span class="w"> </span>build<span class="w"> </span>build/docs/includes
|
||||
...
|
||||
The<span class="w"> </span>HTML<span class="w"> </span>pages<span class="w"> </span>are<span class="w"> </span><span class="k">in</span><span class="w"> </span>dist/docs.
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="make-docs-clean-docs-live">
|
||||
<span id="make-docs-clean"></span><h3><a class="toc-backref" href="#id21" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.clean</span> <span class="pre">docs.live</span></code></a><a class="headerlink" href="#make-docs-clean-docs-live" title="Link to this heading">¶</a></h3>
|
||||
<p>We describe the usage of the <code class="docutils literal notranslate"><span class="pre">doc.*</span></code> targets in the <a class="reference internal" href="contribution_guide.html#contrib-docs"><span class="std std-ref">How to contribute /
|
||||
Documentation</span></a> section. If you want to edit the documentation
|
||||
read our <a class="reference internal" href="contribution_guide.html#make-docs-live"><span class="std std-ref">Live build</span></a> section. If you are working in your own brand,
|
||||
adjust your <a class="reference internal" href="../admin/settings/settings_brand.html#settings-brand"><span class="std std-ref">brand:</span></a>.</p>
|
||||
</section>
|
||||
<section id="make-docs-gh-pages">
|
||||
<span id="id6"></span><h3><a class="toc-backref" href="#id22" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.gh-pages</span></code></a><a class="headerlink" href="#make-docs-gh-pages" title="Link to this heading">¶</a></h3>
|
||||
<p>To deploy on github.io first adjust your <a class="reference internal" href="../admin/settings/settings_brand.html#settings-brand"><span class="std std-ref">brand:</span></a>. For any
|
||||
further read <a class="reference internal" href="contribution_guide.html#deploy-on-github-io"><span class="std std-ref">deploy on github.io</span></a>.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="make-test">
|
||||
<span id="id7"></span><h2><a class="toc-backref" href="#id23" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></a><a class="headerlink" href="#make-test" title="Link to this heading">¶</a></h2>
|
||||
<p>Runs a series of tests: <a class="reference internal" href="#make-test-pylint"><span class="std std-ref">make test.pylint</span></a>, <code class="docutils literal notranslate"><span class="pre">test.pep8</span></code>, <code class="docutils literal notranslate"><span class="pre">test.unit</span></code>
|
||||
and <code class="docutils literal notranslate"><span class="pre">test.robot</span></code>. You can run tests selective, e.g.:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ make test.pep8 test.unit test.shell
|
||||
TEST test.pep8 OK
|
||||
...
|
||||
TEST test.unit OK
|
||||
...
|
||||
TEST test.shell OK
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="make-test-shell">
|
||||
<span id="id8"></span><h3><a class="toc-backref" href="#id24" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.shell</span></code></a><a class="headerlink" href="#make-test-shell" title="Link to this heading">¶</a></h3>
|
||||
<p><a class="reference internal" href="../admin/buildhosts.html#sh-lint"><span class="std std-ref">Lint shell scripts</span></a> / if you have changed some bash scripting run this test before
|
||||
commit.</p>
|
||||
</section>
|
||||
<section id="make-test-pylint">
|
||||
<span id="id9"></span><h3><a class="toc-backref" href="#id25" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.pylint</span></code></a><a class="headerlink" href="#make-test-pylint" title="Link to this heading">¶</a></h3>
|
||||
<p><a class="reference external" href="https://www.pylint.org/">Pylint</a> is known as one of the best source-code, bug and quality checker for the
|
||||
Python programming language. The pylint profile used in the SearXNG project is
|
||||
found in project’s root folder <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/.pylintrc">git://.pylintrc</a>.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="make-search-checker-engine-name">
|
||||
<span id="make-search-checker"></span><h2><a class="toc-backref" href="#id26" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">search.checker.{engine</span> <span class="pre">name}</span></code></a><a class="headerlink" href="#make-search-checker-engine-name" title="Link to this heading">¶</a></h2>
|
||||
<p>To check all engines:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">search</span><span class="o">.</span><span class="n">checker</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To check a engine with whitespace in the name like <em>google news</em> replace space
|
||||
by underline:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">search</span><span class="o">.</span><span class="n">checker</span><span class="o">.</span><span class="n">google_news</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To see HTTP requests and more use SEARXNG_DEBUG:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">SEARXNG_DEBUG</span><span class="o">=</span><span class="mi">1</span> <span class="n">search</span><span class="o">.</span><span class="n">checker</span><span class="o">.</span><span class="n">google_news</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To filter out HTTP redirects (<a class="reference external" href="https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection">3xx</a>):</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">SEARXNG_DEBUG</span><span class="o">=</span><span class="mi">1</span> <span class="n">search</span><span class="o">.</span><span class="n">checker</span><span class="o">.</span><span class="n">google_news</span> <span class="o">|</span> <span class="n">grep</span> <span class="o">-</span><span class="n">A1</span> <span class="s2">"HTTP/1.1</span><span class="se">\"</span><span class="s2"> 3[0-9][0-9]"</span>
|
||||
<span class="o">...</span>
|
||||
<span class="n">Engine</span> <span class="n">google</span> <span class="n">news</span> <span class="n">Checking</span>
|
||||
<span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">news</span><span class="o">.</span><span class="n">google</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="mi">443</span> <span class="s2">"GET /search?q=life&hl=en&lr=lang_en&ie=utf8&oe=utf8&ceid=US%3Aen&gl=US HTTP/1.1"</span> <span class="mi">302</span> <span class="mi">0</span>
|
||||
<span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">news</span><span class="o">.</span><span class="n">google</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="mi">443</span> <span class="s2">"GET /search?q=life&hl=en-US&lr=lang_en&ie=utf8&oe=utf8&ceid=US:en&gl=US HTTP/1.1"</span> <span class="mi">200</span> <span class="kc">None</span>
|
||||
<span class="o">--</span>
|
||||
<span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">news</span><span class="o">.</span><span class="n">google</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="mi">443</span> <span class="s2">"GET /search?q=computer&hl=en&lr=lang_en&ie=utf8&oe=utf8&ceid=US%3Aen&gl=US HTTP/1.1"</span> <span class="mi">302</span> <span class="mi">0</span>
|
||||
<span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">news</span><span class="o">.</span><span class="n">google</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="mi">443</span> <span class="s2">"GET /search?q=computer&hl=en-US&lr=lang_en&ie=utf8&oe=utf8&ceid=US:en&gl=US HTTP/1.1"</span> <span class="mi">200</span> <span class="kc">None</span>
|
||||
<span class="o">--</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="make-themes">
|
||||
<span id="id10"></span><h2><a class="toc-backref" href="#id27" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">themes.*</span></code></a><a class="headerlink" href="#make-themes" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="quickstart.html#devquickstart"><span class="std std-ref">Development Quickstart</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>The <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/Makefile">git://Makefile</a> targets <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">theme.*</span></code> cover common tasks to build the
|
||||
theme(s). The <code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">themes.*</span></code> command line can be used to convenient run
|
||||
common theme build tasks.</p>
|
||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>INFO: sourced NVM environment from /home/runner/.nvm
|
||||
themes.:
|
||||
all : test & build all themes
|
||||
simple : test & build simple theme
|
||||
lint : lint JS & CSS (LESS) files
|
||||
fix : fix JS & CSS (LESS) files
|
||||
test : test all themes
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To get live builds while modifying CSS & JS use (<a class="reference internal" href="#make-run"><span class="std std-ref">make run</span></a>):</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nv">LIVE_THEME</span><span class="o">=</span>simple<span class="w"> </span>make<span class="w"> </span>run
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="make-static-build">
|
||||
<span id="id11"></span><h2><a class="toc-backref" href="#id28" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">static.build.*</span></code></a><a class="headerlink" href="#make-static-build" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="quickstart.html#devquickstart"><span class="std std-ref">Development Quickstart</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>The <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/Makefile">git://Makefile</a> targets <code class="docutils literal notranslate"><span class="pre">static.build.*</span></code> cover common tasks to build (a
|
||||
commit of) the static files. The <code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">static.build..*</span></code> command line
|
||||
can be used to convenient run common build tasks of the static files.</p>
|
||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>INFO: sourced NVM environment from /home/runner/.nvm
|
||||
static.build.: [build] /static
|
||||
commit : build & commit /static folder
|
||||
drop : drop last commit if it was previously done by static.build.commit
|
||||
restore : git restore of the /static folder (after themes.all)
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="manage-go-help">
|
||||
<span id="id12"></span><h2><a class="toc-backref" href="#id29" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">go.help</span></code></a><a class="headerlink" href="#manage-go-help" title="Link to this heading">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">go.*</span></code> command line can be used to convenient run common <a class="reference external" href="https://en.wikipedia.org/wiki/Go_(programming_language)">go
|
||||
(wiki)</a> tasks.</p>
|
||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>INFO: sourced NVM environment from /home/runner/.nvm
|
||||
go: GOROOT=/home/runner/work/searxng/searxng/.govm/go1.24.5
|
||||
install : compiles and installs packages
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</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="../index.html">
|
||||
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<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="commits.html">Git Commits & Change Management</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="extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="translation.html">Translation</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#python-environment-make-install">Python environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#node-js-environment-make-node-env">Node.js environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">node.env</span></code>)</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#nvm-make-nvm-install-nvm-status">NVM <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.install</span> <span class="pre">nvm.status</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#make-nvm-nodejs"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">nvm.nodejs</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-run"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-format"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">format</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-clean"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-docs"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#make-docs-clean-docs-live"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.clean</span> <span class="pre">docs.live</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#make-docs-gh-pages"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.gh-pages</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-test"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#make-test-shell"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.shell</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#make-test-pylint"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.pylint</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-search-checker-engine-name"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">search.checker.{engine</span> <span class="pre">name}</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-themes"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">themes.*</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#make-static-build"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">static.build.*</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#manage-go-help"><code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">go.help</span></code></a></li>
|
||||
</ul>
|
||||
</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>
|
||||
</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="translation.html" title="previous chapter">Translation</a>
|
||||
<li>Next: <a href="reST.html" title="next chapter">reST primer</a></ul>
|
||||
</li>
|
||||
</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/dev/makefile.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
165
dev/plugins/builtins.html
Normal file
165
dev/plugins/builtins.html
Normal file
@@ -0,0 +1,165 @@
|
||||
<!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>Built-in Plugins — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Calculator" href="calculator.html" />
|
||||
<link rel="prev" title="Plugin Development" href="development.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="calculator.html" title="Calculator"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="development.html" title="Plugin Development"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Built-in Plugins</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="built-in-plugins">
|
||||
<span id="builtin-plugins"></span><h1>Built-in Plugins<a class="headerlink" href="#built-in-plugins" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="time_zone.html">Time Zone</a></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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Built-in Plugins</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="development.html" title="previous chapter">Plugin Development</a>
|
||||
<li>Next: <a href="calculator.html" title="next chapter">Calculator</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/builtins.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
183
dev/plugins/calculator.html
Normal file
183
dev/plugins/calculator.html
Normal file
@@ -0,0 +1,183 @@
|
||||
<!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>Calculator — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Hash Values" href="hash_plugin.html" />
|
||||
<link rel="prev" title="Built-in Plugins" href="builtins.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="hash_plugin.html" title="Hash Values"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="builtins.html" title="Built-in Plugins"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Calculator</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.plugins.calculator">
|
||||
<span id="calculator"></span><span id="plugins-calculator"></span><h1>Calculator<a class="headerlink" href="#module-searx.plugins.calculator" title="Link to this heading">¶</a></h1>
|
||||
<p>Calculate mathematical expressions using <a class="reference external" href="https://docs.python.org/3/library/ast.html#ast.parse" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ast.parse</span></code></a> (mode=”eval”).</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.calculator.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.calculator.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/calculator.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.calculator.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Plugin converts strings to different hash digests. The results are
|
||||
displayed in area for the “answers”.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.calculator.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'calculator'</span></em><a class="headerlink" href="#searx.plugins.calculator.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.calculator.SXNGPlugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/calculator.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.calculator.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs AFTER the search request. Can return a list of
|
||||
<a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> objects to be added to the
|
||||
final result list.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Calculator</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.calculator.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="builtins.html" title="previous chapter">Built-in Plugins</a>
|
||||
<li>Next: <a href="hash_plugin.html" title="next chapter">Hash Values</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/calculator.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
428
dev/plugins/development.html
Normal file
428
dev/plugins/development.html
Normal file
@@ -0,0 +1,428 @@
|
||||
<!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>Plugin Development — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Built-in Plugins" href="builtins.html" />
|
||||
<link rel="prev" title="Plugins" href="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="builtins.html" title="Built-in Plugins"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Plugins"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Plugin Development</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.plugins">
|
||||
<span id="plugin-development"></span><span id="dev-plugin"></span><h1>Plugin Development<a class="headerlink" href="#module-searx.plugins" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Further reading ..</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../admin/plugins.html#plugins-admin"><span class="std std-ref">List of plugins</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../../admin/settings/settings_plugins.html#settings-plugins"><span class="std std-ref">SearXNG settings</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>Plugins can extend or replace functionality of various components of SearXNG.</p>
|
||||
<p>Entry points (hooks) define when a plugin runs. Right now only three hooks are
|
||||
implemented. So feel free to implement a hook if it fits the behaviour of your
|
||||
plugin / a plugin doesn’t need to implement all the hooks.</p>
|
||||
<ul class="simple">
|
||||
<li><p>pre search: <a class="reference internal" href="#searx.plugins.Plugin.pre_search" title="searx.plugins.Plugin.pre_search"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.pre_search</span></code></a></p></li>
|
||||
<li><p>post search: <a class="reference internal" href="#searx.plugins.Plugin.post_search" title="searx.plugins.Plugin.post_search"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.post_search</span></code></a></p></li>
|
||||
<li><p>on each result item: <a class="reference internal" href="#searx.plugins.Plugin.on_result" title="searx.plugins.Plugin.on_result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.on_result</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Below you will find some examples, for more coding examples have a look at the
|
||||
built-in plugins <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/plugins/">git://searx/plugins/</a> or <a class="reference external" href="https://github.com/return42/tgwf-searx-plugins/">Only show green hosted results</a>.</p>
|
||||
<section id="add-answer-example">
|
||||
<h2>Add Answer example<a class="headerlink" href="#add-answer-example" title="Link to this heading">¶</a></h2>
|
||||
<p>Here is an example of a very simple plugin that adds a “Hello World” into the
|
||||
answer area:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span> <span class="k">as</span> <span class="n">_</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answer</span>
|
||||
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">MyPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
|
||||
|
||||
<span class="nb">id</span> <span class="o">=</span> <span class="s2">"hello world"</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plg_cfg</span><span class="p">):</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s2">"Hello"</span><span class="p">),</span> <span class="n">description</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s2">"demo plugin"</span><span class="p">))</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">[</span> <span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="s2">"Hello World"</span><span class="p">)</span> <span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="filter-urls-example">
|
||||
<span id="id1"></span><h2>Filter URLs example<a class="headerlink" href="#filter-urls-example" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Further reading ..</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result.filter_urls" title="searx.result_types._base.Result.filter_urls"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.filter_urls(..)</span></code></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>The <a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result.filter_urls" title="searx.result_types._base.Result.filter_urls"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.filter_urls(..)</span></code></a>
|
||||
can be used to filter and/or modify URL fields. In the following example, the
|
||||
filter function <code class="docutils literal notranslate"><span class="pre">my_url_filter</span></code>:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">my_url_filter</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span> <span class="o">|</span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s2">"google"</span> <span class="ow">in</span> <span class="n">url_src</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">False</span> <span class="c1"># remove URL field from result</span>
|
||||
<span class="k">if</span> <span class="s2">"facebook"</span> <span class="ow">in</span> <span class="n">url_src</span><span class="p">:</span>
|
||||
<span class="n">new_url</span> <span class="o">=</span> <span class="n">url_src</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"facebook"</span><span class="p">,</span> <span class="s2">"fb-dummy"</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">new_url</span> <span class="c1"># return modified URL</span>
|
||||
<span class="k">return</span> <span class="kc">True</span> <span class="c1"># leave URL in field unchanged</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>is applied to all URL fields in the <a class="reference internal" href="#searx.plugins.Plugin.on_result" title="searx.plugins.Plugin.on_result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.on_result</span></code></a> hook:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">MyUrlFilter</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
|
||||
<span class="o">...</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">on_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="n">result</span><span class="o">.</span><span class="n">filter_urls</span><span class="p">(</span><span class="n">my_url_filter</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="kc">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementation">
|
||||
<h2>Implementation<a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.</span></span><span class="sig-name descname"><span class="pre">Plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.plugins.PluginCfg" title="searx.plugins._core.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#Plugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.Plugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Abstract base class of all Plugins.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.plugins.Plugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.active">
|
||||
<span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ClassVar" title="(in Python v3.14)"><span class="pre">ClassVar</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.plugins.Plugin.active" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Plugin is enabled/disabled by default (<a class="reference internal" href="#searx.plugins.PluginCfg.active" title="searx.plugins.PluginCfg.active"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PluginCfg.active</span></code></a>).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#searx.plugins.Plugin.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords in the search query that activate the plugin. The <em>keyword</em> is
|
||||
the first word in a search query. If a plugin should be executed regardless
|
||||
of the search query, the list of keywords should be empty (which is also the
|
||||
default in the base class for Plugins).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.info">
|
||||
<span class="sig-name descname"><span class="pre">info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#searx.plugins.PluginInfo" title="searx.plugins._core.PluginInfo"><span class="pre">PluginInfo</span></a></em><a class="headerlink" href="#searx.plugins.Plugin.info" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Information about the <em>plugin</em>, see <a class="reference internal" href="#searx.plugins.PluginInfo" title="searx.plugins.PluginInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PluginInfo</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.log">
|
||||
<span class="sig-name descname"><span class="pre">log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.14)"><span class="pre">Logger</span></a></em><a class="headerlink" href="#searx.plugins.Plugin.log" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A logger object, is automatically initialized when calling the
|
||||
constructor (if not already set in the subclass).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.init">
|
||||
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://flask.palletsprojects.com/en/stable/api/#flask.Flask" title="(in Flask v3.1.x)"><span class="pre">flask.Flask</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#Plugin.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.Plugin.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the plugin, the return value decides whether this
|
||||
plugin is active or not. Initialization only takes place once, at the
|
||||
time the WEB application is set up. The base method always returns
|
||||
<code class="docutils literal notranslate"><span class="pre">True</span></code>, the method can be overwritten in the inheritances,</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code> plugin is active</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code> plugin is inactive</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.pre_search">
|
||||
<span class="sig-name descname"><span class="pre">pre_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#Plugin.pre_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.Plugin.pre_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs BEFORE the search request and returns a boolean:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code> to continue the search</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code> to stop the search</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.on_result">
|
||||
<span class="sig-name descname"><span class="pre">on_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#Plugin.on_result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.Plugin.on_result" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs for each result of each engine and returns a boolean:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code> to keep the result</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code> to remove the result from the result list</p></li>
|
||||
</ul>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">result</span></code> can be modified to the needs.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>If <a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result.url" title="searx.result_types._base.Result.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.url</span></code></a> is modified,
|
||||
<a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result.parsed_url" title="searx.result_types._base.Result.parsed_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.parsed_url</span></code></a> must
|
||||
be changed accordingly:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">result</span><span class="p">[</span><span class="s2">"parsed_url"</span><span class="p">]</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s2">"url"</span><span class="p">])</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.Plugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><span class="pre">LegacyResult</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#Plugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.Plugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs AFTER the search request. Can return a list of
|
||||
<a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> objects to be added to the
|
||||
final result list.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.</span></span><span class="sig-name descname"><span class="pre">PluginInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preference_section:</span> <span class="pre">~typing.Literal['general'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'ui'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'privacy'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'query']</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">'general'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">examples:</span> <span class="pre">list[str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keywords:</span> <span class="pre">list[str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginInfo" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Object that holds information about a <em>plugin</em>, these infos are shown to
|
||||
the user in the Preferences menu.</p>
|
||||
<p>To be able to translate the information into other languages, the text must
|
||||
be written in English and translated with <a class="reference external" href="https://python-babel.github.io/flask-babel/index.html#flask_babel.gettext" title="(in Flask-Babel)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_babel.gettext</span></code></a>.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.plugins.PluginInfo.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID-selector in HTML/CSS <cite>#<id></cite>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo.name">
|
||||
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.plugins.PluginInfo.name" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the <em>plugin</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo.description">
|
||||
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.plugins.PluginInfo.description" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Short description of the <em>answerer</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo.preference_section">
|
||||
<span class="sig-name descname"><span class="pre">preference_section</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.14)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'general'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'ui'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'privacy'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'query'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'general'</span></em><a class="headerlink" href="#searx.plugins.PluginInfo.preference_section" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Section (tab/group) in the preferences where this plugin is shown to the
|
||||
user.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">query</span></code> is reserved for plugins that are activated via a
|
||||
<em>keyword</em> as part of a search query, see:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.plugins.PluginInfo.examples" title="searx.plugins.PluginInfo.examples"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PluginInfo.examples</span></code></a></p></li>
|
||||
<li><p><a class="reference internal" href="#searx.plugins.Plugin.keywords" title="searx.plugins.Plugin.keywords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.keywords</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Those plugins are shown in the preferences in tab <em>Special Queries</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo.examples">
|
||||
<span class="sig-name descname"><span class="pre">examples</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.plugins.PluginInfo.examples" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>List of short examples of the usage / of query terms.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginInfo.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.plugins.PluginInfo.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>See <a class="reference internal" href="#searx.plugins.Plugin.keywords" title="searx.plugins.Plugin.keywords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.keywords</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginStorage">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.</span></span><span class="sig-name descname"><span class="pre">PluginStorage</span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginStorage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginStorage" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A storage for managing the <em>plugins</em> of SearXNG.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginStorage.plugin_list">
|
||||
<span class="sig-name descname"><span class="pre">plugin_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.14)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.plugins.Plugin" title="searx.plugins._core.Plugin"><span class="pre">Plugin</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.plugins.PluginStorage.plugin_list" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The list of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugins</span></code> in this storage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginStorage.load_settings">
|
||||
<span class="sig-name descname"><span class="pre">load_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginStorage.load_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginStorage.load_settings" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Load plugins configured in SearXNG’s settings <a class="reference internal" href="../../admin/settings/settings_plugins.html#settings-plugins"><span class="std std-ref">plugins:</span></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginStorage.register">
|
||||
<span class="sig-name descname"><span class="pre">register</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.plugins.Plugin" title="searx.plugins._core.Plugin"><span class="pre">Plugin</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginStorage.register"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginStorage.register" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Register a <a class="reference internal" href="#searx.plugins.Plugin" title="searx.plugins.Plugin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin</span></code></a>. In case of name collision (if two
|
||||
plugins have same ID) a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#KeyError" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">KeyError</span></code></a> exception is raised.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginStorage.init">
|
||||
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://flask.palletsprojects.com/en/stable/api/#flask.Flask" title="(in Flask v3.1.x)"><span class="pre">flask.Flask</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginStorage.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginStorage.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Calls the method <a class="reference internal" href="#searx.plugins.Plugin.init" title="searx.plugins.Plugin.init"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Plugin.init</span></code></a> of each plugin in this
|
||||
storage. Depending on its return value, the plugin is removed from
|
||||
<em>this</em> storage or not.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginStorage.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginStorage.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginStorage.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Extend <code class="xref py py-obj docutils literal notranslate"><span class="pre">search.result_container</span>
|
||||
<span class="pre"><searx.results.ResultContainer</span></code>> with result items from plugins listed
|
||||
in <code class="xref py py-obj docutils literal notranslate"><span class="pre">search.user_plugins</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginCfg">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.</span></span><span class="sig-name descname"><span class="pre">PluginCfg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">active</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/_core.html#PluginCfg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.PluginCfg" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Settings of a plugin.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">mypackage.mymodule.MyPlugin</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.PluginCfg.active">
|
||||
<span class="sig-name descname"><span class="pre">active</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#searx.plugins.PluginCfg.active" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Plugin is active by default and the user can <em>opt-out</em> in the preferences.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Plugin Development</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#add-answer-example">Add Answer example</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#filter-urls-example">Filter URLs example</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#implementation">Implementation</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.Plugin"><code class="docutils literal notranslate"><span class="pre">Plugin</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.PluginInfo"><code class="docutils literal notranslate"><span class="pre">PluginInfo</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.PluginStorage"><code class="docutils literal notranslate"><span class="pre">PluginStorage</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.PluginCfg"><code class="docutils literal notranslate"><span class="pre">PluginCfg</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="builtins.html">Built-in Plugins</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">Plugins</a>
|
||||
<li>Next: <a href="builtins.html" title="next chapter">Built-in Plugins</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/development.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
189
dev/plugins/hash_plugin.html
Normal file
189
dev/plugins/hash_plugin.html
Normal file
@@ -0,0 +1,189 @@
|
||||
<!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>Hash Values — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Hostnames" href="hostnames.html" />
|
||||
<link rel="prev" title="Calculator" href="calculator.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="hostnames.html" title="Hostnames"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="calculator.html" title="Calculator"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Hash Values</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="hash-values">
|
||||
<span id="hash-plugin-plugin"></span><h1>Hash Values<a class="headerlink" href="#hash-values" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.hash_plugin.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/hash_plugin.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Plugin converts strings to different hash digests. The results are
|
||||
displayed in area for the “answers”.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'hash_plugin'</span></em><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['md5',</span> <span class="pre">'sha1',</span> <span class="pre">'sha224',</span> <span class="pre">'sha256',</span> <span class="pre">'sha384',</span> <span class="pre">'sha512']</span></em><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords in the search query that activate the plugin. The <em>keyword</em> is
|
||||
the first word in a search query. If a plugin should be executed regardless
|
||||
of the search query, the list of keywords should be empty (which is also the
|
||||
default in the base class for Plugins).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/hash_plugin.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns a result list only for the first page.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Hash Values</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.hash_plugin.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="calculator.html" title="previous chapter">Calculator</a>
|
||||
<li>Next: <a href="hostnames.html" title="next chapter">Hostnames</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/hash_plugin.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
284
dev/plugins/hostnames.html
Normal file
284
dev/plugins/hostnames.html
Normal file
@@ -0,0 +1,284 @@
|
||||
<!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>Hostnames — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Self-Info" href="self_info.html" />
|
||||
<link rel="prev" title="Hash Values" href="hash_plugin.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="self_info.html" title="Self-Info"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="hash_plugin.html" title="Hash Values"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Hostnames</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.plugins.hostnames">
|
||||
<span id="hostnames"></span><span id="hostnames-plugin"></span><h1>Hostnames<a class="headerlink" href="#module-searx.plugins.hostnames" title="Link to this heading">¶</a></h1>
|
||||
<p>During the initialization phase, the plugin checks whether a <code class="docutils literal notranslate"><span class="pre">hostnames:</span></code>
|
||||
configuration exists. If this is not the case, the plugin is not included in the
|
||||
PluginStorage (it is not available for selection).</p>
|
||||
<ul>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">hostnames.replace</span></code>: A <strong>mapping</strong> of regular expressions to hostnames to be
|
||||
replaced by other hostnames.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">hostnames</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">replace</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="s">'(.*\.)?youtube\.com$'</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">'invidious.example.com'</span>
|
||||
<span class="w"> </span><span class="s">'(.*\.)?youtu\.be$'</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">'invidious.example.com'</span>
|
||||
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">hostnames.remove</span></code>: A <strong>list</strong> of regular expressions of the hostnames whose
|
||||
results should be taken from the results list.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">hostnames</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">remove</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">'(.*\.)?facebook.com$'</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">hostnames.high_priority</span></code>: A <strong>list</strong> of regular expressions for hostnames
|
||||
whose result should be given higher priority. The results from these hosts are
|
||||
arranged higher in the results list.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">hostnames</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">high_priority</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">'(.*\.)?wikipedia.org$'</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">hostnames.lower_priority</span></code>: A <strong>list</strong> of regular expressions for hostnames
|
||||
whose result should be given lower priority. The results from these hosts are
|
||||
arranged lower in the results list.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">hostnames</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">low_priority</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">'(.*\.)?google(\..*)?$'</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<p>If the URL matches the pattern of <code class="docutils literal notranslate"><span class="pre">high_priority</span></code> AND <code class="docutils literal notranslate"><span class="pre">low_priority</span></code>, the
|
||||
higher priority wins over the lower priority.</p>
|
||||
<p>Alternatively, you can also specify a file name for the <strong>mappings</strong> or
|
||||
<strong>lists</strong> to load these from an external file:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">hostnames</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">replace</span><span class="p">:</span><span class="w"> </span><span class="s">'rewrite-hosts.yml'</span>
|
||||
<span class="w"> </span><span class="nt">remove</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">'(.*\.)?facebook.com$'</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">low_priority</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">'(.*\.)?google(\..*)?$'</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">high_priority</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">'(.*\.)?wikipedia.org$'</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">rewrite-hosts.yml</span></code> from the example above must be in the folder in which
|
||||
the <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> file is already located (<code class="docutils literal notranslate"><span class="pre">/etc/searxng</span></code>). The file then
|
||||
only contains the lists or the mapping tables without further information on the
|
||||
namespaces. In the example above, this would be a mapping table that looks
|
||||
something like this:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="s">'(.*\.)?youtube\.com$'</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">'invidious.example.com'</span>
|
||||
<span class="s">'(.*\.)?youtu\.be$'</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">'invidious.example.com'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hostnames.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.hostnames.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/hostnames.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hostnames.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Rewrite hostnames, remove results or prioritize them.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hostnames.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'hostnames'</span></em><a class="headerlink" href="#searx.plugins.hostnames.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hostnames.SXNGPlugin.on_result">
|
||||
<span class="sig-name descname"><span class="pre">on_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/hostnames.html#SXNGPlugin.on_result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hostnames.SXNGPlugin.on_result" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs for each result of each engine and returns a boolean:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code> to keep the result</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code> to remove the result from the result list</p></li>
|
||||
</ul>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">result</span></code> can be modified to the needs.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>If <a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result.url" title="searx.result_types._base.Result.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.url</span></code></a> is modified,
|
||||
<a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result.parsed_url" title="searx.result_types._base.Result.parsed_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.parsed_url</span></code></a> must
|
||||
be changed accordingly:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">result</span><span class="p">[</span><span class="s2">"parsed_url"</span><span class="p">]</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s2">"url"</span><span class="p">])</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hostnames.SXNGPlugin.init">
|
||||
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://flask.palletsprojects.com/en/stable/api/#flask.Flask" title="(in Flask v3.1.x)"><span class="pre">flask.Flask</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/hostnames.html#SXNGPlugin.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hostnames.SXNGPlugin.init" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Initialization of the plugin, the return value decides whether this
|
||||
plugin is active or not. Initialization only takes place once, at the
|
||||
time the WEB application is set up. The base method always returns
|
||||
<code class="docutils literal notranslate"><span class="pre">True</span></code>, the method can be overwritten in the inheritances,</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code> plugin is active</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code> plugin is inactive</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.plugins.hostnames.filter_url_field">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.plugins.hostnames.</span></span><span class="sig-name descname"><span class="pre">filter_url_field</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><span class="pre">LegacyResult</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">url_src</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/hostnames.html#filter_url_field"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hostnames.filter_url_field" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns bool <code class="docutils literal notranslate"><span class="pre">True</span></code> to use URL unchanged (<code class="docutils literal notranslate"><span class="pre">False</span></code> to ignore URL).
|
||||
If URL should be modified, the returned string is the new URL to use.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Hostnames</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.hostnames.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.hostnames.filter_url_field"><code class="docutils literal notranslate"><span class="pre">filter_url_field()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="hash_plugin.html" title="previous chapter">Hash Values</a>
|
||||
<li>Next: <a href="self_info.html" title="next chapter">Self-Info</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/hostnames.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
161
dev/plugins/index.html
Normal file
161
dev/plugins/index.html
Normal file
@@ -0,0 +1,161 @@
|
||||
<!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>Plugins — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Plugin Development" href="development.html" />
|
||||
<link rel="prev" title="Search API" href="../search_api.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="development.html" title="Plugin Development"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../search_api.html" title="Search API"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Plugins</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="plugins">
|
||||
<h1>Plugins<a class="headerlink" href="#plugins" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="development.html">Plugin Development</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#add-answer-example">Add Answer example</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#filter-urls-example">Filter URLs example</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="development.html#implementation">Implementation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="time_zone.html">Time Zone</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Plugins</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="builtins.html">Built-in Plugins</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="../search_api.html" title="previous chapter">Search API</a>
|
||||
<li>Next: <a href="development.html" title="next chapter">Plugin Development</a></ul>
|
||||
</li>
|
||||
</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/dev/plugins/index.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
190
dev/plugins/self_info.html
Normal file
190
dev/plugins/self_info.html
Normal file
@@ -0,0 +1,190 @@
|
||||
<!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>Self-Info — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Tor check" href="tor_check.html" />
|
||||
<link rel="prev" title="Hostnames" href="hostnames.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="tor_check.html" title="Tor check"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="hostnames.html" title="Hostnames"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Self-Info</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="self-info">
|
||||
<span id="self-info-plugin"></span><h1>Self-Info<a class="headerlink" href="#self-info" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.self_info.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.self_info.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/self_info.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.self_info.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Simple plugin that displays information about user’s request, including
|
||||
the IP or HTTP User-Agent. The information is displayed in area for the
|
||||
“answers”.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.self_info.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'self_info'</span></em><a class="headerlink" href="#searx.plugins.self_info.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.self_info.SXNGPlugin.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['ip',</span> <span class="pre">'user-agent']</span></em><a class="headerlink" href="#searx.plugins.self_info.SXNGPlugin.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords in the search query that activate the plugin. The <em>keyword</em> is
|
||||
the first word in a search query. If a plugin should be executed regardless
|
||||
of the search query, the list of keywords should be empty (which is also the
|
||||
default in the base class for Plugins).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.self_info.SXNGPlugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/self_info.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.self_info.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Returns a result list only for the first page.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Self-Info</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.self_info.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="hostnames.html" title="previous chapter">Hostnames</a>
|
||||
<li>Next: <a href="tor_check.html" title="next chapter">Tor check</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/self_info.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
192
dev/plugins/time_zone.html
Normal file
192
dev/plugins/time_zone.html
Normal file
@@ -0,0 +1,192 @@
|
||||
<!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>Time Zone — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Answerers" href="../answerers/index.html" />
|
||||
<link rel="prev" title="Unit Converter" href="unit_converter.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="../answerers/index.html" title="Answerers"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="unit_converter.html" title="Unit Converter"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Time Zone</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.plugins.time_zone">
|
||||
<span id="time-zone"></span><span id="time-zone-plugin"></span><h1>Time Zone<a class="headerlink" href="#module-searx.plugins.time_zone" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.time_zone.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">final</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.time_zone.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/time_zone.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.time_zone.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Plugin to display the current time at different timezones (usually the
|
||||
query city).</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.time_zone.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'time_zone'</span></em><a class="headerlink" href="#searx.plugins.time_zone.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.time_zone.SXNGPlugin.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['time',</span> <span class="pre">'timezone',</span> <span class="pre">'now',</span> <span class="pre">'clock',</span> <span class="pre">'timezones']</span></em><a class="headerlink" href="#searx.plugins.time_zone.SXNGPlugin.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords in the search query that activate the plugin. The <em>keyword</em> is
|
||||
the first word in a search query. If a plugin should be executed regardless
|
||||
of the search query, the list of keywords should be empty (which is also the
|
||||
default in the base class for Plugins).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.time_zone.SXNGPlugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/time_zone.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.time_zone.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The plugin uses the <a class="reference internal" href="../../src/searx.weather.html#searx.weather.GeoLocation" title="searx.weather.GeoLocation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.weather.GeoLocation</span></code></a> class, which
|
||||
is already implemented in the context of weather forecasts, to determine
|
||||
the time zone. The <a class="reference internal" href="../../src/searx.weather.html#searx.weather.DateTime" title="searx.weather.DateTime"><code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.weather.DateTime</span></code></a> class is used for
|
||||
the localized display of date and time.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Time Zone</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.time_zone.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="unit_converter.html" title="previous chapter">Unit Converter</a>
|
||||
<li>Next: <a href="../answerers/index.html" title="next chapter">Answerers</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/time_zone.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
201
dev/plugins/tor_check.html
Normal file
201
dev/plugins/tor_check.html
Normal file
@@ -0,0 +1,201 @@
|
||||
<!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>Tor check — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Unit Converter" href="unit_converter.html" />
|
||||
<link rel="prev" title="Self-Info" href="self_info.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="unit_converter.html" title="Unit Converter"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="self_info.html" title="Self-Info"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Tor check</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.plugins.tor_check">
|
||||
<span id="tor-check"></span><span id="tor-check-plugin"></span><h1>Tor check<a class="headerlink" href="#module-searx.plugins.tor_check" title="Link to this heading">¶</a></h1>
|
||||
<p>A plugin to check if the ip address of the request is a Tor exit-node if the
|
||||
user searches for <code class="docutils literal notranslate"><span class="pre">tor-check</span></code>. It fetches the tor exit node list from
|
||||
<a class="reference internal" href="#searx.plugins.tor_check.url_exit_list" title="searx.plugins.tor_check.url_exit_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">url_exit_list</span></code></a> and parses all the IPs into a list, then checks if the
|
||||
user’s IP address is in it.</p>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.plugins.tor_check.url_exit_list">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">url_exit_list</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://check.torproject.org/exit-addresses'</span></em><a class="headerlink" href="#searx.plugins.tor_check.url_exit_list" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>URL to load Tor exit list from.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.tor_check.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.tor_check.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/tor_check.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.tor_check.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Rewrite hostnames, remove results or prioritize them.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.tor_check.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tor_check'</span></em><a class="headerlink" href="#searx.plugins.tor_check.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.tor_check.SXNGPlugin.keywords">
|
||||
<span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['tor-check',</span> <span class="pre">'tor_check',</span> <span class="pre">'torcheck',</span> <span class="pre">'tor',</span> <span class="pre">'tor</span> <span class="pre">check']</span></em><a class="headerlink" href="#searx.plugins.tor_check.SXNGPlugin.keywords" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Keywords in the search query that activate the plugin. The <em>keyword</em> is
|
||||
the first word in a search query. If a plugin should be executed regardless
|
||||
of the search query, the list of keywords should be empty (which is also the
|
||||
default in the base class for Plugins).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.tor_check.SXNGPlugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/tor_check.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.tor_check.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs AFTER the search request. Can return a list of
|
||||
<a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> objects to be added to the
|
||||
final result list.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Tor check</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.tor_check.url_exit_list"><code class="docutils literal notranslate"><span class="pre">url_exit_list</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.tor_check.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="self_info.html" title="previous chapter">Self-Info</a>
|
||||
<li>Next: <a href="unit_converter.html" title="next chapter">Unit Converter</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/tor_check.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
189
dev/plugins/unit_converter.html
Normal file
189
dev/plugins/unit_converter.html
Normal file
@@ -0,0 +1,189 @@
|
||||
<!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>Unit Converter — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Time Zone" href="time_zone.html" />
|
||||
<link rel="prev" title="Tor check" href="tor_check.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="time_zone.html" title="Time Zone"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="tor_check.html" title="Tor check"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Unit Converter</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.plugins.unit_converter">
|
||||
<span id="unit-converter"></span><span id="unit-converter-plugin"></span><h1>Unit Converter<a class="headerlink" href="#module-searx.plugins.unit_converter" title="Link to this heading">¶</a></h1>
|
||||
<p>A plugin for converting measured values from one unit to another unit (a
|
||||
unit converter).</p>
|
||||
<p>The plugin looks up the symbols (given in the query term) in a list of
|
||||
converters, each converter is one item in the list (compare
|
||||
<code class="xref py py-obj docutils literal notranslate"><span class="pre">ADDITIONAL_UNITS</span></code>). If the symbols are ambiguous, the matching units
|
||||
of measurement are evaluated. The weighting in the evaluation results from the
|
||||
sorting of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span> <span class="pre">of</span> <span class="pre">unit</span> <span class="pre">converters</span></code>.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.plugins.unit_converter.SXNGPlugin">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.unit_converter.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/unit_converter.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.unit_converter.SXNGPlugin" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Convert between units. The result is displayed in area for the
|
||||
“answers”.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.plugins.unit_converter.SXNGPlugin.id">
|
||||
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'unit_converter'</span></em><a class="headerlink" href="#searx.plugins.unit_converter.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The ID (suffix) in the HTML form.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.plugins.unit_converter.SXNGPlugin.post_search">
|
||||
<span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/unit_converter.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.unit_converter.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Runs AFTER the search request. Can return a list of
|
||||
<a class="reference internal" href="../result_types/base_result.html#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> objects to be added to the
|
||||
final result list.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Unit Converter</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.plugins.unit_converter.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Plugins</a>
|
||||
<ul>
|
||||
<li><a href="builtins.html">Built-in Plugins</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="tor_check.html" title="previous chapter">Tor check</a>
|
||||
<li>Next: <a href="time_zone.html" title="next chapter">Time Zone</a></ul>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/plugins/unit_converter.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
220
dev/quickstart.html
Normal file
220
dev/quickstart.html
Normal file
@@ -0,0 +1,220 @@
|
||||
<!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>Development Quickstart — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Git Commits & Change Management" href="commits.html" />
|
||||
<link rel="prev" title="Developer documentation" href="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="commits.html" title="Git Commits & Change Management"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Developer documentation"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Development Quickstart</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="development-quickstart">
|
||||
<span id="devquickstart"></span><h1>Development Quickstart<a class="headerlink" href="#development-quickstart" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="makefile.html#makefile"><span class="std std-ref">Makefile & ./manage</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../admin/buildhosts.html#buildhosts"><span class="std std-ref">Buildhosts</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>SearXNG loves developers; Developers do not need to worry about tool chains, the
|
||||
usual developer tasks can be comfortably executed via <a class="reference internal" href="makefile.html#makefile"><span class="std std-ref">make</span></a>.</p>
|
||||
<p>Don’t hesitate, just clone SearXNG’s sources and start hacking right now ..</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/searxng/searxng.git<span class="w"> </span>searxng
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>For the developer environment, <a class="reference external" href="https://mise.jdx.dev/getting-started.html">mise en place</a> is recommended:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>curl<span class="w"> </span>https://mise.run<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The tools required for a developer environment are provided via <a class="reference external" href="https://github.com/searxng/searxng/blob/master/mise.toml">mise.toml</a>,
|
||||
trust the project:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mise<span class="w"> </span>trust
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Here is how a minimal workflow looks like:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><em>start</em> hacking</p></li>
|
||||
<li><p><em>run</em> your code: <a class="reference internal" href="makefile.html#make-run"><span class="std std-ref">make run</span></a></p></li>
|
||||
<li><p><em>format & test</em> your code: <a class="reference internal" href="makefile.html#make-format"><span class="std std-ref">make format</span></a> and <a class="reference internal" href="makefile.html#make-test"><span class="std std-ref">make test</span></a></p></li>
|
||||
</ol>
|
||||
<p>If you think at some point something fails, go back to <em>start</em>. Otherwise,
|
||||
choose a meaningful commit message and we are happy to receive your pull
|
||||
request. To not end in <em>wild west</em> we have some directives, please pay attention
|
||||
to our “<a class="reference internal" href="contribution_guide.html#how-to-contribute"><span class="std std-ref">How to contribute</span></a>” guideline.</p>
|
||||
<p>If you want to debug with the <em>good old Python Debugger</em> <a class="reference external" href="https://docs.python.org/3/library/pdb.html#module-pdb">pdb</a>: Alternatively to
|
||||
<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code> (2.) which starts a <a class="reference internal" href="../admin/installation-granian.html#searxng-granian"><span class="std std-ref">Granian</span></a> server you can jump
|
||||
into the developer environment and start a python based HTTP server by:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./manage dev.env
|
||||
...
|
||||
(dev.env)$ SEARXNG_DEBUG=1 python -m searx.webapp
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Since this is a pure Python solution, you can set breakpoints in your code with
|
||||
<code class="docutils literal notranslate"><span class="pre">pdb.set_trace()</span></code> and the debugger will wait for you in the terminal prompt.</p>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="makefile.html#make-nvm"><span class="std std-ref">NVM make nvm.install nvm.status</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="makefile.html#make-themes"><span class="std std-ref">make themes.*</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>If you implement themes, you will need to setup a <a class="reference internal" href="makefile.html#make-node-env"><span class="std std-ref">Node.js environment</span></a>. Before you call <em>make run</em> (2.), you need to compile the
|
||||
modified styles and JavaScript: <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">node.clean</span> <span class="pre">themes.all</span></code>. If <a class="reference external" href="https://biomejs.dev/">Biome</a>
|
||||
or <a class="reference external" href="https://stylelint.io/">Stylelint</a> reports issues, try <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">themes.fix</span></code>.</p>
|
||||
<p>Alternatively you can also compile selective the theme you have modified,
|
||||
e.g. the <em>simple</em> theme.</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>themes.simple
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>To get live builds while modifying CSS & JS use: <code class="docutils literal notranslate"><span class="pre">LIVE_THEME=simple</span> <span class="pre">make</span> <span class="pre">run</span></code></p>
|
||||
</div>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="makefile.html#make-static-build"><span class="std std-ref">make static.build.*</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p>If you finished your <em>tests</em> you can start to commit your changes. To separate
|
||||
the modified source code from the build products first run:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>static.build.restore
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This will restore the old build products and only your changes of the code
|
||||
remain in the working tree which can now be added & committed. When all sources
|
||||
are committed, you can commit the build products simply by:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>static.build.commit
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Committing the build products should be the last step, just before you send us
|
||||
your PR. There is also a make target to rewind this last build commit:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>static.build.drop
|
||||
</pre></div>
|
||||
</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="../index.html">
|
||||
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<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 current"><a class="current reference internal" href="#">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="commits.html">Git Commits & Change Management</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="extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</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="makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="index.html" title="previous chapter">Developer documentation</a>
|
||||
<li>Next: <a href="commits.html" title="next chapter">Git Commits & Change Management</a></ul>
|
||||
</li>
|
||||
</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/dev/quickstart.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
1760
dev/reST.html
Normal file
1760
dev/reST.html
Normal file
File diff suppressed because it is too large
Load Diff
400
dev/result_types/answer.html
Normal file
400
dev/result_types/answer.html
Normal file
File diff suppressed because one or more lines are too long
263
dev/result_types/base_result.html
Normal file
263
dev/result_types/base_result.html
Normal file
@@ -0,0 +1,263 @@
|
||||
<!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>Result — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Main Search Results" href="main_result.html" />
|
||||
<link rel="prev" title="Result Types" href="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="main_result.html" title="Main Search Results"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Result Types"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Result</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.result_types._base">
|
||||
<span id="result"></span><h1>Result<a class="headerlink" href="#module-searx.result_types._base" title="Link to this heading">¶</a></h1>
|
||||
<p>Basic types for the typification of results.</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> base class</p></li>
|
||||
<li><p><a class="reference internal" href="#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LegacyResult</span></code></a> for internal use only</p></li>
|
||||
</ul>
|
||||
<hr class="docutils" />
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types._base.</span></span><span class="sig-name descname"><span class="pre">Result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parsed_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult" title="(in Python v3.14)"><span class="pre">ParseResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base class of all result types <a class="reference internal" href="index.html#result-types"><span class="std std-ref">Result Types</span></a>.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result.url">
|
||||
<span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A link related to this <em>result</em></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result.engine">
|
||||
<span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.engine" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the engine <em>this</em> result comes from. In case of <em>plugins</em> a
|
||||
prefix <code class="docutils literal notranslate"><span class="pre">plugin:</span></code> is set, in case of <em>answerer</em> prefix <code class="docutils literal notranslate"><span class="pre">answerer:</span></code> is
|
||||
set.</p>
|
||||
<p>The field is optional and is initialized from the context if necessary.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result.parsed_url">
|
||||
<span class="sig-name descname"><span class="pre">parsed_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult" title="(in Python v3.14)"><span class="pre">ParseResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.parsed_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p><a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">urllib.parse.ParseResult</span></code></a> of <a class="reference internal" href="#searx.result_types._base.Result.url" title="searx.result_types._base.Result.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.url</span></code></a>.</p>
|
||||
<p>The field is optional and is initialized from the context if necessary.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result.normalize_result_fields">
|
||||
<span class="sig-name descname"><span class="pre">normalize_result_fields</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result.normalize_result_fields"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result.normalize_result_fields" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Normalize fields <code class="docutils literal notranslate"><span class="pre">url</span></code> and <code class="docutils literal notranslate"><span class="pre">parse_sql</span></code>.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If field <code class="docutils literal notranslate"><span class="pre">url</span></code> is set and field <code class="docutils literal notranslate"><span class="pre">parse_url</span></code> is unset, init
|
||||
<code class="docutils literal notranslate"><span class="pre">parse_url</span></code> from field <code class="docutils literal notranslate"><span class="pre">url</span></code>. The <code class="docutils literal notranslate"><span class="pre">url</span></code> field is initialized
|
||||
with the resulting value in <code class="docutils literal notranslate"><span class="pre">parse_url</span></code>, if <code class="docutils literal notranslate"><span class="pre">url</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">parse_url</span></code> are not equal.</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result.filter_urls">
|
||||
<span class="sig-name descname"><span class="pre">filter_urls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.14)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><span class="pre">LegacyResult</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result.filter_urls"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result.filter_urls" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A filter function is passed in the <code class="docutils literal notranslate"><span class="pre">filter_func</span></code> argument to
|
||||
filter and/or modify the URLs.</p>
|
||||
<p>The filter function receives the <a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span> <span class="pre">object</span></code></a> as
|
||||
the first argument and the field name (<code class="docutils literal notranslate"><span class="pre">str</span></code>) in the second argument.
|
||||
In the third argument the URL string value is passed to the filter function.</p>
|
||||
<p>The filter function is applied to all fields that contain a URL,
|
||||
in addition to the familiar <code class="docutils literal notranslate"><span class="pre">url</span></code> field, these include fields such as:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="s2">"url"</span><span class="p">,</span> <span class="s2">"iframe_src"</span><span class="p">,</span> <span class="s2">"audio_src"</span><span class="p">,</span> <span class="s2">"img_src"</span><span class="p">,</span> <span class="s2">"thumbnail_src"</span><span class="p">,</span> <span class="s2">"thumbnail"</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>and the <code class="docutils literal notranslate"><span class="pre">urls</span></code> list of items of the infobox.</p>
|
||||
<p>For each field, the filter function is called and returns a bool or a
|
||||
string value:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code>: leave URL in field unchanged</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code>: remove URL field from result (or remove entire result)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">str</span></code>: modified URL to be used instead</p></li>
|
||||
</ul>
|
||||
<p>See <a class="reference internal" href="../plugins/development.html#filter-urls-example"><span class="std std-ref">Filter URLs example</span></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.Result.defaults_from">
|
||||
<span class="sig-name descname"><span class="pre">defaults_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result.defaults_from"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result.defaults_from" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fields not set in <em>self</em> will be updated from the field values of the
|
||||
<em>other</em>.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class" id="legacyresult">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.LegacyResult">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types._base.</span></span><span class="sig-name descname"><span class="pre">LegacyResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#LegacyResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.LegacyResult" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>A wrapper around a legacy result item. The SearXNG core uses this class
|
||||
for untyped dictionaries / to be downward compatible.</p>
|
||||
<p>This class is needed until we have implemented an <a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> class for
|
||||
each result type and the old usages in the codebase have been fully
|
||||
migrated.</p>
|
||||
<p>There is only one place where this class is used, in the
|
||||
<code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.results.ResultContainer</span></code>.</p>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>Do not use this class in your own implementations!</p>
|
||||
</div>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="searx.result_types._base.LegacyResult.filter_urls">
|
||||
<span class="sig-name descname"><span class="pre">filter_urls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.14)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><span class="pre">LegacyResult</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#LegacyResult.filter_urls"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.LegacyResult.filter_urls" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>See <a class="reference internal" href="#searx.result_types._base.Result.filter_urls" title="searx.result_types._base.Result.filter_urls"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.filter_urls</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Result</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.result_types._base.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.url"><code class="docutils literal notranslate"><span class="pre">Result.url</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.engine"><code class="docutils literal notranslate"><span class="pre">Result.engine</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.parsed_url"><code class="docutils literal notranslate"><span class="pre">Result.parsed_url</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.normalize_result_fields"><code class="docutils literal notranslate"><span class="pre">Result.normalize_result_fields()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.filter_urls"><code class="docutils literal notranslate"><span class="pre">Result.filter_urls()</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.defaults_from"><code class="docutils literal notranslate"><span class="pre">Result.defaults_from()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.result_types._base.LegacyResult"><code class="docutils literal notranslate"><span class="pre">LegacyResult</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.LegacyResult.filter_urls"><code class="docutils literal notranslate"><span class="pre">LegacyResult.filter_urls()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Result Types</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">Result Types</a>
|
||||
<li>Next: <a href="main_result.html" title="next chapter">Main Search Results</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/result_types/base_result.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
171
dev/result_types/correction.html
Normal file
171
dev/result_types/correction.html
Normal file
@@ -0,0 +1,171 @@
|
||||
<!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>Correction Results — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Suggestion Results" href="suggestion.html" />
|
||||
<link rel="prev" title="Answer Results" href="answer.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="suggestion.html" title="Suggestion Results"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="answer.html" title="Answer Results"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Correction Results</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="correction-results">
|
||||
<span id="result-types-corrections"></span><h1>Correction Results<a class="headerlink" href="#correction-results" title="Link to this heading">¶</a></h1>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>There is still no typing for these result items. The templates can be used as
|
||||
orientation until the final typing is complete.</p>
|
||||
</div>
|
||||
<p>The <a class="reference internal" href="index.html#area-corrections-results"><span class="std std-ref">area corrections</span></a> shows the user alternative search terms.</p>
|
||||
<p>A result of this type is a very simple dictionary with only one key/value pair</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">"correction"</span> <span class="p">:</span> <span class="s2">"lorem ipsum .."</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>From this simple dict another dict is build up:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># use RawTextQuery to get the corrections URLs with the same bang</span>
|
||||
<span class="p">{</span><span class="s2">"url"</span> <span class="p">:</span> <span class="s2">"!bang lorem ipsum .."</span><span class="p">,</span> <span class="s2">"title"</span><span class="p">:</span> <span class="s2">"lorem ipsum .."</span> <span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>and used in the template <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/elements/corrections.html">corrections.html</a>:</p>
|
||||
<dl>
|
||||
<dt>title<span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Corrected search term.</p>
|
||||
</dd>
|
||||
<dt>url<span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Not really an URL, its the value to insert in a HTML form for a SearXNG query.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Result Types</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="answer.html" title="previous chapter">Answer Results</a>
|
||||
<li>Next: <a href="suggestion.html" title="next chapter">Suggestion Results</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/result_types/correction.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
247
dev/result_types/index.html
Normal file
247
dev/result_types/index.html
Normal file
@@ -0,0 +1,247 @@
|
||||
<!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>Result Types — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Result" href="base_result.html" />
|
||||
<link rel="prev" title="Tineye" href="../engines/online_url_search/tineye.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="base_result.html" title="Result"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../engines/online_url_search/tineye.html" title="Tineye"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</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="">Result Types</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="result-types">
|
||||
<span id="id1"></span><h1>Result Types<a class="headerlink" href="#result-types" title="Link to this heading">¶</a></h1>
|
||||
<p>To understand the typification of the results, let’s take a brief look at the
|
||||
structure of SearXNG .. At its core, SearXNG is nothing more than an aggregator
|
||||
that aggregates the results from various sources, renders them via templates and
|
||||
displays them to the user.</p>
|
||||
<p>The <strong>sources</strong> can be:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p><a class="reference internal" href="../engines/index.html#engine-implementations"><span class="std std-ref">engines</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../plugins/development.html#dev-plugin"><span class="std std-ref">plugins</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../answerers/development.html#dev-answerers"><span class="std std-ref">answerers</span></a></p></li>
|
||||
</ol>
|
||||
<p>The sources provide the results, which are displayed in different <strong>areas</strong>
|
||||
depending on the type of result. The areas are:</p>
|
||||
<dl class="simple" id="area-main-results">
|
||||
<dt><a class="reference internal" href="main_result.html#main-search-results"><span class="std std-ref">area main results</span></a></dt><dd><p>It is the main area in which – as is typical for search engines – the
|
||||
results that a search engine has found for the search term are displayed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple" id="area-answer-results">
|
||||
<dt><a class="reference internal" href="answer.html#result-types-answer"><span class="std std-ref">area answers</span></a></dt><dd><p>This area displays short answers that could be found for the search term.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple" id="area-info-box">
|
||||
<dt><a class="reference internal" href="infobox.html#result-types-infobox"><span class="std std-ref">area info box</span></a></dt><dd><p>An area in which additional information can be displayed, e.g. excerpts from
|
||||
wikipedia or other sources such as maps.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple" id="area-suggestions-results">
|
||||
<dt><a class="reference internal" href="suggestion.html#result-types-suggestion"><span class="std std-ref">area suggestions</span></a></dt><dd><p>Suggestions for alternative search terms can be found in this area. These can
|
||||
be clicked on and a search is carried out with these search terms.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple" id="area-corrections-results">
|
||||
<dt><a class="reference internal" href="correction.html#result-types-corrections"><span class="std std-ref">area corrections</span></a></dt><dd><p>Results in this area are like the suggestion of alternative search terms,
|
||||
which usually result from spelling corrections</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>At this point it is important to note that all <strong>sources</strong> can contribute
|
||||
results to all of the areas mentioned above.</p>
|
||||
<p>In most cases, however, the <a class="reference internal" href="../engines/index.html#engine-implementations"><span class="std std-ref">engines</span></a> will fill
|
||||
the <em>main results</em> and the <a class="reference internal" href="../answerers/development.html#dev-answerers"><span class="std std-ref">answerers</span></a> will generally
|
||||
provide the contributions for the <em>answer</em> area. Not necessary to mention here
|
||||
but for a better understanding: the plugins can also filter out or change
|
||||
results from the main results area (e.g. the URL of the link).</p>
|
||||
<p>The result items are organized in the <code class="xref py py-obj docutils literal notranslate"><span class="pre">results.ResultContainer</span></code> and
|
||||
after all sources have delivered their results, this container is passed to the
|
||||
templating to build a HTML output. The output is usually HTML, but it is also
|
||||
possible to output the result lists as JSON or RSS feed. Thats quite all we need
|
||||
to know before we dive into typification of result items.</p>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>Typification of result items: we are at the very first beginng!</p>
|
||||
</div>
|
||||
<p>The first thing we have to realize is that there is no typification of the
|
||||
result items so far, we have to build it up first .. and that is quite a big
|
||||
task, which we will only be able to accomplish gradually.</p>
|
||||
<p>The foundation for the typeless results was laid back in 2013 in the very first
|
||||
commit <a class="reference external" href="https://github.com/searxng/searxng/commit/ae9fb1d7d">@ae9fb1d</a>, and the principle has not changed since then. At
|
||||
the time, the approach was perfectly adequate, but we have since evolved and the
|
||||
demands on SearXNG increase with every feature request.</p>
|
||||
<p><strong>Motivation:</strong> in the meantime, it has become very difficult to develop new
|
||||
features that require structural changes and it is especially hard for newcomers
|
||||
to find their way in this typeless world. As long as the results are only
|
||||
simple key/value dictionaries, it is not even possible for the IDEs to support
|
||||
the application developer in his work.</p>
|
||||
<p><strong>Planning:</strong> The procedure for subsequent typing will have to be based on the
|
||||
circumstances ..</p>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>As long as there is no type defined for a kind of result the HTML template
|
||||
specify what the properties of a type are.</p>
|
||||
<p>In this sense, you will either find a type definition here in the
|
||||
documentation or, if this does not yet exist, a description of the HTML
|
||||
template.</p>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="base_result.html">Result</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="base_result.html#searx.result_types._base.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="base_result.html#searx.result_types._base.LegacyResult"><code class="docutils literal notranslate"><span class="pre">LegacyResult</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="main_result.html">Main Search Results</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="answer.html">Answer Results</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.BaseAnswer"><code class="docutils literal notranslate"><span class="pre">BaseAnswer</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.Answer"><code class="docutils literal notranslate"><span class="pre">Answer</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.Translations"><code class="docutils literal notranslate"><span class="pre">Translations</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.WeatherAnswer"><code class="docutils literal notranslate"><span class="pre">WeatherAnswer</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.AnswerSet"><code class="docutils literal notranslate"><span class="pre">AnswerSet</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="infobox.html">Infobox Results</a></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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Result Types</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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="../engines/online_url_search/tineye.html" title="previous chapter">Tineye</a>
|
||||
<li>Next: <a href="base_result.html" title="next chapter">Result</a></ul>
|
||||
</li>
|
||||
</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/dev/result_types/index.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
199
dev/result_types/infobox.html
Normal file
199
dev/result_types/infobox.html
Normal file
@@ -0,0 +1,199 @@
|
||||
<!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>Infobox Results — SearXNG Documentation (2025.11.15+45a4b8ad1)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=907fd233"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.15+45a4b8ad1" 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="Simple Theme Templates" href="../templates.html" />
|
||||
<link rel="prev" title="Suggestion Results" href="suggestion.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="../templates.html" title="Simple Theme Templates"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="suggestion.html" title="Suggestion Results"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.15+45a4b8ad1)</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Infobox Results</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="infobox-results">
|
||||
<span id="result-types-infobox"></span><h1>Infobox Results<a class="headerlink" href="#infobox-results" title="Link to this heading">¶</a></h1>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>There is still no typing for these result items. The templates can be used as
|
||||
orientation until the final typing is complete.</p>
|
||||
</div>
|
||||
<p>The <a class="reference internal" href="index.html#area-info-box"><span class="std std-ref">area info box</span></a> is an area where addtional infos shown to the user.</p>
|
||||
<p>Fields used in the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/elements/infobox.html">infobox.html</a>:</p>
|
||||
<dl class="simple">
|
||||
<dt>img_src: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd><p>URL of a image or thumbnail that is displayed in the infobox.</p>
|
||||
</dd>
|
||||
<dt>infobox: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd><p>Title of the info box.</p>
|
||||
</dd>
|
||||
<dt>content: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd><p>Text of the info box.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The infobox has additional subsections for <em>attributes</em>, <em>urls</em> and
|
||||
<em>relatedTopics</em>:</p>
|
||||
<dl>
|
||||
<dt>attributes: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</dt><dd><p>A list of attributes. An <em>attribute</em> is a dictionary with keys:</p>
|
||||
<ul>
|
||||
<li><p>label <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: (mandatory)</p></li>
|
||||
<li><p>value <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: (mandatory)</p></li>
|
||||
<li><p>image <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>] (optional)</p>
|
||||
<p>A list of images. An <em>image</em> is a dictionary with keys:</p>
|
||||
<ul class="simple">
|
||||
<li><p>src <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: URL of an image/thumbnail (mandatory)</p></li>
|
||||
<li><p>alt <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: alternative text for the image (mandatory)</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>urls: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</dt><dd><p>A list of links. An <em>link</em> is a dictionary with keys:</p>
|
||||
<ul class="simple">
|
||||
<li><p>url <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: URL of the link (mandatory)</p></li>
|
||||
<li><p>title <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: Title of the link (mandatory)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>relatedTopics: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</dt><dd><p>A list of topics. An <em>topic</em> is a dictionary with keys:</p>
|
||||
<ul>
|
||||
<li><p>name: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: (mandatory)</p></li>
|
||||
<li><p>suggestions: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>] (optional)</p>
|
||||
<p>A list of suggestions. A <em>suggestion</em> is simple dictionary with just one
|
||||
key/value pair:</p>
|
||||
<ul class="simple">
|
||||
<li><p>suggestion: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: suggested search term (mandatory)</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</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="../../index.html">
|
||||
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
||||
</a></p>
|
||||
|
||||
|
||||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||||
<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="../commits.html">Git Commits & Change Management</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="../extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</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/index.html">Plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</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="../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></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>
|
||||
</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><a href="index.html">Result Types</a>
|
||||
<ul>
|
||||
<li>Previous: <a href="suggestion.html" title="previous chapter">Suggestion Results</a>
|
||||
<li>Next: <a href="../templates.html" title="next chapter">Simple Theme Templates</a></ul>
|
||||
</li></ul>
|
||||
</li>
|
||||
</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/dev/result_types/infobox.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright SearXNG team.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user