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
/
settings
/
settings_plugins.html

settings_plugins.html 14 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222 
  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>plugins: &#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="Installation" href="../installation.html" />
    18. 

  18.     <link rel="prev" title="categories_as_tabs:" href="settings_categories_as_tabs.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="../installation.html" title="Installation"
    31. 

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

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

  33.           <a href="settings_categories_as_tabs.html" title="categories_as_tabs:"
    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-1"><a href="../index.html" >Administrator documentation</a> &#187;</li>
    37. 

  37.           <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Settings</a> &#187;</li>
    38. 

  38.         <li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a></li> 
    39. 

  39.       </ul>
    40. 

  40.     </div>  
    41. 

  41. 

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

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

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

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

  46.             
    47. 

  47.   <section id="plugins">
    48. 

  48. <span id="settings-plugins"></span><h1><code class="docutils literal notranslate"><span class="pre">plugins:</span></code><a class="headerlink" href="#plugins" title="Link to this heading">¶</a></h1>
    49. 

  49. <div class="admonition attention">
    50. 

  50. <p class="admonition-title">Attention</p>
    51. 

  51. <p>The <code class="docutils literal notranslate"><span class="pre">enabled_plugins:</span></code> section in SearXNG’s settings no longer exists.
    52. 

  52. There is no longer a distinction between built-in and external plugin, all
    53. 

  53. plugins are registered via the settings in the <code class="docutils literal notranslate"><span class="pre">plugins:</span></code> section.</p>
    54. 

  54. </div>
    55. 

  55. <aside class="sidebar">
    56. 

  56. <p class="sidebar-title">Further reading ..</p>
    57. 

  57. <ul class="simple">
    58. 

  58. <li><p><a class="reference internal" href="../plugins.html#plugins-admin"><span class="std std-ref">List of plugins</span></a></p></li>
    59. 

  59. <li><p><a class="reference internal" href="../../dev/plugins/development.html#dev-plugin"><span class="std std-ref">Plugin Development</span></a></p></li>
    60. 

  60. </ul>
    61. 

  61. </aside>
    62. 

  62. <p>In SearXNG, plugins can be registered in the <a class="reference internal" href="../../dev/plugins/development.html#searx.plugins.PluginStorage" title="searx.plugins.PluginStorage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PluginStore</span></code></a> via a fully qualified class name.</p>
    63. 

  63. <p>A configuration (<a class="reference internal" href="../../dev/plugins/development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PluginCfg</span></code></a>) can be
    64. 

  64. transferred to the plugin, e.g. to activate it by default / <em>opt-in</em> or
    65. 

  65. <em>opt-out</em> from user’s point of view.</p>
    66. 

  66. <p>Please note that some plugins, such as the <a class="reference internal" href="../../dev/plugins/hostnames.html#hostnames-plugin"><span class="std std-ref">Hostnames</span></a> plugin,
    67. 

  67. require further configuration before they can be made available for selection.</p>
    68. 

  68. <section id="built-in-plugins">
    69. 

  69. <h2>built-in plugins<a class="headerlink" href="#built-in-plugins" title="Link to this heading">¶</a></h2>
    70. 

  70. <p>The built-in plugins are all located in the namespace <cite>searx.plugins</cite>.</p>
    71. 

  71. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">plugins</span><span class="p">:</span>
    72. 

  72. 

  73. <span class="w">  </span><span class="nt">searx.plugins.calculator.SXNGPlugin</span><span class="p">:</span>
    74. 

  74. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    75. 

  75. 

  76. <span class="w">  </span><span class="nt">searx.plugins.hash_plugin.SXNGPlugin</span><span class="p">:</span>
    77. 

  77. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    78. 

  78. 

  79. <span class="w">  </span><span class="nt">searx.plugins.self_info.SXNGPlugin</span><span class="p">:</span>
    80. 

  80. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    81. 

  81. 

  82. <span class="w">  </span><span class="nt">searx.plugins.tracker_url_remover.SXNGPlugin</span><span class="p">:</span>
    83. 

  83. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    84. 

  84. 

  85. <span class="w">  </span><span class="nt">searx.plugins.unit_converter.SXNGPlugin</span><span class="p">:</span>
    86. 

  86. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    87. 

  87. 

  88. <span class="w">  </span><span class="nt">searx.plugins.ahmia_filter.SXNGPlugin</span><span class="p">:</span>
    89. 

  89. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    90. 

  90. 

  91. <span class="w">  </span><span class="nt">searx.plugins.hostnames.SXNGPlugin</span><span class="p">:</span>
    92. 

  92. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
    93. 

  93. 

  94. <span class="w">  </span><span class="nt">searx.plugins.oa_doi_rewrite.SXNGPlugin</span><span class="p">:</span>
    95. 

  95. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
    96. 

  96. 

  97. <span class="w">  </span><span class="nt">searx.plugins.tor_check.SXNGPlugin</span><span class="p">:</span>
    98. 

  98. <span class="w">    </span><span class="nt">active</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
    99. 

  99. </pre></div>
    100. 

  100. </div>
    101. 

  101. </section>
    102. 

  102. <section id="external-plugins">
    103. 

  103. <span id="settings-external-plugins"></span><h2>external plugins<a class="headerlink" href="#external-plugins" title="Link to this heading">¶</a></h2>
    104. 

  104. <p>SearXNG supports <em>external plugins</em> / there is no need to install one, SearXNG
    105. 

  105. runs out of the box.</p>
    106. 

  106. <ul class="simple">
    107. 

  107. <li><p><a class="reference external" href="https://github.com/return42/tgwf-searx-plugins/">Only show green hosted results</a></p></li>
    108. 

  108. <li></li>
    109. 

  109. </ul>
    110. 

  110. </section>
    111. 

  111. </section>
    112. 

  112. 

  113. 

  114.             <div class="clearer"></div>
    115. 

  115.           </div>
    116. 

  116.         </div>
    117. 

  117.       </div>
    118. 

  118.   <span id="sidebar-top"></span>
    119. 

  119.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    120. 

  120.         <div class="sphinxsidebarwrapper">
    121. 

  121.   
    122. 

  122.     
    123. 

  123.             <p class="logo"><a href="../../index.html">
    124. 

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

  125.             </a></p>
    126. 

  126.   
    127. 

  127. 

  128. <h3><a href="../../index.html">Table of Contents</a></h3>
    129. 

  129. <ul class="current">
    130. 

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

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

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

  133. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Settings</a><ul class="current">
    134. 

  134. <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
    135. 

  135. <li class="toctree-l3"><a class="reference internal" href="settings_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
    136. 

  136. <li class="toctree-l3"><a class="reference internal" href="settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
    137. 

  137. <li class="toctree-l3"><a class="reference internal" href="settings_general.html"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
    138. 

  138. <li class="toctree-l3"><a class="reference internal" href="settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
    139. 

  139. <li class="toctree-l3"><a class="reference internal" href="settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
    140. 

  140. <li class="toctree-l3"><a class="reference internal" href="settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
    141. 

  141. <li class="toctree-l3"><a class="reference internal" href="settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
    142. 

  142. <li class="toctree-l3"><a class="reference internal" href="settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
    143. 

  143. <li class="toctree-l3"><a class="reference internal" href="settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
    144. 

  144. <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">plugins:</span></code></a><ul>
    145. 

  145. <li class="toctree-l4"><a class="reference internal" href="#built-in-plugins">built-in plugins</a></li>
    146. 

  146. <li class="toctree-l4"><a class="reference internal" href="#external-plugins">external plugins</a></li>
    147. 

  147. </ul>
    148. 

  148. </li>
    149. 

  149. </ul>
    150. 

  150. </li>
    151. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  166. </ul>
    167. 

  167. </li>
    168. 

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

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

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

  171. </ul>
    172. 

  172. 

  173.   <h3>Project Links</h3>
    174. 

  174.   <ul>
    175. 

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

  176.   
    177. 

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

  178.   
    179. 

  179.     <li><a href="https://searx.space">Public instances</a>
    180. 

  180.   
    181. 

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

  182.   </ul><h3>Navigation</h3>
    183. 

  183. <ul>
    184. 

  184.   <li><a href="../../index.html">Overview</a>
    185. 

  185.     <ul>
    186. 

  186.       <li><a href="../index.html">Administrator documentation</a>
    187. 

  187.         <ul>
    188. 

  188.       <li><a href="index.html">Settings</a>
    189. 

  189.         <ul>
    190. 

  190.           <li>Previous: <a href="settings_categories_as_tabs.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a>
    191. 

  191.           <li>Next: <a href="../installation.html" title="next chapter">Installation</a></ul>
    192. 

  192.       </li></ul>
    193. 

  193.       </li>
    194. 

  194.     </ul>
    195. 

  195.   </li>
    196. 

  196. </ul>
    197. 

  197. <search id="searchbox" style="display: none" role="search">
    198. 

  198.   <h3 id="searchlabel">Quick search</h3>
    199. 

  199.     <div class="searchformwrapper">
    200. 

  200.     <form class="search" action="../../search.html" method="get">
    201. 

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

  202.       <input type="submit" value="Go" />
    203. 

  203.     </form>
    204. 

  204.     </div>
    205. 

  205. </search>
    206. 

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

  207.   <div role="note" aria-label="source link">
    208. 

  208.     <h3>This Page</h3>
    209. 

  209.     <ul class="this-page-menu">
    210. 

  210.       <li><a href="../../_sources/admin/settings/settings_plugins.rst.txt"
    211. 

  211.             rel="nofollow">Show Source</a></li>
    212. 

  212.     </ul>
    213. 

  213.    </div>
    214. 

  214.         </div>
    215. 

  215.       </div>
    216. 

  216.       <div class="clearer"></div>
    217. 

  217.     </div>
    218. 

  218.     <div class="footer" role="contentinfo">
    219. 

  219.     &#169; Copyright SearXNG team.
    220. 

  220.     </div>
    221. 

  221.   </body>
    222. 

  222. </html>
    223.
© 2025 NTab仓库
Page: 40ms Template: 0ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website