searx/admin/plugins.html

201 lines
7.8 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 &#8212; Searx Documentation (Searx-1.1.0.tex)</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/searx.css" />
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></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="Recoll" href="engines/recoll.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="engines/recoll.html" title="Recoll"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.1.0.tex)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> &#187;</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 2 </span><span class="caption-text">Plugins configured at built time (defaults)</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption>
<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 &amp; CSS dependencies</p>
</th>
</tr>
</thead>
<tbody>
<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>Hash plugin</p></th>
<td><p>y</p></td>
<td><p>Converts strings to different hash digests.</p></td>
</tr>
<tr class="row-even"><th class="stub"><p>HTTPS rewrite</p></th>
<td><p>y</p></td>
<td><p>Rewrite HTTP links to HTTPS if possible</p></td>
</tr>
<tr class="row-odd"><th class="stub"><p>Infinite scroll</p></th>
<td></td>
<td><p>Automatically load next page when scrolling to bottom of current page</p>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/js/infinite_scroll.js</span></code> </div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/css/infinite_scroll.css</span></code> </div>
</div>
</td>
</tr>
<tr class="row-even"><th class="stub"><p>Self Informations</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>Hostname replace</p></th>
<td></td>
<td><p>Rewrite result hostnames</p></td>
</tr>
<tr class="row-even"><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>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/js/search_on_category_select.js</span></code> </div>
</div>
</td>
</tr>
<tr class="row-odd"><th class="stub"><p>Search operators</p></th>
<td></td>
<td><p>Filter results using hyphen, site: and -site:.</p></td>
</tr>
</tbody>
</table>
<p>Please note that you might get less results with the additional filtering.</p>
<blockquote>
<div><ul>
<li><ul class="simple">
<li><p>Tracker URL remover</p></li>
<li><p>y</p></li>
<li><p>Remove trackers arguments from the returned URL</p></li>
</ul>
</li>
<li><ul>
<li><p>Vim-like hotkeys</p></li>
<li></li>
<li><p>Navigate search results with Vim-like hotkeys (JavaScript required). Press “h” key on main or result page to get help.</p>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/js/vim_hotkeys.js</span></code> </div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/css/vim_hotkeys.css</span></code> </div>
</div>
</li>
</ul>
</li>
</ul>
</div></blockquote>
</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/searx_logo_small.png" alt="Logo"/>
</a></p>
<h3>Project Links</h3>
<ul>
<li><a href="https://searx.github.io/searx/blog/index.html">Blog</a>
<li><a href="https://github.com/searx/searx">Source</a>
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
<li><a href="https://github.com/searx/searx/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="engines/recoll.html" title="previous chapter">Recoll</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>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2015-2022, Adam Tauber, Noémi Ványi.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.1.1.
</div>
<script src="../_static/version_warning_offset.js"></script>
</body>
</html>