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,556 @@
|
||||
<!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"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>searx.botdetection._helpers - 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 no-toc" 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>
|
||||
<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 has-children"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/contribution_guide.html">How to contribute</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/engines/index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" 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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/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="../../../dev/result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/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="../../../dev/reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><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="../../../dev/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="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 no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<h1>Source code for searx.botdetection._helpers</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="c1"># pylint: disable=missing-module-docstring, invalid-name</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
|
||||
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"log_error_only_once"</span><span class="p">,</span> <span class="s2">"dump_request"</span><span class="p">,</span> <span class="s2">"get_network"</span><span class="p">,</span> <span class="s2">"logger"</span><span class="p">,</span> <span class="s2">"too_many_requests"</span><span class="p">]</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">IPv4Network</span><span class="p">,</span>
|
||||
<span class="n">IPv6Network</span><span class="p">,</span>
|
||||
<span class="n">IPv4Address</span><span class="p">,</span>
|
||||
<span class="n">IPv6Address</span><span class="p">,</span>
|
||||
<span class="n">ip_network</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">werkzeug</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
|
||||
|
||||
<span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">'botdetection'</span><span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">dump_request</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
<span class="n">request</span><span class="o">.</span><span class="n">path</span>
|
||||
<span class="o">+</span> <span class="s2">" || X-Forwarded-For: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'X-Forwarded-For'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || X-Real-IP: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'X-Real-IP'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || form: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">form</span>
|
||||
<span class="o">+</span> <span class="s2">" || Accept: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Accept'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Accept-Language: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Accept-Language'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Accept-Encoding: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Accept-Encoding'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Content-Type: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Content-Type'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Content-Length: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Content-Length'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Connection: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Connection'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || User-Agent: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'User-Agent'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Sec-Fetch-Site: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Sec-Fetch-Site'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Sec-Fetch-Mode: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Sec-Fetch-Mode'</span><span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">" || Sec-Fetch-Dest: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Sec-Fetch-Dest'</span><span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="too_many_requests">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.too_many_requests">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">too_many_requests</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">log_msg</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">werkzeug</span><span class="o">.</span><span class="n">Response</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns a HTTP 429 response object and writes a ERROR message to the</span>
|
||||
<span class="sd"> 'botdetection' logger. This function is used in part by the filter methods</span>
|
||||
<span class="sd"> to return the default ``Too Many Requests`` response.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"BLOCK </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">log_msg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">flask</span><span class="o">.</span><span class="n">make_response</span><span class="p">((</span><span class="s1">'Too Many Requests'</span><span class="p">,</span> <span class="mi">429</span><span class="p">))</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="get_network">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.get_network">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_network</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="s2">"config.Config"</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns the (client) network of whether the ``real_ip`` is part of.</span>
|
||||
|
||||
<span class="sd"> The ``ipv4_prefix`` and ``ipv6_prefix`` define the number of leading bits in</span>
|
||||
<span class="sd"> an address that are compared to determine whether or not an address is part</span>
|
||||
<span class="sd"> of a (client) network.</span>
|
||||
|
||||
<span class="sd"> .. code:: toml</span>
|
||||
|
||||
<span class="sd"> [botdetection]</span>
|
||||
|
||||
<span class="sd"> ipv4_prefix = 32</span>
|
||||
<span class="sd"> ipv6_prefix = 48</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">prefix</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">cfg</span><span class="p">[</span><span class="s2">"botdetection.ipv4_prefix"</span><span class="p">]</span>
|
||||
<span class="k">if</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">6</span><span class="p">:</span>
|
||||
<span class="n">prefix</span> <span class="o">=</span> <span class="n">cfg</span><span class="p">[</span><span class="s2">"botdetection.ipv6_prefix"</span><span class="p">]</span>
|
||||
<span class="n">network</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">real_ip</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">prefix</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<span class="c1"># logger.debug("get_network(): %s", network.compressed)</span>
|
||||
<span class="k">return</span> <span class="n">network</span></div>
|
||||
|
||||
|
||||
|
||||
<span class="n">_logged_errors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">log_error_only_once</span><span class="p">(</span><span class="n">err_msg</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="n">err_msg</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_logged_errors</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">err_msg</span><span class="p">)</span>
|
||||
<span class="n">_logged_errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">err_msg</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
|
||||
</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 no-toc">
|
||||
|
||||
|
||||
|
||||
</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,888 @@
|
||||
<!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"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>searx.botdetection.config - 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 no-toc" 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>
|
||||
<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 has-children"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/contribution_guide.html">How to contribute</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/engines/index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" 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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/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="../../../dev/result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/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="../../../dev/reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><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="../../../dev/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="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 no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<h1>Source code for searx.botdetection.config</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Configuration class :py:class:`Config` with deep-update, schema validation</span>
|
||||
<span class="sd">and deprecated names.</span>
|
||||
|
||||
<span class="sd">The :py:class:`Config` class implements a configuration that is based on</span>
|
||||
<span class="sd">structured dictionaries. The configuration schema is defined in a dictionary</span>
|
||||
<span class="sd">structure and the configuration data is given in a dictionary structure.</span>
|
||||
<span class="sd">"""</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">copy</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">tomllib</span>
|
||||
|
||||
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Config'</span><span class="p">,</span> <span class="s1">'UNSET'</span><span class="p">,</span> <span class="s1">'SchemaIssue'</span><span class="p">,</span> <span class="s1">'set_global_cfg'</span><span class="p">,</span> <span class="s1">'get_global_cfg'</span><span class="p">]</span>
|
||||
|
||||
<span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
||||
|
||||
<span class="n">CFG</span><span class="p">:</span> <span class="s2">"Config | None"</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="sd">"""Global config of the botdetection."""</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">set_global_cfg</span><span class="p">(</span><span class="n">cfg</span><span class="p">:</span> <span class="s2">"Config"</span><span class="p">):</span>
|
||||
<span class="k">global</span> <span class="n">CFG</span> <span class="c1"># pylint: disable=global-statement</span>
|
||||
<span class="n">CFG</span> <span class="o">=</span> <span class="n">cfg</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_global_cfg</span><span class="p">()</span> <span class="o">-></span> <span class="s2">"Config"</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">CFG</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Botdetection's config is not yet initialized."</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">CFG</span>
|
||||
|
||||
|
||||
<span class="nd">@typing</span><span class="o">.</span><span class="n">final</span>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">FALSE</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Class of ``False`` singleton"""</span>
|
||||
|
||||
<span class="c1"># pylint: disable=multiple-statements</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="kc">False</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span>
|
||||
|
||||
<span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span>
|
||||
|
||||
|
||||
<span class="n">UNSET</span> <span class="o">=</span> <span class="n">FALSE</span><span class="p">(</span><span class="s1">'<UNSET>'</span><span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SchemaIssue">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.SchemaIssue">[docs]</a>
|
||||
<span class="nd">@typing</span><span class="o">.</span><span class="n">final</span>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">SchemaIssue</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Exception to store and/or raise a message from a schema issue."""</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s1">'warn'</span><span class="p">,</span> <span class="s1">'invalid'</span><span class="p">],</span> <span class="n">msg</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">level</span> <span class="o">=</span> <span class="n">level</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="sa">f</span><span class="s2">"[cfg schema </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">level</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Config">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">Config</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Base class used for configuration"""</span>
|
||||
|
||||
<span class="n">UNSET</span><span class="p">:</span> <span class="nb">object</span> <span class="o">=</span> <span class="n">UNSET</span>
|
||||
|
||||
<span class="nd">@classmethod</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">from_toml</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">schema_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="s2">"Config"</span><span class="p">:</span>
|
||||
|
||||
<span class="c1"># init schema</span>
|
||||
|
||||
<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"load schema file: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">schema_file</span><span class="p">)</span>
|
||||
<span class="n">cfg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">cfg_schema</span><span class="o">=</span><span class="n">toml_load</span><span class="p">(</span><span class="n">schema_file</span><span class="p">),</span> <span class="n">deprecated</span><span class="o">=</span><span class="n">deprecated</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">cfg_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
|
||||
<span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"missing config file: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">cfg</span>
|
||||
|
||||
<span class="c1"># load configuration</span>
|
||||
|
||||
<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"load config file: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">)</span>
|
||||
<span class="n">upd_cfg</span> <span class="o">=</span> <span class="n">toml_load</span><span class="p">(</span><span class="n">cfg_file</span><span class="p">)</span>
|
||||
|
||||
<span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="n">upd_cfg</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">msg</span> <span class="ow">in</span> <span class="n">issue_list</span><span class="p">:</span>
|
||||
<span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">msg</span><span class="p">))</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_valid</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"schema of </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2"> is invalid!"</span><span class="p">)</span>
|
||||
<span class="n">cfg</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">upd_cfg</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">cfg</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg_schema</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span> <span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]):</span>
|
||||
<span class="w"> </span><span class="sd">"""Constructor of class Config.</span>
|
||||
|
||||
<span class="sd"> :param cfg_schema: Schema of the configuration</span>
|
||||
<span class="sd"> :param deprecated: dictionary that maps deprecated configuration names to a messages</span>
|
||||
|
||||
<span class="sd"> These values are needed for validation, see :py:obj:`validate`.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">cfg_schema</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">deprecated</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">cfg_schema</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="Config.validate">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.validate">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">validate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]):</span>
|
||||
<span class="w"> </span><span class="sd">"""Validation of dictionary ``cfg`` on :py:obj:`Config.SCHEMA`.</span>
|
||||
<span class="sd"> Validation is done by :py:obj:`validate`."""</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">,</span> <span class="n">cfg</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deprecated</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Config.update">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.update">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">upd_cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]):</span>
|
||||
<span class="w"> </span><span class="sd">"""Update this configuration by ``upd_cfg``."""</span>
|
||||
|
||||
<span class="n">dict_deepupdate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">upd_cfg</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Config.default">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.default">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns default value of field ``name`` in ``self.cfg_schema``."""</span>
|
||||
<span class="k">return</span> <span class="n">value</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Config.get">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.get">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span> <span class="o">=</span> <span class="n">UNSET</span><span class="p">,</span> <span class="n">replace</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-></span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns the value to which ``name`` points in the configuration.</span>
|
||||
|
||||
<span class="sd"> If there is no such ``name`` in the config and the ``default`` is</span>
|
||||
<span class="sd"> :py:obj:`UNSET`, a :py:obj:`KeyError` is raised.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parent_dict</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">UNSET</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="n">default</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">replace</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="n">val</span> <span class="o">%</span> <span class="bp">self</span>
|
||||
<span class="k">return</span> <span class="n">val</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Config.set">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.set">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">val</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Set the value to which ``name`` points in the configuration.</span>
|
||||
|
||||
<span class="sd"> If there is no such ``name`` in the config, a :py:obj:`KeyError` is</span>
|
||||
<span class="sd"> raised.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parent_dict</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">parent</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">val</span></div>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_get_parent_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]:</span>
|
||||
<span class="n">parent_name</span> <span class="o">=</span> <span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
|
||||
<span class="k">if</span> <span class="n">parent_name</span><span class="p">:</span>
|
||||
<span class="n">parent</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span><span class="p">(</span><span class="n">parent_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span>
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">parent</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
|
||||
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">parent_name</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">parent</span>
|
||||
|
||||
<div class="viewcode-block" id="Config.path">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.path">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span> <span class="o">=</span> <span class="n">UNSET</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Get a :py:class:`pathlib.Path` object from a config string."""</span>
|
||||
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">default</span>
|
||||
<span class="k">return</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">val</span><span class="p">))</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Config.pyobj">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.pyobj">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">pyobj</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span> <span class="o">=</span> <span class="n">UNSET</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Get python object referred by full qualiffied name (FQN) in the config</span>
|
||||
<span class="sd"> string."""</span>
|
||||
|
||||
<span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">fqn</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">default</span>
|
||||
<span class="p">(</span><span class="n">modulename</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">fqn</span><span class="p">)</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="n">m</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">modulename</span><span class="p">,</span> <span class="p">{},</span> <span class="p">{},</span> <span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">toml_load</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">):</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">tomllib</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="n">tomllib</span><span class="o">.</span><span class="n">TOMLDecodeError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<span class="n">msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\t</span><span class="s1">'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span>
|
||||
<span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
|
||||
<span class="k">raise</span>
|
||||
|
||||
|
||||
<span class="c1"># working with dictionaries</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]):</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns the value to which ``name`` points in the ``dat_dict``.</span>
|
||||
|
||||
<span class="sd"> .. code: python</span>
|
||||
|
||||
<span class="sd"> >>> data_dict = {</span>
|
||||
<span class="sd"> "foo": {"bar": 1 },</span>
|
||||
<span class="sd"> "bar": {"foo": 2 },</span>
|
||||
<span class="sd"> "foobar": [1, 2, 3],</span>
|
||||
<span class="sd"> }</span>
|
||||
<span class="sd"> >>> value('foobar', data_dict)</span>
|
||||
<span class="sd"> [1, 2, 3]</span>
|
||||
<span class="sd"> >>> value('foo.bar', data_dict)</span>
|
||||
<span class="sd"> 1</span>
|
||||
<span class="sd"> >>> value('foo.bar.xxx', data_dict)</span>
|
||||
<span class="sd"> <UNSET></span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">ret_val</span> <span class="o">=</span> <span class="n">data_dict</span>
|
||||
<span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ret_val</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="n">ret_val</span> <span class="o">=</span> <span class="n">ret_val</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">part</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">ret_val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">break</span>
|
||||
<span class="k">return</span> <span class="n">ret_val</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">validate</span><span class="p">(</span>
|
||||
<span class="n">schema_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span> <span class="n">data_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span> <span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="n">SchemaIssue</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Deep validation of dictionary in ``data_dict`` against dictionary in</span>
|
||||
<span class="sd"> ``schema_dict``. Argument deprecated is a dictionary that maps deprecated</span>
|
||||
<span class="sd"> configuration names to a messages::</span>
|
||||
|
||||
<span class="sd"> deprecated = {</span>
|
||||
<span class="sd"> "foo.bar" : "config 'foo.bar' is deprecated, use 'bar.foo'",</span>
|
||||
<span class="sd"> "..." : "..."</span>
|
||||
<span class="sd"> }</span>
|
||||
|
||||
<span class="sd"> The function returns a python tuple ``(is_valid, issue_list)``:</span>
|
||||
|
||||
<span class="sd"> ``is_valid``:</span>
|
||||
<span class="sd"> A bool value indicating ``data_dict`` is valid or not.</span>
|
||||
|
||||
<span class="sd"> ``issue_list``:</span>
|
||||
<span class="sd"> A list of messages (:py:obj:`SchemaIssue`) from the validation::</span>
|
||||
|
||||
<span class="sd"> [schema warn] data_dict: deprecated 'fontlib.foo': <DEPRECATED['foo.bar']></span>
|
||||
<span class="sd"> [schema invalid] data_dict: key unknown 'fontlib.foo'</span>
|
||||
<span class="sd"> [schema invalid] data_dict: type mismatch 'fontlib.foo': expected ..., is ...</span>
|
||||
|
||||
<span class="sd"> If ``schema_dict`` or ``data_dict`` is not a dictionary type a</span>
|
||||
<span class="sd"> :py:obj:`SchemaIssue` is raised.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">names</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="n">is_valid</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
<span class="n">issue_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">SchemaIssue</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">schema_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">'invalid'</span><span class="p">,</span> <span class="s2">"schema_dict is not a dict type"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">'invalid'</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"data_dict issue</span><span class="si">{</span><span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2"> is not a dict type"</span><span class="p">)</span>
|
||||
|
||||
<span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span> <span class="o">=</span> <span class="n">_validate</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">issue_list</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_validate</span><span class="p">(</span>
|
||||
<span class="n">names</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
||||
<span class="n">issue_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">SchemaIssue</span><span class="p">],</span>
|
||||
<span class="n">schema_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span>
|
||||
<span class="n">data_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span>
|
||||
<span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="n">SchemaIssue</span><span class="p">]]:</span>
|
||||
|
||||
<span class="n">is_valid</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
|
||||
<span class="n">data_value</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span>
|
||||
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">data_value</span> <span class="ow">in</span> <span class="n">data_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
|
||||
<span class="n">names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span>
|
||||
|
||||
<span class="n">deprecated_msg</span> <span class="o">=</span> <span class="n">deprecated</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="c1"># print("XXX %s: key %s // data_value: %s" % (name, key, data_value))</span>
|
||||
<span class="k">if</span> <span class="n">deprecated_msg</span><span class="p">:</span>
|
||||
<span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">'warn'</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"data_dict '</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">': deprecated - </span><span class="si">{</span><span class="n">deprecated_msg</span><span class="si">}</span><span class="s2">"</span><span class="p">))</span>
|
||||
|
||||
<span class="n">schema_value</span> <span class="o">=</span> <span class="n">value</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">)</span>
|
||||
<span class="c1"># print("YYY %s: key %s // schema_value: %s" % (name, key, schema_value))</span>
|
||||
<span class="k">if</span> <span class="n">schema_value</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">deprecated_msg</span><span class="p">:</span>
|
||||
<span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">'invalid'</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"data_dict '</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">': key unknown in schema_dict"</span><span class="p">))</span>
|
||||
<span class="n">is_valid</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
|
||||
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">schema_value</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">type</span><span class="p">(</span><span class="n">data_value</span><span class="p">):</span> <span class="c1"># pylint: disable=unidiomatic-typecheck</span>
|
||||
<span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
||||
<span class="n">SchemaIssue</span><span class="p">(</span>
|
||||
<span class="s1">'invalid'</span><span class="p">,</span>
|
||||
<span class="p">(</span><span class="sa">f</span><span class="s2">"data_dict: type mismatch '</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">':"</span> <span class="sa">f</span><span class="s2">" expected </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">schema_value</span><span class="p">)</span><span class="si">}</span><span class="s2">, is: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">data_value</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">),</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">is_valid</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
|
||||
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data_value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="n">_valid</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_validate</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">issue_list</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">,</span> <span class="n">data_value</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">)</span>
|
||||
<span class="n">is_valid</span> <span class="o">=</span> <span class="n">is_valid</span> <span class="ow">and</span> <span class="n">_valid</span>
|
||||
<span class="n">names</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">dict_deepupdate</span><span class="p">(</span><span class="n">base_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span> <span class="n">upd_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">],</span> <span class="n">names</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Deep-update of dictionary in ``base_dict`` by dictionary in ``upd_dict``.</span>
|
||||
|
||||
<span class="sd"> For each ``upd_key`` & ``upd_val`` pair in ``upd_dict``:</span>
|
||||
|
||||
<span class="sd"> 0. If types of ``base_dict[upd_key]`` and ``upd_val`` do not match raise a</span>
|
||||
<span class="sd"> :py:obj:`TypeError`.</span>
|
||||
|
||||
<span class="sd"> 1. If ``base_dict[upd_key]`` is a dict: recursively deep-update it by ``upd_val``.</span>
|
||||
|
||||
<span class="sd"> 2. If ``base_dict[upd_key]`` not exist: set ``base_dict[upd_key]`` from a</span>
|
||||
<span class="sd"> (deep-) copy of ``upd_val``.</span>
|
||||
|
||||
<span class="sd"> 3. If ``upd_val`` is a list, extend list in ``base_dict[upd_key]`` by the</span>
|
||||
<span class="sd"> list in ``upd_val``.</span>
|
||||
|
||||
<span class="sd"> 4. If ``upd_val`` is a set, update set in ``base_dict[upd_key]`` by set in</span>
|
||||
<span class="sd"> ``upd_val``.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># pylint: disable=too-many-branches</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"argument 'base_dict' is not a dictionary type"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"argument 'upd_dict' is not a dictionary type"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">names</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">upd_key</span><span class="p">,</span> <span class="n">upd_val</span> <span class="ow">in</span> <span class="n">upd_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
<span class="c1"># For each upd_key & upd_val pair in upd_dict:</span>
|
||||
|
||||
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
|
||||
<span class="c1"># if base_dict[upd_key] exists, recursively deep-update it</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"type mismatch </span><span class="si">{</span><span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a dict type in base_dict"</span><span class="p">)</span>
|
||||
<span class="n">dict_deepupdate</span><span class="p">(</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span>
|
||||
<span class="n">upd_val</span><span class="p">,</span> <span class="c1"># pyright: ignore[reportUnknownArgumentType]</span>
|
||||
<span class="n">names</span>
|
||||
<span class="o">+</span> <span class="p">[</span>
|
||||
<span class="n">upd_key</span><span class="p">,</span>
|
||||
<span class="p">],</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># if base_dict[upd_key] not exist, set base_dict[upd_key] from deepcopy of upd_val</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span> <span class="c1"># pyright: ignore[reportUnknownArgumentType]</span>
|
||||
|
||||
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
|
||||
<span class="c1"># if base_dict[upd_key] exists, base_dict[up_key] is extended by</span>
|
||||
<span class="c1"># the list from upd_val</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">list</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"type mismatch </span><span class="si">{</span><span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a list type in base_dict"</span><span class="p">)</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
|
||||
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># if base_dict[upd_key] doesn't exists, set base_dict[key] from a deepcopy of the</span>
|
||||
<span class="c1"># list in upd_val.</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span> <span class="c1"># pyright: ignore[reportUnknownArgumentType]</span>
|
||||
|
||||
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">set</span><span class="p">):</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
|
||||
<span class="c1"># if base_dict[upd_key] exists, base_dict[up_key] is updated by the set in upd_val</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">set</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"type mismatch </span><span class="si">{</span><span class="s1">'.'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a set type in base_dict"</span><span class="p">)</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">upd_val</span><span class="o">.</span><span class="n">copy</span><span class="p">())</span>
|
||||
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># if base_dict[upd_key] doesn't exists, set base_dict[upd_key] from a copy of the</span>
|
||||
<span class="c1"># set in upd_val</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">upd_val</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
|
||||
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># for any other type of upd_val replace or add base_dict[upd_key] by a copy</span>
|
||||
<span class="c1"># of upd_val</span>
|
||||
<span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
|
||||
</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 no-toc">
|
||||
|
||||
|
||||
|
||||
</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,574 @@
|
||||
<!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"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>searx.botdetection.http_sec_fetch - 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 no-toc" 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>
|
||||
<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 has-children"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/contribution_guide.html">How to contribute</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/engines/index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" 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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/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="../../../dev/result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/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="../../../dev/reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><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="../../../dev/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="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 no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<h1>Source code for searx.botdetection.http_sec_fetch</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="sd">Method ``http_sec_fetch``</span>
|
||||
<span class="sd">-------------------------</span>
|
||||
|
||||
<span class="sd">The ``http_sec_fetch`` method protect resources from web attacks with `Fetch</span>
|
||||
<span class="sd">Metadata`_. A request is filtered out in case of:</span>
|
||||
|
||||
<span class="sd">- http header Sec-Fetch-Mode_ is invalid</span>
|
||||
<span class="sd">- http header Sec-Fetch-Dest_ is invalid</span>
|
||||
|
||||
<span class="sd">.. _Fetch Metadata:</span>
|
||||
<span class="sd"> https://developer.mozilla.org/en-US/docs/Glossary/Fetch_metadata_request_header</span>
|
||||
|
||||
<span class="sd">.. _Sec-Fetch-Dest:</span>
|
||||
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/API/Request/destination</span>
|
||||
|
||||
<span class="sd">.. _Sec-Fetch-Mode:</span>
|
||||
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/API/Request/mode</span>
|
||||
|
||||
|
||||
<span class="sd">"""</span>
|
||||
<span class="c1"># pylint: disable=unused-argument</span>
|
||||
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">IPv4Network</span><span class="p">,</span>
|
||||
<span class="n">IPv6Network</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">werkzeug</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="is_browser_supported">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.http_sec_fetch.is_browser_supported">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">is_browser_supported</span><span class="p">(</span><span class="n">user_agent</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Check if the browser supports Sec-Fetch headers.</span>
|
||||
|
||||
<span class="sd"> https://caniuse.com/mdn-http_headers_sec-fetch-dest</span>
|
||||
<span class="sd"> https://caniuse.com/mdn-http_headers_sec-fetch-mode</span>
|
||||
<span class="sd"> https://caniuse.com/mdn-http_headers_sec-fetch-site</span>
|
||||
|
||||
<span class="sd"> Supported browsers:</span>
|
||||
<span class="sd"> - Chrome >= 80</span>
|
||||
<span class="sd"> - Firefox >= 90</span>
|
||||
<span class="sd"> - Safari >= 16.4</span>
|
||||
<span class="sd"> - Edge (mirrors Chrome)</span>
|
||||
<span class="sd"> - Opera (mirrors Chrome)</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">user_agent</span> <span class="o">=</span> <span class="n">user_agent</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
||||
|
||||
<span class="c1"># Chrome/Chromium/Edge/Opera</span>
|
||||
<span class="n">chrome_match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="sa">r</span><span class="s1">'chrome/(\d+)'</span><span class="p">,</span> <span class="n">user_agent</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">chrome_match</span><span class="p">:</span>
|
||||
<span class="n">version</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">chrome_match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="mi">80</span>
|
||||
|
||||
<span class="c1"># Firefox</span>
|
||||
<span class="n">firefox_match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="sa">r</span><span class="s1">'firefox/(\d+)'</span><span class="p">,</span> <span class="n">user_agent</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">firefox_match</span><span class="p">:</span>
|
||||
<span class="n">version</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">firefox_match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">version</span> <span class="o">>=</span> <span class="mi">90</span>
|
||||
|
||||
<span class="c1"># Safari</span>
|
||||
<span class="n">safari_match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="sa">r</span><span class="s1">'version/(\d+)\.(\d+)'</span><span class="p">,</span> <span class="n">user_agent</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">safari_match</span><span class="p">:</span>
|
||||
<span class="n">major</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">safari_match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
|
||||
<span class="n">minor</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">safari_match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">major</span> <span class="o">></span> <span class="mi">16</span> <span class="ow">or</span> <span class="p">(</span><span class="n">major</span> <span class="o">==</span> <span class="mi">16</span> <span class="ow">and</span> <span class="n">minor</span> <span class="o">>=</span> <span class="mi">4</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="kc">False</span></div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">filter_request</span><span class="p">(</span>
|
||||
<span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span>
|
||||
<span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">,</span>
|
||||
<span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">werkzeug</span><span class="o">.</span><span class="n">Response</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">request</span><span class="o">.</span><span class="n">is_secure</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
|
||||
<span class="s2">"Sec-Fetch cannot be verified for non-secure requests (HTTP headers are not set/sent by the client)."</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="c1"># Only check Sec-Fetch headers for supported browsers</span>
|
||||
<span class="n">user_agent</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'User-Agent'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">is_browser_supported</span><span class="p">(</span><span class="n">user_agent</span><span class="p">):</span>
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"Sec-Fetch-Mode"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">val</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'navigate'</span><span class="p">,</span> <span class="s1">'cors'</span><span class="p">):</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"invalid Sec-Fetch-Mode '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">flask</span><span class="o">.</span><span class="n">redirect</span><span class="p">(</span><span class="n">flask</span><span class="o">.</span><span class="n">url_for</span><span class="p">(</span><span class="s1">'index'</span><span class="p">),</span> <span class="n">code</span><span class="o">=</span><span class="mi">302</span><span class="p">)</span>
|
||||
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"Sec-Fetch-Site"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">val</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'same-origin'</span><span class="p">,</span> <span class="s1">'same-site'</span><span class="p">,</span> <span class="s1">'none'</span><span class="p">):</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"invalid Sec-Fetch-Site '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
|
||||
<span class="n">flask</span><span class="o">.</span><span class="n">redirect</span><span class="p">(</span><span class="n">flask</span><span class="o">.</span><span class="n">url_for</span><span class="p">(</span><span class="s1">'index'</span><span class="p">),</span> <span class="n">code</span><span class="o">=</span><span class="mi">302</span><span class="p">)</span>
|
||||
|
||||
<span class="n">val</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"Sec-Fetch-Dest"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">val</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'document'</span><span class="p">,</span> <span class="s1">'empty'</span><span class="p">):</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"invalid Sec-Fetch-Dest '</span><span class="si">%s</span><span class="s2">'"</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
|
||||
<span class="n">flask</span><span class="o">.</span><span class="n">redirect</span><span class="p">(</span><span class="n">flask</span><span class="o">.</span><span class="n">url_for</span><span class="p">(</span><span class="s1">'index'</span><span class="p">),</span> <span class="n">code</span><span class="o">=</span><span class="mi">302</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
|
||||
</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 no-toc">
|
||||
|
||||
|
||||
|
||||
</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,554 @@
|
||||
<!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"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>searx.botdetection.ip_lists - 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 no-toc" 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>
|
||||
<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 has-children"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/contribution_guide.html">How to contribute</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/engines/index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" 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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/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="../../../dev/result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/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="../../../dev/reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><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="../../../dev/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="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 no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<h1>Source code for searx.botdetection.ip_lists</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">""".. _botdetection.ip_lists:</span>
|
||||
|
||||
<span class="sd">Method ``ip_lists``</span>
|
||||
<span class="sd">-------------------</span>
|
||||
|
||||
<span class="sd">The ``ip_lists`` method implements :py:obj:`block-list <block_ip>` and</span>
|
||||
<span class="sd">:py:obj:`pass-list <pass_ip>`.</span>
|
||||
|
||||
<span class="sd">.. code:: toml</span>
|
||||
|
||||
<span class="sd"> [botdetection.ip_lists]</span>
|
||||
|
||||
<span class="sd"> pass_ip = [</span>
|
||||
<span class="sd"> '167.235.158.251', # IPv4 of check.searx.space</span>
|
||||
<span class="sd"> '192.168.0.0/16', # IPv4 private network</span>
|
||||
<span class="sd"> 'fe80::/10', # IPv6 linklocal</span>
|
||||
<span class="sd"> ]</span>
|
||||
|
||||
<span class="sd"> block_ip = [</span>
|
||||
<span class="sd"> '93.184.216.34', # IPv4 of example.org</span>
|
||||
<span class="sd"> '257.1.1.1', # invalid IP --> will be ignored, logged in ERROR class</span>
|
||||
<span class="sd"> ]</span>
|
||||
|
||||
<span class="sd">"""</span>
|
||||
<span class="c1"># pylint: disable=unused-argument</span>
|
||||
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tuple</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">ip_network</span><span class="p">,</span>
|
||||
<span class="n">IPv4Address</span><span class="p">,</span>
|
||||
<span class="n">IPv6Address</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
|
||||
|
||||
<span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">'ip_limit'</span><span class="p">)</span>
|
||||
|
||||
<span class="n">SEARXNG_ORG</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="c1"># https://github.com/searxng/searxng/pull/2484#issuecomment-1576639195</span>
|
||||
<span class="s1">'167.235.158.251'</span><span class="p">,</span> <span class="c1"># IPv4 check.searx.space</span>
|
||||
<span class="s1">'2a01:04f8:1c1c:8fc2::/64'</span><span class="p">,</span> <span class="c1"># IPv6 check.searx.space</span>
|
||||
<span class="p">]</span>
|
||||
<span class="sd">"""Passlist of IPs from the SearXNG organization, e.g. `check.searx.space`."""</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="pass_ip">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ip_lists.pass_ip">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">pass_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Checks if the IP on the subnet is in one of the members of the</span>
|
||||
<span class="sd"> ``botdetection.ip_lists.pass_ip`` list.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'botdetection.ip_lists.pass_searxng_org'</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
||||
<span class="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="n">SEARXNG_ORG</span><span class="p">:</span>
|
||||
<span class="n">net</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="n">net</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="n">net</span><span class="o">.</span><span class="n">version</span> <span class="ow">and</span> <span class="n">real_ip</span> <span class="ow">in</span> <span class="n">net</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"IP matches </span><span class="si">{</span><span class="n">net</span><span class="o">.</span><span class="n">compressed</span><span class="si">}</span><span class="s2"> in SEARXNG_ORG list."</span>
|
||||
<span class="k">return</span> <span class="n">ip_is_subnet_of_member_in_list</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="s1">'botdetection.ip_lists.pass_ip'</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="block_ip">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ip_lists.block_ip">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">block_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Checks if the IP on the subnet is in one of the members of the</span>
|
||||
<span class="sd"> ``botdetection.ip_lists.block_ip`` list.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">block</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">ip_is_subnet_of_member_in_list</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="s1">'botdetection.ip_lists.block_ip'</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">block</span><span class="p">:</span>
|
||||
<span class="n">msg</span> <span class="o">+=</span> <span class="s2">" To remove IP from list, please contact the maintainer of the service."</span>
|
||||
<span class="k">return</span> <span class="n">block</span><span class="p">,</span> <span class="n">msg</span></div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">ip_is_subnet_of_member_in_list</span><span class="p">(</span>
|
||||
<span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">list_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">list_name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="p">[]):</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">net</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="n">net</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"invalid IP </span><span class="si">%s</span><span class="s2"> in </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">net</span><span class="p">,</span> <span class="n">list_name</span><span class="p">)</span>
|
||||
<span class="k">continue</span>
|
||||
<span class="k">if</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="n">net</span><span class="o">.</span><span class="n">version</span> <span class="ow">and</span> <span class="n">real_ip</span> <span class="ow">in</span> <span class="n">net</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"IP matches </span><span class="si">{</span><span class="n">net</span><span class="o">.</span><span class="n">compressed</span><span class="si">}</span><span class="s2"> in </span><span class="si">{</span><span class="n">list_name</span><span class="si">}</span><span class="s2">."</span>
|
||||
<span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"IP is not a member of an item in the f</span><span class="si">{</span><span class="n">list_name</span><span class="si">}</span><span class="s2"> list"</span>
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
|
||||
</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 no-toc">
|
||||
|
||||
|
||||
|
||||
</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,632 @@
|
||||
<!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"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>searx.botdetection.link_token - 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 no-toc" 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>
|
||||
<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 has-children"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/contribution_guide.html">How to contribute</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/engines/index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" 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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/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="../../../dev/result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/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="../../../dev/reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><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="../../../dev/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="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 no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<h1>Source code for searx.botdetection.link_token</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="sd">Method ``link_token``</span>
|
||||
<span class="sd">---------------------</span>
|
||||
|
||||
<span class="sd">The ``link_token`` method evaluates a request as :py:obj:`suspicious</span>
|
||||
<span class="sd"><is_suspicious>` if the URL ``/client<token>.css`` is not requested by the</span>
|
||||
<span class="sd">client. By adding a random component (the token) in the URL, a bot can not send</span>
|
||||
<span class="sd">a ping by request a static URL.</span>
|
||||
|
||||
<span class="sd">.. note::</span>
|
||||
|
||||
<span class="sd"> This method requires a valkey DB and needs a HTTP X-Forwarded-For_ header.</span>
|
||||
|
||||
<span class="sd">To get in use of this method a flask URL route needs to be added:</span>
|
||||
|
||||
<span class="sd">.. code:: python</span>
|
||||
|
||||
<span class="sd"> @app.route('/client<token>.css', methods=['GET', 'POST'])</span>
|
||||
<span class="sd"> def client_token(token=None):</span>
|
||||
<span class="sd"> link_token.ping(request, token)</span>
|
||||
<span class="sd"> return Response('', mimetype='text/css')</span>
|
||||
|
||||
<span class="sd">And in the HTML template from flask a stylesheet link is needed (the value of</span>
|
||||
<span class="sd">``link_token`` comes from :py:obj:`get_token`):</span>
|
||||
|
||||
<span class="sd">.. code:: html</span>
|
||||
|
||||
<span class="sd"> <link rel="stylesheet"</span>
|
||||
<span class="sd"> href="{{ url_for('client_token', token=link_token) }}"</span>
|
||||
<span class="sd"> type="text/css" ></span>
|
||||
|
||||
<span class="sd">.. _X-Forwarded-For:</span>
|
||||
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For</span>
|
||||
|
||||
<span class="sd">"""</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">IPv4Network</span><span class="p">,</span>
|
||||
<span class="n">IPv6Network</span><span class="p">,</span>
|
||||
<span class="n">ip_address</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">string</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">random</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.valkeylib</span><span class="w"> </span><span class="kn">import</span> <span class="n">secret_hash</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">get_network</span><span class="p">,</span>
|
||||
<span class="n">logger</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">valkeydb</span>
|
||||
|
||||
<span class="n">TOKEN_LIVE_TIME</span> <span class="o">=</span> <span class="mi">600</span>
|
||||
<span class="sd">"""Lifetime (sec) of limiter's CSS token."""</span>
|
||||
|
||||
<span class="n">PING_LIVE_TIME</span> <span class="o">=</span> <span class="mi">3600</span>
|
||||
<span class="sd">"""Lifetime (sec) of the ping-key from a client (request)"""</span>
|
||||
|
||||
<span class="n">PING_KEY</span> <span class="o">=</span> <span class="s1">'SearXNG_limiter.ping'</span>
|
||||
<span class="sd">"""Prefix of all ping-keys generated by :py:obj:`get_ping_key`"""</span>
|
||||
|
||||
<span class="n">TOKEN_KEY</span> <span class="o">=</span> <span class="s1">'SearXNG_limiter.token'</span>
|
||||
<span class="sd">"""Key for which the current token is stored in the DB"""</span>
|
||||
|
||||
<span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">'botdetection.link_token'</span><span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="is_suspicious">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.is_suspicious">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">is_suspicious</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">,</span> <span class="n">renew</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Checks whether a valid ping is exists for this (client) network, if not</span>
|
||||
<span class="sd"> this request is rated as *suspicious*. If a valid ping exists and argument</span>
|
||||
<span class="sd"> ``renew`` is ``True`` the expire time of this ping is reset to</span>
|
||||
<span class="sd"> :py:obj:`PING_LIVE_TIME`.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">valkey_client</span> <span class="o">=</span> <span class="n">valkeydb</span><span class="o">.</span><span class="n">get_valkey_client</span><span class="p">()</span>
|
||||
<span class="n">ping_key</span> <span class="o">=</span> <span class="n">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">valkey_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">ping_key</span><span class="p">):</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"missing ping (IP: </span><span class="si">%s</span><span class="s2">) / request: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">ping_key</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="kc">True</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">renew</span><span class="p">:</span>
|
||||
<span class="n">valkey_client</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping_key</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="n">PING_LIVE_TIME</span><span class="p">)</span>
|
||||
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"found ping for (client) network </span><span class="si">%s</span><span class="s2"> -> </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">ping_key</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="kc">False</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ping">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.ping">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">ping</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">,</span> <span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""This function is called by a request to URL ``/client<token>.css``. If</span>
|
||||
<span class="sd"> ``token`` is valid a :py:obj:`PING_KEY` for the client is stored in the DB.</span>
|
||||
<span class="sd"> The expire time of this ping-key is :py:obj:`PING_LIVE_TIME`.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">valkey_client</span> <span class="o">=</span> <span class="n">valkeydb</span><span class="o">.</span><span class="n">get_valkey_client</span><span class="p">()</span>
|
||||
<span class="n">cfg</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">get_global_cfg</span><span class="p">()</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">token_is_valid</span><span class="p">(</span><span class="n">token</span><span class="p">):</span>
|
||||
<span class="k">return</span>
|
||||
|
||||
<span class="n">real_ip</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">remote_addr</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
||||
<span class="n">network</span> <span class="o">=</span> <span class="n">get_network</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
|
||||
|
||||
<span class="n">ping_key</span> <span class="o">=</span> <span class="n">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
|
||||
<span class="s2">"store ping_key for (client) network </span><span class="si">%s</span><span class="s2"> (IP </span><span class="si">%s</span><span class="s2">) -> </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">ping_key</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">valkey_client</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping_key</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="n">PING_LIVE_TIME</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="get_ping_key">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.get_ping_key">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Generates a hashed key that fits (more or less) to a *WEB-browser</span>
|
||||
<span class="sd"> session* in a network."""</span>
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
<span class="n">PING_KEY</span>
|
||||
<span class="o">+</span> <span class="s2">"["</span>
|
||||
<span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span>
|
||||
<span class="n">network</span><span class="o">.</span><span class="n">compressed</span> <span class="o">+</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Accept-Language'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> <span class="o">+</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'User-Agent'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
<span class="o">+</span> <span class="s2">"]"</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">token_is_valid</span><span class="p">(</span><span class="n">token</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="n">valid</span> <span class="o">=</span> <span class="n">token</span> <span class="o">==</span> <span class="n">get_token</span><span class="p">()</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"token is valid --> </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">valid</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">valid</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="get_token">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.get_token">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_token</span><span class="p">()</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns current token. If there is no currently active token a new token</span>
|
||||
<span class="sd"> is generated randomly and stored in the Valkey DB. Without without a</span>
|
||||
<span class="sd"> database connection, string "12345678" is returned.</span>
|
||||
|
||||
<span class="sd"> - :py:obj:`TOKEN_LIVE_TIME`</span>
|
||||
<span class="sd"> - :py:obj:`TOKEN_KEY`</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">valkey_client</span> <span class="o">=</span> <span class="n">valkeydb</span><span class="o">.</span><span class="n">get_valkey_client</span><span class="p">()</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="c1"># This function is also called when limiter is inactive / no valkey DB</span>
|
||||
<span class="c1"># (see render function in webapp.py)</span>
|
||||
<span class="k">return</span> <span class="s1">'12345678'</span>
|
||||
|
||||
<span class="n">token</span> <span class="o">=</span> <span class="n">valkey_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">TOKEN_KEY</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">token</span><span class="p">:</span>
|
||||
<span class="n">token</span> <span class="o">=</span> <span class="n">token</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">token</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">string</span><span class="o">.</span><span class="n">ascii_lowercase</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">16</span><span class="p">))</span>
|
||||
<span class="n">valkey_client</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">TOKEN_KEY</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="n">TOKEN_LIVE_TIME</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">token</span></div>
|
||||
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
|
||||
</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 no-toc">
|
||||
|
||||
|
||||
|
||||
</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,643 @@
|
||||
<!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"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
|
||||
<link rel="prefetch" href="../../../_static/searxng-wordmark.svg" as="image">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>searx.botdetection.trusted_proxies - 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 no-toc" 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>
|
||||
<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 has-children"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a><input aria-label="Toggle navigation of Developer documentation" 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/quickstart.html">Development Quickstart</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/commits.html">Git Commits & Change Management</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/contribution_guide.html">How to contribute</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/extended_types.html">Extended Types</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/engines/index.html">Engine Implementations</a><input aria-label="Toggle navigation of Engine Implementations" 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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/enginelib.html">Engine Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engines.html">SearXNG’s engines loader</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/engine_overview.html">Engine Overview</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_online.html">Demo Online Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/xpath.html">XPath Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/mediawiki.html">MediaWiki Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/json_engine.html">JSON Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/adobe_stock.html">Adobe Stock</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/alpinelinux.html">Alpine Linux Packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/annas_archive.html">Anna’s Archive</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/aol.html">AOL</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/archlinux.html">Arch Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/arxiv.html">arXiv</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/astrophysics_data_system.html">Astrophysics Data System (ADS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/azure.html">Azure Resources</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bing.html">Bing Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bpb.html">Bpb</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/brave.html">Brave Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/bt4g.html">BT4G</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/chinaso.html">ChinaSo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/core.html">CORE</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/crossref.html">Crossref</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/dailymotion.html">Dailymotion</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/discourse.html">Discourse Forums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/duckduckgo.html">DuckDuckGo Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/geizhals.html">Geizhals</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitea.html">Gitea</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/github_code.html">Github Code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/gitlab.html">GitLab</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/google.html">Google Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/huggingface.html">Hugging Face</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/karmasearch.html">Karmasearch</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/lemmy.html">Lemmy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/loc.html">Library of Congress</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/marginalia.html">Marginalia Search</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mastodon.html">Mastodon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/moviepilot.html">Moviepilot</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mrs.html">Matrix Rooms Search (MRS)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/mwmbl.html">Mwmbl Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/odysee.html">Odysee</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openalex.html">OpenAlex</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/openlibrary.html">Open Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/peertube.html">Peertube Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/piped.html">Piped</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/presearch.html">Presearch Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/pubmed.html">PubMed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/qwant.html">Qwant</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/radio_browser.html">RadioBrowser</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/recoll.html">Recoll Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/repology.html">Repology</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/reuters.html">Reuters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/semantic_scholar.html">Semantic Scholar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/soundcloud.html">Soundcloud</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/sourcehut.html">Sourcehut</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/springer.html">Springer Nature</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/startpage.html">Startpage Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tagesschau.html">Tagesschau API</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/torznab.html">Torznab WebAPI</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/tubearchivist.html">Tube Archivist</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/void.html">Void Linux binary packages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wallhaven.html">Wallhaven</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/wikipedia.html">Wikimedia</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yacy.html">Yacy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/yahoo.html">Yahoo Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online/zlibrary.html">Z-Library</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline_concept.html">Offline Concept</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/demo/demo_offline.html">Demo Offline Engine</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/command-line-engines.html">Command Line Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/nosql-engines.html">NoSQL databases</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/search-indexer-engines.html">Local Search APIs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/offline/sql-engines.html">SQL Engines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/engines/online_url_search/tineye.html">Tineye</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/result_types/base_result.html">Result</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/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="../../../dev/result_types/main/keyvalue.html">Key-Value Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/code.html">Code Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/paper.html">Paper Results</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/result_types/main/file.html">File Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/answer.html">Answer Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/correction.html">Correction Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/suggestion.html">Suggestion Results</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../dev/result_types/infobox.html">Infobox Results</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/templates.html">Simple Theme Templates</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/search_api.html">Search API</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/development.html">Plugin Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/plugins/calculator.html">Calculator</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hash_plugin.html">Hash Values</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/hostnames.html">Hostnames</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/infinite_scroll.html">Infinite scroll</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/self_info.html">Self-Info</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/tor_check.html">Tor check</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/unit_converter.html">Unit Converter</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/plugins/time_zone.html">Time Zone</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/development.html">Answerer Development</a></li>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../dev/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="../../../dev/answerers/random.html">Random</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../dev/answerers/statistics.html">Statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/translation.html">Translation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../dev/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="../../../dev/reST.html">reST primer</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../dev/searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><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="../../../dev/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="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 no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<h1>Source code for searx.botdetection.trusted_proxies</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Implementation of a middleware to determine the real IP of an HTTP request</span>
|
||||
<span class="sd">(:py:obj:`flask.request.remote_addr`) behind a proxy chain."""</span>
|
||||
<span class="c1"># pylint: disable=too-many-branches</span>
|
||||
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">abc</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="n">IPv4Address</span><span class="p">,</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">ip_address</span><span class="p">,</span> <span class="n">ip_network</span><span class="p">,</span> <span class="n">IPv4Network</span><span class="p">,</span> <span class="n">IPv6Network</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">werkzeug.http</span><span class="w"> </span><span class="kn">import</span> <span class="n">parse_list_header</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">log_error_only_once</span><span class="p">,</span> <span class="n">logger</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">_typeshed.wsgi</span><span class="w"> </span><span class="kn">import</span> <span class="n">StartResponse</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">_typeshed.wsgi</span><span class="w"> </span><span class="kn">import</span> <span class="n">WSGIApplication</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">_typeshed.wsgi</span><span class="w"> </span><span class="kn">import</span> <span class="n">WSGIEnvironment</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ProxyFix">
|
||||
<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ProxyFix">[docs]</a>
|
||||
<span class="nd">@t</span><span class="o">.</span><span class="n">final</span>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">ProxyFix</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""A middleware like the ProxyFix_ class, where the ``x_for`` argument is</span>
|
||||
<span class="sd"> replaced by a method that determines the number of trusted proxies via the</span>
|
||||
<span class="sd"> ``botdetection.trusted_proxies`` setting.</span>
|
||||
|
||||
<span class="sd"> .. sidebar:: :py:obj:`flask.Request.remote_addr`</span>
|
||||
|
||||
<span class="sd"> SearXNG uses Werkzeug's ProxyFix_ (with it default ``x_for=1``).</span>
|
||||
|
||||
<span class="sd"> The remote IP (:py:obj:`flask.Request.remote_addr`) of the request is taken</span>
|
||||
<span class="sd"> from (first match):</span>
|
||||
|
||||
<span class="sd"> - X-Forwarded-For_: If the header is set, the first untrusted IP that comes</span>
|
||||
<span class="sd"> before the IPs that are still part of the ``botdetection.trusted_proxies``</span>
|
||||
<span class="sd"> is used.</span>
|
||||
|
||||
<span class="sd"> - `X-Real-IP <https://github.com/searxng/searxng/issues/1237#issuecomment-1147564516>`__:</span>
|
||||
<span class="sd"> If X-Forwarded-For_ is not set, `X-Real-IP` is used</span>
|
||||
<span class="sd"> (``botdetection.trusted_proxies`` is ignored).</span>
|
||||
|
||||
<span class="sd"> If none of the header is set, the REMOTE_ADDR_ from the WSGI layer is used.</span>
|
||||
<span class="sd"> If (for whatever reasons) none IP can be determined, an error message is</span>
|
||||
<span class="sd"> displayed and ``100::`` is used instead (:rfc:`6666`).</span>
|
||||
|
||||
<span class="sd"> .. _ProxyFix:</span>
|
||||
<span class="sd"> https://werkzeug.palletsprojects.com/middleware/proxy_fix/</span>
|
||||
|
||||
<span class="sd"> .. _X-Forwarded-For:</span>
|
||||
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For</span>
|
||||
|
||||
<span class="sd"> .. _REMOTE_ADDR:</span>
|
||||
<span class="sd"> https://wsgi.readthedocs.io/en/latest/proposals-2.0.html#making-some-keys-required</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wsgi_app</span><span class="p">:</span> <span class="s2">"WSGIApplication"</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">wsgi_app</span> <span class="o">=</span> <span class="n">wsgi_app</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">trusted_proxies</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">list</span><span class="p">[</span><span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">]:</span>
|
||||
<span class="n">cfg</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">get_global_cfg</span><span class="p">()</span>
|
||||
<span class="n">proxy_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"botdetection.trusted_proxies"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="p">[])</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">ip_network</span><span class="p">(</span><span class="n">net</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="n">proxy_list</span><span class="p">]</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">trusted_remote_addr</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">x_forwarded_for</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">],</span>
|
||||
<span class="n">trusted_proxies</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">],</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="c1"># always rtl</span>
|
||||
<span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="n">x_forwarded_for</span><span class="p">):</span>
|
||||
<span class="n">trust</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="n">trusted_proxies</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="n">net</span><span class="o">.</span><span class="n">version</span> <span class="ow">and</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">net</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"trust proxy </span><span class="si">%s</span><span class="s2"> (member of </span><span class="si">%s</span><span class="s2">)"</span><span class="p">,</span> <span class="n">addr</span><span class="p">,</span> <span class="n">net</span><span class="p">)</span>
|
||||
<span class="n">trust</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
<span class="k">break</span>
|
||||
|
||||
<span class="c1"># client address</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">trust</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">addr</span><span class="o">.</span><span class="n">compressed</span>
|
||||
|
||||
<span class="c1"># fallback to first address</span>
|
||||
<span class="k">return</span> <span class="n">x_forwarded_for</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">compressed</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">:</span> <span class="s2">"WSGIEnvironment"</span><span class="p">,</span> <span class="n">start_response</span><span class="p">:</span> <span class="s2">"StartResponse"</span><span class="p">)</span> <span class="o">-></span> <span class="n">abc</span><span class="o">.</span><span class="n">Iterable</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]:</span>
|
||||
<span class="c1"># pylint: disable=too-many-statements</span>
|
||||
|
||||
<span class="n">trusted_proxies</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">trusted_proxies</span><span class="p">()</span>
|
||||
|
||||
<span class="c1"># We do not rely on the REMOTE_ADDR from the WSGI environment / the</span>
|
||||
<span class="c1"># variable is first removed from the WSGI environment and explicitly set</span>
|
||||
<span class="c1"># in this function!</span>
|
||||
|
||||
<span class="n">orig_remote_addr</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"REMOTE_ADDR"</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Validate the IPs involved in this game and delete all invalid ones</span>
|
||||
<span class="c1"># from the WSGI environment.</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">orig_remote_addr</span><span class="p">:</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">addr</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">orig_remote_addr</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">6</span> <span class="ow">and</span> <span class="n">addr</span><span class="o">.</span><span class="n">ipv4_mapped</span><span class="p">:</span>
|
||||
<span class="n">addr</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">ipv4_mapped</span>
|
||||
<span class="n">orig_remote_addr</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">compressed</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"REMOTE_ADDR: </span><span class="si">%s</span><span class="s2"> / discard REMOTE_ADDR from WSGI environment"</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
|
||||
<span class="n">orig_remote_addr</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">x_real_ip</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"HTTP_X_REAL_IP"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">x_real_ip</span><span class="p">:</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">addr</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">x_real_ip</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">6</span> <span class="ow">and</span> <span class="n">addr</span><span class="o">.</span><span class="n">ipv4_mapped</span><span class="p">:</span>
|
||||
<span class="n">addr</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">ipv4_mapped</span>
|
||||
<span class="n">x_real_ip</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">compressed</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"X-Real-IP: </span><span class="si">%s</span><span class="s2"> / discard HTTP_X_REAL_IP from WSGI environment"</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
|
||||
<span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"HTTP_X_REAL_IP"</span><span class="p">)</span>
|
||||
<span class="n">x_real_ip</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">x_forwarded_for</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="k">if</span> <span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"HTTP_X_FORWARDED_FOR"</span><span class="p">):</span>
|
||||
<span class="k">for</span> <span class="n">x_for_ip</span> <span class="ow">in</span> <span class="n">parse_list_header</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"HTTP_X_FORWARDED_FOR"</span><span class="p">))):</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">addr</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">x_for_ip</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"X-Forwarded-For: </span><span class="si">%s</span><span class="s2"> / discard HTTP_X_FORWARDED_FOR from WSGI environment"</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
|
||||
<span class="n">environ</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"HTTP_X_FORWARDED_FOR"</span><span class="p">)</span>
|
||||
<span class="n">x_forwarded_for</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="k">break</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">addr</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">6</span> <span class="ow">and</span> <span class="n">addr</span><span class="o">.</span><span class="n">ipv4_mapped</span><span class="p">:</span>
|
||||
<span class="n">addr</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">ipv4_mapped</span>
|
||||
<span class="n">x_forwarded_for</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">addr</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># log questionable WSGI environments</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">x_forwarded_for</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">x_real_ip</span><span class="p">:</span>
|
||||
<span class="n">log_error_only_once</span><span class="p">(</span><span class="s2">"X-Forwarded-For nor X-Real-IP header is set!"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">x_forwarded_for</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">trusted_proxies</span><span class="p">:</span>
|
||||
<span class="n">log_error_only_once</span><span class="p">(</span><span class="s2">"missing botdetection.trusted_proxies config"</span><span class="p">)</span>
|
||||
<span class="c1"># without trusted_proxies, this variable is useless for determining</span>
|
||||
<span class="c1"># the real IP</span>
|
||||
<span class="n">x_forwarded_for</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
||||
<span class="c1"># securing the WSGI environment variables that are adjusted</span>
|
||||
|
||||
<span class="n">environ</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s2">"botdetection.trusted_proxies.orig"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"REMOTE_ADDR"</span><span class="p">:</span> <span class="n">orig_remote_addr</span><span class="p">}})</span>
|
||||
|
||||
<span class="c1"># determine *the real IP*</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">x_forwarded_for</span><span class="p">:</span>
|
||||
<span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">trusted_remote_addr</span><span class="p">(</span><span class="n">x_forwarded_for</span><span class="p">,</span> <span class="n">trusted_proxies</span><span class="p">)</span>
|
||||
|
||||
<span class="k">elif</span> <span class="n">x_real_ip</span><span class="p">:</span>
|
||||
<span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">]</span> <span class="o">=</span> <span class="n">x_real_ip</span>
|
||||
|
||||
<span class="k">elif</span> <span class="n">orig_remote_addr</span><span class="p">:</span>
|
||||
<span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">]</span> <span class="o">=</span> <span class="n">orig_remote_addr</span>
|
||||
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"No remote IP could be determined, use black-hole address: 100::"</span><span class="p">)</span>
|
||||
<span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"100::"</span>
|
||||
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">_</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">])</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"REMOTE_ADDR: </span><span class="si">%s</span><span class="s2">, use black-hole address: 100::"</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
|
||||
<span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"100::"</span>
|
||||
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"final REMOTE_ADDR is: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">environ</span><span class="p">[</span><span class="s2">"REMOTE_ADDR"</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wsgi_app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span></div>
|
||||
|
||||
</pre></div>
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
|
||||
|
||||
</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 no-toc">
|
||||
|
||||
|
||||
|
||||
</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