NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
searxng
/
admin
/
index.html

index.html 16 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230 
  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>Administrator documentation &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</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=b12b0e12"></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.4.30+fd33559cf" 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="Settings" href="settings/index.html" />
    18. 

  18.     <link rel="prev" title="Why use a private instance?" href="../own-instance.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="settings/index.html" title="Settings"
    31. 

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

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

  33.           <a href="../own-instance.html" title="Why use a private instance?"
    34. 

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

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

  36.         <li class="nav-item nav-item-this"><a href="">Administrator documentation</a></li> 
    37. 

  37.       </ul>
    38. 

  38.     </div>  
    39. 

  39. 

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

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

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

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

  44.             
    45. 

  45.   <section id="administrator-documentation">
    46. 

  46. <h1>Administrator documentation<a class="headerlink" href="#administrator-documentation" title="Link to this heading">¶</a></h1>
    47. 

  47. <div class="toctree-wrapper compound">
    48. 

  48. <ul>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="settings/index.html">Settings</a><ul>
    50. 

  50. <li class="toctree-l2"><a class="reference internal" href="settings/settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
    51. 

  51. <li class="toctree-l2"><a class="reference internal" href="settings/settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
    52. 

  52. <li class="toctree-l2"><a class="reference internal" href="settings/settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
    53. 

  53. <li class="toctree-l2"><a class="reference internal" href="settings/settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
    54. 

  54. <li class="toctree-l2"><a class="reference internal" href="settings/settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
    55. 

  55. <li class="toctree-l2"><a class="reference internal" href="settings/settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
    56. 

  56. <li class="toctree-l2"><a class="reference internal" href="settings/settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
    57. 

  57. <li class="toctree-l2"><a class="reference internal" href="settings/settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
    58. 

  58. <li class="toctree-l2"><a class="reference internal" href="settings/settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="settings/settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="settings/settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li>
    61. 

  61. </ul>
    62. 

  62. </li>
    63. 

  63. <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
    64. 

  64. <li class="toctree-l1"><a class="reference internal" href="installation-docker.html">Docker Container</a><ul>
    65. 

  65. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html#get-docker">Get Docker</a></li>
    66. 

  66. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html#searxng-searxng">searxng/searxng</a></li>
    67. 

  67. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html#build-the-image">Build the image</a></li>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="installation-docker.html#command-line">Command line</a></li>
    69. 

  69. </ul>
    70. 

  70. </li>
    71. 

  71. <li class="toctree-l1"><a class="reference internal" href="installation-scripts.html">Installation Script</a></li>
    72. 

  72. <li class="toctree-l1"><a class="reference internal" href="installation-searxng.html">Step by step installation</a><ul>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="installation-searxng.html#install-packages">Install packages</a></li>
    74. 

  74. <li class="toctree-l2"><a class="reference internal" href="installation-searxng.html#create-user">Create user</a></li>
    75. 

  75. <li class="toctree-l2"><a class="reference internal" href="installation-searxng.html#install-searxng-dependencies">Install SearXNG &amp; dependencies</a></li>
    76. 

  76. <li class="toctree-l2"><a class="reference internal" href="installation-searxng.html#configuration">Configuration</a></li>
    77. 

  77. <li class="toctree-l2"><a class="reference internal" href="installation-searxng.html#check">Check</a></li>
    78. 

  78. </ul>
    79. 

  79. </li>
    80. 

  80. <li class="toctree-l1"><a class="reference internal" href="installation-uwsgi.html">uWSGI</a><ul>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#origin-uwsgi">Origin uWSGI</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#distributors">Distributors</a></li>
    83. 

  83. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#uwsgi-maintenance">uWSGI maintenance</a></li>
    84. 

  84. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#uwsgi-setup">uWSGI setup</a></li>
    85. 

  85. <li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#pitfalls-of-the-tyrant-mode">Pitfalls of the Tyrant mode</a></li>
    86. 

  86. </ul>
    87. 

  87. </li>
    88. 

  88. <li class="toctree-l1"><a class="reference internal" href="installation-nginx.html">NGINX</a><ul>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html#the-nginx-http-server">The nginx HTTP server</a></li>
    90. 

  90. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html#nginx-s-searxng-site">NGINX’s SearXNG site</a></li>
    91. 

  91. <li class="toctree-l2"><a class="reference internal" href="installation-nginx.html#disable-logs">Disable logs</a></li>
    92. 

  92. </ul>
    93. 

  93. </li>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="installation-apache.html">Apache</a><ul>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#the-apache-http-server">The Apache HTTP server</a></li>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#apache-s-searxng-site">Apache’s SearXNG site</a></li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="installation-apache.html#disable-logs">disable logs</a></li>
    98. 

  98. </ul>
    99. 

  99. </li>
    100. 

  100. <li class="toctree-l1"><a class="reference internal" href="update-searxng.html">SearXNG maintenance</a><ul>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="update-searxng.html#how-to-update">How to update</a></li>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="update-searxng.html#how-to-inspect-debug">How to inspect &amp; debug</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="update-searxng.html#migrate-and-stay-tuned">Migrate and stay tuned!</a></li>
    104. 

  104. </ul>
    105. 

  105. </li>
    106. 

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

  107. <li class="toctree-l1"><a class="reference internal" href="searx.favicons.html">Favicons</a><ul>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="searx.favicons.html#infrastructure">Infrastructure</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="searx.favicons.html#setting-up-the-cache">Setting up the cache</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="searx.favicons.html#proxy-configuration">Proxy configuration</a></li>
    111. 

  111. </ul>
    112. 

  112. </li>
    113. 

  113. <li class="toctree-l1"><a class="reference internal" href="searx.limiter.html">Limiter</a><ul>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#enable-limiter">Enable Limiter</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#configure-limiter">Configure Limiter</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#limiter-toml"><code class="docutils literal notranslate"><span class="pre">limiter.toml</span></code></a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#implementation">Implementation</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#searx.limiter.LIMITER_CFG_SCHEMA"><code class="docutils literal notranslate"><span class="pre">LIMITER_CFG_SCHEMA</span></code></a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#searx.limiter.pre_request"><code class="docutils literal notranslate"><span class="pre">pre_request()</span></code></a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#searx.limiter.is_installed"><code class="docutils literal notranslate"><span class="pre">is_installed()</span></code></a></li>
    121. 

  121. <li class="toctree-l2"><a class="reference internal" href="searx.limiter.html#searx.limiter.initialize"><code class="docutils literal notranslate"><span class="pre">initialize()</span></code></a></li>
    122. 

  122. </ul>
    123. 

  123. </li>
    124. 

  124. <li class="toctree-l1"><a class="reference internal" href="api.html">Administration API</a><ul>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="api.html#get-configuration-data">Get configuration data</a></li>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="api.html#embed-search-bar">Embed search bar</a></li>
    127. 

  127. </ul>
    128. 

  128. </li>
    129. 

  129. <li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a><ul>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="architecture.html#uwsgi-setup">uWSGI Setup</a></li>
    131. 

  131. </ul>
    132. 

  132. </li>
    133. 

  133. <li class="toctree-l1"><a class="reference internal" href="plugins.html">List of plugins</a></li>
    134. 

  134. <li class="toctree-l1"><a class="reference internal" href="buildhosts.html">Buildhosts</a><ul>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="buildhosts.html#build-and-development-tools">Build and Development tools</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="buildhosts.html#build-docs">Build docs</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="buildhosts.html#lint-shell-scripts">Lint shell scripts</a></li>
    138. 

  138. </ul>
    139. 

  139. </li>
    140. 

  140. </ul>
    141. 

  141. </div>
    142. 

  142. </section>
    143. 

  143. 

  144. 

  145.             <div class="clearer"></div>
    146. 

  146.           </div>
    147. 

  147.         </div>
    148. 

  148.       </div>
    149. 

  149.   <span id="sidebar-top"></span>
    150. 

  150.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    151. 

  151.         <div class="sphinxsidebarwrapper">
    152. 

  152.   
    153. 

  153.     
    154. 

  154.             <p class="logo"><a href="../index.html">
    155. 

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

  156.             </a></p>
    157. 

  157.   
    158. 

  158. 

  159. <h3><a href="../index.html">Table of Contents</a></h3>
    160. 

  160. <ul class="current">
    161. 

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

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

  163. <li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator documentation</a><ul>
    164. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  177. <li class="toctree-l2"><a class="reference internal" href="architecture.html">Architecture</a></li>
    178. 

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

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

  180. </ul>
    181. 

  181. </li>
    182. 

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

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

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

  185. </ul>
    186. 

  186. 

  187.   <h3>Project Links</h3>
    188. 

  188.   <ul>
    189. 

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

  190.   
    191. 

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

  192.   
    193. 

  193.     <li><a href="https://searx.space">Public instances</a>
    194. 

  194.   
    195. 

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

  196.   </ul><h3>Navigation</h3>
    197. 

  197. <ul>
    198. 

  198.   <li><a href="../index.html">Overview</a>
    199. 

  199.     <ul>
    200. 

  200.           <li>Previous: <a href="../own-instance.html" title="previous chapter">Why use a private instance?</a>
    201. 

  201.           <li>Next: <a href="settings/index.html" title="next chapter">Settings</a>
    202. 

  202.     </ul>
    203. 

  203.   </li>
    204. 

  204. </ul>
    205. 

  205. <search id="searchbox" style="display: none" role="search">
    206. 

  206.   <h3 id="searchlabel">Quick search</h3>
    207. 

  207.     <div class="searchformwrapper">
    208. 

  208.     <form class="search" action="../search.html" method="get">
    209. 

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

  210.       <input type="submit" value="Go" />
    211. 

  211.     </form>
    212. 

  212.     </div>
    213. 

  213. </search>
    214. 

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

  215.   <div role="note" aria-label="source link">
    216. 

  216.     <h3>This Page</h3>
    217. 

  217.     <ul class="this-page-menu">
    218. 

  218.       <li><a href="../_sources/admin/index.rst.txt"
    219. 

  219.             rel="nofollow">Show Source</a></li>
    220. 

  220.     </ul>
    221. 

  221.    </div>
    222. 

  222.         </div>
    223. 

  223.       </div>
    224. 

  224.       <div class="clearer"></div>
    225. 

  225.     </div>
    226. 

  226.     <div class="footer" role="contentinfo">
    227. 

  227.     &#169; Copyright SearXNG team.
    228. 

  228.     </div>
    229. 

  229.   </body>
    230. 

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