devol
/
searx
mirror of https://github.com/searx/searx
1
0
Fork 0
Code Issues Releases Wiki Activity
searx/admin/engines/recoll.html

157 lines
7.5 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
<!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">
Deploying to gh-pages from @ 002d53abf35192ba1094d7516da10b3442ca1f16 🚀
2020-12-14 19:16:25 +01:00
<title>Recoll &#8212; Searx Documentation (Searx-0.18.0.tex)</title>
Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
Deploying to gh-pages from @ fb4e6080ed758e770dd1ef217927d7fde6894755 🚀
2021-01-05 16:45:49 +01:00
<link rel="stylesheet" href="../../_static/searx.css" type="text/css" />
Deploying to gh-pages from @ c89e59650b812a532c9bce741055b568920b2b94 🚀
2021-02-17 20:54:37 +01:00
<link rel="stylesheet" type="text/css" href="../../_static/tabs.css" />
Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
<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>
<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>
Deploying to gh-pages from @ 002d53abf35192ba1094d7516da10b3442ca1f16 🚀
2020-12-14 19:16:25 +01:00
<li class="nav-item nav-item-0"><a href="../../index.html">Searx Documentation (Searx-0.18.0.tex)</a> &#187;</li>
Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
<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>
Deploying to gh-pages from @ 9c55d772e98f5e51da4a34389dc240cfb3b14852 🚀
2021-01-12 10:55:12 +01:00
<li><a href="https://searx.space">Public instances</a>
Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
Deploying to gh-pages from @ 9c55d772e98f5e51da4a34389dc240cfb3b14852 🚀
2021-01-12 10:55:12 +01:00
<li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
</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.
Deploying to gh-pages from @ 22a2e544551e87fb9ea74d2fe07b59bfa0815368 🚀
2021-03-12 20:22:18 +01:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.2.
Deploying to gh-pages from @ 4a36a3044d6e39bc60d026d99ed7a010f6505a5f 🚀
2020-11-30 08:38:13 +01:00
</div>
<script src="../../_static/version_warning_offset.js"></script>
</body>
</html>