mirror of
https://github.com/searxng/searxng.git
synced 2026-07-23 08:21:24 +00:00
[doc] build from commit d3566fe8a8
This commit is contained in:
return42
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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'x86_64'</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
303
dev/engines/online/annas_archive.html
Normal file
303
dev/engines/online/annas_archive.html
Normal file
@@ -0,0 +1,303 @@
|
||||
<!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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="AOL" href="aol.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="aol.html" title="AOL"
|
||||
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 (2026.5.5+d3566fe8a)</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.gl/">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://software.annas-archive.gl/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.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.annas_archive.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></span><a class="headerlink" href="#searx.engines.annas_archive.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>List of Anna’s archive domains or a single domain (as string).</p>
|
||||
</dd></dl>
|
||||
|
||||
<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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span class="p">,</span> <span class="n">newest_added</span><span class="p">,</span> <span class="n">oldest_added</span><span class="p">,</span> <span class="n">random</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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> <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/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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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="aol.html" title="next chapter">AOL</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>
|
||||
238
dev/engines/online/aol.html
Normal file
238
dev/engines/online/aol.html
Normal file
@@ -0,0 +1,238 @@
|
||||
<!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>AOL — SearXNG Documentation (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="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="archlinux.html" title="Arch Linux"
|
||||
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 (2026.5.5+d3566fe8a)</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="">AOL</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.aol">
|
||||
<span id="aol"></span><span id="aol-engine"></span><h1>AOL<a class="headerlink" href="#module-searx.engines.aol" title="Link to this heading">¶</a></h1>
|
||||
<p>AOL supports WEB, image, and video search. Internally, it uses the Bing
|
||||
index.</p>
|
||||
<p>AOL doesn’t seem to support setting the language via request parameters, instead
|
||||
the results are based on the URL. For example, there is</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://search.aol.com">search.aol.com</a> for English results</p></li>
|
||||
<li><p><a class="reference external" href="https://suche.aol.de">suche.aol.de</a> for German results</p></li>
|
||||
</ul>
|
||||
<p>However, AOL offers its services only in a few regions:</p>
|
||||
<ul class="simple">
|
||||
<li><p>en-US: search.aol.com</p></li>
|
||||
<li><p>de-DE: suche.aol.de</p></li>
|
||||
<li><p>fr-FR: recherche.aol.fr</p></li>
|
||||
<li><p>en-GB: search.aol.co.uk</p></li>
|
||||
<li><p>en-CA: search.aol.ca</p></li>
|
||||
</ul>
|
||||
<p>In order to still offer sufficient support for language and region, the <a class="reference external" href="https://support.microsoft.com/en-us/topic/advanced-search-keywords-ea595928-5d63-4a0b-9c6b-0b769865e78a">search
|
||||
keywords</a> known from Bing, <code class="docutils literal notranslate"><span class="pre">language</span></code> and <code class="docutils literal notranslate"><span class="pre">loc</span></code> (region), are added to the
|
||||
search term (AOL is basically just a proxy for Bing).</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 current"><a class="current reference internal" href="#">AOL</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="karmasearch.html">Karmasearch</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="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="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="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/aol.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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="AOL" href="aol.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="aol.html" title="AOL"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2026.5.5+d3566fe8a)</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"><a class="reference internal" href="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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="aol.html" title="previous chapter">AOL</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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'unset'</span></span><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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5000</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
387
dev/engines/online/bing.html
Normal file
387
dev/engines/online/bing.html
Normal file
@@ -0,0 +1,387 @@
|
||||
<!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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Some functionality (paging and time-range results) are not supported
|
||||
since they depend on JavaScript.</p>
|
||||
</div>
|
||||
<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><span 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></span><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.get_locale_params">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">get_locale_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_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 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#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="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/bing.html#get_locale_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing.get_locale_params" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>API documentation states the <code class="docutils literal notranslate"><span class="pre">mkt</span></code> parameter is <em>the
|
||||
recommended primary signal</em> for locale:</p>
|
||||
<blockquote>
|
||||
<div><p>If known, you are encouraged to always specify the market.
|
||||
Specifying the market helps Bing route the request and return an
|
||||
appropriate and optimal response.</p>
|
||||
</div></blockquote>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">mkt</span></code> parameter takes a full <code class="docutils literal notranslate"><span class="pre"><language>-<country></span></code> code.</p>
|
||||
<p>This function is shared with <a class="reference internal" href="#module-searx.engines.bing_images" title="searx.engines.bing_images"><code class="xref py py-mod docutils literal notranslate"><span class="pre">searx.engines.bing_images</span></code></a>,
|
||||
<a class="reference internal" href="#module-searx.engines.bing_news" title="searx.engines.bing_news"><code class="xref py py-mod docutils literal notranslate"><span class="pre">searx.engines.bing_news</span></code></a>, and <a class="reference internal" href="#module-searx.engines.bing_videos" title="searx.engines.bing_videos"><code class="xref py py-mod docutils literal notranslate"><span class="pre">searx.engines.bing_videos</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.bing.override_accept_language">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</span></span><span class="sig-name descname"><span class="pre">override_accept_language</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">engine_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 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/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/bing.html#override_accept_language"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing.override_accept_language" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Override the <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header.</p>
|
||||
<p>The default header built by <a class="reference internal" href="../../../src/searx.search.processors.html#searx.search.processors.online.OnlineProcessor" title="searx.search.processors.online.OnlineProcessor"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnlineProcessor</span></code></a>
|
||||
appends <code class="docutils literal notranslate"><span class="pre">en;q=0.3</span></code> as a fallback language:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Accept</span><span class="o">-</span><span class="n">Language</span><span class="p">:</span> <span class="n">de</span><span class="p">,</span><span class="n">de</span><span class="o">-</span><span class="n">DE</span><span class="p">;</span><span class="n">q</span><span class="o">=</span><span class="mf">0.7</span><span class="p">,</span><span class="n">en</span><span class="p">;</span><span class="n">q</span><span class="o">=</span><span class="mf">0.3</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Bing seems to better select the results locale based on the
|
||||
<code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> value header.</p>
|
||||
<p>This function is shared with <a class="reference internal" href="#module-searx.engines.bing_images" title="searx.engines.bing_images"><code class="xref py py-mod docutils literal notranslate"><span class="pre">searx.engines.bing_images</span></code></a>,
|
||||
<a class="reference internal" href="#module-searx.engines.bing_news" title="searx.engines.bing_news"><code class="xref py py-mod docutils literal notranslate"><span class="pre">searx.engines.bing_news</span></code></a>, and <a class="reference internal" href="#module-searx.engines.bing_videos" title="searx.engines.bing_videos"><code class="xref py py-mod docutils literal notranslate"><span class="pre">searx.engines.bing_videos</span></code></a>.</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><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 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></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.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.bing.</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/bing.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.bing.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Get response from Bing-Web</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> <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/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 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><span 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></span><a class="headerlink" href="#searx.engines.bing_images.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing-Image 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-Image</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><span 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></span><a class="headerlink" href="#searx.engines.bing_videos.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Bing-Video 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></span><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><span 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></span><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><span 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></span><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>Parse the Bing-News response.</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
456
dev/engines/online/brave.html
Normal file
456
dev/engines/online/brave.html
Normal file
@@ -0,0 +1,456 @@
|
||||
<!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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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">
|
||||
<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="#module-searx.engines.brave" id="id3">Brave Standard Engine</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#brave-regions" id="id4">Brave regions</a></p></li>
|
||||
<li><p><a class="reference internal" href="#brave-goggles" id="id5">Brave Goggles</a></p></li>
|
||||
<li><p><a class="reference internal" href="#brave-languages" id="id6">Brave languages</a></p></li>
|
||||
<li><p><a class="reference internal" href="#implementations" id="id7">Implementations</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#module-searx.engines.braveapi" id="id8">Brave API Engine</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#configuration" id="id9">Configuration</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p>Brave offers two different engines for SearXNG:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>The standard engine (<code class="docutils literal notranslate"><span class="pre">brave</span></code>) uses the web interface.</p></li>
|
||||
<li><p>The API engine (<code class="docutils literal notranslate"><span class="pre">braveapi</span></code>) uses the official REST API.</p></li>
|
||||
</ol>
|
||||
<section id="module-searx.engines.brave">
|
||||
<span id="brave-standard-engine"></span><span id="brave-engine"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Brave Standard Engine</a><a class="headerlink" href="#module-searx.engines.brave" title="Link to this heading">¶</a></h2>
|
||||
<p>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><h3><a class="toc-backref" href="#id4" role="doc-backlink">Brave regions</a><a class="headerlink" href="#brave-regions" title="Link to this heading">¶</a></h3>
|
||||
<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><h3><a class="toc-backref" href="#id5" role="doc-backlink">Brave Goggles</a><a class="headerlink" href="#brave-goggles" title="Link to this heading">¶</a></h3>
|
||||
<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><h3><a class="toc-backref" href="#id6" role="doc-backlink">Brave languages</a><a class="headerlink" href="#brave-languages" title="Link to this heading">¶</a></h3>
|
||||
<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">
|
||||
<h3><a class="toc-backref" href="#id7" 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.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><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'search'</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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>
|
||||
<section id="module-searx.engines.braveapi">
|
||||
<span id="brave-api-engine"></span><span id="braveapi-engine"></span><h2><a class="toc-backref" href="#id8" role="doc-backlink">Brave API Engine</a><a class="headerlink" href="#module-searx.engines.braveapi" title="Link to this heading">¶</a></h2>
|
||||
<p>Engine to search using the Brave (WEB) Search API.</p>
|
||||
<section id="configuration">
|
||||
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h3>
|
||||
<p>The engine has the following mandatory setting:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.braveapi.api_key" title="searx.engines.braveapi.api_key"><code class="xref py py-obj docutils literal notranslate"><span class="pre">api_key</span></code></a></p></li>
|
||||
</ul>
|
||||
<p>Optional settings are:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.braveapi.results_per_page" title="searx.engines.braveapi.results_per_page"><code class="xref py py-obj docutils literal notranslate"><span class="pre">results_per_page</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">braveapi</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">braveapi</span>
|
||||
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="s">'YOUR-API-KEY'</span><span class="w"> </span><span class="c1"># required</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="c1"># optional</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The API supports paging and time filters.</p>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.braveapi.api_key">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</span></span><span class="sig-name descname"><span class="pre">api_key</span></span><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><a class="headerlink" href="#searx.engines.braveapi.api_key" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>API key for Brave Search API (required).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.braveapi.results_per_page">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</span></span><span class="sig-name descname"><span class="pre">results_per_page</span></span><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">20</span></span><a class="headerlink" href="#searx.engines.braveapi.results_per_page" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Maximum number of results per page (default 20).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.braveapi.base_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://api.search.brave.com/res/v1/web/search'</span></span><a class="headerlink" href="#searx.engines.braveapi.base_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Base URL for the Brave Search API.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.braveapi.time_range_map">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</span></span><span class="sig-name descname"><span class="pre">time_range_map</span></span><span 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">'past_day',</span> <span class="pre">'month':</span> <span class="pre">'past_month',</span> <span class="pre">'week':</span> <span class="pre">'past_week',</span> <span class="pre">'year':</span> <span class="pre">'past_year'}</span></span><a class="headerlink" href="#searx.engines.braveapi.time_range_map" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Mapping of SearXNG time ranges to Brave API time ranges.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.braveapi.init">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</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">_</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/braveapi.html#init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.braveapi.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.braveapi.request">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</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/braveapi.html#request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.braveapi.request" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Create the API request.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.braveapi.response">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.braveapi.</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/braveapi.html#response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.braveapi.response" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Process the API response and return results.</p>
|
||||
</dd></dl>
|
||||
|
||||
<p>The API engine requires an API key from Brave. This can be obtained from the
|
||||
<a class="reference external" href="https://api-dashboard.search.brave.com/">API Dashboard</a>.</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 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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'relevance'</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'news'</span></span><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><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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><span 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></span><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><span 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></span><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><span 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></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/search.json'</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'likes'</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
478
dev/engines/online/duckduckgo.html
Normal file
478
dev/engines/online/duckduckgo.html
Normal file
@@ -0,0 +1,478 @@
|
||||
<!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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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>
|
||||
<p>DDG’s WEB search:</p>
|
||||
<ul class="simple">
|
||||
<li><p>DuckDuckGo WEB : <code class="docutils literal notranslate"><span class="pre">https://links.duckduckgo.com/d.js?q=..</span></code> (HTTP GET)</p></li>
|
||||
<li><p>DuckDuckGo WEB no-AI: <code class="docutils literal notranslate"><span class="pre">https://noai.duckduckgo.com/</span></code> (HTTP GET)</p></li>
|
||||
<li><p>DuckDuckGo WEB html : <code class="docutils literal notranslate"><span class="pre">https://html.duckduckgo.com/html</span></code> (HTTP POST no-JS / form data)</p></li>
|
||||
<li><p>DuckDuckGo WEB lite : <code class="docutils literal notranslate"><span class="pre">https://lite.duckduckgo.com/lite</span></code> (HTTP POST no-JS / form data)</p></li>
|
||||
</ul>
|
||||
<p>DDG’s content search / see engine <code class="docutils literal notranslate"><span class="pre">duckduckgo_extra.py</span></code></p>
|
||||
<ul class="simple">
|
||||
<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>
|
||||
<div class="admonition hint">
|
||||
<p class="admonition-title">Hint</p>
|
||||
<p>For WEB searches and to determine the <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value, DDG-html (no-JS) is
|
||||
used.</p>
|
||||
</div>
|
||||
<p>Special features of the no-JS services (DDG-lite & DDG-html):</p>
|
||||
<ul class="simple">
|
||||
<li><p>The no-JS clients receive a form that contains all the controlling parameters.</p></li>
|
||||
<li><p>When the form data is submitted, a real WEB browser sets the HTTP <em>Sec-Fetch</em>
|
||||
headers.</p></li>
|
||||
</ul>
|
||||
<p>HTML <code class="docutils literal notranslate"><span class="pre"><form></span></code>, HTTP-Headers & DDG’s bot Blocker:</p>
|
||||
<blockquote>
|
||||
<div><p>The HTTP <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent">User-Agent</a> (see below) is generated by the WEB-client and are
|
||||
checked by DDG’s bot blocker.</p>
|
||||
</div></blockquote>
|
||||
<p>To simulate the behavior of a real browser session, it might be necessary to
|
||||
evaluate additional headers. For example, in the response from DDG, the
|
||||
<a class="reference external" href="https://developer.mozilla.org/docs/Web/HTTP/Reference/Headers/Referrer-Policy#directives">Referrer-Policy</a> is always set to <code class="docutils literal notranslate"><span class="pre">origin</span></code>. A real browser would then include
|
||||
the following header in the next request:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Referer</span><span class="p">:</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">html</span><span class="o">.</span><span class="n">duckduckgo</span><span class="o">.</span><span class="n">com</span><span class="o">/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The fields of the html-form are reverse-engineered from DDG-html and may be
|
||||
subject to additional bot detection mechanisms and breaking changes in the
|
||||
future.</p>
|
||||
<p>Query field:</p>
|
||||
<p>Intro page: <a class="reference external" href="https://html.duckduckgo.com/html/">https://html.duckduckgo.com/html/</a></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">q</span></code> (str): Search query string</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">b</span></code> (str): Beginning parameter - empty string for first page requests. If a
|
||||
second page is requested, this field is not set!</p></li>
|
||||
</ul>
|
||||
<p>Search options:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">kl</span></code> (str): Keyboard language/region code (e.g. ‘en-us’ default: ‘wt-wt’)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">df</span></code> (str): Time filter, maps to values like ‘d’ (day), ‘w’ (week), ‘m’ (month), ‘y’ (year)</p></li>
|
||||
</ul>
|
||||
<p>The key/value pairs <code class="docutils literal notranslate"><span class="pre">df</span></code> and <code class="docutils literal notranslate"><span class="pre">kl</span></code> are additional saved in the cookies,
|
||||
example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Cookie</span><span class="p">:</span> <span class="n">kl</span><span class="o">=</span><span class="n">en</span><span class="o">-</span><span class="n">us</span><span class="p">;</span> <span class="n">df</span><span class="o">=</span><span class="n">m</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><em>next page</em> form fields:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">nextParams</span></code> (str): Continuation parameters from previous page response,
|
||||
typically empty string. Opposite of <code class="docutils literal notranslate"><span class="pre">b</span></code>; this field is not set when
|
||||
requesting the first result page.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">api</span></code> (str): API endpoint identifier, typically ‘d.js’</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">o</span></code> (str): Output format, typically <code class="docutils literal notranslate"><span class="pre">json</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">v</span></code> (str): Typically <code class="docutils literal notranslate"><span class="pre">l</span></code> for subsequent pages</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">dc</span></code> (int): Display count - value equal to offset (s) + 1</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">s</span></code> (int): Search offset for pagination</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">vqd</span></code> (str): Validation query digest</p></li>
|
||||
</ul>
|
||||
<p>General assumptions regarding DDG’s bot blocker:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Except <code class="docutils literal notranslate"><span class="pre">Cookie:</span> <span class="pre">kl=..;</span> <span class="pre">df=..</span></code> DDG does not use cookies in any of its
|
||||
services.</p></li>
|
||||
<li><p>DDG does not accept queries with more than 499 chars</p></li>
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value (“Validation query digest”) is needed to pass DDG’s bot
|
||||
protection and is used by all request to DDG.</p></li>
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">vqd</span></code> value is generally not needed for the first query (intro); it is
|
||||
only required when additional pages are accessed (or when new content needs to
|
||||
be loaded for the query while scrolling).</p></li>
|
||||
<li><p>The second page (additional content) for a query cannot be requested without
|
||||
<code class="docutils literal notranslate"><span class="pre">vqd</span></code>, as this would lead to an immediate blocking, since such a use-case
|
||||
does not exist in the process flows provided by DDG (and is a clear indication
|
||||
of a bot).</p></li>
|
||||
</ul>
|
||||
<p>The following HTTP headers are being evaluated (and may possibly be responsible
|
||||
for issues):</p>
|
||||
<dl class="simple">
|
||||
<dt><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent">User-Agent</a>:</dt><dd><p>The HTTP User-Agent is also involved in the formation of the vqd value, read
|
||||
<a class="reference external" href="https://github.com/ggfevans/searxng/blob/mod-sidecar-harvester/docs/ddg-bot-detection-research.md">DuckDuckGo Bot Detection Research & Solution</a>. However, it is not checked
|
||||
whether the UA is a known header. However, it is possible that certain UA
|
||||
headers (such as curl) are filtered.</p>
|
||||
</dd>
|
||||
<dt><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Sec-Fetch-Mode>">Sec-Fetch-Mode</a>:</dt><dd><p>In the past, Sec-Fetch-Mode had to be set to ‘navigate’, otherwise there were
|
||||
problems with the bot blocker.. I don’t know if DDG still evaluates this
|
||||
header today</p>
|
||||
</dd>
|
||||
<dt><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language">Accept-Language</a>:</dt><dd><p>DDG-Lite and DDG-HTML TRY 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>
|
||||
<p>In DDG’s bot blocker, the IP will be blocked (DDG does not have a client session!)</p>
|
||||
<ul>
|
||||
<li><p>As far as is known, it is possible to remove a un-blocked an IP by executing a
|
||||
DDG query in a real web browser over the blocked IP (at least that’s my
|
||||
assumption).</p>
|
||||
<p>How exactly the blocking mechanism currently works is not fully known, and
|
||||
there were also changes to the bot blocker in the period of Q3/Q4 2025: in the
|
||||
past, the IP blocking was implemented as a ‘sliding window’ (unblock after
|
||||
about 1 hour without requests from this IP)</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Terms / phrases that you keep coming across:</p>
|
||||
<ul>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">d.js</span></code>, <code class="docutils literal notranslate"><span class="pre">i.js</span></code>, <code class="docutils literal notranslate"><span class="pre">v.js</span></code>, <code class="docutils literal notranslate"><span class="pre">news.js</span></code> are the endpoints of the DDG’s web
|
||||
API through which additional content for a query can be requested (vqd
|
||||
required)</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">*.js</span></code> endpoints return a JSON response and can therefore only be
|
||||
executed on a JS-capable client.</p>
|
||||
<p>The service at <a class="reference external" href="https://lite.duckduckgo.com/lite">https://lite.duckduckgo.com/lite</a> offers general WEB searches
|
||||
(no news, videos etc). DDG-lite and DDG-html can be used by clients that do
|
||||
not support JS, aka <em>no-JS</em>.</p>
|
||||
<p>DDG-lite works a bit differently: here, <code class="docutils literal notranslate"><span class="pre">d.js</span></code> is not an endpoint but a
|
||||
field (<code class="docutils literal notranslate"><span class="pre">api=d.js</span></code>) in a form that is sent to DDG-lite.</p>
|
||||
</li>
|
||||
<li><p>The request argument <code class="docutils literal notranslate"><span class="pre">origin=funnel_home_website</span></code> is often seen in the DDG
|
||||
services when the category is changed (e.g., from web search to news, images,
|
||||
or to the video category)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.safesearch">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">safesearch</span></span><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></span><a class="headerlink" href="#searx.engines.duckduckgo.safesearch" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>DDG-lite: user can’t select but the results are filtered.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.ddg_url">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">ddg_url</span></span><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://html.duckduckgo.com/html/'</span></span><a class="headerlink" href="#searx.engines.duckduckgo.ddg_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The process flow for determining the <code class="docutils literal notranslate"><span class="pre">vqd</span></code> values was implemented for the
|
||||
no-JS variant (DDG-html)</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">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#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> value that fits to the <em>query</em> (and HTTP <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent">User-Agent</a>
|
||||
header).</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>params</strong> – request parameters</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</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><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/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</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">'en_US'</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 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/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>
|
||||
<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.</p>
|
||||
</div>
|
||||
<p>DDG defines its languages by a region code (<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>). 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>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.duckduckgo.quote_ddg_bangs">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.duckduckgo.</span></span><span class="sig-name descname"><span class="pre">quote_ddg_bangs</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#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></span><a class="reference internal" href="../../../_modules/searx/engines/duckduckgo.html#quote_ddg_bangs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.duckduckgo.quote_ddg_bangs" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>To avoid a redirect, the !bang directives in the query string are
|
||||
quoted.</p>
|
||||
</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><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.1.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.1.0)"><span class="pre">_Element</span></a></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 “All 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><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/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><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><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_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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'updated'</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'desc'</span></span><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><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></span><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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></span><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.1.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.1.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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="Karmasearch" href="karmasearch.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="karmasearch.html" title="Karmasearch"
|
||||
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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'models'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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="karmasearch.html" title="next chapter">Karmasearch</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>
|
||||
231
dev/engines/online/karmasearch.html
Normal file
231
dev/engines/online/karmasearch.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>Karmasearch — SearXNG Documentation (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="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="lemmy.html" title="Lemmy"
|
||||
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 (2026.5.5+d3566fe8a)</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="">Karmasearch</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-searx.engines.karmasearch">
|
||||
<span id="karmasearch"></span><span id="karmasearch-engine"></span><h1>Karmasearch<a class="headerlink" href="#module-searx.engines.karmasearch" title="Link to this heading">¶</a></h1>
|
||||
<p>Karmasearch uses Brave’s index, so the results should be the same as Brave’s.</p>
|
||||
<p>However, the advantages of this engine are:</p>
|
||||
<ul class="simple">
|
||||
<li><p>it has less strict rate-limits</p></li>
|
||||
<li><p>it has a JSON API, so it’s less likely to break</p></li>
|
||||
</ul>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.karmasearch.fetch_traits">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.karmasearch.</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/karmasearch.html#fetch_traits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.karmasearch.fetch_traits" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Fetch <a class="reference internal" href="brave.html#brave-languages"><span class="std std-ref">languages</span></a> and <a class="reference internal" href="brave.html#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="aol.html">AOL</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="#">Karmasearch</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="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="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="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/karmasearch.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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="Karmasearch" href="karmasearch.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="karmasearch.html" title="Karmasearch"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2026.5.5+d3566fe8a)</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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Communities'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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="karmasearch.html" title="previous chapter">Karmasearch</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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><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">
|
||||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><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">
|
||||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="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="mwmbl.html" title="Mwmbl Engine"
|
||||
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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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="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/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>
|
||||
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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="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="odysee.html" title="Odysee"
|
||||
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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="#">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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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_plugins.html#settings-plugins"><span class="std std-ref">infinite_scroll</span></a> plugin 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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></span><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><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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.</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'search'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><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><span 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></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="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="semantic_scholar.html" title="Semantic Scholar"
|
||||
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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'relevance'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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="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/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>
|
||||
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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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="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="soundcloud.html" title="Soundcloud"
|
||||
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 (2026.5.5+d3566fe8a)</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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="#">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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span 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></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'recently-updated'</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
367
dev/engines/online/startpage.html
Normal file
367
dev/engines/online/startpage.html
Normal file
@@ -0,0 +1,367 @@
|
||||
<!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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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>HTTP <code class="docutils literal notranslate"><span class="pre">Accept-Language</span></code> header (<code class="docutils literal notranslate"><span class="pre">send_accept_language_header</span></code>):</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.</p>
|
||||
<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>
|
||||
<p>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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'web'</span></span><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.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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">18</span></span><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><span 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></span><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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3600</span></span><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">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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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.1.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.1.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.1.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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'x86_64'</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
387
dev/engines/online/wikipedia.html
Normal file
387
dev/engines/online/wikipedia.html
Normal file
@@ -0,0 +1,387 @@
|
||||
<!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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['infobox']</span></span><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.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><span 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></span><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><span 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></span><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><span 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></span><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 (<code class="docutils literal notranslate"><span class="pre">send_accept_language_header</span></code>):</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><span 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></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['infobox']</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'global'</span></span><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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'text'</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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></span><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><span 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></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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 (2026.5.5+d3566fe8a)</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=4f012ed5"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script data-project="searxng" data-version="2026.5.5+d3566fe8a" 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 (2026.5.5+d3566fe8a)</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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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><span 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><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></span><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="aol.html">AOL</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="karmasearch.html">Karmasearch</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="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="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>
|
||||
Reference in New Issue
Block a user