mirror of
https://github.com/searxng/searxng.git
synced 2026-05-18 00:44:31 +02:00
[doc] build from commit df1f24fb7f
This commit is contained in:
inetol
@@ -0,0 +1,600 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../../../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html"><link rel="next" title="NoSQL databases" href="nosql-engines.html"><link rel="prev" title="Demo Offline Engine" href="../demo/demo_offline.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Command Line Engines - SearXNG Documentation (2026.5.10+df1f24fb7)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=4b1b1f10" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../../index.html"><div class="brand">SearXNG Documentation (2026.5.10+df1f24fb7)</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><div class="sidebar-scroll"><a class="sidebar-brand" href="../../../index.html">
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="../../../_static/searxng-wordmark.svg" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">SearXNG Documentation (2026.5.10+df1f24fb7)</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user/index.html">User information</a><input aria-label="Toggle navigation of User information" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/search-syntax.html">Search syntax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/configured_engines.html">Configured Engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/about.html">About SearXNG</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a><input aria-label="Toggle navigation of Administrator documentation" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../admin/settings/index.html">Settings</a><input aria-label="Toggle navigation of Settings" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_valkey.html"><code class="docutils literal notranslate"><span class="pre">valkey:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-docker.html">Installation container</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-scripts.html">Installation Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-searxng.html">Step by step installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-granian.html">Granian</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-uwsgi.html">uWSGI</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-nginx.html">NGINX</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-apache.html">Apache</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/update-searxng.html">SearXNG maintenance</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.favicons.html">Favicons</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.limiter.html">Limiter</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/api.html">Administration API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/architecture.html">Architecture</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/plugins.html">List of plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/buildhosts.html">Buildhosts</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../../index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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 has-children"><a class="reference internal" href="../index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../result_types/index.html">Result Types</a><input aria-label="Toggle navigation of Result Types" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../result_types/main_result.html">Main Search Results</a><input aria-label="Toggle navigation of Main Search Results" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../plugins/index.html">Plugins</a><input aria-label="Toggle navigation of Plugins" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../plugins/builtins.html">Built-in Plugins</a><input aria-label="Toggle navigation of Built-in Plugins" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../answerers/index.html">Answerers</a><input aria-label="Toggle navigation of Answerers" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../answerers/builtins.html">Built-in Answerers</a><input aria-label="Toggle navigation of Built-in Answerers" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><input aria-label="Toggle navigation of Tooling box searxng_extra" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../searxng_extra/update.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/update/</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a><input aria-label="Toggle navigation of DevOps tooling box" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../utils/searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../src/index.html">Source-Code</a><input aria-label="Toggle navigation of Source-Code" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.babel_extract.html">Custom message extractor (i18n)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.botdetection.html">Bot Detection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.cache.html">Caches</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.exceptions.html">SearXNG Exceptions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.favicons.html">Favicons (source)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.infopage.html">Online <code class="docutils literal notranslate"><span class="pre">/info</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.locales.html">Locales</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.html">Search</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.processors.html">Search processors</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.settings.html">Settings Loader</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.sqlitedb.html">SQLite DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.utils.html">Utility functions for the engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeydb.html">Valkey DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeylib.html">Valkey Library</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.weather.html">Weather</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/blob/master/docs/dev/engines/offline/command-line-engines.rst?plain=true" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/edit/master/docs/dev/engines/offline/command-line-engines.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="command-line-engines">
|
||||
<span id="engine-command"></span><h1>Command Line Engines<a class="headerlink" href="#command-line-engines" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/command.py">command.py</a></p></li>
|
||||
<li><p><a class="reference internal" href="../index.html#offline-engines"><span class="std std-ref">Offline Engines</span></a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial sponsored by <a class="reference external" href="https://nlnet.nl/discovery">Search and Discovery Fund</a> of <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
|
||||
</aside>
|
||||
<p id="module-searx.engines.command">With <em>command engines</em> administrators can run engines to integrate arbitrary
|
||||
shell commands.</p>
|
||||
<div class="admonition attention">
|
||||
<p class="admonition-title">Attention</p>
|
||||
<p>When creating and enabling a <code class="docutils literal notranslate"><span class="pre">command</span></code> engine on a public instance, you
|
||||
must be careful to avoid leaking private data.</p>
|
||||
</div>
|
||||
<p>The easiest solution is to limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described
|
||||
in section <a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>. The engine base is flexible. Only your
|
||||
imagination can limit the power of this engine (and maybe security concerns).</p>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>The following options are available:</p>
|
||||
<dl>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">command</span></code>:</dt><dd><p>A comma separated list of the elements of the command. A special token
|
||||
<code class="docutils literal notranslate"><span class="pre">{{QUERY}}</span></code> tells where to put the search terms of the user. Example:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="s">'ls'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'-l'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'-h'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'{{QUERY}}'</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">delimiter</span></code>:</dt><dd><p>A mapping containing a delimiter <code class="docutils literal notranslate"><span class="pre">char</span></code> and the <em>titles</em> of each element in
|
||||
<code class="docutils literal notranslate"><span class="pre">keys</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">parse_regex</span></code>:</dt><dd><p>A dict containing the regular expressions for each result key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">query_type</span></code>:</p>
|
||||
<blockquote>
|
||||
<div><p>The expected type of user search terms. Possible values: <code class="docutils literal notranslate"><span class="pre">path</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">enum</span></code>.</p>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">path</span></code>:</dt><dd><p>Checks if the user provided path is inside the working directory. If not,
|
||||
the query is not executed.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">enum</span></code>:</dt><dd><p>Is a list of allowed search terms. If the user submits something which is
|
||||
not included in the list, the query returns an error.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">query_enum</span></code>:</dt><dd><p>A list containing allowed search terms if <code class="docutils literal notranslate"><span class="pre">query_type</span></code> is set to <code class="docutils literal notranslate"><span class="pre">enum</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">working_dir</span></code>:</dt><dd><p>The directory where the command has to be executed. Default: <code class="docutils literal notranslate"><span class="pre">./</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">result_separator</span></code>:</dt><dd><p>The character that separates results. Default: <code class="docutils literal notranslate"><span class="pre">\n</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
||||
<p>The example engine below can be used to find files with a specific name in the
|
||||
configured working directory:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">find</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">command</span>
|
||||
<span class="w"> </span><span class="nt">command</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'find'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'.'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'-name'</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">'{{QUERY}}'</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">query_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">path</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fnd</span>
|
||||
<span class="w"> </span><span class="nt">delimiter</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">chars</span><span class="p">:</span><span class="w"> </span><span class="s">'</span><span class="nv"> </span><span class="s">'</span>
|
||||
<span class="w"> </span><span class="nt">keys</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'line'</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h2>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h2>
|
||||
</section>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.command.check_parsing_options">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.command.</span></span><span class="sig-name descname"><span class="pre">check_parsing_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">engine_settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/command.html#check_parsing_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.command.check_parsing_options" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Checks if delimiter based parsing or regex parsing is configured correctly</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="nosql-engines.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">NoSQL databases</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="../demo/demo_offline.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Demo Offline Engine</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © SearXNG team
|
||||
</div>
|
||||
Made with
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://github.com/searxng/searxng/" aria-label="GitHub">💾</a>
|
||||
<a class="muted-link " href="https://searx.space/" aria-label="searx.space">🌐</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Command Line Engines</a><ul>
|
||||
<li><a class="reference internal" href="#configuration">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
<li><a class="reference internal" href="#implementations">Implementations</a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.command.check_parsing_options"><code class="docutils literal notranslate"><span class="pre">check_parsing_options()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../../_static/documentation_options.js?v=c15363ef"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../../../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,659 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../../../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html"><link rel="next" title="Local Search APIs" href="search-indexer-engines.html"><link rel="prev" title="Command Line Engines" href="command-line-engines.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>NoSQL databases - SearXNG Documentation (2026.5.10+df1f24fb7)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=4b1b1f10" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../../index.html"><div class="brand">SearXNG Documentation (2026.5.10+df1f24fb7)</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><div class="sidebar-scroll"><a class="sidebar-brand" href="../../../index.html">
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="../../../_static/searxng-wordmark.svg" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">SearXNG Documentation (2026.5.10+df1f24fb7)</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user/index.html">User information</a><input aria-label="Toggle navigation of User information" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/search-syntax.html">Search syntax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/configured_engines.html">Configured Engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/about.html">About SearXNG</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a><input aria-label="Toggle navigation of Administrator documentation" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../admin/settings/index.html">Settings</a><input aria-label="Toggle navigation of Settings" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_valkey.html"><code class="docutils literal notranslate"><span class="pre">valkey:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-docker.html">Installation container</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-scripts.html">Installation Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-searxng.html">Step by step installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-granian.html">Granian</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-uwsgi.html">uWSGI</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-nginx.html">NGINX</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-apache.html">Apache</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/update-searxng.html">SearXNG maintenance</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.favicons.html">Favicons</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.limiter.html">Limiter</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/api.html">Administration API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/architecture.html">Architecture</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/plugins.html">List of plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/buildhosts.html">Buildhosts</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../../index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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 has-children"><a class="reference internal" href="../index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../result_types/index.html">Result Types</a><input aria-label="Toggle navigation of Result Types" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../result_types/main_result.html">Main Search Results</a><input aria-label="Toggle navigation of Main Search Results" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../plugins/index.html">Plugins</a><input aria-label="Toggle navigation of Plugins" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../plugins/builtins.html">Built-in Plugins</a><input aria-label="Toggle navigation of Built-in Plugins" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../answerers/index.html">Answerers</a><input aria-label="Toggle navigation of Answerers" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../answerers/builtins.html">Built-in Answerers</a><input aria-label="Toggle navigation of Built-in Answerers" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><input aria-label="Toggle navigation of Tooling box searxng_extra" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../searxng_extra/update.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/update/</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a><input aria-label="Toggle navigation of DevOps tooling box" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../utils/searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../src/index.html">Source-Code</a><input aria-label="Toggle navigation of Source-Code" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.babel_extract.html">Custom message extractor (i18n)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.botdetection.html">Bot Detection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.cache.html">Caches</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.exceptions.html">SearXNG Exceptions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.favicons.html">Favicons (source)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.infopage.html">Online <code class="docutils literal notranslate"><span class="pre">/info</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.locales.html">Locales</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.html">Search</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.processors.html">Search processors</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.settings.html">Settings Loader</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.sqlitedb.html">SQLite DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.utils.html">Utility functions for the engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeydb.html">Valkey DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeylib.html">Valkey Library</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.weather.html">Weather</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/blob/master/docs/dev/engines/offline/nosql-engines.rst?plain=true" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/edit/master/docs/dev/engines/offline/nosql-engines.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="nosql-databases">
|
||||
<span id="nosql-engines"></span><h1>NoSQL databases<a class="headerlink" href="#nosql-databases" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/NoSQL">NoSQL database</a></p></li>
|
||||
<li><p><a class="reference external" href="https://valkey.io/">valkey.io</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.mongodb.com">MongoDB</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial sponsored by <a class="reference external" href="https://nlnet.nl/discovery">Search and Discovery Fund</a> of <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
|
||||
</aside>
|
||||
<p>The following <a class="reference external" href="https://en.wikipedia.org/wiki/NoSQL">NoSQL database</a> are supported:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#engine-valkey-server"><span class="std std-ref">Valkey Server</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-mongodb"><span class="std std-ref">MongoDB / PyMongo</span></a></p></li>
|
||||
</ul>
|
||||
<p>All of the engines above are just commented out in the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>, as you have to set various options and install
|
||||
dependencies before using them.</p>
|
||||
<p>By default, the engines use the <code class="docutils literal notranslate"><span class="pre">key-value</span></code> template for displaying results /
|
||||
see <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/key-value.html">simple</a>
|
||||
theme. If you are not satisfied with the original result layout, you can use
|
||||
your own template, set <code class="docutils literal notranslate"><span class="pre">result_template</span></code> attribute to <code class="docutils literal notranslate"><span class="pre">{template_name}</span></code> and
|
||||
place the templates at:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">searx</span><span class="o">/</span><span class="n">templates</span><span class="o">/</span><span class="p">{</span><span class="n">theme_name</span><span class="p">}</span><span class="o">/</span><span class="n">result_templates</span><span class="o">/</span><span class="p">{</span><span class="n">template_name</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Furthermore, if you do not wish to expose these engines on a public instance, you
|
||||
can still add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described in
|
||||
section <a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
<section id="extra-dependencies">
|
||||
<h2>Extra Dependencies<a class="headerlink" href="#extra-dependencies" title="Link to this heading">¶</a></h2>
|
||||
<p>For using <a class="reference internal" href="#engine-valkey-server"><span class="std std-ref">Valkey Server</span></a> or <a class="reference internal" href="#engine-mongodb"><span class="std std-ref">MongoDB / PyMongo</span></a> you need to
|
||||
install additional packages in Python’s Virtual Environment of your SearXNG
|
||||
instance. To switch into the environment (<a class="reference internal" href="../../../admin/installation-searxng.html#searxng-src"><span class="std std-ref">Install SearXNG & dependencies</span></a>) you can use
|
||||
<a class="reference internal" href="../../../utils/searxng.sh.html#searxng-sh"><span class="std std-ref">utils/searxng.sh</span></a>:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo utils/searxng.sh instance cmd bash
|
||||
(searxng-pyenv)$ pip install ...
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="configure-the-engines">
|
||||
<h2>Configure the engines<a class="headerlink" href="#configure-the-engines" title="Link to this heading">¶</a></h2>
|
||||
<p><a class="reference external" href="https://en.wikipedia.org/wiki/NoSQL">NoSQL database</a> are used for storing arbitrary data without first defining
|
||||
their structure.</p>
|
||||
<section id="valkey-server">
|
||||
<span id="engine-valkey-server"></span><h3>Valkey Server<a class="headerlink" href="#valkey-server" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="https://github.com/andymccurdy/valkey-py#installation">valkey</a></p></li>
|
||||
<li><p><a class="reference external" href="https://valkey.io/">valkey.io</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/valkey_server.py">valkey_server.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.valkey_server">Valkey is an open source (BSD licensed), in-memory data structure (key value
|
||||
based) store. Before configuring the <code class="docutils literal notranslate"><span class="pre">valkey_server</span></code> engine, you must install
|
||||
the dependency <a class="reference external" href="https://github.com/andymccurdy/valkey-py#installation">valkey</a>.</p>
|
||||
<section id="configuration">
|
||||
<h4>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h4>
|
||||
<p>Select a database to search in and set its index in the option <code class="docutils literal notranslate"><span class="pre">db</span></code>. You can
|
||||
either look for exact matches or use partial keywords to find what you are
|
||||
looking for by configuring <code class="docutils literal notranslate"><span class="pre">exact_match_only</span></code>.</p>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h4>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h4>
|
||||
<p>Below is an example configuration:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># Required dependency: valkey</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myvalkey</span>
|
||||
<span class="w"> </span><span class="nt">shortcut </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">rds</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">valkey_server</span>
|
||||
<span class="w"> </span><span class="nt">exact_match_only</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
<span class="w"> </span><span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="s">'127.0.0.1'</span>
|
||||
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6379</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
|
||||
<span class="w"> </span><span class="nt">db</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h4>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
</section>
|
||||
<section id="mongodb-pymongo">
|
||||
<span id="engine-mongodb"></span><h3>MongoDB / PyMongo<a class="headerlink" href="#mongodb-pymongo" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="https://github.com/mongodb/mongo-python-driver#installation">pymongo</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.mongodb.com">MongoDB</a></p></li>
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/mongodb.py">mongodb.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.mongodb"><a class="reference external" href="https://www.mongodb.com">MongoDB</a> is a document based database program that handles JSON like data.
|
||||
Before configuring the <code class="docutils literal notranslate"><span class="pre">mongodb</span></code> engine, you must install the dependency
|
||||
<a class="reference external" href="https://github.com/mongodb/mongo-python-driver#installation">pymongo</a>.</p>
|
||||
<section id="id1">
|
||||
<h4>Configuration<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h4>
|
||||
<p>In order to query <a class="reference external" href="https://www.mongodb.com">MongoDB</a>, you have to select a <code class="docutils literal notranslate"><span class="pre">database</span></code> and a
|
||||
<code class="docutils literal notranslate"><span class="pre">collection</span></code>. Furthermore, you have to select a <code class="docutils literal notranslate"><span class="pre">key</span></code> that is going to be
|
||||
searched. <a class="reference external" href="https://www.mongodb.com">MongoDB</a> also supports the option <code class="docutils literal notranslate"><span class="pre">exact_match_only</span></code>, so configure
|
||||
it as you wish.</p>
|
||||
</section>
|
||||
<section id="id2">
|
||||
<h4>Example<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
|
||||
<p>Below is an example configuration for using a MongoDB collection:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># MongoDB engine</span>
|
||||
<span class="c1"># Required dependency: pymongo</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mymongo</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mongodb</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">md</span>
|
||||
<span class="w"> </span><span class="nt">exact_match_only</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
<span class="w"> </span><span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="s">'127.0.0.1'</span>
|
||||
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">27017</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">results_per_page</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">20</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="s">'business'</span>
|
||||
<span class="w"> </span><span class="nt">collection</span><span class="p">:</span><span class="w"> </span><span class="s">'reviews'</span><span class="w"> </span><span class="c1"># name of the db collection</span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'name'</span><span class="w"> </span><span class="c1"># key in the collection to search for</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id3">
|
||||
<h4>Implementations<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="search-indexer-engines.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Local Search APIs</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="command-line-engines.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Command Line Engines</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © SearXNG team
|
||||
</div>
|
||||
Made with
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://github.com/searxng/searxng/" aria-label="GitHub">💾</a>
|
||||
<a class="muted-link " href="https://searx.space/" aria-label="searx.space">🌐</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">NoSQL databases</a><ul>
|
||||
<li><a class="reference internal" href="#extra-dependencies">Extra Dependencies</a></li>
|
||||
<li><a class="reference internal" href="#configure-the-engines">Configure the engines</a><ul>
|
||||
<li><a class="reference internal" href="#valkey-server">Valkey Server</a><ul>
|
||||
<li><a class="reference internal" href="#configuration">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
<li><a class="reference internal" href="#implementations">Implementations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#mongodb-pymongo">MongoDB / PyMongo</a><ul>
|
||||
<li><a class="reference internal" href="#id1">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#id2">Example</a></li>
|
||||
<li><a class="reference internal" href="#id3">Implementations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../../_static/documentation_options.js?v=c15363ef"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../../../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,649 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../../../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html"><link rel="next" title="SQL Engines" href="sql-engines.html"><link rel="prev" title="NoSQL databases" href="nosql-engines.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Local Search APIs - SearXNG Documentation (2026.5.10+df1f24fb7)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=4b1b1f10" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../../index.html"><div class="brand">SearXNG Documentation (2026.5.10+df1f24fb7)</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><div class="sidebar-scroll"><a class="sidebar-brand" href="../../../index.html">
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="../../../_static/searxng-wordmark.svg" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">SearXNG Documentation (2026.5.10+df1f24fb7)</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user/index.html">User information</a><input aria-label="Toggle navigation of User information" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/search-syntax.html">Search syntax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/configured_engines.html">Configured Engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/about.html">About SearXNG</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a><input aria-label="Toggle navigation of Administrator documentation" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../admin/settings/index.html">Settings</a><input aria-label="Toggle navigation of Settings" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_valkey.html"><code class="docutils literal notranslate"><span class="pre">valkey:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-docker.html">Installation container</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-scripts.html">Installation Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-searxng.html">Step by step installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-granian.html">Granian</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-uwsgi.html">uWSGI</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-nginx.html">NGINX</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-apache.html">Apache</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/update-searxng.html">SearXNG maintenance</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.favicons.html">Favicons</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.limiter.html">Limiter</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/api.html">Administration API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/architecture.html">Architecture</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/plugins.html">List of plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/buildhosts.html">Buildhosts</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../../index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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 has-children"><a class="reference internal" href="../index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../result_types/index.html">Result Types</a><input aria-label="Toggle navigation of Result Types" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../result_types/main_result.html">Main Search Results</a><input aria-label="Toggle navigation of Main Search Results" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../plugins/index.html">Plugins</a><input aria-label="Toggle navigation of Plugins" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../plugins/builtins.html">Built-in Plugins</a><input aria-label="Toggle navigation of Built-in Plugins" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../answerers/index.html">Answerers</a><input aria-label="Toggle navigation of Answerers" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../answerers/builtins.html">Built-in Answerers</a><input aria-label="Toggle navigation of Built-in Answerers" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><input aria-label="Toggle navigation of Tooling box searxng_extra" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../searxng_extra/update.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/update/</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a><input aria-label="Toggle navigation of DevOps tooling box" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../utils/searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../src/index.html">Source-Code</a><input aria-label="Toggle navigation of Source-Code" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.babel_extract.html">Custom message extractor (i18n)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.botdetection.html">Bot Detection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.cache.html">Caches</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.exceptions.html">SearXNG Exceptions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.favicons.html">Favicons (source)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.infopage.html">Online <code class="docutils literal notranslate"><span class="pre">/info</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.locales.html">Locales</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.html">Search</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.processors.html">Search processors</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.settings.html">Settings Loader</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.sqlitedb.html">SQLite DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.utils.html">Utility functions for the engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeydb.html">Valkey DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeylib.html">Valkey Library</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.weather.html">Weather</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/blob/master/docs/dev/engines/offline/search-indexer-engines.rst?plain=true" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/edit/master/docs/dev/engines/offline/search-indexer-engines.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="local-search-apis">
|
||||
<h1>Local Search APIs<a class="headerlink" href="#local-search-apis" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://docs.meilisearch.com/learn/what_is_meilisearch/comparison_to_alternatives.html">Comparison to alternatives</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial sponsored by <a class="reference external" href="https://nlnet.nl/discovery">Search and Discovery Fund</a> of <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
|
||||
</aside>
|
||||
<p>Administrators might find themselves wanting to integrate locally running search
|
||||
engines. The following ones are supported for now:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.meilisearch.com">Meilisearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org">Solr</a></p></li>
|
||||
</ul>
|
||||
<p>Each search engine is powerful, capable of full-text search. All of the engines
|
||||
above are added to <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> just commented out, as you have to
|
||||
<code class="docutils literal notranslate"><span class="pre">base_url</span></code> for all them.</p>
|
||||
<p>Please note that if you are not using HTTPS to access these engines, you have to
|
||||
enable HTTP requests by setting <code class="docutils literal notranslate"><span class="pre">enable_http</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
||||
<p>Furthermore, if you do not want to expose these engines on a public instance,
|
||||
you can still add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described
|
||||
in section <a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
<section id="module-searx.engines.meilisearch">
|
||||
<span id="meilisearch-engine"></span><span id="engine-meilisearch"></span><h2>MeiliSearch Engine<a class="headerlink" href="#module-searx.engines.meilisearch" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/meilisearch.py">meilisearch.py</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.meilisearch.com">MeiliSearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://docs.meilisearch.com/">MeiliSearch Documentation</a></p></li>
|
||||
<li><p><a class="reference external" href="https://docs.meilisearch.com/learn/getting_started/installation.html">Install MeiliSearch</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://www.meilisearch.com">MeiliSearch</a> is aimed at individuals and small companies. It is designed for
|
||||
small-scale (less than 10 million documents) data collections. E.g. it is great
|
||||
for storing web pages you have visited and searching in the contents later.</p>
|
||||
<p>The engine supports faceted search, so you can search in a subset of documents
|
||||
of the collection. Furthermore, you can search in <a class="reference external" href="https://www.meilisearch.com">MeiliSearch</a> instances that
|
||||
require authentication by setting <a class="reference external" href="https://www.meilisearch.com/docs/reference/api/overview#authorization">auth_key</a>.</p>
|
||||
<section id="example">
|
||||
<h3>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h3>
|
||||
<p>Here is a simple example to query a Meilisearch instance:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">meilisearch</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">meilisearch</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mes</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:7700</span>
|
||||
<span class="w"> </span><span class="nt">index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-index</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="c1"># auth_key: Bearer XXXXX</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="module-searx.engines.elasticsearch">
|
||||
<span id="elasticsearch-engine"></span><span id="engine-elasticsearch"></span><h2>Elasticsearch Engine<a class="headerlink" href="#module-searx.engines.elasticsearch" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/elasticsearch.py">elasticsearch.py</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Elasticsearch Guide</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html">Install Elasticsearch</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a> supports numerous ways to query the data it is storing. At the
|
||||
moment the engine supports the most popular search methods (<code class="docutils literal notranslate"><span class="pre">query_type</span></code>):</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">match</span></code>,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">simple_query_string</span></code>,</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">term</span></code> and</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">terms</span></code>.</p></li>
|
||||
</ul>
|
||||
<p>If none of the methods fit your use case, you can select <code class="docutils literal notranslate"><span class="pre">custom</span></code> query type
|
||||
and provide the JSON payload to submit to Elasticsearch in
|
||||
<code class="docutils literal notranslate"><span class="pre">custom_query_json</span></code>.</p>
|
||||
<section id="id1">
|
||||
<h3>Example<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
|
||||
<p>The following is an example configuration for an <a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a> instance with
|
||||
authentication configured to read from <code class="docutils literal notranslate"><span class="pre">my-index</span></code> index.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">elasticsearch</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">els</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">elasticsearch</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:9200</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">elastic</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">changeme</span>
|
||||
<span class="w"> </span><span class="nt">index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-index</span>
|
||||
<span class="w"> </span><span class="nt">query_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">match</span>
|
||||
<span class="w"> </span><span class="c1"># custom_query_json: '{ ... }'</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="module-searx.engines.solr">
|
||||
<span id="solr-engine"></span><span id="engine-solr"></span><h2>Solr Engine<a class="headerlink" href="#module-searx.engines.solr" title="Link to this heading">¶</a></h2>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/solr.py">solr.py</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org">Solr</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org/resources.html">Solr Resources</a></p></li>
|
||||
<li><p><a class="reference external" href="https://solr.apache.org/guide/installing-solr.html">Install Solr</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p><a class="reference external" href="https://solr.apache.org">Solr</a> is a popular search engine based on Lucene, just like <a class="reference external" href="https://www.elastic.co/elasticsearch/">Elasticsearch</a>. But
|
||||
instead of searching in indices, you can search in collections.</p>
|
||||
<section id="id2">
|
||||
<h3>Example<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h3>
|
||||
<p>This is an example configuration for searching in the collection
|
||||
<code class="docutils literal notranslate"><span class="pre">my-collection</span></code> and get the results in ascending order.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">solr</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">solr</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slr</span>
|
||||
<span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:8983</span>
|
||||
<span class="w"> </span><span class="nt">collection</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-collection</span>
|
||||
<span class="w"> </span><span class="nt">sort</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">asc</span>
|
||||
<span class="w"> </span><span class="nt">enable_http</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="sql-engines.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">SQL Engines</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="nosql-engines.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">NoSQL databases</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © SearXNG team
|
||||
</div>
|
||||
Made with
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://github.com/searxng/searxng/" aria-label="GitHub">💾</a>
|
||||
<a class="muted-link " href="https://searx.space/" aria-label="searx.space">🌐</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Local Search APIs</a><ul>
|
||||
<li><a class="reference internal" href="#module-searx.engines.meilisearch">MeiliSearch Engine</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#module-searx.engines.elasticsearch">Elasticsearch Engine</a><ul>
|
||||
<li><a class="reference internal" href="#id1">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#module-searx.engines.solr">Solr Engine</a><ul>
|
||||
<li><a class="reference internal" href="#id2">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../../_static/documentation_options.js?v=c15363ef"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../../../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,894 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../../../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html"><link rel="next" title="Tineye" href="../online_url_search/tineye.html"><link rel="prev" title="Local Search APIs" href="search-indexer-engines.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>SQL Engines - SearXNG Documentation (2026.5.10+df1f24fb7)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=4b1b1f10" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../../index.html"><div class="brand">SearXNG Documentation (2026.5.10+df1f24fb7)</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><div class="sidebar-scroll"><a class="sidebar-brand" href="../../../index.html">
|
||||
<div class="sidebar-logo-container">
|
||||
<img class="sidebar-logo" src="../../../_static/searxng-wordmark.svg" alt="Logo"/>
|
||||
</div>
|
||||
|
||||
<span class="sidebar-brand-text">SearXNG Documentation (2026.5.10+df1f24fb7)</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user/index.html">User information</a><input aria-label="Toggle navigation of User information" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/search-syntax.html">Search syntax</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/configured_engines.html">Configured Engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user/about.html">About SearXNG</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a><input aria-label="Toggle navigation of Administrator documentation" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../admin/settings/index.html">Settings</a><input aria-label="Toggle navigation of Settings" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_valkey.html"><code class="docutils literal notranslate"><span class="pre">valkey:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../admin/settings/settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-docker.html">Installation container</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-scripts.html">Installation Script</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-searxng.html">Step by step installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-granian.html">Granian</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-uwsgi.html">uWSGI</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-nginx.html">NGINX</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/installation-apache.html">Apache</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/update-searxng.html">SearXNG maintenance</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.favicons.html">Favicons</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/searx.limiter.html">Limiter</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/api.html">Administration API</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/architecture.html">Architecture</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/plugins.html">List of plugins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../admin/buildhosts.html">Buildhosts</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../../index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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 has-children"><a class="reference internal" href="../index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><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="../demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../result_types/index.html">Result Types</a><input aria-label="Toggle navigation of Result Types" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../result_types/main_result.html">Main Search Results</a><input aria-label="Toggle navigation of Main Search Results" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../plugins/index.html">Plugins</a><input aria-label="Toggle navigation of Plugins" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../plugins/builtins.html">Built-in Plugins</a><input aria-label="Toggle navigation of Built-in Plugins" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../answerers/index.html">Answerers</a><input aria-label="Toggle navigation of Answerers" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../answerers/builtins.html">Built-in Answerers</a><input aria-label="Toggle navigation of Built-in Answerers" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><input aria-label="Toggle navigation of Tooling box searxng_extra" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../searxng_extra/update.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/update/</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a><input aria-label="Toggle navigation of DevOps tooling box" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../utils/searxng.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searxng.sh</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../src/index.html">Source-Code</a><input aria-label="Toggle navigation of Source-Code" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.babel_extract.html">Custom message extractor (i18n)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.botdetection.html">Bot Detection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.cache.html">Caches</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.exceptions.html">SearXNG Exceptions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.favicons.html">Favicons (source)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.infopage.html">Online <code class="docutils literal notranslate"><span class="pre">/info</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.locales.html">Locales</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.html">Search</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.search.processors.html">Search processors</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.settings.html">Settings Loader</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.sqlitedb.html">SQLite DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.utils.html">Utility functions for the engines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeydb.html">Valkey DB</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.valkeylib.html">Valkey Library</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../src/searx.weather.html">Weather</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/blob/master/docs/dev/engines/offline/sql-engines.rst?plain=true" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://github.com/searxng/searxng/edit/master/docs/dev/engines/offline/sql-engines.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="sql-engines">
|
||||
<span id="id1"></span><h1>SQL Engines<a class="headerlink" href="#sql-engines" title="Link to this heading">¶</a></h1>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">further read</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://www.sqlite.org/index.html">SQLite</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.postgresql.org">PostgreSQL</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.mysql.com">MySQL</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<p>Initial sponsored by <a class="reference external" href="https://nlnet.nl/discovery">Search and Discovery Fund</a> of <a class="reference external" href="https://nlnet.nl/">NLnet Foundation</a>.</p>
|
||||
</aside>
|
||||
<p>With the <em>SQL engines</em> you can bind SQL databases into SearXNG. The following
|
||||
Relational Database Management System (RDBMS) are supported:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#engine-sqlite"><span class="std std-ref">SQLite</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-postgresql"><span class="std std-ref">PostgreSQL</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-mysql-server"><span class="std std-ref">MySQL</span></a> & <a class="reference internal" href="#engine-mariadb-server"><span class="std std-ref">MariaDB</span></a></p></li>
|
||||
</ul>
|
||||
<p>All of the engines above are just commented out in the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/settings.yml">settings.yml</a>, as you have to set the required attributes for the
|
||||
engines, e.g. <code class="docutils literal notranslate"><span class="pre">database:</span></code> …</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="nv">sqlite|postgresql|mysql_server</span><span class="p p-Indicator">}</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
<span class="w"> </span><span class="nt">result_template</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="nv">template_name</span><span class="p p-Indicator">}</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>By default, the engines use the <code class="docutils literal notranslate"><span class="pre">key-value</span></code> template for displaying results /
|
||||
see <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/key-value.html">simple</a>
|
||||
theme. If you are not satisfied with the original result layout, you can use
|
||||
your own template, set <code class="docutils literal notranslate"><span class="pre">result_template</span></code> attribute to <code class="docutils literal notranslate"><span class="pre">{template_name}</span></code> and
|
||||
place the templates at:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">searx</span><span class="o">/</span><span class="n">templates</span><span class="o">/</span><span class="p">{</span><span class="n">theme_name</span><span class="p">}</span><span class="o">/</span><span class="n">result_templates</span><span class="o">/</span><span class="p">{</span><span class="n">template_name</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you do not wish to expose these engines on a public instance, you can still
|
||||
add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described in section
|
||||
<a class="reference internal" href="../../../admin/settings/settings_engines.html#private-engines"><span class="std std-ref">Private Engines (tokens)</span></a>.</p>
|
||||
<section id="extra-dependencies">
|
||||
<h2>Extra Dependencies<a class="headerlink" href="#extra-dependencies" title="Link to this heading">¶</a></h2>
|
||||
<p>For using <a class="reference internal" href="#engine-postgresql"><span class="std std-ref">PostgreSQL</span></a> or <a class="reference internal" href="#engine-mysql-server"><span class="std std-ref">MySQL</span></a> you need to
|
||||
install additional packages in Python’s Virtual Environment of your SearXNG
|
||||
instance. To switch into the environment (<a class="reference internal" href="../../../admin/installation-searxng.html#searxng-src"><span class="std std-ref">Install SearXNG & dependencies</span></a>) you can use
|
||||
<a class="reference internal" href="../../../utils/searxng.sh.html#searxng-sh"><span class="std std-ref">utils/searxng.sh</span></a>:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo utils/searxng.sh instance cmd bash
|
||||
(searxng-pyenv)$ pip install ...
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="configure-the-engines">
|
||||
<h2>Configure the engines<a class="headerlink" href="#configure-the-engines" title="Link to this heading">¶</a></h2>
|
||||
<p>The configuration of the new database engines are similar. You must put a valid
|
||||
SQL-SELECT query in <code class="docutils literal notranslate"><span class="pre">query_str</span></code>. At the moment you can only bind at most one
|
||||
parameter in your query. By setting the attribute <code class="docutils literal notranslate"><span class="pre">limit</span></code> you can define how
|
||||
many results you want from the SQL server. Basically, it is the same as the
|
||||
<code class="docutils literal notranslate"><span class="pre">LIMIT</span></code> keyword in SQL.</p>
|
||||
<p>Please, do not include <code class="docutils literal notranslate"><span class="pre">LIMIT</span></code> or <code class="docutils literal notranslate"><span class="pre">OFFSET</span></code> in your SQL query as the engines
|
||||
rely on these keywords during paging. If you want to configure the number of
|
||||
returned results use the option <code class="docutils literal notranslate"><span class="pre">limit</span></code>.</p>
|
||||
<section id="engine-sqlite">
|
||||
<span id="id2"></span><h3>SQLite<a class="headerlink" href="#engine-sqlite" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/sqlite.py">sqlite.py</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.sqlite">SQLite is a small, fast and reliable SQL database engine. It does not require
|
||||
any extra dependency.</p>
|
||||
<section id="configuration">
|
||||
<h4>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h4>
|
||||
<p>The engine has the following (additional) settings:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#searx.engines.sqlite.result_type" title="searx.engines.sqlite.result_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">result_type</span></code></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="example">
|
||||
<h4>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h4>
|
||||
<p>To demonstrate the power of database engines, here is a more complex example
|
||||
which reads from a <a class="reference external" href="https://mediathekview.de/">MediathekView</a> (DE) movie database. For this example of the
|
||||
SQLite engine download the database:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://liste.mediathekview.de/filmliste-v2.db.bz2">https://liste.mediathekview.de/filmliste-v2.db.bz2</a></p></li>
|
||||
</ul>
|
||||
<p>and unpack into <code class="docutils literal notranslate"><span class="pre">searx/data/filmliste-v2.db</span></code>. To search the database use e.g
|
||||
Query to test: <code class="docutils literal notranslate"><span class="pre">!mediathekview</span> <span class="pre">concert</span></code></p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mediathekview</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sqlite</span>
|
||||
<span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mediathekview</span>
|
||||
<span class="w"> </span><span class="nt">categories</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">general</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">videos</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">result_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MainResult</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searx/data/filmliste-v2.db</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">>-</span>
|
||||
<span class="w"> </span><span class="no">SELECT title || ' (' || time(duration, 'unixepoch') || ')' AS title,</span>
|
||||
<span class="w"> </span><span class="no">COALESCE( NULLIF(url_video_hd,''), NULLIF(url_video_sd,''), url_video) AS url,</span>
|
||||
<span class="w"> </span><span class="no">description AS content</span>
|
||||
<span class="w"> </span><span class="no">FROM film</span>
|
||||
<span class="w"> </span><span class="no">WHERE title LIKE :wildcard OR description LIKE :wildcard</span>
|
||||
<span class="w"> </span><span class="no">ORDER BY duration DESC</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="implementations">
|
||||
<h4>Implementations<a class="headerlink" href="#implementations" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">database</span></span><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.sqlite.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Filename of the SQLite DB.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><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.sqlite.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.result_type">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">result_type</span></span><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">'MainResult'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'KeyValue'</span></span><span class="p"><span class="pre">]</span></span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'KeyValue'</span></span><a class="headerlink" href="#searx.engines.sqlite.result_type" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>The result type can be <code class="xref py py-obj docutils literal notranslate"><span class="pre">MainResult</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">KeyValue</span></code>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="searx.engines.sqlite.sqlite_cursor">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.sqlite.</span></span><span class="sig-name descname"><span class="pre">sqlite_cursor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/engines/sqlite.html#sqlite_cursor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.engines.sqlite.sqlite_cursor" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Implements a <a class="reference external" href="https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Context</span> <span class="pre">Manager</span></code></a> for a
|
||||
<a class="reference external" href="https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sqlite3.Cursor</span></code></a>.</p>
|
||||
<p>Open database in read only mode: if the database doesn’t exist. The default
|
||||
mode creates an empty file on the file system. See:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://docs.python.org/3/library/sqlite3.html#sqlite3.connect">https://docs.python.org/3/library/sqlite3.html#sqlite3.connect</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.sqlite.org/uri.html">https://www.sqlite.org/uri.html</a></p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="engine-postgresql">
|
||||
<span id="id3"></span><h3>PostgreSQL<a class="headerlink" href="#engine-postgresql" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/postgresql.py">postgresql.py</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="psycopg2">psycopg2-binary</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.postgresql">PostgreSQL is a powerful and robust open source database. Before configuring
|
||||
the PostgreSQL engine, you must install the dependency <code class="docutils literal notranslate"><span class="pre">psychopg2</span></code>.</p>
|
||||
<section id="id4">
|
||||
<h4>Example<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h4>
|
||||
<p>Below is an example configuration:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgresql</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searxng</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="s">'SELECT</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">my_table</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">my_column</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">%(query)s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id5">
|
||||
<h4>Implementations<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.host">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">host</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></span><a class="headerlink" href="#searx.engines.postgresql.host" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hostname of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.port">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">port</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'5432'</span></span><a class="headerlink" href="#searx.engines.postgresql.port" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Port of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">database</span></span><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.postgresql.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">username</span></span><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.postgresql.username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Username for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.password">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">password</span></span><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.postgresql.password" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Password for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.postgresql.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.postgresql.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><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.postgresql.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="engine-mysql-server">
|
||||
<span id="id6"></span><h3>MySQL<a class="headerlink" href="#engine-mysql-server" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/mysql_server.py">mysql_server.py</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="https://pypi.org/project/mysql-connector-python">mysql-connector-python</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.mysql_server">MySQL is said to be the most popular open source database. Before enabling
|
||||
MySQL engine, you must install the package <code class="docutils literal notranslate"><span class="pre">mysql-connector-python</span></code>.</p>
|
||||
<p>The authentication plugin is configurable by setting <code class="docutils literal notranslate"><span class="pre">auth_plugin</span></code> in the
|
||||
attributes. By default it is set to <code class="docutils literal notranslate"><span class="pre">caching_sha2_password</span></code>.</p>
|
||||
<section id="id7">
|
||||
<h4>Example<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h4>
|
||||
<p>This is an example configuration for querying a MySQL server:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysql_server</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searxng</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="s">'SELECT</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">my_table</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">my_column=%(query)s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id8">
|
||||
<h4>Implementations<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.host">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">host</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></span><a class="headerlink" href="#searx.engines.mysql_server.host" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hostname of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.port">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">port</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3306</span></span><a class="headerlink" href="#searx.engines.mysql_server.port" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Port of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">database</span></span><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.mysql_server.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">username</span></span><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.mysql_server.username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Username for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.password">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">password</span></span><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.mysql_server.password" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Password for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mysql_server.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mysql_server.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><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.mysql_server.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="mariadb">
|
||||
<span id="engine-mariadb-server"></span><h3>MariaDB<a class="headerlink" href="#mariadb" title="Link to this heading">¶</a></h3>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">info</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/mariadb_server.py">mariadb_server.py</a></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span></code> <a class="reference external" href="https://pypi.org/project/mariadb">mariadb</a></p></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<p id="module-searx.engines.mariadb_server">MariaDB is a community driven fork of MySQL. Before enabling MariaDB engine,
|
||||
you must the install the pip package <code class="docutils literal notranslate"><span class="pre">mariadb</span></code> along with the necessary
|
||||
prerequities.</p>
|
||||
<p><a class="reference external" href="https://mariadb.com/docs/server/connect/programming-languages/c/install/">See the following documentation for more details</a></p>
|
||||
<section id="id9">
|
||||
<h4>Example<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h4>
|
||||
<p>This is an example configuration for querying a MariaDB server:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mariadb_server</span>
|
||||
<span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span>
|
||||
<span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">searxng</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
|
||||
<span class="w"> </span><span class="nt">limit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span>
|
||||
<span class="w"> </span><span class="nt">query_str</span><span class="p">:</span><span class="w"> </span><span class="s">'SELECT</span><span class="nv"> </span><span class="s">*</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">my_table</span><span class="nv"> </span><span class="s">WHERE</span><span class="nv"> </span><span class="s">my_column=%(query)s'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id10">
|
||||
<h4>Implementations<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h4>
|
||||
</section>
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.host">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">host</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></span><a class="headerlink" href="#searx.engines.mariadb_server.host" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Hostname of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.port">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">port</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3306</span></span><a class="headerlink" href="#searx.engines.mariadb_server.port" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Port of the DB connector</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.database">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">database</span></span><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.mariadb_server.database" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Name of the database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.username">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">username</span></span><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.mariadb_server.username" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Username for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.password">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">password</span></span><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.mariadb_server.password" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Password for the DB connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt class="sig sig-object py" id="searx.engines.mariadb_server.query_str">
|
||||
<span class="sig-prename descclassname"><span class="pre">searx.engines.mariadb_server.</span></span><span class="sig-name descname"><span class="pre">query_str</span></span><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.mariadb_server.query_str" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>SQL query that returns the result items.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="../online_url_search/tineye.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Tineye</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="search-indexer-engines.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Local Search APIs</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © SearXNG team
|
||||
</div>
|
||||
Made with
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://github.com/searxng/searxng/" aria-label="GitHub">💾</a>
|
||||
<a class="muted-link " href="https://searx.space/" aria-label="searx.space">🌐</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">SQL Engines</a><ul>
|
||||
<li><a class="reference internal" href="#extra-dependencies">Extra Dependencies</a></li>
|
||||
<li><a class="reference internal" href="#configure-the-engines">Configure the engines</a><ul>
|
||||
<li><a class="reference internal" href="#engine-sqlite">SQLite</a><ul>
|
||||
<li><a class="reference internal" href="#configuration">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
<li><a class="reference internal" href="#implementations">Implementations</a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.sqlite.database"><code class="docutils literal notranslate"><span class="pre">database</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.sqlite.query_str"><code class="docutils literal notranslate"><span class="pre">query_str</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.sqlite.result_type"><code class="docutils literal notranslate"><span class="pre">result_type</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.sqlite.sqlite_cursor"><code class="docutils literal notranslate"><span class="pre">sqlite_cursor()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#engine-postgresql">PostgreSQL</a><ul>
|
||||
<li><a class="reference internal" href="#id4">Example</a></li>
|
||||
<li><a class="reference internal" href="#id5">Implementations</a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.postgresql.host"><code class="docutils literal notranslate"><span class="pre">host</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.postgresql.port"><code class="docutils literal notranslate"><span class="pre">port</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.postgresql.database"><code class="docutils literal notranslate"><span class="pre">database</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.postgresql.username"><code class="docutils literal notranslate"><span class="pre">username</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.postgresql.password"><code class="docutils literal notranslate"><span class="pre">password</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.postgresql.query_str"><code class="docutils literal notranslate"><span class="pre">query_str</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#engine-mysql-server">MySQL</a><ul>
|
||||
<li><a class="reference internal" href="#id7">Example</a></li>
|
||||
<li><a class="reference internal" href="#id8">Implementations</a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mysql_server.host"><code class="docutils literal notranslate"><span class="pre">host</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mysql_server.port"><code class="docutils literal notranslate"><span class="pre">port</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mysql_server.database"><code class="docutils literal notranslate"><span class="pre">database</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mysql_server.username"><code class="docutils literal notranslate"><span class="pre">username</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mysql_server.password"><code class="docutils literal notranslate"><span class="pre">password</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mysql_server.query_str"><code class="docutils literal notranslate"><span class="pre">query_str</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#mariadb">MariaDB</a><ul>
|
||||
<li><a class="reference internal" href="#id9">Example</a></li>
|
||||
<li><a class="reference internal" href="#id10">Implementations</a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mariadb_server.host"><code class="docutils literal notranslate"><span class="pre">host</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mariadb_server.port"><code class="docutils literal notranslate"><span class="pre">port</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mariadb_server.database"><code class="docutils literal notranslate"><span class="pre">database</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mariadb_server.username"><code class="docutils literal notranslate"><span class="pre">username</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mariadb_server.password"><code class="docutils literal notranslate"><span class="pre">password</span></code></a></li>
|
||||
<li><a class="reference internal" href="#searx.engines.mariadb_server.query_str"><code class="docutils literal notranslate"><span class="pre">query_str</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../../_static/documentation_options.js?v=c15363ef"></script>
|
||||
<script src="../../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../../../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user