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
/
utils
/
morty.sh.html

morty.sh.html 16 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 
  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>utils/morty.sh &#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="utils/lxc.sh" href="lxc.sh.html" />
    23. 

  23.     <link rel="prev" title="utils/filtron.sh" href="filtron.sh.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="lxc.sh.html" title="utils/lxc.sh"
    36. 

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

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

  38.           <a href="filtron.sh.html" title="utils/filtron.sh"
    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">Admin’s tooling box</a> &#187;</li>
    42. 

  42.         <li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">utils/morty.sh</span></code></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="utils-morty-sh">
    52. 

  52. <span id="morty-sh"></span><h1><code class="docutils literal notranslate"><span class="pre">utils/morty.sh</span></code><a class="headerlink" href="#utils-morty-sh" 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 internal" href="../admin/architecture.html#architecture"><span class="std std-ref">Architecture</span></a></p></li>
    57. 

  57. <li><p><a class="reference internal" href="../admin/installation.html#installation"><span class="std std-ref">Installation</span></a> (<a class="reference internal" href="../admin/installation-nginx.html#installation-nginx"><span class="std std-ref">nginx</span></a> &amp; <a class="reference internal" href="../admin/installation-apache.html#installation-apache"><span class="std std-ref">apache</span></a>)</p></li>
    58. 

  58. <li><p><a class="reference internal" href="../admin/morty.html#searx-morty"><span class="std std-ref">How to setup result proxy</span></a></p></li>
    59. 

  59. </ul>
    60. 

  60. </aside>
    61. 

  61. <p>To simplify installation and maintenance of a <a class="reference external" href="https://github.com/asciimoo/morty">morty</a> instance you can use the
    62. 

  62. script <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/morty.sh">Origin: utils/morty.sh</a>.  In most cases you will install <a class="reference external" href="https://github.com/asciimoo/morty">morty</a> simply by
    63. 

  63. running the command:</p>
    64. 

  64. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo -H ./utils/morty.sh install all
    65. 

  65. </pre></div>
    66. 

  66. </div>
    67. 

  67. <p>The script adds a <code class="docutils literal notranslate"><span class="pre">${SERVICE_USER}</span></code> (default:<code class="docutils literal notranslate"><span class="pre">morty</span></code>) and installs <a class="reference external" href="https://github.com/asciimoo/morty">morty</a>
    68. 

  68. into this user account:</p>
    69. 

  69. <ol class="arabic simple">
    70. 

  70. <li><p>Create a separated user account (<code class="docutils literal notranslate"><span class="pre">morty</span></code>).</p></li>
    71. 

  71. <li><p>Download and install <a class="reference external" href="https://golang.org/">Go</a> binary in user’s $HOME (<code class="docutils literal notranslate"><span class="pre">~morty</span></code>).</p></li>
    72. 

  72. <li><p>Install <a class="reference external" href="https://github.com/asciimoo/morty">morty</a> with the package management from <a class="reference external" href="https://golang.org/">Go</a> (<code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span> <span class="pre">-v</span> <span class="pre">-u</span>
    73. 

  73. <span class="pre">github.com/asciimoo/morty</span></code>)</p></li>
    74. 

  74. <li><p>Setup a systemd service unit <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/templates/lib/systemd/system/morty.service">[ref]</a>
    75. 

  75. (<code class="docutils literal notranslate"><span class="pre">/lib/systemd/system/morty.service</span></code>).</p></li>
    76. 

  76. </ol>
    77. 

  77. <div class="admonition hint">
    78. 

  78. <p class="admonition-title">Hint</p>
    79. 

  79. <p>To add morty to your searx instance read chapter <a class="reference internal" href="../admin/morty.html#searx-morty"><span class="std std-ref">How to setup result proxy</span></a>.</p>
    80. 

  80. </div>
    81. 

  81. <section id="create-user">
    82. 

  82. <h2>Create user<a class="headerlink" href="#create-user" title="Permalink to this heading">¶</a></h2>
    83. 

  83. <div class="sphinx-tabs docutils container">
    84. 

  84. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-YmFzaA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-0-YmFzaA==" name="YmFzaA==" role="tab" tabindex="0">bash</button></div><div aria-labelledby="tab-0-YmFzaA==" class="sphinx-tabs-panel group-tab" id="panel-0-YmFzaA==" name="YmFzaA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H useradd --shell /bin/bash --system <span class="se">\</span>
    85. 

  85.     --home-dir <span class="s2">&quot;/usr/local/morty&quot;</span> <span class="se">\</span>
    86. 

  86.     --comment <span class="s2">&quot;Privacy-respecting metasearch engine&quot;</span> morty
    87. 

  87. 

  88. $ sudo -H mkdir <span class="s2">&quot;/usr/local/morty&quot;</span>
    89. 

  89. $ sudo -H chown -R <span class="s2">&quot;morty:morty&quot;</span> <span class="s2">&quot;/usr/local/morty&quot;</span>
    90. 

  90. </pre></div>
    91. 

  91. </div>
    92. 

  92. </div></div>
    93. 

  93. </section>
    94. 

  94. <section id="install-go">
    95. 

  95. <h2>Install go<a class="headerlink" href="#install-go" title="Permalink to this heading">¶</a></h2>
    96. 

  96. <div class="sphinx-tabs docutils container">
    97. 

  97. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-YmFzaA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-1-YmFzaA==" name="YmFzaA==" role="tab" tabindex="0">bash</button></div><div aria-labelledby="tab-1-YmFzaA==" class="sphinx-tabs-panel group-tab" id="panel-1-YmFzaA==" name="YmFzaA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ cat &gt; <span class="s2">&quot;/usr/local/morty/.go_env&quot;</span> <span class="s">&lt;&lt;EOF</span>
    98. 

  98. <span class="s">export GOPATH=/usr/local/morty/go-apps</span>
    99. 

  99. <span class="s">export PATH=$PATH:/usr/local/morty/local/go/bin:$GOPATH/bin</span>
    100. 

  100. <span class="s">EOF</span>
    101. 

  101. $ sudo -i -u <span class="s2">&quot;morty&quot;</span>
    102. 

  102. <span class="o">(</span>morty<span class="o">)</span> $ <span class="nb">echo</span> <span class="s1">&#39;source /usr/local/morty/.go_env&#39;</span> &gt;&gt; ~/.profile
    103. 

  103. <span class="o">(</span>morty<span class="o">)</span> $ mkdir /usr/local/morty/local
    104. 

  104. <span class="o">(</span>morty<span class="o">)</span> $ wget --progress<span class="o">=</span>bar -O <span class="s2">&quot;go1.13.5.linux-amd64.tar.gz&quot;</span> <span class="se">\</span>
    105. 

  105.             <span class="s2">&quot;https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz&quot;</span>
    106. 

  106. <span class="o">(</span>morty<span class="o">)</span> $ tar -C /usr/local/morty/local -xzf <span class="s2">&quot;go1.13.5.linux-amd64.tar.gz&quot;</span>
    107. 

  107. <span class="o">(</span>morty<span class="o">)</span> $ which go
    108. 

  108. /usr/local/morty/local/go/bin/go
    109. 

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

  110. </div>
    111. 

  111. </div></div>
    112. 

  112. </section>
    113. 

  113. <section id="install-morty">
    114. 

  114. <h2>Install morty<a class="headerlink" href="#install-morty" title="Permalink to this heading">¶</a></h2>
    115. 

  115. <p>Install morty software and systemd unit:</p>
    116. 

  116. <div class="sphinx-tabs docutils container">
    117. 

  117. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-YmFzaA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-2-YmFzaA==" name="YmFzaA==" role="tab" tabindex="0">bash</button></div><div aria-labelledby="tab-2-YmFzaA==" class="sphinx-tabs-panel group-tab" id="panel-2-YmFzaA==" name="YmFzaA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -i -u <span class="s2">&quot;morty&quot;</span>
    118. 

  118. <span class="o">(</span>morty<span class="o">)</span> $ go get -v -u github.com/asciimoo/morty
    119. 

  119. </pre></div>
    120. 

  120. </div>
    121. 

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

  122. <div class="sphinx-tabs docutils container">
    123. 

  123. <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-c3lzdGVtZA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-3-c3lzdGVtZA==" name="c3lzdGVtZA==" role="tab" tabindex="0">systemd</button></div><div aria-labelledby="tab-3-c3lzdGVtZA==" class="sphinx-tabs-panel group-tab" id="panel-3-c3lzdGVtZA==" name="c3lzdGVtZA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>Unit<span class="o">]</span>
    124. 

  124. 

  125. <span class="nv">Description</span><span class="o">=</span>morty
    126. 

  126. <span class="nv">After</span><span class="o">=</span>syslog.target
    127. 

  127. <span class="nv">After</span><span class="o">=</span>network.target
    128. 

  128. 

  129. <span class="o">[</span>Service<span class="o">]</span>
    130. 

  130. 

  131. <span class="nv">Type</span><span class="o">=</span>simple
    132. 

  132. <span class="nv">User</span><span class="o">=</span>morty
    133. 

  133. <span class="nv">Group</span><span class="o">=</span>morty
    134. 

  134. <span class="nv">WorkingDirectory</span><span class="o">=</span>/usr/local/morty
    135. 

  135. <span class="nv">ExecStart</span><span class="o">=</span>/usr/local/morty/go-apps/bin/morty -key <span class="s1">&#39;&#39;</span> -listen <span class="s1">&#39;127.0.0.1:3000&#39;</span> -timeout <span class="m">5</span>
    136. 

  136. 

  137. <span class="nv">Restart</span><span class="o">=</span>always
    138. 

  138. <span class="nv">Environment</span><span class="o">=</span><span class="nv">USER</span><span class="o">=</span>morty <span class="nv">HOME</span><span class="o">=</span>/usr/local/morty <span class="nv">DEBUG</span><span class="o">=</span><span class="nb">false</span>
    139. 

  139. 

  140. <span class="c1"># Some distributions may not support these hardening directives.  If you cannot</span>
    141. 

  141. <span class="c1"># start the service due to an unknown option, comment out the ones not supported</span>
    142. 

  142. <span class="c1"># by your version of systemd.</span>
    143. 

  143. 

  144. <span class="nv">ProtectSystem</span><span class="o">=</span>full
    145. 

  145. <span class="nv">PrivateDevices</span><span class="o">=</span>yes
    146. 

  146. <span class="nv">PrivateTmp</span><span class="o">=</span>yes
    147. 

  147. <span class="nv">NoNewPrivileges</span><span class="o">=</span><span class="nb">true</span>
    148. 

  148. 

  149. <span class="o">[</span>Install<span class="o">]</span>
    150. 

  150. 

  151. <span class="nv">WantedBy</span><span class="o">=</span>multi-user.target
    152. 

  152. </pre></div>
    153. 

  153. </div>
    154. 

  154. </div></div>
    155. 

  155. </section>
    156. 

  156. <section id="overview">
    157. 

  157. <span id="morty-sh-overview"></span><h2>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">¶</a></h2>
    158. 

  158. <p>The <code class="docutils literal notranslate"><span class="pre">--help</span></code> output of the script is largely self-explanatory
    159. 

  159. (<a class="reference internal" href="index.html#toolboxing-common"><span class="std std-ref">Common commands &amp; environment</span></a>):</p>
    160. 

  160. <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage::
    161. 

  161.   morty.sh shell
    162. 

  162.   morty.sh install    [all|user]
    163. 

  163.   morty.sh update     [morty]
    164. 

  164.   morty.sh remove     [all]
    165. 

  165.   morty.sh activate   [service]
    166. 

  166.   morty.sh deactivate [service]
    167. 

  167.   morty.sh inspect    [service]
    168. 

  168.   morty.sh option     [debug-on|debug-off|new-key]
    169. 

  169.   morty.sh apache     [install|remove]
    170. 

  170.   morty.sh nginx      [install|remove]
    171. 

  171.   morty.sh info       [searx]
    172. 

  172. 

  173. shell
    174. 

  174.   start interactive shell from user morty
    175. 

  175. install / remove
    176. 

  176.   all:        complete setup of morty service
    177. 

  177.   user:       add/remove service user &#39;morty&#39; (/usr/local/morty)
    178. 

  178. update morty
    179. 

  179.   Update morty installation (/usr/local/morty)
    180. 

  180. activate service
    181. 

  181.   activate and start service daemon (systemd unit)
    182. 

  182. deactivate service
    183. 

  183.   stop and deactivate service daemon (systemd unit)
    184. 

  184. inspect service
    185. 

  185.   show service status and log
    186. 

  186. option
    187. 

  187.   set one of the available options
    188. 

  188.   :new-key:   set new morty key
    189. 

  189. apache : http://fv-az163-121/morty/
    190. 

  190.   :install: apache site with a reverse proxy (ProxyPass)
    191. 

  191.   :remove:  apache site morty.conf
    192. 

  192. nginx (http://fv-az163-121/morty/)
    193. 

  193.   :install: nginx site with a reverse proxy (ProxyPass)
    194. 

  194.   :remove:  nginx site morty.conf
    195. 

  195. 

  196. If needed, set the environment variables in the &#39;.config.sh&#39; file::
    197. 

  197.   PUBLIC_URL_MORTY:     http://fv-az163-121/morty/
    198. 

  198.   MORTY_LISTEN:         127.0.0.1:3000
    199. 

  199.   SERVICE_USER:         morty
    200. 

  200. 

  201. To activate result and image proxy in searx, edit settings.yml (read:
    202. 

  202. https://searx.github.io/searx/admin/morty.html)::
    203. 

  203.   result_proxy:
    204. 

  204.       url : http://fv-az163-121/morty/
    205. 

  205.   server:
    206. 

  206.       image_proxy : True
    207. 

  207. </pre></div>
    208. 

  208. </div>
    209. 

  209. </section>
    210. 

  210. </section>
    211. 

  211. 

  212. 

  213.             <div class="clearer"></div>
    214. 

  214.           </div>
    215. 

  215.         </div>
    216. 

  216.       </div>
    217. 

  217.   <span id="sidebar-top"></span>
    218. 

  218.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    219. 

  219.         <div class="sphinxsidebarwrapper">
    220. 

  220.   
    221. 

  221.     
    222. 

  222.             <p class="logo"><a href="../index.html">
    223. 

  223.               <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
    224. 

  224.             </a></p>
    225. 

  225.   
    226. 

  226. 

  227.   <h3>Project Links</h3>
    228. 

  228.   <ul>
    229. 

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

  230.   
    231. 

  231.     <li><a href="https://github.com/searx/searx">Source</a>
    232. 

  232.   
    233. 

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

  234.   
    235. 

  235.     <li><a href="https://twitter.com/Searx_engine">Twitter</a>
    236. 

  236.   
    237. 

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

  238.   </ul><h3>Navigation</h3>
    239. 

  239. <ul>
    240. 

  240.   <li><a href="../index.html">Overview</a>
    241. 

  241.     <ul>
    242. 

  242.       <li><a href="index.html">Admin’s tooling box</a>
    243. 

  243.         <ul>
    244. 

  244.           <li>Previous: <a href="filtron.sh.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">utils/filtron.sh</span></code></a>
    245. 

  245.           <li>Next: <a href="lxc.sh.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span></code></a></ul>
    246. 

  246.       </li>
    247. 

  247.     </ul>
    248. 

  248.   </li>
    249. 

  249. </ul>
    250. 

  250. <div id="searchbox" style="display: none" role="search">
    251. 

  251.   <h3 id="searchlabel">Quick search</h3>
    252. 

  252.     <div class="searchformwrapper">
    253. 

  253.     <form class="search" action="../search.html" method="get">
    254. 

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

  255.       <input type="submit" value="Go" />
    256. 

  256.     </form>
    257. 

  257.     </div>
    258. 

  258. </div>
    259. 

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

  260.         </div>
    261. 

  261.       </div>
    262. 

  262.       <div class="clearer"></div>
    263. 

  263.     </div>
    264. 

  264.   
    265. 

  265.     <div class="footer" role="contentinfo">
    266. 

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

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

  268.     </div>
    269. 

  269.   <script src="../_static/version_warning_offset.js"></script>
    270. 

  270. 

  271.   </body>
    272. 

  272. </html>
    273.