forked from zaclys/searxng
190 lines
11 KiB
HTML
190 lines
11 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>Recoll Engine — 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="Startpage Engines" href="startpage.html" />
|
||
|
|
<link rel="prev" title="Piped" href="piped.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="startpage.html" title="Startpage Engines"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="piped.html" title="Piped"
|
||
|
|
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" >Developer documentation</a> »</li>
|
||
|
|
<li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> »</li>
|
||
|
|
<li class="nav-item nav-item-this"><a href="">Recoll Engine</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body" role="main">
|
||
|
|
|
||
|
|
<section id="recoll-engine">
|
||
|
|
<span id="engine-recoll"></span><h1>Recoll Engine<a class="headerlink" href="#recoll-engine" title="Permalink to this heading">¶</a></h1>
|
||
|
|
<nav class="contents local" id="contents">
|
||
|
|
<ul class="simple">
|
||
|
|
<li><p><a class="reference internal" href="#configuration" id="id1">Configuration</a></p></li>
|
||
|
|
<li><p><a class="reference internal" href="#example" id="id2">Example</a></p></li>
|
||
|
|
<li><p><a class="reference internal" href="#implementations" id="id3">Implementations</a></p></li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<span class="target" id="module-searx.engines.recoll"></span><aside 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>
|
||
|
|
<li><p><a class="reference external" href="https://github.com/searxng/searxng/blob/master/searx/engines/recoll.py">git://searx/engines/recoll.py</a></p></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<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>
|
||
|
|
<section id="configuration">
|
||
|
|
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Configuration</a><a class="headerlink" href="#configuration" title="Permalink to this heading">¶</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>
|
||
|
|
</section>
|
||
|
|
<section id="example">
|
||
|
|
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Example</a><a class="headerlink" href="#example" title="Permalink to this heading">¶</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 interface 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="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org/</span>
|
||
|
|
<span class="nt">mount_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/export/documents</span>
|
||
|
|
<span class="nt">dl_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://download.example.org</span>
|
||
|
|
<span class="nt">search_dir</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section id="implementations">
|
||
|
|
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Implementations</a><a class="headerlink" href="#implementations" title="Permalink to this heading">¶</a></h2>
|
||
|
|
</section>
|
||
|
|
</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"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer documentation</a><ul class="current">
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html">Development Quickstart</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../contribution_guide.html">How to contribute</a></li>
|
||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../plugins.html">Plugins</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../lxcdev.html">Developing in Linux Containers</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile & <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
|
||
|
|
</ul>
|
||
|
|
</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">Developer documentation</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="../index.html">Engine Implementations</a>
|
||
|
|
<ul>
|
||
|
|
<li>Previous: <a href="piped.html" title="previous chapter">Piped</a>
|
||
|
|
<li>Next: <a href="startpage.html" title="next chapter">Startpage Engines</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" 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/dev/engines/online/recoll.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>
|