installation.rst.txt 2.5 KB

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