2020-11-30 07:38:13 +00: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" >
2021-03-27 19:39:04 +00:00
< title > Recoll — Searx Documentation (Searx-1.0.0.tex)< / title >
2021-08-14 20:50:30 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "../../_static/searx.css" / >
2021-02-17 19:54:37 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../_static/tabs.css" / >
2021-08-14 20:50:30 +00:00
< script data-url_root = "../../" id = "documentation_options" src = "../../_static/documentation_options.js" > < / script >
2020-11-30 07:38:13 +00:00
< 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" / >
< / 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 >
2021-03-27 19:39:04 +00:00
< li class = "nav-item nav-item-0" > < a href = "../../index.html" > Searx Documentation (Searx-1.0.0.tex)< / a > » < / li >
2020-11-30 07:38:13 +00:00
< li class = "nav-item nav-item-1" > < a href = "../index.html" > Administrator documentation< / a > » < / li >
< li class = "nav-item nav-item-2" > < a href = "../engines.html" accesskey = "U" > Engines< / a > » < / 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" >
2021-04-08 17:47:22 +00:00
< div class = "section" id = "recoll" >
2020-11-30 07:38:13 +00:00
< span id = "engine-recoll" > < / span > < h1 > Recoll< a class = "headerlink" href = "#recoll" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-04-08 17:47:22 +00:00
< div class = "sidebar" >
2020-11-30 07:38:13 +00:00
< 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 >
2021-04-08 17:47:22 +00:00
< / div >
2020-11-30 07:38:13 +00:00
< 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 >
2021-04-08 17:47:22 +00:00
< div class = "section" id = "configuration" >
2020-11-30 07:38:13 +00:00
< 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 >
2021-04-08 17:47:22 +00:00
< / div >
< div class = "section" id = "example" >
2020-11-30 07:38:13 +00:00
< 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 >
2021-03-16 10:09:10 +00:00
< div class = "highlight-yaml notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nt" > base_url< / span > < span class = "p" > :< / 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 = "l l-Scalar l-Scalar-Plain" > /export/documents< / span >
< span class = "nt" > dl_prefix< / span > < span class = "p" > :< / 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 = "s" > ' ' < / span >
2020-11-30 07:38:13 +00:00
< / pre > < / div >
< / div >
2021-04-08 17:47:22 +00:00
< / div >
< / div >
2020-11-30 07:38:13 +00:00
< 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 >
2021-09-19 16:49:20 +00:00
< li > < a href = "blog/index.html" > Blog< / a >
2020-11-30 07:38:13 +00:00
< li > < a href = "https://github.com/searx/searx" > Source< / a >
< li > < a href = "https://github.com/searx/searx/wiki" > Wiki< / a >
2021-01-12 09:55:12 +00:00
< li > < a href = "https://searx.space" > Public instances< / a >
2020-11-30 07:38:13 +00:00
< li > < a href = "https://twitter.com/Searx_engine" > Twitter< / a >
2021-01-12 09:55:12 +00:00
< li > < a href = "https://github.com/searx/searx/issues" > Issue Tracker< / a >
2020-11-30 07:38:13 +00: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" >
2021-08-14 20:50:30 +00:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
2020-11-30 07:38:13 +00:00
< 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" >
2021-09-19 16:49:20 +00:00
© Copyright 2015-2021, Adam Tauber, Noémi Ványi.
2021-08-14 20:50:30 +00:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 4.1.2.
2020-11-30 07:38:13 +00:00
< / div >
< script src = "../../_static/version_warning_offset.js" > < / script >
< / body >
< / html >
