diff options
| author | Noémi Ványi <kvch@users.noreply.github.com> | 2020-11-30 08:35:15 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-30 08:35:15 +0100 |
| commit | 4a36a3044d6e39bc60d026d99ed7a010f6505a5f (patch) | |
| tree | 7037ea2a1e86ec7d308a5d231eae3aa0897e0f87 /docs/admin/engines.rst | |
| parent | 93c2603561c039fb43137c251493e77032f91743 (diff) | |
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
Diffstat (limited to 'docs/admin/engines.rst')
| -rw-r--r-- | docs/admin/engines.rst | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/docs/admin/engines.rst b/docs/admin/engines.rst index 4d1872dfc..f1ac03699 100644 --- a/docs/admin/engines.rst +++ b/docs/admin/engines.rst @@ -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 %} + |