forked from zaclys/searxng
202 lines
9.1 KiB
HTML
202 lines
9.1 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
|
|||
|
|
<html lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|||
|
|
<title>Plugins builtin — SearXNG Documentation (2023.8.11+905ce2a6f)</title>
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" />
|
|||
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=3c88bde0"></script>
|
|||
|
|
<script src="../_static/doctools.js?v=888ff710"></script>
|
|||
|
|
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
|||
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../search.html" />
|
|||
|
|
<link rel="next" title="Buildhosts" href="buildhosts.html" />
|
|||
|
|
<link rel="prev" title="Architecture" href="architecture.html" />
|
|||
|
|
</head><body>
|
|||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|||
|
|
<h3>Navigation</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li class="right" style="margin-right: 10px">
|
|||
|
|
<a href="../genindex.html" title="General Index"
|
|||
|
|
accesskey="I">index</a></li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|||
|
|
>modules</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="buildhosts.html" title="Buildhosts"
|
|||
|
|
accesskey="N">next</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="architecture.html" title="Architecture"
|
|||
|
|
accesskey="P">previous</a> |</li>
|
|||
|
|
<li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2023.8.11+905ce2a6f)</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-this"><a href="">Plugins builtin</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="document">
|
|||
|
|
<div class="documentwrapper">
|
|||
|
|
<div class="bodywrapper">
|
|||
|
|
<div class="body" role="main">
|
|||
|
|
|
|||
|
|
<section id="plugins-builtin">
|
|||
|
|
<span id="plugins-generic"></span><h1>Plugins builtin<a class="headerlink" href="#plugins-builtin" title="Permalink to this heading">¶</a></h1>
|
|||
|
|
<aside class="sidebar">
|
|||
|
|
<p class="sidebar-title">Further reading ..</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><a class="reference internal" href="../dev/plugins.html#dev-plugin"><span class="std std-ref">Plugins</span></a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</aside>
|
|||
|
|
<p>Configuration defaults (at built time):</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">DO<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Default on</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<span id="configured-plugins"></span><table class="docutils align-default" id="id1">
|
|||
|
|
<caption><span class="caption-number">Table 1 </span><span class="caption-text">Plugins configured at built time (defaults)</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 23%" />
|
|||
|
|
<col style="width: 8%" />
|
|||
|
|
<col style="width: 69%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head stub"><p>Name</p></th>
|
|||
|
|
<th class="head"><p>DO</p></th>
|
|||
|
|
<th class="head"><p>Description</p>
|
|||
|
|
<p>JS & CSS dependencies</p>
|
|||
|
|
</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><th class="stub"><p>Hash plugin</p></th>
|
|||
|
|
<td><p>y</p></td>
|
|||
|
|
<td><p>Converts strings to different hash digests.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><th class="stub"><p>Hostname replace</p></th>
|
|||
|
|
<td></td>
|
|||
|
|
<td><p>Rewrite result hostnames or remove results based on the hostname</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><th class="stub"><p>Open Access DOI rewrite</p></th>
|
|||
|
|
<td></td>
|
|||
|
|
<td><p>Avoid paywalls by redirecting to open-access versions of publications when available</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><th class="stub"><p>Search on category select</p></th>
|
|||
|
|
<td><p>y</p></td>
|
|||
|
|
<td><p>Perform search immediately if a category selected. Disable to select multiple categories. (JavaScript required)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><th class="stub"><p>Self Information</p></th>
|
|||
|
|
<td><p>y</p></td>
|
|||
|
|
<td><p>Displays your IP if the query is “ip” and your user agent if the query contains “user agent”.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><th class="stub"><p>Tor check plugin</p></th>
|
|||
|
|
<td></td>
|
|||
|
|
<td><p>This plugin checks if the address of the request is a Tor exit-node, and informs the user if it is; like check.torproject.org, but from SearXNG.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><th class="stub"><p>Tracker URL remover</p></th>
|
|||
|
|
<td><p>y</p></td>
|
|||
|
|
<td><p>Remove trackers arguments from the returned URL</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><th class="stub"><p>Vim-like hotkeys</p></th>
|
|||
|
|
<td></td>
|
|||
|
|
<td><p>Navigate search results with Vim-like hotkeys (JavaScript required). Press “h” key on main or result page to get help.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="clearer"></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<span id="sidebar-top"></span>
|
|||
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|||
|
|
<div class="sphinxsidebarwrapper">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="logo"><a href="../index.html">
|
|||
|
|
<img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo"/>
|
|||
|
|
</a></p>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h3><a href="../index.html">Table of Contents</a></h3>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator documentation</a><ul class="current">
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings/index.html">Settings</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation-docker.html">Docker Container</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation-scripts.html">Installation Script</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation-searxng.html">Step by step installation</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html">uWSGI</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation-nginx.html">NGINX</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation-apache.html">Apache</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="update-searxng.html">SearXNG maintenance</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="api.html">Administration API</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="architecture.html">Architecture</a></li>
|
|||
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Plugins builtin</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="buildhosts.html">Buildhosts</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer documentation</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../utils/index.html">DevOps tooling box</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h3>Project Links</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
|
|||
|
|
|
|||
|
|
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
|
|||
|
|
|
|||
|
|
<li><a href="https://searx.space">Public instances</a>
|
|||
|
|
|
|||
|
|
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
|
|||
|
|
</ul><h3>Navigation</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="../index.html">Overview</a>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="index.html">Administrator documentation</a>
|
|||
|
|
<ul>
|
|||
|
|
<li>Previous: <a href="architecture.html" title="previous chapter">Architecture</a>
|
|||
|
|
<li>Next: <a href="buildhosts.html" title="next chapter">Buildhosts</a></ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<div id="searchbox" style="display: none" role="search">
|
|||
|
|
<h3 id="searchlabel">Quick search</h3>
|
|||
|
|
<div class="searchformwrapper">
|
|||
|
|
<form class="search" action="../search.html" method="get">
|
|||
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|||
|
|
<input type="submit" value="Go" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<script>document.getElementById('searchbox').style.display = "block"</script>
|
|||
|
|
<div role="note" aria-label="source link">
|
|||
|
|
<h3>This Page</h3>
|
|||
|
|
<ul class="this-page-menu">
|
|||
|
|
<li><a href="../_sources/admin/plugins.rst.txt"
|
|||
|
|
rel="nofollow">Show Source</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="clearer"></div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="footer" role="contentinfo">
|
|||
|
|
© Copyright SearXNG team.
|
|||
|
|
</div>
|
|||
|
|
<script src="../_static/version_warning_offset.js"></script>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|