NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Tree: 6936637040
Branches Tags
searxng
/
admin
/
architecture.html

architecture.html 18 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227 
  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html lang="en" data-content_root="../">
    4. 

  4.   <head>
    5. 

  5.     <meta charset="utf-8" />
    6. 

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <meta name="viewport" content="width=device-width, initial-scale=1">
    8. 

  8.     <title>Architecture &#8212; SearXNG Documentation (2025.5.13+4fb29aae8)</title>
    9. 

  9.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
    11. 

  11.     <script src="../_static/documentation_options.js?v=67dbeb42"></script>
    12. 

  12.     <script src="../_static/doctools.js?v=9a2dae69"></script>
    13. 

  13.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    14. 

  14.     <script data-project="searxng" data-version="2025.5.13+4fb29aae8" src="../_static/describe_version.js?v=fa7f30d0"></script>
    15. 

  15.     <link rel="index" title="Index" href="../genindex.html" />
    16. 

  16.     <link rel="search" title="Search" href="../search.html" />
    17. 

  17.     <link rel="next" title="List of plugins" href="plugins.html" />
    18. 

  18.     <link rel="prev" title="Administration API" href="api.html" /> 
    19. 

  19.   </head><body>
    20. 

  20.     <div class="related" role="navigation" aria-label="Related">
    21. 

  21.       <h3>Navigation</h3>
    22. 

  22.       <ul>
    23. 

  23.         <li class="right" style="margin-right: 10px">
    24. 

  24.           <a href="../genindex.html" title="General Index"
    25. 

  25.              accesskey="I">index</a></li>
    26. 

  26.         <li class="right" >
    27. 

  27.           <a href="../py-modindex.html" title="Python Module Index"
    28. 

  28.              >modules</a> |</li>
    29. 

  29.         <li class="right" >
    30. 

  30.           <a href="plugins.html" title="List of plugins"
    31. 

  31.              accesskey="N">next</a> |</li>
    32. 

  32.         <li class="right" >
    33. 

  33.           <a href="api.html" title="Administration API"
    34. 

  34.              accesskey="P">previous</a> |</li>
    35. 

  35.         <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.5.13+4fb29aae8)</a> &#187;</li>
    36. 

  36.           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> &#187;</li>
    37. 

  37.         <li class="nav-item nav-item-this"><a href="">Architecture</a></li> 
    38. 

  38.       </ul>
    39. 

  39.     </div>  
    40. 

  40. 

  41.     <div class="document">
    42. 

  42.       <div class="documentwrapper">
    43. 

  43.         <div class="bodywrapper">
    44. 

  44.           <div class="body" role="main">
    45. 

  45.             
    46. 

  46.   <section id="architecture">
    47. 

  47. <span id="id1"></span><h1>Architecture<a class="headerlink" href="#architecture" title="Link to this heading">¶</a></h1>
    48. 

  48. <aside class="sidebar">
    49. 

  49. <p class="sidebar-title">Further reading</p>
    50. 

  50. <ul class="simple">
    51. 

  51. <li><p>Reverse Proxy: <a class="reference internal" href="installation-apache.html#apache-searxng-site"><span class="std std-ref">Apache</span></a> &amp; <a class="reference internal" href="installation-nginx.html#nginx-searxng-site"><span class="std std-ref">nginx</span></a></p></li>
    52. 

  52. <li><p>uWSGI: <a class="reference internal" href="installation-uwsgi.html#searxng-uwsgi"><span class="std std-ref">uWSGI</span></a></p></li>
    53. 

  53. <li><p>SearXNG: <a class="reference internal" href="installation-searxng.html#installation-basic"><span class="std std-ref">Step by step installation</span></a></p></li>
    54. 

  54. </ul>
    55. 

  55. </aside>
    56. 

  56. <p>Herein you will find some hints and suggestions about typical architectures of
    57. 

  57. SearXNG infrastructures.</p>
    58. 

  58. <section id="uwsgi-setup">
    59. 

  59. <span id="architecture-uwsgi"></span><h2>uWSGI Setup<a class="headerlink" href="#uwsgi-setup" title="Link to this heading">¶</a></h2>
    60. 

  60. <p>We start with a <em>reference</em> setup for public SearXNG instances which can be build
    61. 

  61. up and maintained by the scripts from our <a class="reference internal" href="../utils/index.html#toolboxing"><span class="std std-ref">DevOps tooling box</span></a>.</p>
    62. 

  62. <figure class="align-default" id="id2">
    63. 

  63. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">digraph</span> <span class="n">G</span> <span class="p">{</span>
    64. 

  64. 

  65.   <span class="n">node</span> <span class="p">[</span><span class="n">style</span><span class="o">=</span><span class="n">filled</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">box</span><span class="p">,</span> <span class="n">fillcolor</span><span class="o">=</span><span class="s2">&quot;#ffffcc&quot;</span><span class="p">,</span> <span class="n">fontname</span><span class="o">=</span><span class="n">Sans</span><span class="p">];</span>
    66. 

  66.   <span class="n">edge</span> <span class="p">[</span><span class="n">fontname</span><span class="o">=</span><span class="s2">&quot;Sans&quot;</span><span class="p">];</span>
    67. 

  67. 

  68.   <span class="n">browser</span> <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;browser&quot;</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">tab</span><span class="p">,</span> <span class="n">fillcolor</span><span class="o">=</span><span class="n">aliceblue</span><span class="p">];</span>
    69. 

  69.   <span class="n">rp</span>      <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;reverse proxy&quot;</span><span class="p">];</span>
    70. 

  70.   <span class="n">static</span>  <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;static files&quot;</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">folder</span><span class="p">,</span> <span class="n">href</span><span class="o">=</span><span class="s2">&quot;url to configure static files&quot;</span><span class="p">,</span> <span class="n">fillcolor</span><span class="o">=</span><span class="n">lightgray</span><span class="p">];</span>
    71. 

  71.   <span class="n">uwsgi</span>   <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;uwsgi&quot;</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">parallelogram</span> <span class="n">href</span><span class="o">=</span><span class="s2">&quot;https://docs.searxng.org/utils/searx.sh.html&quot;</span><span class="p">]</span>
    72. 

  72.   <span class="n">redis</span>     <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;redis DB&quot;</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">cylinder</span><span class="p">];</span>
    73. 

  73.   <span class="n">searxng1</span>  <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;SearXNG #1&quot;</span><span class="p">,</span> <span class="n">fontcolor</span><span class="o">=</span><span class="n">blue3</span><span class="p">];</span>
    74. 

  74.   <span class="n">searxng2</span>  <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;SearXNG #2&quot;</span><span class="p">,</span> <span class="n">fontcolor</span><span class="o">=</span><span class="n">blue3</span><span class="p">];</span>
    75. 

  75.   <span class="n">searxng3</span>  <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;SearXNG #3&quot;</span><span class="p">,</span> <span class="n">fontcolor</span><span class="o">=</span><span class="n">blue3</span><span class="p">];</span>
    76. 

  76.   <span class="n">searxng4</span>  <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;SearXNG #4&quot;</span><span class="p">,</span> <span class="n">fontcolor</span><span class="o">=</span><span class="n">blue3</span><span class="p">];</span>
    77. 

  77. 

  78.   <span class="n">browser</span> <span class="o">-&gt;</span> <span class="n">rp</span> <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;HTTPS&quot;</span><span class="p">]</span>
    79. 

  79. 

  80.   <span class="n">subgraph</span> <span class="n">cluster_searxng</span> <span class="p">{</span>
    81. 

  81.       <span class="n">label</span> <span class="o">=</span> <span class="s2">&quot;SearXNG instance&quot;</span> <span class="n">fontname</span><span class="o">=</span><span class="n">Sans</span><span class="p">;</span>
    82. 

  82.       <span class="n">bgcolor</span><span class="o">=</span><span class="s2">&quot;#fafafa&quot;</span><span class="p">;</span>
    83. 

  83.       <span class="p">{</span> <span class="n">rank</span><span class="o">=</span><span class="n">same</span><span class="p">;</span> <span class="n">static</span> <span class="n">rp</span> <span class="p">};</span>
    84. 

  84.       <span class="n">rp</span> <span class="o">-&gt;</span> <span class="n">static</span>  <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;optional: reverse proxy serves static files&quot;</span><span class="p">,</span> <span class="n">fillcolor</span><span class="o">=</span><span class="n">slategray</span><span class="p">,</span> <span class="n">fontcolor</span><span class="o">=</span><span class="n">slategray</span><span class="p">];</span>
    85. 

  85.       <span class="n">rp</span> <span class="o">-&gt;</span> <span class="n">uwsgi</span> <span class="p">[</span><span class="n">label</span><span class="o">=</span><span class="s2">&quot;http:// (tcp) or unix:// (socket)&quot;</span><span class="p">];</span>
    86. 

  86.       <span class="n">uwsgi</span> <span class="o">-&gt;</span> <span class="n">searxng1</span> <span class="o">-&gt;</span> <span class="n">redis</span><span class="p">;</span>
    87. 

  87.       <span class="n">uwsgi</span> <span class="o">-&gt;</span> <span class="n">searxng2</span> <span class="o">-&gt;</span> <span class="n">redis</span><span class="p">;</span>
    88. 

  88.       <span class="n">uwsgi</span> <span class="o">-&gt;</span> <span class="n">searxng3</span> <span class="o">-&gt;</span> <span class="n">redis</span><span class="p">;</span>
    89. 

  89.       <span class="n">uwsgi</span> <span class="o">-&gt;</span> <span class="n">searxng4</span> <span class="o">-&gt;</span> <span class="n">redis</span><span class="p">;</span>
    90. 

  90.   <span class="p">}</span>
    91. 

  91. 

  92. <span class="p">}</span>
    93. 

  93. </pre></div>
    94. 

  94. </div>
    95. 

  95. <figcaption>
    96. 

  96. <p><span class="caption-number">Fig. 2 </span><span class="caption-text">Reference architecture of a public SearXNG setup.</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
    97. 

  97. </figcaption>
    98. 

  98. </figure>
    99. 

  99. <p>The reference installation activates <code class="docutils literal notranslate"><span class="pre">server.limiter</span></code>, <code class="docutils literal notranslate"><span class="pre">server.image_proxy</span></code>
    100. 

  100. and <code class="docutils literal notranslate"><span class="pre">ui.static_use_hash</span></code> (<a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/utils/templates/etc/searxng/settings.yml">/etc/searxng/settings.yml</a>)</p>
    101. 

  101. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># SearXNG settings</span>
    102. 

  102. 

  103. <span class="nt">use_default_settings</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    104. 

  104. 

  105. <span class="nt">general</span><span class="p">:</span>
    106. 

  106. <span class="w">  </span><span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
    107. 

  107. <span class="w">  </span><span class="nt">instance_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SearXNG&quot;</span>
    108. 

  108. 

  109. <span class="nt">search</span><span class="p">:</span>
    110. 

  110. <span class="w">  </span><span class="nt">safe_search</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span>
    111. 

  111. <span class="w">  </span><span class="nt">autocomplete</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;duckduckgo&#39;</span>
    112. 

  112. <span class="w">  </span><span class="nt">formats</span><span class="p">:</span>
    113. 

  113. <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">html</span>
    114. 

  114. 

  115. <span class="nt">server</span><span class="p">:</span>
    116. 

  116. <span class="w">  </span><span class="c1"># Is overwritten by ${SEARXNG_SECRET}</span>
    117. 

  117. <span class="w">  </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ultrasecretkey&quot;</span>
    118. 

  118. <span class="w">  </span><span class="nt">limiter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    119. 

  119. <span class="w">  </span><span class="nt">image_proxy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    120. 

  120. <span class="w">  </span><span class="c1"># public URL of the instance, to ensure correct inbound links. Is overwritten</span>
    121. 

  121. <span class="w">  </span><span class="c1"># by ${SEARXNG_BASE_URL}.</span>
    122. 

  122. <span class="w">  </span><span class="c1"># base_url: http://example.com/location</span>
    123. 

  123. 

  124. <span class="nt">redis</span><span class="p">:</span>
    125. 

  125. <span class="w">  </span><span class="c1"># URL to connect redis database. Is overwritten by ${SEARXNG_REDIS_URL}.</span>
    126. 

  126. <span class="w">  </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unix:///usr/local/searxng-redis/run/redis.sock?db=0</span>
    127. 

  127. 

  128. <span class="nt">ui</span><span class="p">:</span>
    129. 

  129. <span class="w">  </span><span class="nt">static_use_hash</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    130. 

  130. </pre></div>
    131. 

  131. </div>
    132. 

  132. </section>
    133. 

  133. </section>
    134. 

  134. 

  135. 

  136.             <div class="clearer"></div>
    137. 

  137.           </div>
    138. 

  138.         </div>
    139. 

  139.       </div>
    140. 

  140.   <span id="sidebar-top"></span>
    141. 

  141.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    142. 

  142.         <div class="sphinxsidebarwrapper">
    143. 

  143.   
    144. 

  144.     
    145. 

  145.             <p class="logo"><a href="../index.html">
    146. 

  146.               <img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
    147. 

  147.             </a></p>
    148. 

  148.   
    149. 

  149. 

  150. <h3><a href="../index.html">Table of Contents</a></h3>
    151. 

  151. <ul class="current">
    152. 

  152. <li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li>
    153. 

  153. <li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li>
    154. 

  154. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator documentation</a><ul class="current">
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="settings/index.html">Settings</a></li>
    156. 

  156. <li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li>
    157. 

  157. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html">Docker Container</a></li>
    158. 

  158. <li class="toctree-l2"><a class="reference internal" href="installation-scripts.html">Installation Script</a></li>
    159. 

  159. <li class="toctree-l2"><a class="reference internal" href="installation-searxng.html">Step by step installation</a></li>
    160. 

  160. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html">uWSGI</a></li>
    161. 

  161. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html">NGINX</a></li>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html">Apache</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="update-searxng.html">SearXNG maintenance</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="searx.favicons.html">Favicons</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html">Limiter</a></li>
    167. 

  167. <li class="toctree-l2"><a class="reference internal" href="api.html">Administration API</a></li>
    168. 

  168. <li class="toctree-l2 current"><a class="current reference internal" href="#">Architecture</a><ul>
    169. 

  169. <li class="toctree-l3"><a class="reference internal" href="#uwsgi-setup">uWSGI Setup</a></li>
    170. 

  170. </ul>
    171. 

  171. </li>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="plugins.html">List of plugins</a></li>
    173. 

  173. <li class="toctree-l2"><a class="reference internal" href="buildhosts.html">Buildhosts</a></li>
    174. 

  174. </ul>
    175. 

  175. </li>
    176. 

  176. <li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Developer documentation</a></li>
    177. 

  177. <li class="toctree-l1"><a class="reference internal" href="../utils/index.html">DevOps tooling box</a></li>
    178. 

  178. <li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li>
    179. 

  179. </ul>
    180. 

  180. 

  181.   <h3>Project Links</h3>
    182. 

  182.   <ul>
    183. 

  183.     <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
    184. 

  184.   
    185. 

  185.     <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
    186. 

  186.   
    187. 

  187.     <li><a href="https://searx.space">Public instances</a>
    188. 

  188.   
    189. 

  189.     <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
    190. 

  190.   </ul><h3>Navigation</h3>
    191. 

  191. <ul>
    192. 

  192.   <li><a href="../index.html">Overview</a>
    193. 

  193.     <ul>
    194. 

  194.       <li><a href="index.html">Administrator documentation</a>
    195. 

  195.         <ul>
    196. 

  196.           <li>Previous: <a href="api.html" title="previous chapter">Administration API</a>
    197. 

  197.           <li>Next: <a href="plugins.html" title="next chapter">List of plugins</a></ul>
    198. 

  198.       </li>
    199. 

  199.     </ul>
    200. 

  200.   </li>
    201. 

  201. </ul>
    202. 

  202. <search id="searchbox" style="display: none" role="search">
    203. 

  203.   <h3 id="searchlabel">Quick search</h3>
    204. 

  204.     <div class="searchformwrapper">
    205. 

  205.     <form class="search" action="../search.html" method="get">
    206. 

  206.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    207. 

  207.       <input type="submit" value="Go" />
    208. 

  208.     </form>
    209. 

  209.     </div>
    210. 

  210. </search>
    211. 

  211. <script>document.getElementById('searchbox').style.display = "block"</script>
    212. 

  212.   <div role="note" aria-label="source link">
    213. 

  213.     <h3>This Page</h3>
    214. 

  214.     <ul class="this-page-menu">
    215. 

  215.       <li><a href="../_sources/admin/architecture.rst.txt"
    216. 

  216.             rel="nofollow">Show Source</a></li>
    217. 

  217.     </ul>
    218. 

  218.    </div>
    219. 

  219.         </div>
    220. 

  220.       </div>
    221. 

  221.       <div class="clearer"></div>
    222. 

  222.     </div>
    223. 

  223.     <div class="footer" role="contentinfo">
    224. 

  224.     &#169; Copyright SearXNG team.
    225. 

  225.     </div>
    226. 

  226.   </body>
    227. 

  227. </html>
    228.
© 2025 NTab仓库
Page: 55ms Template: 1ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website