index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  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>Administrator documentation &#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="Installation" href="installation.html" />
  20. <link rel="prev" title="Why use a private instance?" href="../user/own-instance.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="installation.html" title="Installation"
  33. accesskey="N">next</a> |</li>
  34. <li class="right" >
  35. <a href="../user/own-instance.html" title="Why use a private instance?"
  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-this"><a href="">Administrator documentation</a></li>
  39. </ul>
  40. </div>
  41. <div class="document">
  42. <div class="documentwrapper">
  43. <div class="bodywrapper">
  44. <div class="body" role="main">
  45. <section id="administrator-documentation">
  46. <h1>Administrator documentation<a class="headerlink" href="#administrator-documentation" title="Permalink to this heading">¶</a></h1>
  47. <div class="toctree-wrapper compound">
  48. <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
  49. <ul>
  50. <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
  51. <li class="toctree-l2"><a class="reference internal" href="installation.html#installation-scripts">Installation scripts</a></li>
  52. </ul>
  53. </li>
  54. <li class="toctree-l1"><a class="reference internal" href="installation-searx.html">Step by step installation</a><ul>
  55. <li class="toctree-l2"><a class="reference internal" href="installation-searx.html#install-packages">Install packages</a></li>
  56. <li class="toctree-l2"><a class="reference internal" href="installation-searx.html#create-user">Create user</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="installation-searx.html#install-searx-dependencies">install searx &amp; dependencies</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="installation-searx.html#configuration">Configuration</a></li>
  59. <li class="toctree-l2"><a class="reference internal" href="installation-searx.html#check">Check</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l1"><a class="reference internal" href="installation-uwsgi.html">uwsgi</a><ul>
  63. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#origin-uwsgi">Origin uWSGI</a></li>
  64. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#distributors">Distributors</a></li>
  65. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#all-together">All together</a></li>
  66. </ul>
  67. </li>
  68. <li class="toctree-l1"><a class="reference internal" href="installation-nginx.html">Install with nginx</a><ul>
  69. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html#the-nginx-http-server">The nginx HTTP server</a></li>
  70. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html#a-nginx-searx-site">A nginx searx site</a></li>
  71. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html#disable-logs">Disable logs</a></li>
  72. </ul>
  73. </li>
  74. <li class="toctree-l1"><a class="reference internal" href="installation-apache.html">Install with apache</a><ul>
  75. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#the-apache-http-server">The apache HTTP server</a></li>
  76. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#apache-reverse-proxy">Apache Reverse Proxy</a></li>
  77. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#uwsgi-support">uWSGI support</a></li>
  78. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#restart-service">Restart service</a></li>
  79. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#disable-logs">disable logs</a></li>
  80. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#the-debian-layout">The Debian Layout</a></li>
  81. </ul>
  82. </li>
  83. <li class="toctree-l1"><a class="reference internal" href="installation-docker.html">Docker installation</a><ul>
  84. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html#docker-image-searx-searx">Docker image searx/searx</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html#public-instance">Public instance</a></li>
  86. </ul>
  87. </li>
  88. <li class="toctree-l1"><a class="reference internal" href="update-searx.html">How to update</a></li>
  89. <li class="toctree-l1"><a class="reference internal" href="update-searx.html#how-to-inspect-debug">How to inspect &amp; debug</a></li>
  90. <li class="toctree-l1"><a class="reference internal" href="settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a><ul>
  91. <li class="toctree-l2"><a class="reference internal" href="settings.html#settings-yml-location">settings.yml location</a></li>
  92. <li class="toctree-l2"><a class="reference internal" href="settings.html#global-settings">Global Settings</a></li>
  93. <li class="toctree-l2"><a class="reference internal" href="settings.html#engine-settings">Engine settings</a></li>
  94. <li class="toctree-l2"><a class="reference internal" href="settings.html#use-default-settings">use_default_settings</a></li>
  95. </ul>
  96. </li>
  97. <li class="toctree-l1"><a class="reference internal" href="api.html">Administration API</a><ul>
  98. <li class="toctree-l2"><a class="reference internal" href="api.html#get-configuration-data">Get configuration data</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="api.html#embed-search-bar">Embed search bar</a></li>
  100. </ul>
  101. </li>
  102. <li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
  103. <li class="toctree-l1"><a class="reference internal" href="filtron.html">How to protect an instance</a><ul>
  104. <li class="toctree-l2"><a class="reference internal" href="filtron.html#filtron-go">filtron &amp; go</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="filtron.html#sample-configuration-of-filtron">Sample configuration of filtron</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="filtron.html#route-request-through-filtron">Route request through filtron</a></li>
  107. </ul>
  108. </li>
  109. <li class="toctree-l1"><a class="reference internal" href="morty.html">How to setup result proxy</a></li>
  110. <li class="toctree-l1"><a class="reference internal" href="engines.html">Engines</a><ul>
  111. <li class="toctree-l2"><a class="reference internal" href="engines.html#special-engine-settings">Special Engine Settings</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="engines.html#general-engine-settings">General Engine Settings</a></li>
  113. </ul>
  114. </li>
  115. <li class="toctree-l1"><a class="reference internal" href="private-engines.html">How to create private engines</a><ul>
  116. <li class="toctree-l2"><a class="reference internal" href="private-engines.html#server-side-configuration">Server side configuration</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="private-engines.html#client-side-configuration">Client side configuration</a></li>
  118. </ul>
  119. </li>
  120. <li class="toctree-l1"><a class="reference internal" href="command-engine.html">Run shell commands from your instance</a><ul>
  121. <li class="toctree-l2"><a class="reference internal" href="command-engine.html#the-command">The command</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="command-engine.html#access-control">Access control</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="command-engine.html#available-settings">Available settings</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="command-engine.html#customize-the-result-template">Customize the result template</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="command-engine.html#examples">Examples</a></li>
  126. </ul>
  127. </li>
  128. <li class="toctree-l1"><a class="reference internal" href="indexer-engines.html">Search in indexers</a><ul>
  129. <li class="toctree-l2"><a class="reference internal" href="indexer-engines.html#elasticsearch">Elasticsearch</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="indexer-engines.html#meilisearch">Meilisearch</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="indexer-engines.html#solr">Solr</a></li>
  132. </ul>
  133. </li>
  134. <li class="toctree-l1"><a class="reference internal" href="no-sql-engines.html">Query SQL and NoSQL servers</a><ul>
  135. <li class="toctree-l2"><a class="reference internal" href="no-sql-engines.html#sql">SQL</a></li>
  136. <li class="toctree-l2"><a class="reference internal" href="no-sql-engines.html#nosql">NoSQL</a></li>
  137. </ul>
  138. </li>
  139. <li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins builtin</a></li>
  140. <li class="toctree-l1"><a class="reference internal" href="buildhosts.html">Buildhosts</a><ul>
  141. <li class="toctree-l2"><a class="reference internal" href="buildhosts.html#build-docs">Build docs</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="buildhosts.html#lint-shell-scripts">Lint shell scripts</a></li>
  143. </ul>
  144. </li>
  145. </ul>
  146. </div>
  147. </section>
  148. <div class="clearer"></div>
  149. </div>
  150. </div>
  151. </div>
  152. <span id="sidebar-top"></span>
  153. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  154. <div class="sphinxsidebarwrapper">
  155. <p class="logo"><a href="../index.html">
  156. <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
  157. </a></p>
  158. <h3>Project Links</h3>
  159. <ul>
  160. <li><a href="https://searx.github.io/searx/blog/index.html">Blog</a>
  161. <li><a href="https://github.com/searx/searx">Source</a>
  162. <li><a href="https://github.com/searx/searx/wiki">Wiki</a>
  163. <li><a href="https://twitter.com/Searx_engine">Twitter</a>
  164. <li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
  165. </ul><h3>Navigation</h3>
  166. <ul>
  167. <li><a href="../index.html">Overview</a>
  168. <ul>
  169. <li>Previous: <a href="../user/own-instance.html" title="previous chapter">Why use a private instance?</a>
  170. <li>Next: <a href="installation.html" title="next chapter">Installation</a>
  171. </ul>
  172. </li>
  173. </ul>
  174. <div id="searchbox" style="display: none" role="search">
  175. <h3 id="searchlabel">Quick search</h3>
  176. <div class="searchformwrapper">
  177. <form class="search" action="../search.html" method="get">
  178. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  179. <input type="submit" value="Go" />
  180. </form>
  181. </div>
  182. </div>
  183. <script>document.getElementById('searchbox').style.display = "block"</script>
  184. </div>
  185. </div>
  186. <div class="clearer"></div>
  187. </div>
  188. <div class="footer" role="contentinfo">
  189. &#169; Copyright 2015-2022, Adam Tauber, Noémi Ványi.
  190. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
  191. </div>
  192. <script src="../_static/version_warning_offset.js"></script>
  193. </body>
  194. </html>