git.iko.soy/searx
on v1.0.0 help sign in
searx/docs/admin/installation.rst
81 lines 2.5 kB history raw
1.. _installation:
3============
4Installation
5============
7*You're spoilt for choice*, choose your preferred method of installation.
9- :ref:`installation docker`
10- :ref:`installation scripts`
11- :ref:`installation basic`
13The :ref:`installation basic` is good enough for intranet usage and it is a
14excellent illustration of *how a searx instance is build up*. If you place your
15instance public to the internet you should really consider to install a
16:ref:`filtron reverse proxy <filtron.sh>` and for privacy a :ref:`result proxy
17<morty.sh>` is mandatory.
19Therefore, if you do not have any special preferences, its recommend to use the
20:ref:`installation docker` or the `Installation scripts`_ from our :ref:`tooling
21box <toolboxing>` as described below.
23.. _installation scripts:
25Installation scripts
26====================
28.. sidebar:: Update OS first!
30 To avoid unwanted side effects, update your OS before installing searx.
32The following will install a setup as shown in :ref:`architecture`. First you
33need to get a clone. The clone is only needed for the installation procedure
34and some maintenance tasks (alternatively you can create your own fork).
36For the installation procedure, use a *sudoer* login to run the scripts. If you
37install from ``root``, take into account that the scripts are creating a
38``searx``, a ``filtron`` and a ``morty`` user. In the installation procedure
39these new created users do need read access to the clone of searx, which is not
40the case if you clone into a folder below ``/root``.
43.. code:: bash
45 $ cd ~/Downloads
46 $ git clone https://github.com/searx/searx searx
47 $ cd searx
49**Install** :ref:`searx service <searx.sh>`
51This installs searx as described in :ref:`installation basic`.
53.. code:: bash
55 $ sudo -H ./utils/searx.sh install all
57**Install** :ref:`filtron reverse proxy <filtron.sh>`
59.. code:: bash
61 $ sudo -H ./utils/filtron.sh install all
63**Install** :ref:`result proxy <morty.sh>`
65.. code:: bash
67 $ sudo -H ./utils/morty.sh install all
69If all services are running fine, you can add it to your HTTP server:
71- :ref:`installation apache`
72- :ref:`installation nginx`
74.. _git stash: https://git-scm.com/docs/git-stash
76.. tip::
78 About script's installation options have a look at chapter :ref:`toolboxing
79 setup`. How to brand your instance see chapter :ref:`settings global`. To
80 *stash* your instance's setup, `git stash`_ your clone's :origin:`Makefile`
81 and :origin:`.config.sh` file .