Add recoll engine (#2325)

recoll is a local search engine based on Xapian:
http://www.lesbonscomptes.com/recoll/

By itself recoll does not offer web or API access,
this can be achieved using recoll-webui:
https://framagit.org/medoc92/recollwebui.git

This engine uses a custom 'files' result template

set `base_url` to the location where recoll-webui can be reached
set `dl_prefix` to a location where the file hierarchy as indexed by recoll can be reached
set `search_dir` to the part of the indexed file hierarchy to be searched, use an empty string to search the entire search domain
This commit is contained in:
Noémi Ványi 2020-11-30 08:35:15 +01:00 committed by GitHub
parent 93c2603561
commit 4a36a3044d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 298 additions and 6 deletions

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 %}