devol/searx
1
0
Fork 0
mirror of https://github.com/searx/searx synced 2025-02-21 22:27:41 +01:00
Code Issues Releases Wiki Activity

Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀

Browse Source
This commit is contained in:
dalf 2020-11-30 07:38:13 +00:00
parent f40a70393f
commit 2baeefaf85
12 changed files with 293 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
_sources/admin/engines.rst.txt
View File

@ -1,14 +1,28 @@
.. _engines generic:
=======
Engines
=======
Special Engine Settings
=======================
.. sidebar:: Further reading ..
- :ref:`settings engine`
- :ref:`engine settings`
- :ref:`engine file`
- :ref:`engine settings` & :ref:`engine file`
.. toctree::
:maxdepth: 1
engines/recoll.rst
.. _engines generic:
General Engine Settings
=======================
Explanation of the :ref:`general engine configuration` shown in the table
:ref:`configured engines`.
============= =========== ==================== ============
:ref:`engine settings` :ref:`engine file`
@ -30,8 +44,6 @@ Disabled **D**
Show errors **DE**
============= =========== =================================
Configuration defaults (at built time):
.. _configured engines:
.. jinja:: webapp
@ -73,3 +85,4 @@ Configuration defaults (at built time):
- {{(mod.display_error_messages and "y") or ""}}
{% endfor %}

50
_sources/admin/engines/recoll.rst.txt Normal file
View File

@ -0,0 +1,50 @@
.. _engine recoll:
======
Recoll
======
.. sidebar:: info
- `Recoll <https://www.lesbonscomptes.com/recoll/>`_
- `recoll-webui <https://framagit.org/medoc92/recollwebui.git>`_
Recoll_ is a desktop full-text search tool based on Xapian. By itself Recoll_
does not offer web or API access, this can be achieved using recoll-webui_
Configuration
=============
You must configure the following settings:
``base_url``:
Location where recoll-webui can be reached.
``mount_prefix``:
Location where the file hierarchy is mounted on your *local* filesystem.
``dl_prefix``:
Location where the file hierarchy as indexed by recoll can be reached.
``search_dir``:
Part of the indexed file hierarchy to be search, if empty the full domain is
searched.
Example
=======
Scenario:
#. Recoll indexes a local filesystem mounted in ``/export/documents/reference``,
#. the Recoll search inteface can be reached at https://recoll.example.org/ and
#. the contents of this filesystem can be reached though https://download.example.org/reference
.. code:: yaml
base_url: https://recoll.example.org/
mount_prefix: /export/documents
dl_prefix: https://download.example.org
search_dir: ''

3
_sources/dev/engine_overview.rst.txt
View File

@ -18,6 +18,9 @@ engines. Adapters are stored under the folder :origin:`searx/engines`.
:depth: 3
:backlinks: entry
.. _general engine configuration:
general engine configuration
============================

25
admin/engines.html
View File

@ -20,7 +20,7 @@
<script src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Plugins builtin" href="plugins.html" />
<link rel="next" title="Recoll" href="engines/recoll.html" />
<link rel="prev" title="How to setup result proxy" href="morty.html" />
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../';</script>
@ -35,7 +35,7 @@
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="plugins.html" title="Plugins builtin"
<a href="engines/recoll.html" title="Recoll"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="morty.html" title="How to setup result proxy"
@ -52,15 +52,26 @@
<div class="body" role="main">
<div class="section" id="engines">
<span id="engines-generic"></span><h1>Engines<a class="headerlink" href="#engines" title="Permalink to this headline"></a></h1>
<h1>Engines<a class="headerlink" href="#engines" title="Permalink to this headline"></a></h1>
<div class="section" id="special-engine-settings">
<h2>Special Engine Settings<a class="headerlink" href="#special-engine-settings" title="Permalink to this headline"></a></h2>
<div class="sidebar">
<p class="sidebar-title">Further reading ..</p>
<ul class="simple">
<li><p><a class="reference internal" href="settings.html#settings-engine"><span class="std std-ref">Engine settings</span></a></p></li>
<li><p><a class="reference internal" href="../dev/engine_overview.html#engine-settings"><span class="std std-ref">settings.yml</span></a></p></li>
<li><p><a class="reference internal" href="../dev/engine_overview.html#engine-file"><span class="std std-ref">engine file</span></a></p></li>
<li><p><a class="reference internal" href="../dev/engine_overview.html#engine-settings"><span class="std std-ref">settings.yml</span></a> &amp; <a class="reference internal" href="../dev/engine_overview.html#engine-file"><span class="std std-ref">engine file</span></a></p></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="engines/recoll.html">Recoll</a></li>
</ul>
</div>
</div>
<div class="section" id="general-engine-settings">
<span id="engines-generic"></span><h2>General Engine Settings<a class="headerlink" href="#general-engine-settings" title="Permalink to this headline"></a></h2>
<p>Explanation of the <a class="reference internal" href="../dev/engine_overview.html#general-engine-configuration"><span class="std std-ref">general engine configuration</span></a> shown in the table
<a class="reference internal" href="#configured-engines"><span class="std std-ref">Engines configured at built time (defaults)</span></a>.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 23%" />
@ -112,7 +123,6 @@
</tr>
</tbody>
</table>
<p>Configuration defaults (at built time):</p>
<span id="configured-engines"></span><table class="docutils align-default" id="id1">
<caption><span class="caption-number">Table 1 </span><span class="caption-text">Engines configured at built time (defaults)</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption>
<colgroup>
@ -1771,6 +1781,7 @@
</tr>
</tbody>
</table>
</div>
</div>
@ -1804,7 +1815,7 @@
<li><a href="index.html">Administrator documentation</a>
<ul>
<li>Previous: <a href="morty.html" title="previous chapter">How to setup result proxy</a>
<li>Next: <a href="plugins.html" title="next chapter">Plugins builtin</a></ul>
<li>Next: <a href="engines/recoll.html" title="next chapter">Recoll</a></ul>
</li>
</ul>
</li>

159
admin/engines/recoll.html Normal file
View File

@ -0,0 +1,159 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Recoll &#8212; Searx Documentation (Searx-0.17.0.tex)</title>
<link rel="stylesheet" href="../../_static/searx.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_tabs/tabs.css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Plugins builtin" href="../plugins.html" />
<link rel="prev" title="Engines" href="../engines.html" />
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../../';</script>
</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="../plugins.html" title="Plugins builtin"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../engines.html" title="Engines"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Searx Documentation (Searx-0.17.0.tex)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Administrator documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">Engines</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Recoll</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="recoll">
<span id="engine-recoll"></span><h1>Recoll<a class="headerlink" href="#recoll" title="Permalink to this headline"></a></h1>
<div class="sidebar">
<p class="sidebar-title">info</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a></p></li>
<li><p><a class="reference external" href="https://framagit.org/medoc92/recollwebui.git">recoll-webui</a></p></li>
</ul>
</div>
<p><a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a> is a desktop full-text search tool based on Xapian. By itself <a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a>
does not offer web or API access, this can be achieved using <a class="reference external" href="https://framagit.org/medoc92/recollwebui.git">recoll-webui</a></p>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
<p>You must configure the following settings:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code>:</dt><dd><p>Location where recoll-webui can be reached.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">mount_prefix</span></code>:</dt><dd><p>Location where the file hierarchy is mounted on your <em>local</em> filesystem.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">dl_prefix</span></code>:</dt><dd><p>Location where the file hierarchy as indexed by recoll can be reached.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">search_dir</span></code>:</dt><dd><p>Part of the indexed file hierarchy to be search, if empty the full domain is
searched.</p>
</dd>
</dl>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline"></a></h2>
<p>Scenario:</p>
<ol class="arabic simple">
<li><p>Recoll indexes a local filesystem mounted in <code class="docutils literal notranslate"><span class="pre">/export/documents/reference</span></code>,</p></li>
<li><p>the Recoll search inteface can be reached at <a class="reference external" href="https://recoll.example.org/">https://recoll.example.org/</a> and</p></li>
<li><p>the contents of this filesystem can be reached though <a class="reference external" href="https://download.example.org/reference">https://download.example.org/reference</a></p></li>
</ol>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">base_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org/</span>
<span class="l l-Scalar l-Scalar-Plain">mount_prefix</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">/export/documents</span>
<span class="l l-Scalar l-Scalar-Plain">dl_prefix</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://download.example.org</span>
<span class="l l-Scalar l-Scalar-Plain">search_dir</span><span class="p p-Indicator">:</span> <span class="s">&#39;&#39;</span>
</pre></div>
</div>
</div>
</div>
<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://github.com/searx/searx">Source</a>
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
<li><a href="https://searx.space/">Public instances</a>
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Administrator documentation</a>
<ul>
<li><a href="../engines.html">Engines</a>
<ul>
<li>Previous: <a href="../engines.html" title="previous chapter">Engines</a>
<li>Next: <a href="../plugins.html" title="next chapter">Plugins builtin</a></ul>
</li></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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2015-2020, Adam Tauber, Noémi Ványi.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
<script src="../../_static/version_warning_offset.js"></script>
</body>
</html>

6
admin/index.html
View File

@ -112,7 +112,11 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="morty.html">How to setup result proxy</a></li>
<li class="toctree-l1"><a class="reference internal" href="engines.html">Engines</a></li>
<li class="toctree-l1"><a class="reference internal" href="engines.html">Engines</a><ul>
<li class="toctree-l2"><a class="reference internal" href="engines.html#special-engine-settings">Special Engine Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="engines.html#general-engine-settings">General Engine Settings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins builtin</a></li>
<li class="toctree-l1"><a class="reference internal" href="buildhosts.html">Buildhosts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="buildhosts.html#build-docs">Build docs</a></li>

6
admin/plugins.html
View File

@ -21,7 +21,7 @@
<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="Engines" href="engines.html" />
<link rel="prev" title="Recoll" href="engines/recoll.html" />
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../';</script>
</head><body>
@ -38,7 +38,7 @@
<a href="buildhosts.html" title="Buildhosts"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="engines.html" title="Engines"
<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-0.17.0.tex)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> &#187;</li>
@ -161,7 +161,7 @@
<ul>
<li><a href="index.html">Administrator documentation</a>
<ul>
<li>Previous: <a href="engines.html" title="previous chapter">Engines</a>
<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>

66
dev/engine_overview.html
View File

@ -52,7 +52,7 @@
<div class="body" role="main">
<div class="section" id="engine-overview">
<span id="engines-dev"></span><h1><a class="toc-backref" href="#id3">Engine overview</a><a class="headerlink" href="#engine-overview" title="Permalink to this headline"></a></h1>
<span id="engines-dev"></span><h1><a class="toc-backref" href="#id4">Engine overview</a><a class="headerlink" href="#engine-overview" title="Permalink to this headline"></a></h1>
<p>searx is a <a class="reference external" href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch-engine</a>, so it uses different search engines to provide
better results.</p>
<p>Because there is no general search API which could be used for every search
@ -61,30 +61,30 @@ engines. Adapters are stored under the folder <a class="reference external" hre
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#engine-overview" id="id3">Engine overview</a></p>
<li><p><a class="reference internal" href="#engine-overview" id="id4">Engine overview</a></p>
<ul>
<li><p><a class="reference internal" href="#general-engine-configuration" id="id4">general engine configuration</a></p>
<li><p><a class="reference internal" href="#general-engine-configuration" id="id5">general engine configuration</a></p>
<ul>
<li><p><a class="reference internal" href="#engine-file" id="id5">engine file</a></p></li>
<li><p><a class="reference internal" href="#settings-yml" id="id6">settings.yml</a></p></li>
<li><p><a class="reference internal" href="#overrides" id="id7">overrides</a></p></li>
<li><p><a class="reference internal" href="#example-code" id="id8">example code</a></p></li>
<li><p><a class="reference internal" href="#engine-file" id="id6">engine file</a></p></li>
<li><p><a class="reference internal" href="#settings-yml" id="id7">settings.yml</a></p></li>
<li><p><a class="reference internal" href="#overrides" id="id8">overrides</a></p></li>
<li><p><a class="reference internal" href="#example-code" id="id9">example code</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#making-a-request" id="id9">making a request</a></p>
<li><p><a class="reference internal" href="#making-a-request" id="id10">making a request</a></p>
<ul>
<li><p><a class="reference internal" href="#passed-arguments" id="id10">passed arguments</a></p></li>
<li><p><a class="reference internal" href="#parsed-arguments" id="id11">parsed arguments</a></p></li>
<li><p><a class="reference internal" href="#id2" id="id12">example code</a></p></li>
<li><p><a class="reference internal" href="#passed-arguments" id="id11">passed arguments</a></p></li>
<li><p><a class="reference internal" href="#parsed-arguments" id="id12">parsed arguments</a></p></li>
<li><p><a class="reference internal" href="#id3" id="id13">example code</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#returned-results" id="id13">returned results</a></p>
<li><p><a class="reference internal" href="#returned-results" id="id14">returned results</a></p>
<ul>
<li><p><a class="reference internal" href="#default" id="id14">default</a></p></li>
<li><p><a class="reference internal" href="#images" id="id15">images</a></p></li>
<li><p><a class="reference internal" href="#videos" id="id16">videos</a></p></li>
<li><p><a class="reference internal" href="#torrent" id="id17">torrent</a></p></li>
<li><p><a class="reference internal" href="#map" id="id18">map</a></p></li>
<li><p><a class="reference internal" href="#default" id="id15">default</a></p></li>
<li><p><a class="reference internal" href="#images" id="id16">images</a></p></li>
<li><p><a class="reference internal" href="#videos" id="id17">videos</a></p></li>
<li><p><a class="reference internal" href="#torrent" id="id18">torrent</a></p></li>
<li><p><a class="reference internal" href="#map" id="id19">map</a></p></li>
</ul>
</li>
</ul>
@ -92,7 +92,7 @@ engines. Adapters are stored under the folder <a class="reference external" hre
</ul>
</div>
<div class="section" id="general-engine-configuration">
<h2><a class="toc-backref" href="#id4">general engine configuration</a><a class="headerlink" href="#general-engine-configuration" title="Permalink to this headline"></a></h2>
<span id="id1"></span><h2><a class="toc-backref" href="#id5">general engine configuration</a><a class="headerlink" href="#general-engine-configuration" title="Permalink to this headline"></a></h2>
<p>It is required to tell searx the type of results the engine provides. The
arguments can be set in the engine file or in the settings file
(normally <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>). The arguments in the settings file override
@ -100,7 +100,7 @@ the ones in the engine file.</p>
<p>It does not matter if an option is stored in the engine file or in the
settings. However, the standard way is the following:</p>
<div class="section" id="engine-file">
<span id="id1"></span><h3><a class="toc-backref" href="#id5">engine file</a><a class="headerlink" href="#engine-file" title="Permalink to this headline"></a></h3>
<span id="id2"></span><h3><a class="toc-backref" href="#id6">engine file</a><a class="headerlink" href="#engine-file" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%" />
@ -138,7 +138,7 @@ settings. However, the standard way is the following:</p>
</table>
</div>
<div class="section" id="settings-yml">
<span id="engine-settings"></span><h3><a class="toc-backref" href="#id6">settings.yml</a><a class="headerlink" href="#settings-yml" title="Permalink to this headline"></a></h3>
<span id="engine-settings"></span><h3><a class="toc-backref" href="#id7">settings.yml</a><a class="headerlink" href="#settings-yml" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 29%" />
@ -183,7 +183,7 @@ settings. However, the standard way is the following:</p>
</table>
</div>
<div class="section" id="overrides">
<h3><a class="toc-backref" href="#id7">overrides</a><a class="headerlink" href="#overrides" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id8">overrides</a><a class="headerlink" href="#overrides" title="Permalink to this headline"></a></h3>
<p>A few of the options have default values in the engine, but are often
overwritten by the settings. If <code class="docutils literal notranslate"><span class="pre">None</span></code> is assigned to an option in the engine
file, it has to be redefined in the settings, otherwise searx will not start
@ -224,7 +224,7 @@ engine on other URL</p></td>
</table>
</div>
<div class="section" id="example-code">
<h3><a class="toc-backref" href="#id8">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id9">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># engine dependent config</span>
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
<span class="n">paging</span> <span class="o">=</span> <span class="bp">True</span>
@ -234,11 +234,11 @@ engine on other URL</p></td>
</div>
</div>
<div class="section" id="making-a-request">
<h2><a class="toc-backref" href="#id9">making a request</a><a class="headerlink" href="#making-a-request" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id10">making a request</a><a class="headerlink" href="#making-a-request" title="Permalink to this headline"></a></h2>
<p>To perform a search an URL have to be specified. In addition to specifying an
URL, arguments can be passed to the query.</p>
<div class="section" id="passed-arguments">
<h3><a class="toc-backref" href="#id10">passed arguments</a><a class="headerlink" href="#passed-arguments" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id11">passed arguments</a><a class="headerlink" href="#passed-arguments" title="Permalink to this headline"></a></h3>
<p>These arguments can be used to construct the search query. Furthermore,
parameters with default value can be redefined for special purposes.</p>
<table class="docutils align-default">
@ -302,7 +302,7 @@ parameters with default value can be redefined for special purposes.</p>
</table>
</div>
<div class="section" id="parsed-arguments">
<h3><a class="toc-backref" href="#id11">parsed arguments</a><a class="headerlink" href="#parsed-arguments" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id12">parsed arguments</a><a class="headerlink" href="#parsed-arguments" title="Permalink to this headline"></a></h3>
<p>The function <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">request(query,</span> <span class="pre">params):</span></code> always returns the <code class="docutils literal notranslate"><span class="pre">params</span></code>
variable. Inside searx, the following paramters can be used to specify a search
request:</p>
@ -346,8 +346,8 @@ request:</p>
</tbody>
</table>
</div>
<div class="section" id="id2">
<h3><a class="toc-backref" href="#id12">example code</a><a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h3><a class="toc-backref" href="#id13">example code</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># search-url</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://example.com/&#39;</span>
<span class="n">search_string</span> <span class="o">=</span> <span class="s1">&#39;search?{query}&amp;page={page}&#39;</span>
@ -366,7 +366,7 @@ request:</p>
</div>
</div>
<div class="section" id="returned-results">
<h2><a class="toc-backref" href="#id13">returned results</a><a class="headerlink" href="#returned-results" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id14">returned results</a><a class="headerlink" href="#returned-results" title="Permalink to this headline"></a></h2>
<p>Searx is able to return results of different media-types. Currently the
following media-types are supported:</p>
<ul class="simple">
@ -379,7 +379,7 @@ following media-types are supported:</p>
<p>To set another media-type as default, the parameter <code class="docutils literal notranslate"><span class="pre">template</span></code> must be set to
the desired type.</p>
<div class="section" id="default">
<h3><a class="toc-backref" href="#id14">default</a><a class="headerlink" href="#default" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id15">default</a><a class="headerlink" href="#default" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
@ -407,7 +407,7 @@ the desired type.</p>
</table>
</div>
<div class="section" id="images">
<h3><a class="toc-backref" href="#id15">images</a><a class="headerlink" href="#images" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id16">images</a><a class="headerlink" href="#images" title="Permalink to this headline"></a></h3>
<p>To use this template, the parameter:</p>
<table class="docutils align-default">
<colgroup>
@ -446,7 +446,7 @@ time of publish <em>(partly implemented)</em></p></td>
</table>
</div>
<div class="section" id="videos">
<h3><a class="toc-backref" href="#id16">videos</a><a class="headerlink" href="#videos" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id17">videos</a><a class="headerlink" href="#videos" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
@ -480,7 +480,7 @@ time of publish <em>(partly implemented)</em></p></td>
</table>
</div>
<div class="section" id="torrent">
<h3><a class="toc-backref" href="#id17">torrent</a><a class="headerlink" href="#torrent" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id18">torrent</a><a class="headerlink" href="#torrent" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
@ -530,7 +530,7 @@ time of publish <em>(not implemented yet)</em></p></td>
</table>
</div>
<div class="section" id="map">
<h3><a class="toc-backref" href="#id18">map</a><a class="headerlink" href="#map" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id19">map</a><a class="headerlink" href="#map" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />

2
dev/reST.html
View File

@ -1412,7 +1412,7 @@ kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p></td>
<p>Templating is suitable for documentation which is created generic at the build
time. The <a class="reference external" href="https://github.com/tardyp/sphinx-jinja">sphinx-jinja</a> extension evaluates <a class="reference external" href="https://jinja.palletsprojects.com/">jinja</a> templates in the <a class="reference internal" href="makefile.html#make-pyenv"><span class="std std-ref">build
environment</span></a> (with searx modules installed). We use this e.g. to
build chapter: <a class="reference internal" href="../admin/engines.html#engines-generic"><span class="std std-ref">Engines</span></a>. Below the jinja directive from the
build chapter: <a class="reference internal" href="../admin/engines.html#engines-generic"><span class="std std-ref">General Engine Settings</span></a>. Below the jinja directive from the
<a class="reference external" href="https://github.com/searx/searx/blob/master/docs/admin/engines.rst">git://docs/admin/engines.rst</a> is shown:</p>
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">jinja</span><span class="p">::</span> webapp

2
dev/search_api.html
View File

@ -64,7 +64,7 @@
<ul class="simple">
<li><p><a class="reference internal" href="engine_overview.html#engines-dev"><span class="std std-ref">Engine overview</span></a></p></li>
<li><p><a class="reference internal" href="../admin/settings.html#settings-yml"><span class="std std-ref">settings.yml</span></a></p></li>
<li><p><a class="reference internal" href="../admin/engines.html#engines-generic"><span class="std std-ref">Engines</span></a></p></li>
<li><p><a class="reference internal" href="../admin/engines.html#engines-generic"><span class="std std-ref">General Engine Settings</span></a></p></li>
</ul>
</div>
<dl>

BIN
objects.inv
View File

Binary file not shown.

2
searchindex.js
View File

File diff suppressed because one or more lines are too long