gitea.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../../">
  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>Gitea &#8212; SearXNG Documentation (2025.5.1+1a1628149)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../../_static/documentation_options.js?v=cc9fc81d"></script>
  11. <script src="../../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.5.1+1a1628149" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../../genindex.html" />
  15. <link rel="search" title="Search" href="../../../search.html" />
  16. <link rel="next" title="GitLab" href="gitlab.html" />
  17. <link rel="prev" title="Geizhals" href="geizhals.html" />
  18. </head><body>
  19. <div class="related" role="navigation" aria-label="Related">
  20. <h3>Navigation</h3>
  21. <ul>
  22. <li class="right" style="margin-right: 10px">
  23. <a href="../../../genindex.html" title="General Index"
  24. accesskey="I">index</a></li>
  25. <li class="right" >
  26. <a href="../../../py-modindex.html" title="Python Module Index"
  27. >modules</a> |</li>
  28. <li class="right" >
  29. <a href="gitlab.html" title="GitLab"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="geizhals.html" title="Geizhals"
  33. accesskey="P">previous</a> |</li>
  34. <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.1+1a1628149)</a> &#187;</li>
  35. <li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> &#187;</li>
  36. <li class="nav-item nav-item-2"><a href="../index.html" accesskey="U">Engine Implementations</a> &#187;</li>
  37. <li class="nav-item nav-item-this"><a href="">Gitea</a></li>
  38. </ul>
  39. </div>
  40. <div class="document">
  41. <div class="documentwrapper">
  42. <div class="bodywrapper">
  43. <div class="body" role="main">
  44. <section id="module-searx.engines.gitea">
  45. <span id="gitea"></span><span id="gitea-engine"></span><h1>Gitea<a class="headerlink" href="#module-searx.engines.gitea" title="Link to this heading">¶</a></h1>
  46. <p>Engine to search in collaborative software platforms based on <a class="reference external" href="https://about.gitea.com/">Gitea</a> or <a class="reference external" href="https://forgejo.org/">Forgejo</a>.</p>
  47. <section id="configuration">
  48. <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
  49. <p>The engine has the following mandatory setting:</p>
  50. <ul class="simple">
  51. <li><p><a class="reference internal" href="#searx.engines.gitea.base_url" title="searx.engines.gitea.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></li>
  52. </ul>
  53. <p>Optional settings are:</p>
  54. <ul class="simple">
  55. <li><p><a class="reference internal" href="#searx.engines.gitea.sort" title="searx.engines.gitea.sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sort</span></code></a></p></li>
  56. <li><p><a class="reference internal" href="#searx.engines.gitea.order" title="searx.engines.gitea.order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">order</span></code></a></p></li>
  57. <li><p><a class="reference internal" href="#searx.engines.gitea.page_size" title="searx.engines.gitea.page_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_size</span></code></a></p></li>
  58. </ul>
  59. <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea.com</span>
  60. <span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea</span>
  61. <span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://gitea.com</span>
  62. <span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea</span>
  63. <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">forgejo.com</span>
  64. <span class="w"> </span><span class="nt">engine</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gitea</span>
  65. <span class="w"> </span><span class="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://code.forgejo.org</span>
  66. <span class="w"> </span><span class="nt">shortcut</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">forgejo</span>
  67. </pre></div>
  68. </div>
  69. <p>If you would like to use additional instances, just configure new engines in the
  70. <a class="reference internal" href="../../../admin/settings/settings_engines.html#settings-engines"><span class="std std-ref">settings</span></a> and set the <code class="docutils literal notranslate"><span class="pre">base_url</span></code>.</p>
  71. </section>
  72. <section id="implementation">
  73. <h2>Implementation<a class="headerlink" href="#implementation" title="Link to this heading">¶</a></h2>
  74. </section>
  75. <dl class="py data">
  76. <dt class="sig sig-object py" id="searx.engines.gitea.base_url">
  77. <span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#searx.engines.gitea.base_url" title="Link to this definition">¶</a></dt>
  78. <dd><p>URL of the <a class="reference external" href="https://about.gitea.com/">Gitea</a> instance.</p>
  79. </dd></dl>
  80. <dl class="py data">
  81. <dt class="sig sig-object py" id="searx.engines.gitea.sort">
  82. <span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">sort</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'updated'</span></em><a class="headerlink" href="#searx.engines.gitea.sort" title="Link to this definition">¶</a></dt>
  83. <dd><p>Sort criteria, possible values:</p>
  84. <ul class="simple">
  85. <li><p><code class="docutils literal notranslate"><span class="pre">updated</span></code> (default)</p></li>
  86. <li><p><code class="docutils literal notranslate"><span class="pre">alpha</span></code></p></li>
  87. <li><p><code class="docutils literal notranslate"><span class="pre">created</span></code></p></li>
  88. <li><p><code class="docutils literal notranslate"><span class="pre">size</span></code></p></li>
  89. <li><p><code class="docutils literal notranslate"><span class="pre">id</span></code></p></li>
  90. </ul>
  91. </dd></dl>
  92. <dl class="py data">
  93. <dt class="sig sig-object py" id="searx.engines.gitea.order">
  94. <span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'desc'</span></em><a class="headerlink" href="#searx.engines.gitea.order" title="Link to this definition">¶</a></dt>
  95. <dd><p>Sort order, possible values:</p>
  96. <ul class="simple">
  97. <li><p><code class="docutils literal notranslate"><span class="pre">desc</span></code> (default)</p></li>
  98. <li><p><code class="docutils literal notranslate"><span class="pre">asc</span></code></p></li>
  99. </ul>
  100. </dd></dl>
  101. <dl class="py data">
  102. <dt class="sig sig-object py" id="searx.engines.gitea.page_size">
  103. <span class="sig-prename descclassname"><span class="pre">searx.engines.gitea.</span></span><span class="sig-name descname"><span class="pre">page_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#searx.engines.gitea.page_size" title="Link to this definition">¶</a></dt>
  104. <dd><p>Maximum number of results per page (default 10).</p>
  105. </dd></dl>
  106. </section>
  107. <div class="clearer"></div>
  108. </div>
  109. </div>
  110. </div>
  111. <span id="sidebar-top"></span>
  112. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  113. <div class="sphinxsidebarwrapper">
  114. <p class="logo"><a href="../../../index.html">
  115. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  116. </a></p>
  117. <h3><a href="../../../index.html">Table of Contents</a></h3>
  118. <ul class="current">
  119. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  120. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  121. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  122. <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer documentation</a><ul class="current">
  123. <li class="toctree-l2"><a class="reference internal" href="../../quickstart.html">Development Quickstart</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="../../rtm_asdf.html">Runtime Management</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="../../contribution_guide.html">How to contribute</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="../../extended_types.html">Extended Types</a></li>
  127. <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Engine Implementations</a><ul class="current">
  128. <li class="toctree-l3"><a class="reference internal" href="../enginelib.html">Engine Library</a></li>
  129. <li class="toctree-l3"><a class="reference internal" href="../engines.html">SearXNG’s engines loader</a></li>
  130. <li class="toctree-l3"><a class="reference internal" href="../engine_overview.html">Engine Overview</a></li>
  131. <li class="toctree-l3"><a class="reference internal" href="../index.html#resultlist-and-engines">ResultList and engines</a></li>
  132. <li class="toctree-l3 current"><a class="reference internal" href="../index.html#engine-types">Engine Types</a><ul class="current">
  133. <li class="toctree-l4 current"><a class="reference internal" href="../index.html#online-engines">Online Engines</a><ul class="current">
  134. <li class="toctree-l5"><a class="reference internal" href="../demo/demo_online.html">Demo Online Engine</a></li>
  135. <li class="toctree-l5"><a class="reference internal" href="../xpath.html">XPath Engine</a></li>
  136. <li class="toctree-l5"><a class="reference internal" href="../mediawiki.html">MediaWiki Engine</a></li>
  137. <li class="toctree-l5"><a class="reference internal" href="../json_engine.html">JSON Engine</a></li>
  138. <li class="toctree-l5"><a class="reference internal" href="adobe_stock.html">Adobe Stock</a></li>
  139. <li class="toctree-l5"><a class="reference internal" href="alpinelinux.html">Alpine Linux Packages</a></li>
  140. <li class="toctree-l5"><a class="reference internal" href="annas_archive.html">Anna’s Archive</a></li>
  141. <li class="toctree-l5"><a class="reference internal" href="archlinux.html">Arch Linux</a></li>
  142. <li class="toctree-l5"><a class="reference internal" href="bing.html">Bing Engines</a></li>
  143. <li class="toctree-l5"><a class="reference internal" href="bpb.html">Bpb</a></li>
  144. <li class="toctree-l5"><a class="reference internal" href="brave.html">Brave Engines</a></li>
  145. <li class="toctree-l5"><a class="reference internal" href="bt4g.html">BT4G</a></li>
  146. <li class="toctree-l5"><a class="reference internal" href="core.html">CORE</a></li>
  147. <li class="toctree-l5"><a class="reference internal" href="dailymotion.html">Dailymotion</a></li>
  148. <li class="toctree-l5"><a class="reference internal" href="discourse.html">Discourse Forums</a></li>
  149. <li class="toctree-l5"><a class="reference internal" href="duckduckgo.html">DuckDuckGo Engines</a></li>
  150. <li class="toctree-l5"><a class="reference internal" href="geizhals.html">Geizhals</a></li>
  151. <li class="toctree-l5 current"><a class="current reference internal" href="#">Gitea</a></li>
  152. <li class="toctree-l5"><a class="reference internal" href="gitlab.html">GitLab</a></li>
  153. <li class="toctree-l5"><a class="reference internal" href="google.html">Google Engines</a></li>
  154. <li class="toctree-l5"><a class="reference internal" href="huggingface.html">Hugging Face</a></li>
  155. <li class="toctree-l5"><a class="reference internal" href="lemmy.html">Lemmy</a></li>
  156. <li class="toctree-l5"><a class="reference internal" href="loc.html">Library of Congress</a></li>
  157. <li class="toctree-l5"><a class="reference internal" href="mastodon.html">Mastodon</a></li>
  158. <li class="toctree-l5"><a class="reference internal" href="moviepilot.html">Moviepilot</a></li>
  159. <li class="toctree-l5"><a class="reference internal" href="mrs.html">Matrix Rooms Search (MRS)</a></li>
  160. <li class="toctree-l5"><a class="reference internal" href="mullvad_leta.html">Mullvad-Leta</a></li>
  161. <li class="toctree-l5"><a class="reference internal" href="mwmbl.html">Mwmbl Engine</a></li>
  162. <li class="toctree-l5"><a class="reference internal" href="odysee.html">Odysee</a></li>
  163. <li class="toctree-l5"><a class="reference internal" href="peertube.html">Peertube Engines</a></li>
  164. <li class="toctree-l5"><a class="reference internal" href="piped.html">Piped</a></li>
  165. <li class="toctree-l5"><a class="reference internal" href="presearch.html">Presearch Engine</a></li>
  166. <li class="toctree-l5"><a class="reference internal" href="qwant.html">Qwant</a></li>
  167. <li class="toctree-l5"><a class="reference internal" href="radio_browser.html">RadioBrowser</a></li>
  168. <li class="toctree-l5"><a class="reference internal" href="recoll.html">Recoll Engine</a></li>
  169. <li class="toctree-l5"><a class="reference internal" href="reuters.html">Reuters</a></li>
  170. <li class="toctree-l5"><a class="reference internal" href="seekr.html">Seekr Engines</a></li>
  171. <li class="toctree-l5"><a class="reference internal" href="soundcloud.html">Soundcloud</a></li>
  172. <li class="toctree-l5"><a class="reference internal" href="startpage.html">Startpage Engines</a></li>
  173. <li class="toctree-l5"><a class="reference internal" href="tagesschau.html">Tagesschau API</a></li>
  174. <li class="toctree-l5"><a class="reference internal" href="torznab.html">Torznab WebAPI</a></li>
  175. <li class="toctree-l5"><a class="reference internal" href="void.html">Void Linux binary packages</a></li>
  176. <li class="toctree-l5"><a class="reference internal" href="wallhaven.html">Wallhaven</a></li>
  177. <li class="toctree-l5"><a class="reference internal" href="wikipedia.html">Wikimedia</a></li>
  178. <li class="toctree-l5"><a class="reference internal" href="yacy.html">Yacy</a></li>
  179. <li class="toctree-l5"><a class="reference internal" href="yahoo.html">Yahoo Engine</a></li>
  180. <li class="toctree-l5"><a class="reference internal" href="zlibrary.html">Z-Library</a></li>
  181. </ul>
  182. </li>
  183. <li class="toctree-l4"><a class="reference internal" href="../index.html#offline-engines">Offline Engines</a></li>
  184. <li class="toctree-l4"><a class="reference internal" href="../index.html#online-url-search">Online URL Search</a></li>
  185. <li class="toctree-l4"><a class="reference internal" href="../index.html#online-currency">Online Currency</a></li>
  186. <li class="toctree-l4"><a class="reference internal" href="../index.html#online-dictionary">Online Dictionary</a></li>
  187. </ul>
  188. </li>
  189. </ul>
  190. </li>
  191. <li class="toctree-l2"><a class="reference internal" href="../../result_types/index.html">Result Types</a></li>
  192. <li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
  193. <li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
  194. <li class="toctree-l2"><a class="reference internal" href="../../plugins/index.html">Plugins</a></li>
  195. <li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</a></li>
  196. <li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
  197. <li class="toctree-l2"><a class="reference internal" href="../../lxcdev.html">Developing in Linux Containers</a></li>
  198. <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>
  199. <li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
  200. <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>
  201. </ul>
  202. </li>
  203. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  204. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  205. </ul>
  206. <h3>Project Links</h3>
  207. <ul>
  208. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  209. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  210. <li><a href="https://searx.space">Public instances</a>
  211. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  212. </ul><h3>Navigation</h3>
  213. <ul>
  214. <li><a href="../../../index.html">Overview</a>
  215. <ul>
  216. <li><a href="../../index.html">Developer documentation</a>
  217. <ul>
  218. <li><a href="../index.html">Engine Implementations</a>
  219. <ul>
  220. <li>Previous: <a href="geizhals.html" title="previous chapter">Geizhals</a>
  221. <li>Next: <a href="gitlab.html" title="next chapter">GitLab</a></ul>
  222. </li></ul>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. <search id="searchbox" style="display: none" role="search">
  228. <h3 id="searchlabel">Quick search</h3>
  229. <div class="searchformwrapper">
  230. <form class="search" action="../../../search.html" method="get">
  231. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  232. <input type="submit" value="Go" />
  233. </form>
  234. </div>
  235. </search>
  236. <script>document.getElementById('searchbox').style.display = "block"</script>
  237. <div role="note" aria-label="source link">
  238. <h3>This Page</h3>
  239. <ul class="this-page-menu">
  240. <li><a href="../../../_sources/dev/engines/online/gitea.rst.txt"
  241. rel="nofollow">Show Source</a></li>
  242. </ul>
  243. </div>
  244. </div>
  245. </div>
  246. <div class="clearer"></div>
  247. </div>
  248. <div class="footer" role="contentinfo">
  249. &#169; Copyright SearXNG team.
  250. </div>
  251. </body>
  252. </html>