2019-12-30 18:31:17 +01:00
<!DOCTYPE html>
2022-08-07 12:55:40 +00:00
< html lang = "en" >
2019-12-30 18:31:17 +01:00
< head >
< meta charset = "utf-8" / >
2020-09-30 10:35:05 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2019-12-30 18:31:17 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2021-03-27 19:39:04 +00:00
< title > Installation — Searx Documentation (Searx-1.0.0.tex)< / title >
2021-08-14 20:50:30 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/searx.css" / >
2021-02-17 19:54:37 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/tabs.css" / >
2021-08-14 20:50:30 +00:00
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
2020-02-15 10:08:58 +01:00
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
2022-08-07 12:55:40 +00:00
< script src = "../_static/_sphinx_javascript_frameworks_compat.js" > < / script >
2020-02-15 10:08:58 +01:00
< script src = "../_static/doctools.js" > < / script >
2019-12-30 18:31:17 +01:00
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2020-06-19 11:15:15 +02:00
< link rel = "next" title = "Step by step installation" href = "installation-searx.html" / >
2022-01-16 20:46:04 +00:00
< link rel = "prev" title = "Administrator documentation" href = "index.html" / >
2019-12-30 18:31:17 +01: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 13:12:59 +00:00
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2019-12-30 18:31:17 +01:00
< li class = "right" >
2020-06-19 11:15:15 +02:00
< a href = "installation-searx.html" title = "Step by step installation"
2019-12-30 18:31:17 +01:00
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "index.html" title = "Administrator documentation"
accesskey="P">previous< / a > |< / li >
2021-03-27 19:39:04 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Searx Documentation (Searx-1.0.0.tex)< / a > » < / li >
2020-09-30 10:35:05 +02:00
< li class = "nav-item nav-item-1" > < a href = "index.html" accesskey = "U" > Administrator documentation< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Installation< / a > < / li >
2019-12-30 18:31:17 +01:00
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2022-08-07 12:55:40 +00:00
< section id = "installation" >
< span id = "id1" > < / span > < h1 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this heading" > ¶< / a > < / h1 >
2020-06-19 11:15:15 +02:00
< p > < em > You’ < / em > , choose your preferred method of installation.< / p >
2019-12-30 18:31:17 +01:00
< ul class = "simple" >
2020-06-19 11:15:15 +02:00
< li > < p > < a class = "reference internal" href = "installation-docker.html#installation-docker" > < span class = "std std-ref" > Docker installation< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#installation-scripts" > < span class = "std std-ref" > Installation scripts< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "installation-searx.html#installation-basic" > < span class = "std std-ref" > Step by step installation< / span > < / a > < / p > < / li >
2019-12-30 18:31:17 +01:00
< / ul >
2020-06-19 11:15:15 +02:00
< p > The < a class = "reference internal" href = "installation-searx.html#installation-basic" > < span class = "std std-ref" > Step by step installation< / span > < / a > is good enough for intranet usage and it is a
excellent illustration of < em > how a searx instance is build up< / em > . If you place your
instance public to the internet you should really consider to install a
< a class = "reference internal" href = "../utils/filtron.sh.html#filtron-sh" > < span class = "std std-ref" > filtron reverse proxy< / span > < / a > and for privacy a < a class = "reference internal" href = "../utils/morty.sh.html#morty-sh" > < span class = "std std-ref" > result proxy< / span > < / a > is mandatory.< / p >
< p > Therefore, if you do not have any special preferences, its recommend to use the
< a class = "reference internal" href = "installation-docker.html#installation-docker" > < span class = "std std-ref" > Docker installation< / span > < / a > or the < a class = "reference internal" href = "#installation-scripts" > Installation scripts< / a > from our < a class = "reference internal" href = "../utils/index.html#toolboxing" > < span class = "std std-ref" > tooling
box< / span > < / a > as described below.< / p >
2022-08-07 12:55:40 +00:00
< section id = "installation-scripts" >
< span id = "id2" > < / span > < h2 > Installation scripts< a class = "headerlink" href = "#installation-scripts" title = "Permalink to this heading" > ¶< / a > < / h2 >
< aside class = "sidebar" >
2020-06-19 11:15:15 +02:00
< p class = "sidebar-title" > Update OS first!< / p >
< p > To avoid unwanted side effects, update your OS before installing searx.< / p >
2022-08-07 12:55:40 +00:00
< / aside >
2020-06-19 11:15:15 +02:00
< p > The following will install a setup as shown in < a class = "reference internal" href = "architecture.html#architecture" > < span class = "std std-ref" > Architecture< / span > < / a > . First you
need to get a clone. The clone is only needed for the installation procedure
and some maintenance tasks (alternatively you can create your own fork).< / p >
2020-12-14 17:24:55 +00:00
< p > For the installation procedure, use a < em > sudoer< / em > login to run the scripts. If you
install from < code class = "docutils literal notranslate" > < span class = "pre" > root< / span > < / code > , take into account that the scripts are creating a
< code class = "docutils literal notranslate" > < span class = "pre" > searx< / span > < / code > , a < code class = "docutils literal notranslate" > < span class = "pre" > filtron< / span > < / code > and a < code class = "docutils literal notranslate" > < span class = "pre" > morty< / span > < / code > user. In the installation procedure
these new created users do need read access to the clone of searx, which is not
the case if you clone into a folder below < code class = "docutils literal notranslate" > < span class = "pre" > /root< / span > < / code > .< / p >
2020-06-19 11:15:15 +02:00
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ < span class = "nb" > cd< / span > ~/Downloads
2020-09-30 10:35:05 +02:00
$ git clone https://github.com/searx/searx searx
2020-06-19 11:15:15 +02:00
$ < span class = "nb" > cd< / span > searx
2020-04-19 12:57:50 +02:00
< / pre > < / div >
< / div >
2022-08-07 12:55:40 +00:00
< aside class = "sidebar" >
2021-04-29 19:55:44 +00:00
< p class = "sidebar-title" > further read< / p >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "../utils/index.html#toolboxing" > < span class = "std std-ref" > Admin’ < / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "update-searx.html#update-searx" > < span class = "std std-ref" > How to update< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "update-searx.html#inspect-searx" > < span class = "std std-ref" > How to inspect & debug< / span > < / a > < / p > < / li >
< / ul >
2022-08-07 12:55:40 +00:00
< / aside >
2020-06-19 11:15:15 +02:00
< p > < strong > Install< / strong > < a class = "reference internal" href = "../utils/searx.sh.html#searx-sh" > < span class = "std std-ref" > searx service< / span > < / a > < / p >
< p > This installs searx as described in < a class = "reference internal" href = "installation-searx.html#installation-basic" > < span class = "std std-ref" > Step by step installation< / span > < / a > .< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ sudo -H ./utils/searx.sh install all
2020-04-19 12:57:50 +02:00
< / pre > < / div >
< / div >
2020-06-19 11:15:15 +02:00
< p > < strong > Install< / strong > < a class = "reference internal" href = "../utils/filtron.sh.html#filtron-sh" > < span class = "std std-ref" > filtron reverse proxy< / span > < / a > < / p >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ sudo -H ./utils/filtron.sh install all
2020-04-19 12:57:50 +02:00
< / pre > < / div >
< / div >
2020-06-19 11:15:15 +02:00
< p > < strong > Install< / strong > < a class = "reference internal" href = "../utils/morty.sh.html#morty-sh" > < span class = "std std-ref" > result proxy< / span > < / a > < / p >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ sudo -H ./utils/morty.sh install all
2020-04-19 12:57:50 +02:00
< / pre > < / div >
< / div >
2020-06-19 11:15:15 +02:00
< p > If all services are running fine, you can add it to your HTTP server:< / p >
2019-12-30 18:31:17 +01:00
< ul class = "simple" >
2020-06-19 11:15:15 +02:00
< li > < p > < a class = "reference internal" href = "installation-apache.html#installation-apache" > < span class = "std std-ref" > Install with apache< / span > < / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "installation-nginx.html#installation-nginx" > < span class = "std std-ref" > Install with nginx< / span > < / a > < / p > < / li >
2019-12-30 18:31:17 +01:00
< / ul >
2020-12-14 17:24:55 +00:00
< div class = "admonition tip" >
< p class = "admonition-title" > Tip< / p >
2021-01-12 09:55:12 +00:00
< p > About script’ < a class = "reference internal" href = "../utils/index.html#toolboxing-setup" > < span class = "std std-ref" > Tooling box setup< / span > < / a > . How to brand your instance see chapter < a class = "reference internal" href = "settings.html#settings-global" > < span class = "std std-ref" > Global Settings< / span > < / a > . To
2022-08-07 12:55:40 +00:00
< em > stash< / em > your instance’ < a class = "reference external" href = "https://git-scm.com/docs/git-stash" > git stash< / a > your clone’ < a class = "reference external" href = "https://github.com/searx/searx/blob/master/Makefile" > Origin: Makefile< / a >
and < a class = "reference external" href = "https://github.com/searx/searx/blob/master/.config.sh" > Origin: .config.sh< / a > file .< / p >
2021-04-08 17:47:22 +00:00
< / div >
2022-08-07 12:55:40 +00:00
< / section >
< / section >
2019-12-30 18:31:17 +01:00
2020-09-30 10:35:05 +02:00
< div class = "clearer" > < / div >
2019-12-30 18:31:17 +01: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 16:49:20 +00: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 >
2019-12-30 18:31:17 +01:00
2020-09-30 10:35:05 +02:00
< li > < a href = "https://github.com/searx/searx/wiki" > Wiki< / a >
2019-12-30 18:31:17 +01:00
2021-01-12 09:55:12 +00:00
< li > < a href = "https://searx.space" > Public instances< / a >
2019-12-30 18:31:17 +01:00
< li > < a href = "https://twitter.com/Searx_engine" > Twitter< / a >
2021-01-12 09:55:12 +00:00
< li > < a href = "https://github.com/searx/searx/issues" > Issue Tracker< / a >
2019-12-30 18:31:17 +01:00
< / ul > < h3 > Navigation< / h3 >
< ul >
< li > < a href = "../index.html" > Overview< / a >
< ul >
< li > < a href = "index.html" > Administrator documentation< / a >
< ul >
< li > Previous: < a href = "index.html" title = "previous chapter" > Administrator documentation< / a >
2020-06-19 11:15:15 +02:00
< li > Next: < a href = "installation-searx.html" title = "next chapter" > Step by step installation< / a > < / ul >
2019-12-30 18:31:17 +01:00
< / 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 20:50:30 +00:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
2019-12-30 18:31:17 +01:00
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
2022-08-07 12:55:40 +00:00
< script > document . getElementById ( 'searchbox' ) . style . display = "block" < / script >
2019-12-30 18:31:17 +01:00
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "footer" role = "contentinfo" >
2021-09-19 16:49:20 +00:00
© Copyright 2015-2021, Adam Tauber, Noémi Ványi.
2022-08-07 12:55:40 +00:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 5.1.1.
2019-12-30 18:31:17 +01:00
< / div >
2020-02-15 10:08:58 +01:00
< script src = "../_static/version_warning_offset.js" > < / script >
2019-12-30 18:31:17 +01:00
< / body >
< / html >
