Home Explore Help
Sign In
searX
/
searx
mirror of https://github.com/searx/searx
Watch 3
Star 0
Fork 0
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
searx
/
admin
/
installation-uwsgi.html

installation-uwsgi.html 29 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506 
  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. <html lang="en">
    5. 

  5.   <head>
    6. 

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

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

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

  9.     <title>uwsgi &#8212; Searx Documentation (Searx-1.1.0.tex)</title>
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    11. 

  11.     <link rel="stylesheet" type="text/css" href="../_static/searx.css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
    13. 

  13.     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    14. 

  14.     <script src="../_static/jquery.js"></script>
    15. 

  15.     <script src="../_static/underscore.js"></script>
    16. 

  16.     <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
    17. 

  17.     <script src="../_static/doctools.js"></script>
    18. 

  18.     <script src="../_static/sphinx_highlight.js"></script>
    19. 

  19.     <script src="../_static/tabs.js"></script>
    20. 

  20.     <link rel="index" title="Index" href="../genindex.html" />
    21. 

  21.     <link rel="search" title="Search" href="../search.html" />
    22. 

  22.     <link rel="next" title="Install with nginx" href="installation-nginx.html" />
    23. 

  23.     <link rel="prev" title="Step by step installation" href="installation-searx.html" /> 
    24. 

  24.   </head><body>
    25. 

  25.     <div class="related" role="navigation" aria-label="related navigation">
    26. 

  26.       <h3>Navigation</h3>
    27. 

  27.       <ul>
    28. 

  28.         <li class="right" style="margin-right: 10px">
    29. 

  29.           <a href="../genindex.html" title="General Index"
    30. 

  30.              accesskey="I">index</a></li>
    31. 

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

  32.           <a href="../py-modindex.html" title="Python Module Index"
    33. 

  33.              >modules</a> |</li>
    34. 

  34.         <li class="right" >
    35. 

  35.           <a href="installation-nginx.html" title="Install with nginx"
    36. 

  36.              accesskey="N">next</a> |</li>
    37. 

  37.         <li class="right" >
    38. 

  38.           <a href="installation-searx.html" title="Step by step installation"
    39. 

  39.              accesskey="P">previous</a> |</li>
    40. 

  40.         <li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.1.0.tex)</a> &#187;</li>
    41. 

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

  42.         <li class="nav-item nav-item-this"><a href="">uwsgi</a></li> 
    43. 

  43.       </ul>
    44. 

  44.     </div>  
    45. 

  45. 

  46.     <div class="document">
    47. 

  47.       <div class="documentwrapper">
    48. 

  48.         <div class="bodywrapper">
    49. 

  49.           <div class="body" role="main">
    50. 

  50.             
    51. 

  51.   <section id="uwsgi">
    52. 

  52. <span id="searx-uwsgi"></span><h1>uwsgi<a class="headerlink" href="#uwsgi" title="Permalink to this heading">¶</a></h1>
    53. 

  53. <aside class="sidebar">
    54. 

  54. <p class="sidebar-title">further reading</p>
    55. 

  55. <ul class="simple">
    56. 

  56. <li><p><a class="reference external" href="https://www.freedesktop.org/software/systemd/man/systemd.unit.html">systemd.unit</a></p></li>
    57. 

  57. <li><p><a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html">uWSGI Emperor</a></p></li>
    58. 

  58. </ul>
    59. 

  59. </aside>
    60. 

  60. <nav class="contents local" id="contents">
    61. 

  61. <p class="topic-title">Contents</p>
    62. 

  62. <ul class="simple">
    63. 

  63. <li><p><a class="reference internal" href="#origin-uwsgi" id="id1">Origin uWSGI</a></p></li>
    64. 

  64. <li><p><a class="reference internal" href="#distributors" id="id2">Distributors</a></p></li>
    65. 

  65. <li><p><a class="reference internal" href="#all-together" id="id3">All together</a></p></li>
    66. 

  66. </ul>
    67. 

  67. </nav>
    68. 

  68. <section id="origin-uwsgi">
    69. 

  69. <h2><a class="toc-backref" href="#id1" role="doc-backlink">Origin uWSGI</a><a class="headerlink" href="#origin-uwsgi" title="Permalink to this heading">¶</a></h2>
    70. 

  70. <p>How uWSGI is implemented by distributors is different.  uWSGI itself
    71. 

  71. recommend two methods</p>
    72. 

  72. <p><a class="reference external" href="https://www.freedesktop.org/software/systemd/man/systemd.unit.html">systemd.unit</a> template files as described here <a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd">One service per app in systemd</a>.</p>
    73. 

  73. <blockquote>
    74. 

  74. <div><p>There is one <a class="reference external" href="http://0pointer.de/blog/projects/instances.html">systemd unit template</a> and one <a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html#ini-files">uwsgi ini file</a> per uWSGI-app
    75. 

  75. placed at dedicated locations.  Take archlinux and a searx.ini as example:</p>
    76. 

  76. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>unit template    --&gt;  /usr/lib/systemd/system/uwsgi@.service
    77. 

  77. uwsgi ini files  --&gt;  /etc/uwsgi/searx.ini
    78. 

  78. </pre></div>
    79. 

  79. </div>
    80. 

  80. <p>The searx app can be maintained as know from common systemd units:</p>
    81. 

  81. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>systemctl enable  uwsgi@searx
    82. 

  82. systemctl start   uwsgi@searx
    83. 

  83. systemctl restart uwsgi@searx
    84. 

  84. systemctl stop    uwsgi@searx
    85. 

  85. </pre></div>
    86. 

  86. </div>
    87. 

  87. </div></blockquote>
    88. 

  88. <p>The <a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html">uWSGI Emperor</a> mode which fits for maintaining a large range of uwsgi apps.</p>
    89. 

  89. <blockquote>
    90. 

  90. <div><p>The Emperor mode is a special uWSGI instance that will monitor specific
    91. 

  91. events.  The Emperor mode (service) is started by a (common, not template)
    92. 

  92. systemd unit.  The Emperor service will scan specific directories for <a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html#ini-files">uwsgi
    93. 

  93. ini file</a>s (also know as <em>vassals</em>).  If a <em>vassal</em> is added, removed or the
    94. 

  94. timestamp is modified, a corresponding action takes place: a new uWSGI
    95. 

  95. instance is started, reload or stopped.  Take Fedora and a searx.ini as
    96. 

  96. example:</p>
    97. 

  97. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>to start a new searx instance create   --&gt; /etc/uwsgi.d/searx.ini
    98. 

  98. to reload the instance edit timestamp  --&gt; touch /etc/uwsgi.d/searx.ini
    99. 

  99. to stop instance remove ini            --&gt; rm /etc/uwsgi.d/searx.ini
    100. 

  100. </pre></div>
    101. 

  101. </div>
    102. 

  102. </div></blockquote>
    103. 

  103. </section>
    104. 

  104. <section id="distributors">
    105. 

  105. <h2><a class="toc-backref" href="#id2" role="doc-backlink">Distributors</a><a class="headerlink" href="#distributors" title="Permalink to this heading">¶</a></h2>
    106. 

  106. <p>The <a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html">uWSGI Emperor</a> mode and <a class="reference external" href="http://0pointer.de/blog/projects/instances.html">systemd unit template</a> is what the distributors
    107. 

  107. mostly offer their users, even if they differ in the way they implement both
    108. 

  108. modes and their defaults.  Another point they might differ is the packaging of
    109. 

  109. plugins (if so, compare <a class="reference internal" href="installation-searx.html#install-packages"><span class="std std-ref">Install packages</span></a>) and what the default python
    110. 

  110. interpreter is (python2 vs. python3).</p>
    111. 

  111. <p>Fedora starts a Emperor by default, while archlinux does not start any uwsgi
    112. 

  112. service by default.  Worth to know; debian (ubuntu) follow a complete different
    113. 

  113. approach.  <em>debian</em>: your are familiar with the apache infrastructure? .. they
    114. 

  114. do similar for the uWSGI infrastructure (with less comfort), the folders are:</p>
    115. 

  115. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>/etc/uwsgi/apps-available/
    116. 

  116. /etc/uwsgi/apps-enabled/
    117. 

  117. </pre></div>
    118. 

  118. </div>
    119. 

  119. <p>The <a class="reference external" href="https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html#ini-files">uwsgi ini file</a> is enabled by a symbolic link:</p>
    120. 

  120. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ln -s /etc/uwsgi/apps-available/searx.ini /etc/uwsgi/apps-enabled/
    121. 

  121. </pre></div>
    122. 

  122. </div>
    123. 

  123. <p>From debian’s documentation (<code class="docutils literal notranslate"><span class="pre">/usr/share/doc/uwsgi/README.Debian.gz</span></code>): You
    124. 

  124. could control specific instance(s) by issuing:</p>
    125. 

  125. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>service uwsgi &lt;command&gt; &lt;confname&gt; &lt;confname&gt; ...
    126. 

  126. 

  127. sudo -H service uwsgi start searx
    128. 

  128. sudo -H service uwsgi stop  searx
    129. 

  129. </pre></div>
    130. 

  130. </div>
    131. 

  131. <p>My experience is, that this command is a bit buggy.</p>
    132. 

  132. </section>
    133. 

  133. <section id="all-together">
    134. 

  134. <span id="uwsgi-configuration"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">All together</a><a class="headerlink" href="#all-together" title="Permalink to this heading">¶</a></h2>
    135. 

  135. <p>Create the configuration ini-file according to your distribution (see below) and
    136. 

  136. restart the uwsgi application.</p>
    137. 

  137. <div class="sphinx-tabs docutils container">
    138. 

  138. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-VWJ1bnR1IC8gZGViaWFu" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-0-VWJ1bnR1IC8gZGViaWFu" name="VWJ1bnR1IC8gZGViaWFu" role="tab" tabindex="0">Ubuntu / debian</button><button aria-controls="panel-0-QXJjaCBMaW51eA==" aria-selected="false" class="sphinx-tabs-tab group-tab" id="tab-0-QXJjaCBMaW51eA==" name="QXJjaCBMaW51eA==" role="tab" tabindex="-1">Arch Linux</button><button aria-controls="panel-0-RmVkb3JhIC8gUkhFTA==" aria-selected="false" class="sphinx-tabs-tab group-tab" id="tab-0-RmVkb3JhIC8gUkhFTA==" name="RmVkb3JhIC8gUkhFTA==" role="tab" tabindex="-1">Fedora / RHEL</button></div><div aria-labelledby="tab-0-VWJ1bnR1IC8gZGViaWFu" class="sphinx-tabs-panel group-tab" id="panel-0-VWJ1bnR1IC8gZGViaWFu" name="VWJ1bnR1IC8gZGViaWFu" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># init.d --&gt; /usr/share/doc/uwsgi/README.Debian.gz</span>
    139. 

  139. <span class="c1"># For uWSGI debian uses the LSB init process, this might be changed</span>
    140. 

  140. <span class="c1"># one day, see https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=833067</span>
    141. 

  141. 

  142. create     /etc/uwsgi/apps-available/searx.ini
    143. 

  143. enable:    sudo -H ln -s /etc/uwsgi/apps-available/searx.ini /etc/uwsgi/apps-enabled/
    144. 

  144. start:     sudo -H service uwsgi start   searx
    145. 

  145. restart:   sudo -H service uwsgi restart searx
    146. 

  146. stop:      sudo -H service uwsgi stop    searx
    147. 

  147. disable:   sudo -H rm /etc/uwsgi/apps-enabled/searx.ini
    148. 

  148. </pre></div>
    149. 

  149. </div>
    150. 

  150. </div><div aria-labelledby="tab-0-QXJjaCBMaW51eA==" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-0-QXJjaCBMaW51eA==" name="QXJjaCBMaW51eA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># systemd --&gt; /usr/lib/systemd/system/uwsgi@.service</span>
    151. 

  151. <span class="c1"># For uWSGI archlinux uses systemd template units, see</span>
    152. 

  152. <span class="c1"># - http://0pointer.de/blog/projects/instances.html</span>
    153. 

  153. <span class="c1"># - https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd</span>
    154. 

  154. 

  155. create:    /etc/uwsgi/searx.ini
    156. 

  156. enable:    sudo -H systemctl <span class="nb">enable</span>   uwsgi@searx
    157. 

  157. start:     sudo -H systemctl start    uwsgi@searx
    158. 

  158. restart:   sudo -H systemctl restart  uwsgi@searx
    159. 

  159. stop:      sudo -H systemctl stop     uwsgi@searx
    160. 

  160. disable:   sudo -H systemctl disable  uwsgi@searx
    161. 

  161. </pre></div>
    162. 

  162. </div>
    163. 

  163. </div><div aria-labelledby="tab-0-RmVkb3JhIC8gUkhFTA==" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-0-RmVkb3JhIC8gUkhFTA==" name="RmVkb3JhIC8gUkhFTA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># systemd --&gt; /usr/lib/systemd/system/uwsgi.service</span>
    164. 

  164. <span class="c1"># The unit file starts uWSGI in emperor mode (/etc/uwsgi.ini), see</span>
    165. 

  165. <span class="c1"># - https://uwsgi-docs.readthedocs.io/en/latest/Emperor.html</span>
    166. 

  166. 

  167. create:    /etc/uwsgi.d/searx.ini
    168. 

  168. restart:   sudo -H touch /etc/uwsgi.d/searx.ini
    169. 

  169. disable:   sudo -H rm /etc/uwsgi.d/searx.ini
    170. 

  170. </pre></div>
    171. 

  171. </div>
    172. 

  172. </div></div>
    173. 

  173. <div class="sphinx-tabs docutils container">
    174. 

  174. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-VWJ1bnR1IC8gZGViaWFu" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-1-VWJ1bnR1IC8gZGViaWFu" name="VWJ1bnR1IC8gZGViaWFu" role="tab" tabindex="0">Ubuntu / debian</button><button aria-controls="panel-1-QXJjaCBMaW51eA==" aria-selected="false" class="sphinx-tabs-tab group-tab" id="tab-1-QXJjaCBMaW51eA==" name="QXJjaCBMaW51eA==" role="tab" tabindex="-1">Arch Linux</button><button aria-controls="panel-1-RmVkb3JhIC8gUkhFTA==" aria-selected="false" class="sphinx-tabs-tab group-tab" id="tab-1-RmVkb3JhIC8gUkhFTA==" name="RmVkb3JhIC8gUkhFTA==" role="tab" tabindex="-1">Fedora / RHEL</button></div><div aria-labelledby="tab-1-VWJ1bnR1IC8gZGViaWFu" class="sphinx-tabs-panel group-tab" id="panel-1-VWJ1bnR1IC8gZGViaWFu" name="VWJ1bnR1IC8gZGViaWFu" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>uwsgi<span class="o">]</span>
    175. 

  175. 

  176. <span class="c1"># uWSGI core</span>
    177. 

  177. <span class="c1"># ----------</span>
    178. 

  178. <span class="c1">#</span>
    179. 

  179. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core</span>
    180. 

  180. 

  181. <span class="c1"># Who will run the code</span>
    182. 

  182. <span class="nv">uid</span> <span class="o">=</span> searx
    183. 

  183. <span class="nv">gid</span> <span class="o">=</span> searx
    184. 

  184. 

  185. <span class="c1"># set (python) default encoding UTF-8</span>
    186. 

  186. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LANG</span><span class="o">=</span>C.UTF-8
    187. 

  187. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LANGUAGE</span><span class="o">=</span>C.UTF-8
    188. 

  188. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LC_ALL</span><span class="o">=</span>C.UTF-8
    189. 

  189. 

  190. <span class="c1"># chdir to specified directory before apps loading</span>
    191. 

  191. <span class="nv">chdir</span> <span class="o">=</span> /usr/local/searx/searx-src/searx
    192. 

  192. 

  193. <span class="c1"># searx configuration (settings.yml)</span>
    194. 

  194. <span class="nv">env</span> <span class="o">=</span> <span class="nv">SEARX_SETTINGS_PATH</span><span class="o">=</span>/etc/searx/settings.yml
    195. 

  195. 

  196. <span class="c1"># disable logging for privacy</span>
    197. 

  197. disable-logging <span class="o">=</span> <span class="nb">true</span>
    198. 

  198. 

  199. <span class="c1"># The right granted on the created socket</span>
    200. 

  200. chmod-socket <span class="o">=</span> <span class="m">666</span>
    201. 

  201. 

  202. <span class="c1"># Plugin to use and interpreter config</span>
    203. 

  203. single-interpreter <span class="o">=</span> <span class="nb">true</span>
    204. 

  204. 

  205. <span class="c1"># enable master process</span>
    206. 

  206. <span class="nv">master</span> <span class="o">=</span> <span class="nb">true</span>
    207. 

  207. 

  208. <span class="c1"># load apps in each worker instead of the master</span>
    209. 

  209. lazy-apps <span class="o">=</span> <span class="nb">true</span>
    210. 

  210. 

  211. <span class="c1"># load uWSGI plugins</span>
    212. 

  212. <span class="nv">plugin</span> <span class="o">=</span> python3,http
    213. 

  213. 

  214. <span class="c1"># By default the Python plugin does not initialize the GIL.  This means your</span>
    215. 

  215. <span class="c1"># app-generated threads will not run.  If you need threads, remember to enable</span>
    216. 

  216. <span class="c1"># them with enable-threads.  Running uWSGI in multithreading mode (with the</span>
    217. 

  217. <span class="c1"># threads options) will automatically enable threading support. This *strange*</span>
    218. 

  218. <span class="c1"># default behaviour is for performance reasons.</span>
    219. 

  219. enable-threads <span class="o">=</span> <span class="nb">true</span>
    220. 

  220. 

  221. 

  222. <span class="c1"># plugin: python</span>
    223. 

  223. <span class="c1"># --------------</span>
    224. 

  224. <span class="c1">#</span>
    225. 

  225. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python</span>
    226. 

  226. 

  227. <span class="c1"># load a WSGI module</span>
    228. 

  228. <span class="nv">module</span> <span class="o">=</span> searx.webapp
    229. 

  229. 

  230. <span class="c1"># set PYTHONHOME/virtualenv</span>
    231. 

  231. <span class="nv">virtualenv</span> <span class="o">=</span> /usr/local/searx/searx-pyenv
    232. 

  232. 

  233. <span class="c1"># add directory (or glob) to pythonpath</span>
    234. 

  234. <span class="nv">pythonpath</span> <span class="o">=</span> /usr/local/searx/searx-src
    235. 

  235. 

  236. 

  237. <span class="c1"># speak to upstream</span>
    238. 

  238. <span class="c1"># -----------------</span>
    239. 

  239. <span class="c1">#</span>
    240. 

  240. <span class="c1"># Activate the &#39;http&#39; configuration for filtron or activate the &#39;socket&#39;</span>
    241. 

  241. <span class="c1"># configuration if you setup your HTTP server to use uWSGI protocol via sockets.</span>
    242. 

  242. 

  243. <span class="c1"># using IP:</span>
    244. 

  244. <span class="c1">#</span>
    245. 

  245. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http</span>
    246. 

  246. <span class="c1"># Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html</span>
    247. 

  247. 

  248. <span class="nv">http</span> <span class="o">=</span> <span class="m">127</span>.0.0.1:8888
    249. 

  249. 

  250. <span class="c1"># using unix-sockets:</span>
    251. 

  251. <span class="c1">#</span>
    252. 

  252. <span class="c1"># On some distributions you need to create the app folder for the sockets::</span>
    253. 

  253. <span class="c1">#</span>
    254. 

  254. <span class="c1">#   mkdir -p /run/uwsgi/app/searx</span>
    255. 

  255. <span class="c1">#   chown -R searx:searx  /run/uwsgi/app/searx</span>
    256. 

  256. <span class="c1">#</span>
    257. 

  257. <span class="c1"># socket = /run/uwsgi/app/searx/socket</span>
    258. 

  258. 

  259. <span class="c1"># Cache</span>
    260. 

  260. <span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span><span class="m">2000</span>,blocks<span class="o">=</span><span class="m">2000</span>,blocksize<span class="o">=</span><span class="m">4096</span>,bitmap<span class="o">=</span><span class="m">1</span>
    261. 

  261. </pre></div>
    262. 

  262. </div>
    263. 

  263. </div><div aria-labelledby="tab-1-QXJjaCBMaW51eA==" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-1-QXJjaCBMaW51eA==" name="QXJjaCBMaW51eA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>uwsgi<span class="o">]</span>
    264. 

  264. 

  265. <span class="c1"># uWSGI core</span>
    266. 

  266. <span class="c1"># ----------</span>
    267. 

  267. <span class="c1">#</span>
    268. 

  268. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core</span>
    269. 

  269. 

  270. <span class="c1"># Who will run the code</span>
    271. 

  271. <span class="nv">uid</span> <span class="o">=</span> searx
    272. 

  272. <span class="nv">gid</span> <span class="o">=</span> searx
    273. 

  273. 

  274. <span class="c1"># set (python) default encoding UTF-8</span>
    275. 

  275. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LANG</span><span class="o">=</span>C.UTF-8
    276. 

  276. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LANGUAGE</span><span class="o">=</span>C.UTF-8
    277. 

  277. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LC_ALL</span><span class="o">=</span>C.UTF-8
    278. 

  278. 

  279. <span class="c1"># chdir to specified directory before apps loading</span>
    280. 

  280. <span class="nv">chdir</span> <span class="o">=</span> /usr/local/searx/searx-src/searx
    281. 

  281. 

  282. <span class="c1"># searx configuration (settings.yml)</span>
    283. 

  283. <span class="nv">env</span> <span class="o">=</span> <span class="nv">SEARX_SETTINGS_PATH</span><span class="o">=</span>/etc/searx/settings.yml
    284. 

  284. 

  285. <span class="c1"># disable logging for privacy</span>
    286. 

  286. <span class="nv">logger</span> <span class="o">=</span> systemd
    287. 

  287. disable-logging <span class="o">=</span> <span class="nb">true</span>
    288. 

  288. 

  289. <span class="c1"># The right granted on the created socket</span>
    290. 

  290. chmod-socket <span class="o">=</span> <span class="m">666</span>
    291. 

  291. 

  292. <span class="c1"># Plugin to use and interpreter config</span>
    293. 

  293. single-interpreter <span class="o">=</span> <span class="nb">true</span>
    294. 

  294. 

  295. <span class="c1"># enable master process</span>
    296. 

  296. <span class="nv">master</span> <span class="o">=</span> <span class="nb">true</span>
    297. 

  297. 

  298. <span class="c1"># load apps in each worker instead of the master</span>
    299. 

  299. lazy-apps <span class="o">=</span> <span class="nb">true</span>
    300. 

  300. 

  301. <span class="c1"># load uWSGI plugins</span>
    302. 

  302. <span class="nv">plugin</span> <span class="o">=</span> python
    303. 

  303. 

  304. <span class="c1"># By default the Python plugin does not initialize the GIL.  This means your</span>
    305. 

  305. <span class="c1"># app-generated threads will not run.  If you need threads, remember to enable</span>
    306. 

  306. <span class="c1"># them with enable-threads.  Running uWSGI in multithreading mode (with the</span>
    307. 

  307. <span class="c1"># threads options) will automatically enable threading support. This *strange*</span>
    308. 

  308. <span class="c1"># default behaviour is for performance reasons.</span>
    309. 

  309. enable-threads <span class="o">=</span> <span class="nb">true</span>
    310. 

  310. 

  311. 

  312. <span class="c1"># plugin: python</span>
    313. 

  313. <span class="c1"># --------------</span>
    314. 

  314. <span class="c1">#</span>
    315. 

  315. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python</span>
    316. 

  316. 

  317. <span class="c1"># load a WSGI module</span>
    318. 

  318. <span class="nv">module</span> <span class="o">=</span> searx.webapp
    319. 

  319. 

  320. <span class="c1"># set PYTHONHOME/virtualenv</span>
    321. 

  321. <span class="nv">virtualenv</span> <span class="o">=</span> /usr/local/searx/searx-pyenv
    322. 

  322. 

  323. <span class="c1"># add directory (or glob) to pythonpath</span>
    324. 

  324. <span class="nv">pythonpath</span> <span class="o">=</span> /usr/local/searx/searx-src
    325. 

  325. 

  326. 

  327. <span class="c1"># speak to upstream</span>
    328. 

  328. <span class="c1"># -----------------</span>
    329. 

  329. <span class="c1">#</span>
    330. 

  330. <span class="c1"># Activate the &#39;http&#39; configuration for filtron or activate the &#39;socket&#39;</span>
    331. 

  331. <span class="c1"># configuration if you setup your HTTP server to use uWSGI protocol via sockets.</span>
    332. 

  332. 

  333. <span class="c1"># using IP:</span>
    334. 

  334. <span class="c1">#</span>
    335. 

  335. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http</span>
    336. 

  336. <span class="c1"># Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html</span>
    337. 

  337. 

  338. <span class="nv">http</span> <span class="o">=</span> <span class="m">127</span>.0.0.1:8888
    339. 

  339. 

  340. <span class="c1"># using unix-sockets:</span>
    341. 

  341. <span class="c1">#</span>
    342. 

  342. <span class="c1"># On some distributions you need to create the app folder for the sockets::</span>
    343. 

  343. <span class="c1">#</span>
    344. 

  344. <span class="c1">#   mkdir -p /run/uwsgi/app/searx</span>
    345. 

  345. <span class="c1">#   chown -R searx:searx  /run/uwsgi/app/searx</span>
    346. 

  346. <span class="c1">#</span>
    347. 

  347. <span class="c1"># socket = /run/uwsgi/app/searx/socket</span>
    348. 

  348. 

  349. <span class="c1"># Cache</span>
    350. 

  350. <span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span><span class="m">2000</span>,blocks<span class="o">=</span><span class="m">2000</span>,blocksize<span class="o">=</span><span class="m">4096</span>,bitmap<span class="o">=</span><span class="m">1</span>
    351. 

  351. </pre></div>
    352. 

  352. </div>
    353. 

  353. </div><div aria-labelledby="tab-1-RmVkb3JhIC8gUkhFTA==" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-1-RmVkb3JhIC8gUkhFTA==" name="RmVkb3JhIC8gUkhFTA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>uwsgi<span class="o">]</span>
    354. 

  354. 

  355. <span class="c1"># uWSGI core</span>
    356. 

  356. <span class="c1"># ----------</span>
    357. 

  357. <span class="c1">#</span>
    358. 

  358. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core</span>
    359. 

  359. 

  360. <span class="c1"># Who will run the code</span>
    361. 

  361. <span class="nv">uid</span> <span class="o">=</span> searx
    362. 

  362. <span class="nv">gid</span> <span class="o">=</span> searx
    363. 

  363. 

  364. <span class="c1"># set (python) default encoding UTF-8</span>
    365. 

  365. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LANG</span><span class="o">=</span>C.UTF-8
    366. 

  366. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LANGUAGE</span><span class="o">=</span>C.UTF-8
    367. 

  367. <span class="nv">env</span> <span class="o">=</span> <span class="nv">LC_ALL</span><span class="o">=</span>C.UTF-8
    368. 

  368. 

  369. <span class="c1"># chdir to specified directory before apps loading</span>
    370. 

  370. <span class="nv">chdir</span> <span class="o">=</span> /usr/local/searx/searx-src/searx
    371. 

  371. 

  372. <span class="c1"># searx configuration (settings.yml)</span>
    373. 

  373. <span class="nv">env</span> <span class="o">=</span> <span class="nv">SEARX_SETTINGS_PATH</span><span class="o">=</span>/etc/searx/settings.yml
    374. 

  374. 

  375. <span class="c1"># disable logging for privacy</span>
    376. 

  376. disable-logging <span class="o">=</span> <span class="nb">true</span>
    377. 

  377. 

  378. <span class="c1"># The right granted on the created socket</span>
    379. 

  379. chmod-socket <span class="o">=</span> <span class="m">666</span>
    380. 

  380. 

  381. <span class="c1"># Plugin to use and interpreter config</span>
    382. 

  382. single-interpreter <span class="o">=</span> <span class="nb">true</span>
    383. 

  383. 

  384. <span class="c1"># enable master process</span>
    385. 

  385. <span class="nv">master</span> <span class="o">=</span> <span class="nb">true</span>
    386. 

  386. 

  387. <span class="c1"># load apps in each worker instead of the master</span>
    388. 

  388. lazy-apps <span class="o">=</span> <span class="nb">true</span>
    389. 

  389. 

  390. <span class="c1"># load uWSGI plugins</span>
    391. 

  391. <span class="nv">plugin</span> <span class="o">=</span> python3,http
    392. 

  392. 

  393. <span class="c1"># By default the Python plugin does not initialize the GIL.  This means your</span>
    394. 

  394. <span class="c1"># app-generated threads will not run.  If you need threads, remember to enable</span>
    395. 

  395. <span class="c1"># them with enable-threads.  Running uWSGI in multithreading mode (with the</span>
    396. 

  396. <span class="c1"># threads options) will automatically enable threading support. This *strange*</span>
    397. 

  397. <span class="c1"># default behaviour is for performance reasons.</span>
    398. 

  398. enable-threads <span class="o">=</span> <span class="nb">true</span>
    399. 

  399. 

  400. 

  401. <span class="c1"># plugin: python</span>
    402. 

  402. <span class="c1"># --------------</span>
    403. 

  403. <span class="c1">#</span>
    404. 

  404. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python</span>
    405. 

  405. 

  406. <span class="c1"># load a WSGI module</span>
    407. 

  407. <span class="nv">module</span> <span class="o">=</span> searx.webapp
    408. 

  408. 

  409. <span class="c1"># set PYTHONHOME/virtualenv</span>
    410. 

  410. <span class="nv">virtualenv</span> <span class="o">=</span> /usr/local/searx/searx-pyenv
    411. 

  411. 

  412. <span class="c1"># add directory (or glob) to pythonpath</span>
    413. 

  413. <span class="nv">pythonpath</span> <span class="o">=</span> /usr/local/searx/searx-src
    414. 

  414. 

  415. 

  416. <span class="c1"># speak to upstream</span>
    417. 

  417. <span class="c1"># -----------------</span>
    418. 

  418. <span class="c1">#</span>
    419. 

  419. <span class="c1"># Activate the &#39;http&#39; configuration for filtron or activate the &#39;socket&#39;</span>
    420. 

  420. <span class="c1"># configuration if you setup your HTTP server to use uWSGI protocol via sockets.</span>
    421. 

  421. 

  422. <span class="c1"># using IP:</span>
    423. 

  423. <span class="c1">#</span>
    424. 

  424. <span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http</span>
    425. 

  425. <span class="c1"># Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html</span>
    426. 

  426. 

  427. <span class="nv">http</span> <span class="o">=</span> <span class="m">127</span>.0.0.1:8888
    428. 

  428. 

  429. <span class="c1"># using unix-sockets:</span>
    430. 

  430. <span class="c1">#</span>
    431. 

  431. <span class="c1"># On some distributions you need to create the app folder for the sockets::</span>
    432. 

  432. <span class="c1">#</span>
    433. 

  433. <span class="c1">#   mkdir -p /run/uwsgi/app/searx</span>
    434. 

  434. <span class="c1">#   chown -R searx:searx  /run/uwsgi/app/searx</span>
    435. 

  435. <span class="c1">#</span>
    436. 

  436. <span class="c1"># socket = /run/uwsgi/app/searx/socket</span>
    437. 

  437. 

  438. <span class="c1"># Cache</span>
    439. 

  439. <span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span><span class="m">2000</span>,blocks<span class="o">=</span><span class="m">2000</span>,blocksize<span class="o">=</span><span class="m">4096</span>,bitmap<span class="o">=</span><span class="m">1</span>
    440. 

  440. </pre></div>
    441. 

  441. </div>
    442. 

  442. </div></div>
    443. 

  443. </section>
    444. 

  444. </section>
    445. 

  445. 

  446. 

  447.             <div class="clearer"></div>
    448. 

  448.           </div>
    449. 

  449.         </div>
    450. 

  450.       </div>
    451. 

  451.   <span id="sidebar-top"></span>
    452. 

  452.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    453. 

  453.         <div class="sphinxsidebarwrapper">
    454. 

  454.   
    455. 

  455.     
    456. 

  456.             <p class="logo"><a href="../index.html">
    457. 

  457.               <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
    458. 

  458.             </a></p>
    459. 

  459.   
    460. 

  460. 

  461.   <h3>Project Links</h3>
    462. 

  462.   <ul>
    463. 

  463.     <li><a href="https://searx.github.io/searx/blog/index.html">Blog</a>
    464. 

  464.   
    465. 

  465.     <li><a href="https://github.com/searx/searx">Source</a>
    466. 

  466.   
    467. 

  467.     <li><a href="https://github.com/searx/searx/wiki">Wiki</a>
    468. 

  468.   
    469. 

  469.     <li><a href="https://twitter.com/Searx_engine">Twitter</a>
    470. 

  470.   
    471. 

  471.     <li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
    472. 

  472.   </ul><h3>Navigation</h3>
    473. 

  473. <ul>
    474. 

  474.   <li><a href="../index.html">Overview</a>
    475. 

  475.     <ul>
    476. 

  476.       <li><a href="index.html">Administrator documentation</a>
    477. 

  477.         <ul>
    478. 

  478.           <li>Previous: <a href="installation-searx.html" title="previous chapter">Step by step installation</a>
    479. 

  479.           <li>Next: <a href="installation-nginx.html" title="next chapter">Install with nginx</a></ul>
    480. 

  480.       </li>
    481. 

  481.     </ul>
    482. 

  482.   </li>
    483. 

  483. </ul>
    484. 

  484. <div id="searchbox" style="display: none" role="search">
    485. 

  485.   <h3 id="searchlabel">Quick search</h3>
    486. 

  486.     <div class="searchformwrapper">
    487. 

  487.     <form class="search" action="../search.html" method="get">
    488. 

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

  489.       <input type="submit" value="Go" />
    490. 

  490.     </form>
    491. 

  491.     </div>
    492. 

  492. </div>
    493. 

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

  494.         </div>
    495. 

  495.       </div>
    496. 

  496.       <div class="clearer"></div>
    497. 

  497.     </div>
    498. 

  498.   
    499. 

  499.     <div class="footer" role="contentinfo">
    500. 

  500.         &#169; Copyright 2015-2022, Adam Tauber, Noémi Ványi.
    501. 

  501.       Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
    502. 

  502.     </div>
    503. 

  503.   <script src="../_static/version_warning_offset.js"></script>
    504. 

  504. 

  505.   </body>
    506. 

  506. </html>
    507.