searxngRebrandZaclys/docs/admin/engines.rst
Noémi Ványi 4a36a3044d
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
2020-11-30 08:35:15 +01:00

2.2 KiB

Engines

Special Engine Settings

Further reading ..

  • settings engine
  • engine settings & engine file

engines/recoll.rst

General Engine Settings

Explanation of the general engine configuration shown in the table configured engines.

engine settings engine file
Name (cfg) Categories
------------------------- ---------------------------------
Engine .. Paging support P
------------------------- -------------------- ------------
Shortcut S Language support L
Timeout TO Time range support TR
Disabled D Offline O

------------- -----------Safe search SS

-------------------- ------------

------------- -----------Weigth W


------------- -----------Disabled D


------------- -----------Show errors DE


webapp

Engines configured at built time (defaults)

    • Name (cfg)
    • S
    • Engine
    • TO
    • Categories
    • P
    • L
    • SS
    • D
    • TR
    • O
  • W
  • D
  • DE

{% for name, mod in engines.items() %}

    • {{name}}
    • !{{mod.shortcut}}
    • {{mod.__name__}}
    • {{mod.timeout}}
    • {{", ".join(mod.categories)}}
    • {{(mod.paging and "y") or ""}}
    • {{(mod.language_support and "y") or ""}}
    • {{(mod.safesearch and "y") or ""}}
    • {{(mod.disabled and "y") or ""}}
    • {{(mod.time_range_support and "y") or ""}}
    • {{(mod.offline and "y") or ""}}
    • {{mod.weight or 1 }}
    • {{(mod.disabled and "y") or ""}}
    • {{(mod.display_error_messages and "y") or ""}}

{% endfor %}