Home Explore Help
Sign In
SaschaMester
/
Searx
mirror of https://github.com/asciimoo/searx
Watch 2
Star 4
Fork 0
Files Issues 1 Wiki
Branch: gh-pages
Branches Tags
Searx
/
blog
/
lxcdev-202006.html

lxcdev-202006.html 35 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420 
  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>Developing in Linux containers [202006] &#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="Limit access to your searx engines" href="private-engines.html" />
    23. 

  23.     <link rel="prev" title="Running shell commands to fetch results" href="command-line-engines.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="private-engines.html" title="Limit access to your searx engines"
    36. 

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

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

  38.           <a href="command-line-engines.html" title="Running shell commands to fetch results"
    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">Blog</a> &#187;</li>
    42. 

  42.         <li class="nav-item nav-item-this"><a href="">Developing in Linux containers [202006]</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="developing-in-linux-containers-202006">
    52. 

  52. <span id="blog-lxcdev-202006"></span><h1>Developing in Linux containers [202006]<a class="headerlink" href="#developing-in-linux-containers-202006" title="Permalink to this heading">¶</a></h1>
    53. 

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

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

  55. <p>This blog post is written for experienced admins and developers / readers
    56. 

  56. should have a serious meaning about: <em>distributed</em>, <em>merge</em> and <em>linux
    57. 

  57. container</em>.</p>
    58. 

  58. </aside>
    59. 

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

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

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

  62. <li><p><a class="reference internal" href="#motivation" id="id1">Motivation</a></p></li>
    63. 

  63. <li><p><a class="reference internal" href="#gentlemen-start-your-engines" id="id2">Gentlemen, start your engines!</a></p></li>
    64. 

  64. <li><p><a class="reference internal" href="#in-containers-work-as-usual" id="id3">In containers, work as usual</a></p></li>
    65. 

  65. <li><p><a class="reference internal" href="#wrap-production-into-developer-suite" id="id4">Wrap production into developer suite</a></p></li>
    66. 

  66. <li><p><a class="reference internal" href="#abstract" id="id5">Abstract</a></p></li>
    67. 

  67. </ul>
    68. 

  68. </nav>
    69. 

  69. <p>In PR <a class="reference external" href="https://github.com/searx/searx/pull/1803">#1803</a> we added a lot of scripts to Searx’s boilerplate.  In this blog
    70. 

  70. post I will show you, how you can make use of them in <em>distributed and
    71. 

  71. heterogeneous development cycles</em> (TL;DR; jump to the <a class="reference internal" href="#blog-lxcdev-202006-abstract"><span class="std std-ref">Abstract</span></a>).</p>
    72. 

  72. <section id="motivation">
    73. 

  73. <h2><a class="toc-backref" href="#id1" role="doc-backlink">Motivation</a><a class="headerlink" href="#motivation" title="Permalink to this heading">¶</a></h2>
    74. 

  74. <p>Normally in our development cycle, we edit the sources and run some test and/or
    75. 

  75. builds by using <code class="docutils literal notranslate"><span class="pre">make</span></code> before we commit.  This cycle is simple and perfect but
    76. 

  76. might fail in some aspects we should not overlook.</p>
    77. 

  77. <blockquote>
    78. 

  78. <div><p>The environment in which we run all our development processes matters!</p>
    79. 

  79. </div></blockquote>
    80. 

  80. <p>The <a class="reference internal" href="../dev/makefile.html#makefile"><span class="std std-ref">Makefile</span></a> and the <a class="reference internal" href="../dev/makefile.html#make-install"><span class="std std-ref">Python environment</span></a> encapsulate a lot for us, but they
    81. 

  81. do not have access to all prerequisites.  For example, there may have
    82. 

  82. dependencies on packages that are installed on the developer’s desktop, but
    83. 

  83. usually are not preinstalled on a server or client system.  Another examples
    84. 

  84. are; settings have been made to the software on the developer’s host that would
    85. 

  85. never be set on a <em>production</em> system.</p>
    86. 

  86. <p><em>Linux Containers</em> (<a class="reference external" href="https://linuxcontainers.org/lxc/introduction/">LXC</a>) are isolate environments and not to mix up on
    87. 

  87. developer’s all the prerequisites of all the projects he contribute to, is
    88. 

  88. always a good choice.</p>
    89. 

  89. <p>The scripts from PR <a class="reference external" href="https://github.com/searx/searx/pull/1803">#1803</a> can divide in those to install and maintain
    90. 

  90. software:</p>
    91. 

  91. <ul class="simple">
    92. 

  92. <li><p><a class="reference internal" href="../utils/searx.sh.html#searx-sh"><span class="std std-ref">utils/searx.sh</span></a></p></li>
    93. 

  93. <li><p><a class="reference internal" href="../utils/filtron.sh.html#filtron-sh"><span class="std std-ref">utils/filtron.sh</span></a></p></li>
    94. 

  94. <li><p><a class="reference internal" href="../utils/morty.sh.html#morty-sh"><span class="std std-ref">utils/morty.sh</span></a></p></li>
    95. 

  95. </ul>
    96. 

  96. <p>and the script <a class="reference internal" href="../utils/lxc.sh.html#lxc-sh"><span class="std std-ref">utils/lxc.sh</span></a>, with we can scale our installation, maintenance or
    97. 

  97. even development tasks over a stack of containers, what we call: <em>Searx’s lxc
    98. 

  98. suite</em>.</p>
    99. 

  99. </section>
    100. 

  100. <section id="gentlemen-start-your-engines">
    101. 

  101. <h2><a class="toc-backref" href="#id2" role="doc-backlink">Gentlemen, start your engines!</a><a class="headerlink" href="#gentlemen-start-your-engines" title="Permalink to this heading">¶</a></h2>
    102. 

  102. <p>Before you can start with containers, you need to install and initiate <a class="reference external" href="https://linuxcontainers.org/lxd/introduction/">LXD</a>
    103. 

  103. once:</p>
    104. 

  104. <div class="sphinx-tabs docutils container">
    105. 

  105. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-0-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-0-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-0-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ snap install lxd
    106. 

  106. $ lxd init --auto
    107. 

  107. </pre></div>
    108. 

  108. </div>
    109. 

  109. </div></div>
    110. 

  110. <p>And you need to clone from origin or if you have your own fork, clone from your
    111. 

  111. fork:</p>
    112. 

  112. <div class="sphinx-tabs docutils container">
    113. 

  113. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-1-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-1-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-1-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> ~/Downloads
    114. 

  114. $ git clone https://github.com/searx/searx.git
    115. 

  115. $ <span class="nb">cd</span> searx
    116. 

  116. </pre></div>
    117. 

  117. </div>
    118. 

  118. </div></div>
    119. 

  119. <p>The <a class="reference internal" href="../utils/lxc.sh.html#lxc-searx-env"><span class="std std-ref">searx suite</span></a> consists of several images, see <code class="docutils literal notranslate"><span class="pre">export</span>
    120. 

  120. <span class="pre">LXC_SUITE=(...</span></code> near by <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/lxc-searx.env#L19">Origin: utils/lxc-searx.env#L19</a>.  For this blog post
    121. 

  121. we exercise on a <a class="reference external" href="https://www.archlinux.org/">archlinux</a> image.  The container of this image is named
    122. 

  122. <code class="docutils literal notranslate"><span class="pre">searx-archlinux</span></code>.  Lets build the container, but be sure that this container
    123. 

  123. does not already exists, so first lets remove possible old one:</p>
    124. 

  124. <div class="sphinx-tabs docutils container">
    125. 

  125. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-2-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-2-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-2-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh remove searx-archlinux
    126. 

  126. $ sudo -H ./utils/lxc.sh build searx-archlinux
    127. 

  127. </pre></div>
    128. 

  128. </div>
    129. 

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

  130. <aside class="sidebar">
    131. 

  131. <p class="sidebar-title">The <code class="docutils literal notranslate"><span class="pre">searx-archlinux</span></code> container</p>
    132. 

  132. <p>is the base of all our exercises here.</p>
    133. 

  133. </aside>
    134. 

  134. <p>In this container we install all services <a class="reference internal" href="../utils/lxc.sh.html#lxc-sh-install-suite"><span class="std std-ref">including searx, morty &amp; filtron</span></a> in once:</p>
    135. 

  135. <div class="sphinx-tabs docutils container">
    136. 

  136. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-3-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-3-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-3-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh install suite searx-archlinux
    137. 

  137. </pre></div>
    138. 

  138. </div>
    139. 

  139. </div></div>
    140. 

  140. <p>To proxy HTTP from filtron and morty in the container to the outside of the
    141. 

  141. container, install nginx into the container.  Once for the bot blocker filtron:</p>
    142. 

  142. <div class="sphinx-tabs docutils container">
    143. 

  143. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-4-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-4-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-4-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-4-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    144. 

  144.   ./utils/filtron.sh nginx install
    145. 

  145. ...
    146. 

  146. INFO:  got <span class="m">429</span> from http://10.174.184.156/searx
    147. 

  147. </pre></div>
    148. 

  148. </div>
    149. 

  149. </div></div>
    150. 

  150. <p>and once for the content sanitizer (content proxy morty):</p>
    151. 

  151. <div class="sphinx-tabs docutils container">
    152. 

  152. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-5-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-5-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-5-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-5-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    153. 

  153.   ./utils/morty.sh nginx install
    154. 

  154. ...
    155. 

  155. INFO:  got <span class="m">200</span> from http://10.174.184.156/morty/
    156. 

  156. </pre></div>
    157. 

  157. </div>
    158. 

  158. </div></div>
    159. 

  159. <aside class="sidebar">
    160. 

  160. <p class="sidebar-title">Fully functional searx suite</p>
    161. 

  161. <p>From here on you have a fully functional searx suite running with bot blocker
    162. 

  162. (filtron) and Web content sanitizer (content proxy morty) needed for a
    163. 

  163. <em>privacy protecting</em> search engine.</p>
    164. 

  164. </aside>
    165. 

  165. <p>On your system, the IP of your <code class="docutils literal notranslate"><span class="pre">searx-archlinux</span></code> container differs from
    166. 

  166. <a class="reference external" href="http://10.174.184.156/searx">http://10.174.184.156/searx</a>, just open the URL reported in your installation
    167. 

  167. protocol in your WEB browser from the desktop to test the instance from outside
    168. 

  168. of the container.</p>
    169. 

  169. <p>In such a searx suite admins can maintain and access the debug log of the
    170. 

  170. different services quite easy.</p>
    171. 

  171. </section>
    172. 

  172. <section id="in-containers-work-as-usual">
    173. 

  173. <span id="working-in-containers"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">In containers, work as usual</a><a class="headerlink" href="#in-containers-work-as-usual" title="Permalink to this heading">¶</a></h2>
    174. 

  174. <p>Usually you open a root-bash using <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-H</span> <span class="pre">bash</span></code>.  In case of LXC containers
    175. 

  175. open the root-bash in the container using <code class="docutils literal notranslate"><span class="pre">./utils/lxc.sh</span> <span class="pre">cmd</span>
    176. 

  176. <span class="pre">searx-archlinux</span></code>:</p>
    177. 

  177. <div class="sphinx-tabs docutils container">
    178. 

  178. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-6-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-6-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-6-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-6-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux bash
    179. 

  179. INFO:  <span class="o">[</span>searx-archlinux<span class="o">]</span> bash
    180. 

  180. <span class="o">[</span>root@searx-archlinux searx<span class="o">]</span><span class="c1"># pwd</span>
    181. 

  181. /share/searx
    182. 

  182. </pre></div>
    183. 

  183. </div>
    184. 

  184. </div></div>
    185. 

  185. <p>The prompt <code class="docutils literal notranslate"><span class="pre">[root&#64;searx-archlinux</span> <span class="pre">...]</span></code> signals, that you are the root user in
    186. 

  186. the searx-container.  To debug the running searx instance use:</p>
    187. 

  187. <div class="sphinx-tabs docutils container">
    188. 

  188. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-7-cm9vdEBzZWFyeC1hcmNobGludXg=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-7-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tab" tabindex="0"><a class="reference external" href="mailto:root&#37;&#52;&#48;searx-archlinux">root<span>&#64;</span>searx-archlinux</a></button></div><div aria-labelledby="tab-7-cm9vdEBzZWFyeC1hcmNobGludXg=" class="sphinx-tabs-panel group-tab" id="panel-7-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./utils/searx.sh inspect service
    189. 

  189. ...
    190. 

  190. use <span class="o">[</span>CTRL-C<span class="o">]</span> to stop monitoring the log
    191. 

  191. ...
    192. 

  192. </pre></div>
    193. 

  193. </div>
    194. 

  194. </div></div>
    195. 

  195. <p>Back in the browser on your desktop open the service <a class="reference external" href="http://10.174.184.156/searx">http://10.174.184.156/searx</a>
    196. 

  196. and run your application tests while the debug log is shown in the terminal from
    197. 

  197. above.  You can stop monitoring using <code class="docutils literal notranslate"><span class="pre">CTRL-C</span></code>, this also disables the <em>“debug
    198. 

  198. option”</em> in searx’s settings file and restarts the searx uwsgi application.  To
    199. 

  199. debug services from filtron and morty analogous use:</p>
    200. 

  200. <div class="sphinx-tabs docutils container">
    201. 

  201. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-8-cm9vdEBzZWFyeC1hcmNobGludXg=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-8-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tab" tabindex="0"><a class="reference external" href="mailto:root&#37;&#52;&#48;searx-archlinux">root<span>&#64;</span>searx-archlinux</a></button></div><div aria-labelledby="tab-8-cm9vdEBzZWFyeC1hcmNobGludXg=" class="sphinx-tabs-panel group-tab" id="panel-8-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./utils/filtron.sh inspect service
    202. 

  202. $ ./utils/morty.sh inspect service
    203. 

  203. </pre></div>
    204. 

  204. </div>
    205. 

  205. </div></div>
    206. 

  206. <p>Another point we have to notice is that each service (<a class="reference internal" href="../utils/searx.sh.html#searx-sh"><span class="std std-ref">searx</span></a>,
    207. 

  207. <a class="reference internal" href="../utils/filtron.sh.html#filtron-sh"><span class="std std-ref">filtron</span></a> and <a class="reference internal" href="../utils/morty.sh.html#morty-sh"><span class="std std-ref">morty</span></a>) runs under dedicated
    208. 

  208. system user account with the same name (compare <a class="reference internal" href="../admin/installation-searx.html#create-searx-user"><span class="std std-ref">Create user</span></a>).  To
    209. 

  209. get a shell from these accounts, simply call one of the scripts:</p>
    210. 

  210. <div class="sphinx-tabs docutils container">
    211. 

  211. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-9-cm9vdEBzZWFyeC1hcmNobGludXg=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-9-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tab" tabindex="0"><a class="reference external" href="mailto:root&#37;&#52;&#48;searx-archlinux">root<span>&#64;</span>searx-archlinux</a></button></div><div aria-labelledby="tab-9-cm9vdEBzZWFyeC1hcmNobGludXg=" class="sphinx-tabs-panel group-tab" id="panel-9-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./utils/searx.sh shell
    212. 

  212. $ ./utils/filtron.sh shell
    213. 

  213. $ ./utils/morty.sh shell
    214. 

  214. </pre></div>
    215. 

  215. </div>
    216. 

  216. </div></div>
    217. 

  217. <p>To get in touch, open a shell from the service user (<a class="reference external" href="mailto:searx&#37;&#52;&#48;searx-archlinux">searx<span>&#64;</span>searx-archlinux</a>):</p>
    218. 

  218. <div class="sphinx-tabs docutils container">
    219. 

  219. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-10-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-10-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-10-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-10-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    220. 

  220. ./utils/searx.sh shell
    221. 

  221. // <span class="nb">exit</span> with <span class="o">[</span>CTRL-D<span class="o">]</span>
    222. 

  222. <span class="o">(</span>searx-pyenv<span class="o">)</span> <span class="o">[</span>searx@searx-archlinux ~<span class="o">]</span>$ ...
    223. 

  223. </pre></div>
    224. 

  224. </div>
    225. 

  225. </div></div>
    226. 

  226. <p>The prompt <code class="docutils literal notranslate"><span class="pre">[searx&#64;searx-archlinux]</span></code> signals that you are logged in as system
    227. 

  227. user <code class="docutils literal notranslate"><span class="pre">searx</span></code> in the <code class="docutils literal notranslate"><span class="pre">searx-archlinux</span></code> container and the python <em>virtualenv</em>
    228. 

  228. <code class="docutils literal notranslate"><span class="pre">(searx-pyenv)</span></code> environment is activated.</p>
    229. 

  229. <div class="sphinx-tabs docutils container">
    230. 

  230. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-11-c2VhcnhAc2VhcngtYXJjaGxpbnV4" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-11-c2VhcnhAc2VhcngtYXJjaGxpbnV4" name="c2VhcnhAc2VhcngtYXJjaGxpbnV4" role="tab" tabindex="0"><a class="reference external" href="mailto:searx&#37;&#52;&#48;searx-archlinux">searx<span>&#64;</span>searx-archlinux</a></button></div><div aria-labelledby="tab-11-c2VhcnhAc2VhcngtYXJjaGxpbnV4" class="sphinx-tabs-panel group-tab" id="panel-11-c2VhcnhAc2VhcngtYXJjaGxpbnV4" name="c2VhcnhAc2VhcngtYXJjaGxpbnV4" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">(</span>searx-pyenv<span class="o">)</span> <span class="o">[</span>searx@searx-archlinux ~<span class="o">]</span>$ <span class="nb">pwd</span>
    231. 

  231. /usr/local/searx
    232. 

  232. </pre></div>
    233. 

  233. </div>
    234. 

  234. </div></div>
    235. 

  235. </section>
    236. 

  236. <section id="wrap-production-into-developer-suite">
    237. 

  237. <h2><a class="toc-backref" href="#id4" role="doc-backlink">Wrap production into developer suite</a><a class="headerlink" href="#wrap-production-into-developer-suite" title="Permalink to this heading">¶</a></h2>
    238. 

  238. <p>In this section we will see how to change the <em>“Fully functional searx suite”</em>
    239. 

  239. from a LXC container (which is quite ready for production) into a developer
    240. 

  240. suite.  For this, we have to keep an eye on the <a class="reference internal" href="../admin/installation-searx.html#installation-basic"><span class="std std-ref">Step by step installation</span></a>:</p>
    241. 

  241. <ul class="simple">
    242. 

  242. <li><p>searx setup in: <code class="docutils literal notranslate"><span class="pre">/etc/searx/settings.yml</span></code></p></li>
    243. 

  243. <li><p>searx user’s home: <code class="docutils literal notranslate"><span class="pre">/usr/local/searx</span></code></p></li>
    244. 

  244. <li><p>virtualenv in: <code class="docutils literal notranslate"><span class="pre">/usr/local/searx/searx-pyenv</span></code></p></li>
    245. 

  245. <li><p>searx software in: <code class="docutils literal notranslate"><span class="pre">/usr/local/searx/searx-src</span></code></p></li>
    246. 

  246. </ul>
    247. 

  247. <p>The searx software is a clone of the <code class="docutils literal notranslate"><span class="pre">git_url</span></code> (see <a class="reference internal" href="../admin/settings.html#settings-global"><span class="std std-ref">Global Settings</span></a>) and
    248. 

  248. the working tree is checked out from the <code class="docutils literal notranslate"><span class="pre">git_branch</span></code>.  With the use of the
    249. 

  249. <a class="reference internal" href="../utils/searx.sh.html#searx-sh"><span class="std std-ref">utils/searx.sh</span></a> the searx service was installed as <a class="reference internal" href="../admin/installation-uwsgi.html#searx-uwsgi"><span class="std std-ref">uWSGI application</span></a>.  To maintain this service, we can use <code class="docutils literal notranslate"><span class="pre">systemctl</span></code> (compare
    250. 

  250. <a class="reference internal" href="../admin/installation-uwsgi.html#uwsgi-configuration"><span class="std std-ref">service architectures on distributions</span></a>).</p>
    251. 

  251. <div class="sphinx-tabs docutils container">
    252. 

  252. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-12-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-12-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-12-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-12-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    253. 

  253.   systemctl stop uwsgi@searx
    254. 

  254. </pre></div>
    255. 

  255. </div>
    256. 

  256. </div></div>
    257. 

  257. <p>With the command above, we stopped the searx uWSGI-App in the archlinux
    258. 

  258. container.</p>
    259. 

  259. <p>The uWSGI-App for the archlinux dsitros is configured in
    260. 

  260. <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/templates/etc/uwsgi/apps-archlinux/searx.ini">Origin: utils/templates/etc/uwsgi/apps-archlinux/searx.ini</a>, from where at
    261. 

  261. least you should attend the settings of <code class="docutils literal notranslate"><span class="pre">uid</span></code>, <code class="docutils literal notranslate"><span class="pre">chdir</span></code>, <code class="docutils literal notranslate"><span class="pre">env</span></code> and
    262. 

  262. <code class="docutils literal notranslate"><span class="pre">http</span></code>:</p>
    263. 

  263. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>env = SEARX_SETTINGS_PATH=/etc/searx/settings.yml
    264. 

  264. http = 127.0.0.1:8888
    265. 

  265. 

  266. chdir = /usr/local/searx/searx-src/searx
    267. 

  267. virtualenv = /usr/local/searx/searx-pyenv
    268. 

  268. pythonpath = /usr/local/searx/searx-src
    269. 

  269. </pre></div>
    270. 

  270. </div>
    271. 

  271. <p>If you have read the <a class="reference internal" href="../utils/lxc.sh.html#lxc-sh"><span class="std std-ref">“Good to know section”</span></a> you remember, that
    272. 

  272. each container shares the root folder of the repository and the command
    273. 

  273. <code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span> <span class="pre">cmd</span></code> handles relative path names <strong>transparent</strong>.  To wrap the
    274. 

  274. searx installation into a developer one, we simple have to create a smylink to
    275. 

  275. the <strong>transparent</strong> reposetory from the desktop.  Now lets replace the
    276. 

  276. repository at <code class="docutils literal notranslate"><span class="pre">searx-src</span></code> in the container with the working tree from outside
    277. 

  277. of the container:</p>
    278. 

  278. <div class="sphinx-tabs docutils container">
    279. 

  279. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-13-Y29udGFpbmVyIGJlY29tZXMgYSBkZXZlbG9wZXIgc3VpdGU=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-13-Y29udGFpbmVyIGJlY29tZXMgYSBkZXZlbG9wZXIgc3VpdGU=" name="Y29udGFpbmVyIGJlY29tZXMgYSBkZXZlbG9wZXIgc3VpdGU=" role="tab" tabindex="0">container becomes a developer suite</button></div><div aria-labelledby="tab-13-Y29udGFpbmVyIGJlY29tZXMgYSBkZXZlbG9wZXIgc3VpdGU=" class="sphinx-tabs-panel group-tab" id="panel-13-Y29udGFpbmVyIGJlY29tZXMgYSBkZXZlbG9wZXIgc3VpdGU=" name="Y29udGFpbmVyIGJlY29tZXMgYSBkZXZlbG9wZXIgc3VpdGU=" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    280. 

  280.   mv /usr/local/searx/searx-src /usr/local/searx/searx-src.old
    281. 

  281. 

  282. $ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    283. 

  283.   ln -s /share/searx/ /usr/local/searx/searx-src
    284. 

  284. </pre></div>
    285. 

  285. </div>
    286. 

  286. </div></div>
    287. 

  287. <p>Now we can develop as usual in the working tree of our desktop system.  Every
    288. 

  288. time the software was changed, you have to restart the searx service (in the
    289. 

  289. container):</p>
    290. 

  290. <div class="sphinx-tabs docutils container">
    291. 

  291. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-14-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-14-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-14-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-14-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    292. 

  292.   systemctl restart uwsgi@searx
    293. 

  293. </pre></div>
    294. 

  294. </div>
    295. 

  295. </div></div>
    296. 

  296. <p>Remember: <a class="reference internal" href="#working-in-containers"><span class="std std-ref">In containers, work as usual</span></a> .. here are just some examples from my
    297. 

  297. daily usage:</p>
    298. 

  298. <div class="sphinx-tabs docutils container">
    299. 

  299. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-15-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-15-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-15-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-15-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><p>To <em>inspect</em> the searx instance (already described above):</p>
    300. 

  300. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    301. 

  301.   ./utils/searx.sh inspect service
    302. 

  302. </pre></div>
    303. 

  303. </div>
    304. 

  304. <p>Run <a class="reference internal" href="../dev/makefile.html#makefile"><span class="std std-ref">Makefile</span></a>, e.g. to test inside the container:</p>
    305. 

  305. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    306. 

  306.   make <span class="nb">test</span>
    307. 

  307. </pre></div>
    308. 

  308. </div>
    309. 

  309. <p>To install all prerequisites needed for a <a class="reference internal" href="../admin/buildhosts.html#buildhosts"><span class="std std-ref">Buildhosts</span></a>:</p>
    310. 

  310. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    311. 

  311.   ./utils/searx.sh install buildhost
    312. 

  312. </pre></div>
    313. 

  313. </div>
    314. 

  314. <p>To build the docs on a buildhost <a class="reference internal" href="../admin/buildhosts.html#buildhosts"><span class="std std-ref">Buildhosts</span></a>:</p>
    315. 

  315. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
    316. 

  316.   make docs.html
    317. 

  317. </pre></div>
    318. 

  318. </div>
    319. 

  319. </div></div>
    320. 

  320. </section>
    321. 

  321. <section id="abstract">
    322. 

  322. <span id="blog-lxcdev-202006-abstract"></span><h2><a class="toc-backref" href="#id5" role="doc-backlink">Abstract</a><a class="headerlink" href="#abstract" title="Permalink to this heading">¶</a></h2>
    323. 

  323. <p>We build up a fully functional searx suite in a archlinux container:</p>
    324. 

  324. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh install suite searx-archlinux
    325. 

  325. </pre></div>
    326. 

  326. </div>
    327. 

  327. <p>To access HTTP from the desktop we installed nginx for the services inside the
    328. 

  328. container:</p>
    329. 

  329. <div class="sphinx-tabs docutils container">
    330. 

  330. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" name="W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" role="tab" tabindex="0">[<a class="reference external" href="mailto:root&#37;&#52;&#48;searx-archlinux">root<span>&#64;</span>searx-archlinux</a>]</button></div><div aria-labelledby="tab-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" class="sphinx-tabs-panel group-tab" id="panel-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" name="W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./utils/filtron.sh nginx install
    331. 

  331. $ ./utils/morty.sh nginx install
    332. 

  332. </pre></div>
    333. 

  333. </div>
    334. 

  334. </div></div>
    335. 

  335. <p>To wrap the suite into a developer one, we created a symbolic link to the
    336. 

  336. repository which is shared <strong>transparent</strong> from the desktop’s file system into
    337. 

  337. the container :</p>
    338. 

  338. <div class="sphinx-tabs docutils container">
    339. 

  339. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-17-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-17-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" name="W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" role="tab" tabindex="0">[<a class="reference external" href="mailto:root&#37;&#52;&#48;searx-archlinux">root<span>&#64;</span>searx-archlinux</a>]</button></div><div aria-labelledby="tab-17-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" class="sphinx-tabs-panel group-tab" id="panel-17-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" name="W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ mv /usr/local/searx/searx-src /usr/local/searx/searx-src.old
    340. 

  340. $ ln -s /share/searx/ /usr/local/searx/searx-src
    341. 

  341. $ systemctl restart uwsgi@searx
    342. 

  342. </pre></div>
    343. 

  343. </div>
    344. 

  344. </div></div>
    345. 

  345. <p>To get remarks from the suite of the archlinux container we can use:</p>
    346. 

  346. <div class="sphinx-tabs docutils container">
    347. 

  347. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-18-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-18-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-18-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-18-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh show suite searx-archlinux
    348. 

  348. ...
    349. 

  349. <span class="o">[</span>searx-archlinux<span class="o">]</span>  INFO:  <span class="o">(</span>eth0<span class="o">)</span> filtron:    http://10.174.184.156:4004/ http://10.174.184.156/searx
    350. 

  350. <span class="o">[</span>searx-archlinux<span class="o">]</span>  INFO:  <span class="o">(</span>eth0<span class="o">)</span> morty:      http://10.174.184.156:3000/
    351. 

  351. <span class="o">[</span>searx-archlinux<span class="o">]</span>  INFO:  <span class="o">(</span>eth0<span class="o">)</span> docs.live:  http://10.174.184.156:8080/
    352. 

  352. <span class="o">[</span>searx-archlinux<span class="o">]</span>  INFO:  <span class="o">(</span>eth0<span class="o">)</span> IPv6:       http://<span class="o">[</span>fd42:573b:e0b3:e97e:216:3eff:fea5:9b65<span class="o">]</span>
    353. 

  353. ...
    354. 

  354. </pre></div>
    355. 

  355. </div>
    356. 

  356. </div></div>
    357. 

  357. </section>
    358. 

  358. </section>
    359. 

  359. 

  360. 

  361.             <div class="clearer"></div>
    362. 

  362.           </div>
    363. 

  363.         </div>
    364. 

  364.       </div>
    365. 

  365.   <span id="sidebar-top"></span>
    366. 

  366.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    367. 

  367.         <div class="sphinxsidebarwrapper">
    368. 

  368.   
    369. 

  369.     
    370. 

  370.             <p class="logo"><a href="../index.html">
    371. 

  371.               <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
    372. 

  372.             </a></p>
    373. 

  373.   
    374. 

  374. 

  375.   <h3>Project Links</h3>
    376. 

  376.   <ul>
    377. 

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

  378.   
    379. 

  379.     <li><a href="https://github.com/searx/searx">Source</a>
    380. 

  380.   
    381. 

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

  382.   
    383. 

  383.     <li><a href="https://twitter.com/Searx_engine">Twitter</a>
    384. 

  384.   
    385. 

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

  386.   </ul><h3>Navigation</h3>
    387. 

  387. <ul>
    388. 

  388.   <li><a href="../index.html">Overview</a>
    389. 

  389.     <ul>
    390. 

  390.       <li><a href="index.html">Blog</a>
    391. 

  391.         <ul>
    392. 

  392.           <li>Previous: <a href="command-line-engines.html" title="previous chapter">Running shell commands to fetch results</a>
    393. 

  393.           <li>Next: <a href="private-engines.html" title="next chapter">Limit access to your searx engines</a></ul>
    394. 

  394.       </li>
    395. 

  395.     </ul>
    396. 

  396.   </li>
    397. 

  397. </ul>
    398. 

  398. <div id="searchbox" style="display: none" role="search">
    399. 

  399.   <h3 id="searchlabel">Quick search</h3>
    400. 

  400.     <div class="searchformwrapper">
    401. 

  401.     <form class="search" action="../search.html" method="get">
    402. 

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

  403.       <input type="submit" value="Go" />
    404. 

  404.     </form>
    405. 

  405.     </div>
    406. 

  406. </div>
    407. 

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

  408.         </div>
    409. 

  409.       </div>
    410. 

  410.       <div class="clearer"></div>
    411. 

  411.     </div>
    412. 

  412.   
    413. 

  413.     <div class="footer" role="contentinfo">
    414. 

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

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

  416.     </div>
    417. 

  417.   <script src="../_static/version_warning_offset.js"></script>
    418. 

  418. 

  419.   </body>
    420. 

  420. </html>
    421.