recoll.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>Recoll &#8212; Searx Documentation (Searx-1.1.0.tex)</title>
  8. <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
  9. <link rel="stylesheet" type="text/css" href="../../_static/searx.css" />
  10. <link rel="stylesheet" type="text/css" href="../../_static/tabs.css" />
  11. <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
  12. <script src="../../_static/jquery.js"></script>
  13. <script src="../../_static/underscore.js"></script>
  14. <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
  15. <script src="../../_static/doctools.js"></script>
  16. <script src="../../_static/sphinx_highlight.js"></script>
  17. <link rel="index" title="Index" href="../../genindex.html" />
  18. <link rel="search" title="Search" href="../../search.html" />
  19. <link rel="next" title="How to create private engines" href="../private-engines.html" />
  20. <link rel="prev" title="Engines" href="../engines.html" />
  21. </head><body>
  22. <div class="related" role="navigation" aria-label="related navigation">
  23. <h3>Navigation</h3>
  24. <ul>
  25. <li class="right" style="margin-right: 10px">
  26. <a href="../../genindex.html" title="General Index"
  27. accesskey="I">index</a></li>
  28. <li class="right" >
  29. <a href="../../py-modindex.html" title="Python Module Index"
  30. >modules</a> |</li>
  31. <li class="right" >
  32. <a href="../private-engines.html" title="How to create private engines"
  33. accesskey="N">next</a> |</li>
  34. <li class="right" >
  35. <a href="../engines.html" title="Engines"
  36. accesskey="P">previous</a> |</li>
  37. <li class="nav-item nav-item-0"><a href="../../index.html">Searx Documentation (Searx-1.1.0.tex)</a> &#187;</li>
  38. <li class="nav-item nav-item-1"><a href="../index.html" >Administrator documentation</a> &#187;</li>
  39. <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">Engines</a> &#187;</li>
  40. <li class="nav-item nav-item-this"><a href="">Recoll</a></li>
  41. </ul>
  42. </div>
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body" role="main">
  47. <section id="recoll">
  48. <span id="engine-recoll"></span><h1>Recoll<a class="headerlink" href="#recoll" title="Permalink to this heading">¶</a></h1>
  49. <aside class="sidebar">
  50. <p class="sidebar-title">info</p>
  51. <ul class="simple">
  52. <li><p><a class="reference external" href="https://www.lesbonscomptes.com/recoll/">Recoll</a></p></li>
  53. <li><p><a class="reference external" href="https://framagit.org/medoc92/recollwebui.git">recoll-webui</a></p></li>
  54. </ul>
  55. </aside>
  56. <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>
  57. 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>
  58. <section id="configuration">
  59. <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading">¶</a></h2>
  60. <p>You must configure the following settings:</p>
  61. <dl class="simple">
  62. <dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code>:</dt><dd><p>Location where recoll-webui can be reached.</p>
  63. </dd>
  64. <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>
  65. </dd>
  66. <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>
  67. </dd>
  68. <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
  69. searched.</p>
  70. </dd>
  71. </dl>
  72. </section>
  73. <section id="example">
  74. <h2>Example<a class="headerlink" href="#example" title="Permalink to this heading">¶</a></h2>
  75. <p>Scenario:</p>
  76. <ol class="arabic simple">
  77. <li><p>Recoll indexes a local filesystem mounted in <code class="docutils literal notranslate"><span class="pre">/export/documents/reference</span></code>,</p></li>
  78. <li><p>the Recoll search interface can be reached at <a class="reference external" href="https://recoll.example.org/">https://recoll.example.org/</a> and</p></li>
  79. <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>
  80. </ol>
  81. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org/</span><span class="w"></span>
  82. <span class="nt">mount_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/export/documents</span><span class="w"></span>
  83. <span class="nt">dl_prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://download.example.org</span><span class="w"></span>
  84. <span class="nt">search_dir</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;&#39;</span><span class="w"></span>
  85. </pre></div>
  86. </div>
  87. </section>
  88. </section>
  89. <div class="clearer"></div>
  90. </div>
  91. </div>
  92. </div>
  93. <span id="sidebar-top"></span>
  94. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  95. <div class="sphinxsidebarwrapper">
  96. <p class="logo"><a href="../../index.html">
  97. <img class="logo" src="../../_static/searx_logo_small.png" alt="Logo"/>
  98. </a></p>
  99. <h3>Project Links</h3>
  100. <ul>
  101. <li><a href="https://searx.github.io/searx/blog/index.html">Blog</a>
  102. <li><a href="https://github.com/searx/searx">Source</a>
  103. <li><a href="https://github.com/searx/searx/wiki">Wiki</a>
  104. <li><a href="https://twitter.com/Searx_engine">Twitter</a>
  105. <li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
  106. </ul><h3>Navigation</h3>
  107. <ul>
  108. <li><a href="../../index.html">Overview</a>
  109. <ul>
  110. <li><a href="../index.html">Administrator documentation</a>
  111. <ul>
  112. <li><a href="../engines.html">Engines</a>
  113. <ul>
  114. <li>Previous: <a href="../engines.html" title="previous chapter">Engines</a>
  115. <li>Next: <a href="../private-engines.html" title="next chapter">How to create private engines</a></ul>
  116. </li></ul>
  117. </li>
  118. </ul>
  119. </li>
  120. </ul>
  121. <div id="searchbox" style="display: none" role="search">
  122. <h3 id="searchlabel">Quick search</h3>
  123. <div class="searchformwrapper">
  124. <form class="search" action="../../search.html" method="get">
  125. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  126. <input type="submit" value="Go" />
  127. </form>
  128. </div>
  129. </div>
  130. <script>document.getElementById('searchbox').style.display = "block"</script>
  131. </div>
  132. </div>
  133. <div class="clearer"></div>
  134. </div>
  135. <div class="footer" role="contentinfo">
  136. &#169; Copyright 2015-2022, Adam Tauber, Noémi Ványi.
  137. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
  138. </div>
  139. <script src="../../_static/version_warning_offset.js"></script>
  140. </body>
  141. </html>