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
/
index.html

index.html 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228 
  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>Admin’s tooling box &#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.     <link rel="index" title="Index" href="../genindex.html" />
    20. 

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

  21.     <link rel="next" title="utils/searx.sh" href="searx.sh.html" />
    22. 

  22.     <link rel="prev" title="searx_extra/standalone_searx.py" href="../searx_extra/standalone_searx.py.html" /> 
    23. 

  23.   </head><body>
    24. 

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

  25.       <h3>Navigation</h3>
    26. 

  26.       <ul>
    27. 

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

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

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

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

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

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

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

  34.           <a href="searx.sh.html" title="utils/searx.sh"
    35. 

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

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

  37.           <a href="../searx_extra/standalone_searx.py.html" title="searx_extra/standalone_searx.py"
    38. 

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

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

  40.         <li class="nav-item nav-item-this"><a href="">Admin’s tooling box</a></li> 
    41. 

  41.       </ul>
    42. 

  42.     </div>  
    43. 

  43. 

  44.     <div class="document">
    45. 

  45.       <div class="documentwrapper">
    46. 

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

  47.           <div class="body" role="main">
    48. 

  48.             
    49. 

  49.   <section id="admin-s-tooling-box">
    50. 

  50. <span id="toolboxing"></span><span id="searx-utils"></span><h1>Admin’s tooling box<a class="headerlink" href="#admin-s-tooling-box" title="Permalink to this heading">¶</a></h1>
    51. 

  51. <p>In the folder <a class="reference external" href="https://github.com/searx/searx/blob/master/utils/">Origin: utils/</a> we maintain some tools useful for administrators.</p>
    52. 

  52. <div class="toctree-wrapper compound">
    53. 

  53. <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
    54. 

  54. <ul>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="searx.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/searx.sh</span></code></a><ul>
    56. 

  56. <li class="toctree-l2"><a class="reference internal" href="searx.sh.html#install">Install</a></li>
    57. 

  57. <li class="toctree-l2"><a class="reference internal" href="searx.sh.html#overview">Overview</a></li>
    58. 

  58. </ul>
    59. 

  59. </li>
    60. 

  60. <li class="toctree-l1"><a class="reference internal" href="filtron.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/filtron.sh</span></code></a><ul>
    61. 

  61. <li class="toctree-l2"><a class="reference internal" href="filtron.sh.html#create-user">Create user</a></li>
    62. 

  62. <li class="toctree-l2"><a class="reference internal" href="filtron.sh.html#install-go">Install go</a></li>
    63. 

  63. <li class="toctree-l2"><a class="reference internal" href="filtron.sh.html#install-filtron">Install filtron</a></li>
    64. 

  64. <li class="toctree-l2"><a class="reference internal" href="filtron.sh.html#overview">Overview</a></li>
    65. 

  65. </ul>
    66. 

  66. </li>
    67. 

  67. <li class="toctree-l1"><a class="reference internal" href="morty.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/morty.sh</span></code></a><ul>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="morty.sh.html#create-user">Create user</a></li>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="morty.sh.html#install-go">Install go</a></li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="morty.sh.html#install-morty">Install morty</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="morty.sh.html#overview">Overview</a></li>
    72. 

  72. </ul>
    73. 

  73. </li>
    74. 

  74. <li class="toctree-l1"><a class="reference internal" href="lxc.sh.html"><code class="docutils literal notranslate"><span class="pre">utils/lxc.sh</span></code></a><ul>
    75. 

  75. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#install-suite">Install suite</a></li>
    76. 

  76. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#running-commands">Running commands</a></li>
    77. 

  77. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#setup-searx-buildhost">Setup searx buildhost</a></li>
    78. 

  78. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#overview">Overview</a></li>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="lxc.sh.html#searx-suite">searx suite</a></li>
    80. 

  80. </ul>
    81. 

  81. </li>
    82. 

  82. </ul>
    83. 

  83. </div>
    84. 

  84. <section id="common-commands-environment">
    85. 

  85. <span id="toolboxing-common"></span><h2>Common commands &amp; environment<a class="headerlink" href="#common-commands-environment" title="Permalink to this heading">¶</a></h2>
    86. 

  86. <p>Scripts to maintain services often dispose of common commands and environments.</p>
    87. 

  87. <dl>
    88. 

  88. <dt><code class="docutils literal notranslate"><span class="pre">shell</span></code><span class="classifier">command</span></dt><dd><p>Opens a shell from the service user <code class="docutils literal notranslate"><span class="pre">${SERVICE_USSR}</span></code>, very helpful for
    89. 

  89. troubleshooting.</p>
    90. 

  90. </dd>
    91. 

  91. <dt><code class="docutils literal notranslate"><span class="pre">inspect</span> <span class="pre">service</span></code><span class="classifier">command</span></dt><dd><p>Shows status and log of the service, most often you have a option to enable
    92. 

  92. more verbose debug logs.  Very helpful for debugging, but be careful not to
    93. 

  93. enable debugging in a production environment!</p>
    94. 

  94. </dd>
    95. 

  95. <dt><code class="docutils literal notranslate"><span class="pre">FORCE_TIMEOUT</span></code><span class="classifier">environment</span></dt><dd><p>Sets timeout for interactive prompts. If you want to run a script in batch
    96. 

  96. job, with defaults choices, set <code class="docutils literal notranslate"><span class="pre">FORCE_TIMEOUT=0</span></code>.  By example; to install a
    97. 

  97. reverse proxy for filtron on all containers of the <a class="reference internal" href="lxc.sh.html#lxc-searx-env"><span class="std std-ref">searx suite</span></a> use</p>
    98. 

  98. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install
    99. 

  99. </pre></div>
    100. 

  100. </div>
    101. 

  101. </dd>
    102. 

  102. </dl>
    103. 

  103. </section>
    104. 

  104. <section id="tooling-box-setup">
    105. 

  105. <span id="toolboxing-setup"></span><h2>Tooling box setup<a class="headerlink" href="#tooling-box-setup" title="Permalink to this heading">¶</a></h2>
    106. 

  106. <p>The main setup is done in the <a class="reference external" href="https://github.com/searx/searx/blob/master/.config.sh">Origin: .config.sh</a> (read also <a class="reference internal" href="../admin/settings.html#settings-global"><span class="std std-ref">Global Settings</span></a>).</p>
    107. 

  107. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># -*- coding: utf-8; mode: sh -*-</span>
    108. 

  108. <span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
    109. 

  109. <span class="c1"># shellcheck shell=bash disable=SC2034</span>
    110. 

  110. <span class="c1">#</span>
    111. 

  111. <span class="c1"># This environment is used by ./utils scripts like filtron.sh or searx.sh.  The</span>
    112. 

  112. <span class="c1"># default values are *most flexible* and *best maintained*, you normally not</span>
    113. 

  113. <span class="c1"># need to change the defaults (except PUBLIC_URL).</span>
    114. 

  114. <span class="c1">#</span>
    115. 

  115. <span class="c1"># Before you change any value here you have to uninstall any previous</span>
    116. 

  116. <span class="c1"># installation.  Further is it recommended to backup your changes simply by</span>
    117. 

  117. <span class="c1"># adding them to you local brand (git branch)::</span>
    118. 

  118. <span class="c1">#</span>
    119. 

  119. <span class="c1">#     git add .config</span>
    120. 

  120. 

  121. <span class="c1"># The public URL of the searx instance: PUBLIC_URL=&quot;https://mydomain.xy/searx&quot;</span>
    122. 

  122. <span class="c1"># The default is taken from ./utils/brand.env.</span>
    123. 

  123. 

  124. <span class="nv">PUBLIC_URL</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">SEARX_URL</span><span class="si">}</span><span class="s2">&quot;</span>
    125. 

  125. 

  126. <span class="k">if</span> <span class="o">[[</span> <span class="si">${</span><span class="nv">PUBLIC_URL</span><span class="si">}</span> <span class="o">==</span> <span class="s2">&quot;https://searx.me&quot;</span> <span class="o">]]</span><span class="p">;</span> <span class="k">then</span>
    127. 

  127.     <span class="c1"># hint: Linux containers do not have DNS entries, lets use IPs</span>
    128. 

  128.     <span class="nv">PUBLIC_URL</span><span class="o">=</span><span class="s2">&quot;http://</span><span class="k">$(</span>primary_ip<span class="k">)</span><span class="s2">/searx&quot;</span>
    129. 

  129. <span class="k">fi</span>
    130. 

  130. 

  131. <span class="c1"># searx.sh</span>
    132. 

  132. <span class="c1"># ---------</span>
    133. 

  133. 

  134. <span class="c1"># SEARX_INTERNAL_URL=&quot;127.0.0.1:8888&quot;</span>
    135. 

  135. <span class="c1"># SEARX_SETTINGS_TEMPLATE=&quot;${REPO_ROOT}/utils/templates/etc/searx/use_default_settings.yml&quot;</span>
    136. 

  136. 

  137. <span class="c1"># Only change, if you maintain a searx brand in your searx fork (GIT_URL) which</span>
    138. 

  138. <span class="c1"># is not hold by branch &#39;master&#39;.  The branch has to be a local branch, in the</span>
    139. 

  139. <span class="c1"># repository from which you install (which is most often the case).  If you want</span>
    140. 

  140. <span class="c1"># to install branch &#39;foo&#39;, don&#39;t forget to run &#39;git branch foo origin/foo&#39; once.</span>
    141. 

  141. <span class="c1"># GIT_BRANCH=&quot;${GIT_BRANCH:-master}&quot;</span>
    142. 

  142. 

  143. <span class="c1"># filtron.sh</span>
    144. 

  144. <span class="c1"># ----------</span>
    145. 

  145. 

  146. <span class="c1"># FILTRON_API=&quot;127.0.0.1:4005&quot;</span>
    147. 

  147. <span class="c1"># FILTRON_LISTEN=&quot;127.0.0.1:4004&quot;</span>
    148. 

  148. <span class="c1"># FILTRON_TARGET=&quot;127.0.0.1:8888&quot;</span>
    149. 

  149. 

  150. <span class="c1"># morty.sh</span>
    151. 

  151. <span class="c1"># --------</span>
    152. 

  152. 

  153. <span class="c1"># morty listen address</span>
    154. 

  154. <span class="c1"># MORTY_LISTEN=&quot;127.0.0.1:3000&quot;</span>
    155. 

  155. <span class="c1"># PUBLIC_URL_PATH_MORTY=&quot;/morty/&quot;</span>
    156. 

  156. 

  157. <span class="c1"># system services</span>
    158. 

  158. <span class="c1"># ---------------</span>
    159. 

  159. 

  160. <span class="c1"># Common $HOME folder of the service accounts</span>
    161. 

  161. <span class="c1"># SERVICE_HOME_BASE=&quot;/usr/local&quot;</span>
    162. 

  162. 

  163. <span class="c1"># **experimental**: Set SERVICE_USER to run all services by one account, but be</span>
    164. 

  164. <span class="c1"># aware that removing discrete components might conflict!</span>
    165. 

  165. <span class="c1"># SERVICE_USER=searx</span>
    166. 

  166. </pre></div>
    167. 

  167. </div>
    168. 

  168. </section>
    169. 

  169. </section>
    170. 

  170. 

  171. 

  172.             <div class="clearer"></div>
    173. 

  173.           </div>
    174. 

  174.         </div>
    175. 

  175.       </div>
    176. 

  176.   <span id="sidebar-top"></span>
    177. 

  177.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    178. 

  178.         <div class="sphinxsidebarwrapper">
    179. 

  179.   
    180. 

  180.     
    181. 

  181.             <p class="logo"><a href="../index.html">
    182. 

  182.               <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
    183. 

  183.             </a></p>
    184. 

  184.   
    185. 

  185. 

  186.   <h3>Project Links</h3>
    187. 

  187.   <ul>
    188. 

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

  189.   
    190. 

  190.     <li><a href="https://github.com/searx/searx">Source</a>
    191. 

  191.   
    192. 

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

  193.   
    194. 

  194.     <li><a href="https://twitter.com/Searx_engine">Twitter</a>
    195. 

  195.   
    196. 

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

  197.   </ul><h3>Navigation</h3>
    198. 

  198. <ul>
    199. 

  199.   <li><a href="../index.html">Overview</a>
    200. 

  200.     <ul>
    201. 

  201.           <li>Previous: <a href="../searx_extra/standalone_searx.py.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">searx_extra/standalone_searx.py</span></code></a>
    202. 

  202.           <li>Next: <a href="searx.sh.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">utils/searx.sh</span></code></a>
    203. 

  203.     </ul>
    204. 

  204.   </li>
    205. 

  205. </ul>
    206. 

  206. <div id="searchbox" style="display: none" role="search">
    207. 

  207.   <h3 id="searchlabel">Quick search</h3>
    208. 

  208.     <div class="searchformwrapper">
    209. 

  209.     <form class="search" action="../search.html" method="get">
    210. 

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

  211.       <input type="submit" value="Go" />
    212. 

  212.     </form>
    213. 

  213.     </div>
    214. 

  214. </div>
    215. 

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

  216.         </div>
    217. 

  217.       </div>
    218. 

  218.       <div class="clearer"></div>
    219. 

  219.     </div>
    220. 

  220.   
    221. 

  221.     <div class="footer" role="contentinfo">
    222. 

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

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

  224.     </div>
    225. 

  225.   <script src="../_static/version_warning_offset.js"></script>
    226. 

  226. 

  227.   </body>
    228. 

  228. </html>
    229.