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

index.html 18 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247 
  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>Developer 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="Development Quickstart" href="quickstart.html" />
    18. 

  18.     <link rel="prev" title="Buildhosts" href="../admin/buildhosts.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="quickstart.html" title="Development Quickstart"
    31. 

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

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

  33.           <a href="../admin/buildhosts.html" title="Buildhosts"
    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="">Developer 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="developer-documentation">
    46. 

  46. <h1>Developer documentation<a class="headerlink" href="#developer-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="quickstart.html">Development Quickstart</a></li>
    50. 

  50. <li class="toctree-l1"><a class="reference internal" href="rtm_asdf.html">Runtime Management</a><ul>
    51. 

  51. <li class="toctree-l2"><a class="reference internal" href="rtm_asdf.html#get-started">Get started</a></li>
    52. 

  52. <li class="toctree-l2"><a class="reference internal" href="rtm_asdf.html#manage-versions">Manage Versions</a></li>
    53. 

  53. <li class="toctree-l2"><a class="reference internal" href="rtm_asdf.html#introduce-asdf">Introduce asdf</a></li>
    54. 

  54. </ul>
    55. 

  55. </li>
    56. 

  56. <li class="toctree-l1"><a class="reference internal" href="contribution_guide.html">How to contribute</a><ul>
    57. 

  57. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#prime-directives-privacy-hackability">Prime directives: Privacy, Hackability</a></li>
    58. 

  58. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#code">Code</a></li>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#translation">Translation</a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#documentation">Documentation</a></li>
    61. 

  61. </ul>
    62. 

  62. </li>
    63. 

  63. <li class="toctree-l1"><a class="reference internal" href="extended_types.html">Extended Types</a><ul>
    64. 

  64. <li class="toctree-l2"><a class="reference internal" href="extended_types.html#searx.extended_types.sxng_request"><code class="docutils literal notranslate"><span class="pre">sxng_request</span></code></a></li>
    65. 

  65. <li class="toctree-l2"><a class="reference internal" href="extended_types.html#searx.extended_types.SXNG_Request"><code class="docutils literal notranslate"><span class="pre">SXNG_Request</span></code></a></li>
    66. 

  66. <li class="toctree-l2"><a class="reference internal" href="extended_types.html#searx.extended_types.SXNG_Response"><code class="docutils literal notranslate"><span class="pre">SXNG_Response</span></code></a></li>
    67. 

  67. </ul>
    68. 

  68. </li>
    69. 

  69. <li class="toctree-l1"><a class="reference internal" href="engines/index.html">Engine Implementations</a><ul>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="engines/enginelib.html">Engine Library</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="engines/engines.html">SearXNG’s engines loader</a></li>
    72. 

  72. <li class="toctree-l2"><a class="reference internal" href="engines/engine_overview.html">Engine Overview</a></li>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="engines/index.html#resultlist-and-engines">ResultList and engines</a></li>
    74. 

  74. <li class="toctree-l2"><a class="reference internal" href="engines/index.html#engine-types">Engine Types</a></li>
    75. 

  75. </ul>
    76. 

  76. </li>
    77. 

  77. <li class="toctree-l1"><a class="reference internal" href="result_types/index.html">Result Types</a><ul>
    78. 

  78. <li class="toctree-l2"><a class="reference internal" href="result_types/base_result.html">Result</a></li>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="result_types/main_result.html">Main Search Results</a></li>
    80. 

  80. <li class="toctree-l2"><a class="reference internal" href="result_types/answer.html">Answer Results</a></li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="result_types/correction.html">Correction Results</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="result_types/suggestion.html">Suggestion Results</a></li>
    83. 

  83. <li class="toctree-l2"><a class="reference internal" href="result_types/infobox.html">Infobox Results</a></li>
    84. 

  84. </ul>
    85. 

  85. </li>
    86. 

  86. <li class="toctree-l1"><a class="reference internal" href="templates.html">Simple Theme Templates</a><ul>
    87. 

  87. <li class="toctree-l2"><a class="reference internal" href="templates.html#result-template-macros">Result template macros</a></li>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="templates.html#main-result-list">Main Result List</a></li>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="templates.html#answer-results">Answer results</a></li>
    90. 

  90. <li class="toctree-l2"><a class="reference internal" href="templates.html#suggestion-results">Suggestion results</a></li>
    91. 

  91. <li class="toctree-l2"><a class="reference internal" href="templates.html#correction-results">Correction results</a></li>
    92. 

  92. <li class="toctree-l2"><a class="reference internal" href="templates.html#infobox-results">Infobox results</a></li>
    93. 

  93. </ul>
    94. 

  94. </li>
    95. 

  95. <li class="toctree-l1"><a class="reference internal" href="search_api.html">Search API</a><ul>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="search_api.html#parameters">Parameters</a></li>
    97. 

  97. </ul>
    98. 

  98. </li>
    99. 

  99. <li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugins</a><ul>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="plugins/development.html">Plugin Development</a></li>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="plugins/builtins.html">Built-in Plugins</a></li>
    102. 

  102. </ul>
    103. 

  103. </li>
    104. 

  104. <li class="toctree-l1"><a class="reference internal" href="answerers/index.html">Answerers</a><ul>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="answerers/development.html">Answerer Development</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="answerers/builtins.html">Built-in Answerers</a></li>
    107. 

  107. </ul>
    108. 

  108. </li>
    109. 

  109. <li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a><ul>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="translation.html#id2">wlc</a></li>
    111. 

  111. </ul>
    112. 

  112. </li>
    113. 

  113. <li class="toctree-l1"><a class="reference internal" href="lxcdev.html">Developing in Linux Containers</a><ul>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html#motivation">Motivation</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html#gentlemen-start-your-engines">Gentlemen, start your engines!</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html#in-containers-work-as-usual">In containers, work as usual</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html#wrap-production-into-developer-suite">Wrap production into developer suite</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html#summary">Summary</a></li>
    119. 

  119. </ul>
    120. 

  120. </li>
    121. 

  121. <li class="toctree-l1"><a class="reference internal" href="makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a><ul>
    122. 

  122. <li class="toctree-l2"><a class="reference internal" href="makefile.html#python-environment-make-install">Python environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code>)</a></li>
    123. 

  123. <li class="toctree-l2"><a class="reference internal" href="makefile.html#node-js-environment-make-node-env">Node.js environment (<code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">node.env</span></code>)</a></li>
    124. 

  124. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-run"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code></a></li>
    125. 

  125. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-format-python"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">format.python</span></code></a></li>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-clean"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code></a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-docs"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span></code></a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-test"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-search-checker-engine-name"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">search.checker.{engine</span> <span class="pre">name}</span></code></a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-themes"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">themes.*</span></code></a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-static-build"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">static.build.*</span></code></a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="makefile.html#manage-redis-help"><code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">redis.help</span></code></a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="makefile.html#manage-go-help"><code class="docutils literal notranslate"><span class="pre">./manage</span> <span class="pre">go.help</span></code></a></li>
    134. 

  134. </ul>
    135. 

  135. </li>
    136. 

  136. <li class="toctree-l1"><a class="reference internal" href="reST.html">reST primer</a><ul>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="reST.html#soft-skills">Soft skills</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="reST.html#basic-inline-markup">Basic inline markup</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="reST.html#basic-article-structure">Basic article structure</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="reST.html#anchors-links">Anchors &amp; Links</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="reST.html#literal-blocks">Literal blocks</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="reST.html#unicode-substitution">Unicode substitution</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="reST.html#roles">Roles</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="reST.html#figures-images">Figures &amp; Images</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="reST.html#list-markups">List markups</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="reST.html#admonitions">Admonitions</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="reST.html#tables">Tables</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="reST.html#templating">Templating</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="reST.html#tabbed-views">Tabbed views</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="reST.html#math-equations">Math equations</a></li>
    151. 

  151. </ul>
    152. 

  152. </li>
    153. 

  153. <li class="toctree-l1"><a class="reference internal" href="searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a><ul>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="searxng_extra/update.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/update/</span></code></a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="searxng_extra/standalone_searx.py.html"><code class="docutils literal notranslate"><span class="pre">searxng_extra/standalone_searx.py</span></code></a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. </div>
    160. 

  160. </section>
    161. 

  161. 

  162. 

  163.             <div class="clearer"></div>
    164. 

  164.           </div>
    165. 

  165.         </div>
    166. 

  166.       </div>
    167. 

  167.   <span id="sidebar-top"></span>
    168. 

  168.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    169. 

  169.         <div class="sphinxsidebarwrapper">
    170. 

  170.   
    171. 

  171.     
    172. 

  172.             <p class="logo"><a href="../index.html">
    173. 

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

  174.             </a></p>
    175. 

  175.   
    176. 

  176. 

  177. <h3><a href="../index.html">Table of Contents</a></h3>
    178. 

  178. <ul class="current">
    179. 

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

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

  181. <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator documentation</a></li>
    182. 

  182. <li class="toctree-l1 current"><a class="current reference internal" href="#">Developer documentation</a><ul>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="rtm_asdf.html">Runtime Management</a></li>
    185. 

  185. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html">How to contribute</a></li>
    186. 

  186. <li class="toctree-l2"><a class="reference internal" href="extended_types.html">Extended Types</a></li>
    187. 

  187. <li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="search_api.html">Search API</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="plugins/index.html">Plugins</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</a></li>
    193. 

  193. <li class="toctree-l2"><a class="reference internal" href="translation.html">Translation</a></li>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html">Developing in Linux Containers</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="reST.html">reST primer</a></li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
    198. 

  198. </ul>
    199. 

  199. </li>
    200. 

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

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

  202. </ul>
    203. 

  203. 

  204.   <h3>Project Links</h3>
    205. 

  205.   <ul>
    206. 

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

  207.   
    208. 

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

  209.   
    210. 

  210.     <li><a href="https://searx.space">Public instances</a>
    211. 

  211.   
    212. 

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

  213.   </ul><h3>Navigation</h3>
    214. 

  214. <ul>
    215. 

  215.   <li><a href="../index.html">Overview</a>
    216. 

  216.     <ul>
    217. 

  217.           <li>Previous: <a href="../admin/buildhosts.html" title="previous chapter">Buildhosts</a>
    218. 

  218.           <li>Next: <a href="quickstart.html" title="next chapter">Development Quickstart</a>
    219. 

  219.     </ul>
    220. 

  220.   </li>
    221. 

  221. </ul>
    222. 

  222. <search id="searchbox" style="display: none" role="search">
    223. 

  223.   <h3 id="searchlabel">Quick search</h3>
    224. 

  224.     <div class="searchformwrapper">
    225. 

  225.     <form class="search" action="../search.html" method="get">
    226. 

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

  227.       <input type="submit" value="Go" />
    228. 

  228.     </form>
    229. 

  229.     </div>
    230. 

  230. </search>
    231. 

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

  232.   <div role="note" aria-label="source link">
    233. 

  233.     <h3>This Page</h3>
    234. 

  234.     <ul class="this-page-menu">
    235. 

  235.       <li><a href="../_sources/dev/index.rst.txt"
    236. 

  236.             rel="nofollow">Show Source</a></li>
    237. 

  237.     </ul>
    238. 

  238.    </div>
    239. 

  239.         </div>
    240. 

  240.       </div>
    241. 

  241.       <div class="clearer"></div>
    242. 

  242.     </div>
    243. 

  243.     <div class="footer" role="contentinfo">
    244. 

  244.     &#169; Copyright SearXNG team.
    245. 

  245.     </div>
    246. 

  246.   </body>
    247. 

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