2020-06-19 11:15:15 +02:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
2020-09-30 10:35:05 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2020-06-19 11:15:15 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2021-03-27 20:39:04 +01:00
< title > utils/searx.sh — Searx Documentation (Searx-1.0.0.tex)< / title >
2021-08-14 22:50:30 +02:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/searx.css" / >
2021-02-17 20:54:37 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/tabs.css" / >
2021-08-14 22:50:30 +02:00
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
2020-06-19 11:15:15 +02:00
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "utils/filtron.sh" href = "filtron.sh.html" / >
2021-04-29 21:55:44 +02:00
< link rel = "prev" title = "Admin’ href = "index.html" / >
2020-06-19 11:15:15 +02:00
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
2020-11-04 14:12:59 +01:00
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2020-06-19 11:15:15 +02:00
< li class = "right" >
< a href = "filtron.sh.html" title = "utils/filtron.sh"
accesskey="N">next< / a > |< / li >
< li class = "right" >
2021-04-29 21:55:44 +02:00
< a href = "index.html" title = "Admin’
2020-06-19 11:15:15 +02:00
accesskey="P">previous< / a > |< / li >
2021-03-27 20:39:04 +01:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Searx Documentation (Searx-1.0.0.tex)< / a > » < / li >
2021-04-29 21:55:44 +02:00
< li class = "nav-item nav-item-1" > < a href = "index.html" accesskey = "U" > Admin’ < / a > » < / li >
2020-09-30 10:35:05 +02:00
< li class = "nav-item nav-item-this" > < a href = "" > < code class = "docutils literal notranslate" > < span class = "pre" > utils/searx.sh< / span > < / code > < / a > < / li >
2020-06-19 11:15:15 +02:00
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2021-04-08 19:47:22 +02:00
< div class = "section" id = "utils-searx-sh" >
2020-06-19 11:15:15 +02:00
< span id = "searx-sh" > < / span > < h1 > < code class = "docutils literal notranslate" > < span class = "pre" > utils/searx.sh< / span > < / code > < a class = "headerlink" href = "#utils-searx-sh" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-04-08 19:47:22 +02:00
< div class = "sidebar" >
2020-06-19 11:15:15 +02:00
< p class = "sidebar-title" > further reading< / p >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "../admin/architecture.html#architecture" > < span class = "std std-ref" > Architecture< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "../admin/installation.html#installation" > < span class = "std std-ref" > Installation< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "../admin/installation-nginx.html#installation-nginx" > < span class = "std std-ref" > Install with nginx< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "../admin/installation-apache.html#installation-apache" > < span class = "std std-ref" > Install with apache< / span > < / a > < / p > < / li >
< / ul >
2021-04-08 19:47:22 +02:00
< / div >
2020-06-19 11:15:15 +02:00
< p > To simplify installation and maintenance of a searx instance you can use the
2020-09-30 10:35:05 +02:00
script < a class = "reference external" href = "https://github.com/searx/searx/blob/master/utils/searx.sh" > git://utils/searx.sh< / a > .< / p >
2021-04-08 19:47:22 +02:00
< div class = "section" id = "install" >
2020-06-19 11:15:15 +02:00
< h2 > Install< a class = "headerlink" href = "#install" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > In most cases you will install searx simply by running the command:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > sudo -H ./utils/searx.sh install all
< / pre > < / div >
< / div >
< 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" > searx< / span > < / code > ) and installs searx
into this user account. The installation is described in chapter
< a class = "reference internal" href = "../admin/installation-searx.html#installation-basic" > < span class = "std std-ref" > Step by step installation< / span > < / a > .< / p >
2021-04-08 19:47:22 +02:00
< / div >
< div class = "section" id = "overview" >
2020-06-19 11:15:15 +02:00
< span id = "intranet-reverse-proxy" > < / span > < h2 > Overview< a class = "headerlink" href = "#overview" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The < code class = "docutils literal notranslate" > < span class = "pre" > --help< / span > < / code > output of the script is largely self-explanatory
(< a class = "reference internal" href = "index.html#toolboxing-common" > < span class = "std std-ref" > Common commands & environment< / span > < / a > ):< / p >
2020-10-16 19:44:45 +02:00
< div class = "highlight-text notranslate" > < div class = "highlight" > < pre > < span > < / span > usage::
searx.sh shell
2020-12-08 20:36:18 +01:00
searx.sh install [all|user|searx-src|pyenv|uwsgi|packages|settings|buildhost]
2020-10-16 19:44:45 +02:00
searx.sh update [searx]
searx.sh remove [all|user|pyenv|searx-src]
searx.sh activate [service]
searx.sh deactivate [service]
searx.sh inspect [service]
searx.sh option [debug-[on|off]|image-proxy-[on|off]|result-proxy < url> < key> ]
searx.sh apache [install|remove]
shell
start interactive shell from user searx
install / remove
:all: complete (de-) installation of searx service
:user: add/remove service user ' searx' (/usr/local/searx)
:searx-src: clone https://github.com/searx/searx
:pyenv: create/remove virtualenv (python) in /usr/local/searx/searx-pyenv
:uwsgi: install searx uWSGI application
2020-12-24 10:03:21 +01:00
:settings: reinstall settings from /home/runner/work/searx/searx/utils/templates/etc/searx/use_default_settings.yml
2020-10-16 19:44:45 +02:00
:packages: install needed packages from OS package manager
:buildhost: install packages from OS package manager needed by buildhosts
update searx
Update searx installation (/usr/local/searx)
activate service
activate and start service daemon (systemd unit)
deactivate service
stop and deactivate service daemon (systemd unit)
inspect service
run some small tests and inspect service' s status and log
option
set one of the available options
apache
:install: apache site with the searx uwsgi app
:remove: apache site
searx settings: /etc/searx/settings.yml
If needed, set PUBLIC_URL of your WEB service in the ' .config.sh' file::
2021-10-10 15:40:49 +02:00
PUBLIC_URL : http://fv-az121-274/searx
SEARX_INSTANCE_NAME : searx@fv-az121-274
2020-10-16 19:44:45 +02:00
SERVICE_USER : searx
SEARX_INTERNAL_HTTP : http://127.0.0.1:8888
2020-06-19 11:15:15 +02:00
< / pre > < / div >
< / div >
2021-04-08 19:47:22 +02:00
< / div >
< / div >
2020-06-19 11:15:15 +02:00
2020-09-30 10:35:05 +02:00
< div class = "clearer" > < / div >
2020-06-19 11:15:15 +02:00
< / div >
< / div >
< / div >
< span id = "sidebar-top" > < / span >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/searx_logo_small.png" alt = "Logo" / >
< / a > < / p >
< h3 > Project Links< / h3 >
< ul >
2021-09-19 18:49:20 +02:00
< li > < a href = "blog/index.html" > Blog< / a >
2020-09-30 10:35:05 +02:00
< li > < a href = "https://github.com/searx/searx" > Source< / a >
2020-06-19 11:15:15 +02:00
2020-09-30 10:35:05 +02:00
< li > < a href = "https://github.com/searx/searx/wiki" > Wiki< / a >
2020-06-19 11:15:15 +02:00
2021-01-12 10:55:12 +01:00
< li > < a href = "https://searx.space" > Public instances< / a >
2020-06-19 11:15:15 +02:00
< li > < a href = "https://twitter.com/Searx_engine" > Twitter< / a >
2021-01-12 10:55:12 +01:00
< li > < a href = "https://github.com/searx/searx/issues" > Issue Tracker< / a >
2020-06-19 11:15:15 +02:00
< / ul > < h3 > Navigation< / h3 >
< ul >
< li > < a href = "../index.html" > Overview< / a >
< ul >
2021-04-29 21:55:44 +02:00
< li > < a href = "index.html" > Admin’ < / a >
2020-06-19 11:15:15 +02:00
< ul >
2021-04-29 21:55:44 +02:00
< li > Previous: < a href = "index.html" title = "previous chapter" > Admin’ < / a >
2020-06-19 11:15:15 +02:00
< li > Next: < a href = "filtron.sh.html" title = "next chapter" > < code class = "docutils literal notranslate" > < span class = "pre" > utils/filtron.sh< / span > < / code > < / a > < / ul >
< / li >
< / ul >
< / li >
< / ul >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
2021-08-14 22:50:30 +02:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
2020-06-19 11:15:15 +02:00
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "footer" role = "contentinfo" >
2021-09-19 18:49:20 +02:00
© Copyright 2015-2021, Adam Tauber, Noémi Ványi.
2021-08-14 22:50:30 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 4.1.2.
2020-06-19 11:15:15 +02:00
< / div >
< script src = "../_static/version_warning_offset.js" > < / script >
< / body >
< / html >
