git.iko.soy/searx
on engine-data help sign in
searx/docs/admin/installation-searx.rst
120 lines 3.4 kB history raw
1.. _installation basic:
3=========================
4Step by step installation
5=========================
7.. contents:: Contents
8 :depth: 2
9 :local:
10 :backlinks: entry
12Step by step installation with virtualenv. For Ubuntu, be sure to have enable
13universe repository.
15.. _install packages:
17Install packages
18================
20.. kernel-include:: $DOCS_BUILD/includes/searx.rst
21 :start-after: START distro-packages
22 :end-before: END distro-packages
24.. hint::
26 This installs also the packages needed by :ref:`searx uwsgi`
28.. _create searx user:
30Create user
31===========
33.. kernel-include:: $DOCS_BUILD/includes/searx.rst
34 :start-after: START create user
35 :end-before: END create user
37.. _searx-src:
39install searx & dependencies
40============================
42Start a interactive shell from new created user and clone searx:
44.. kernel-include:: $DOCS_BUILD/includes/searx.rst
45 :start-after: START clone searx
46 :end-before: END clone searx
48In the same shell create *virtualenv*:
50.. kernel-include:: $DOCS_BUILD/includes/searx.rst
51 :start-after: START create virtualenv
52 :end-before: END create virtualenv
54To install searx's dependencies, exit the searx *bash* session you opened above
55and restart a new. Before install, first check if your *virtualenv* was sourced
56from the login (*~/.profile*):
58.. kernel-include:: $DOCS_BUILD/includes/searx.rst
59 :start-after: START manage.sh update_packages
60 :end-before: END manage.sh update_packages
62.. tip::
64 Open a second terminal for the configuration tasks and left the ``(searx)$``
65 terminal open for the tasks below.
68.. _use_default_settings.yml:
70Configuration
71=============
73.. sidebar:: ``use_default_settings: True``
75 - :ref:`settings global`
76 - :ref:`settings location`
77 - :ref:`settings use_default_settings`
78 - :origin:`/etc/searx/settings.yml <utils/templates/etc/searx/use_default_settings.yml>`
80To create a initial ``/etc/searx/settings.yml`` you can start with a copy of the
81file :origin:`utils/templates/etc/searx/use_default_settings.yml`. This setup
82:ref:`use default settings <settings use_default_settings>` from
83:origin:`searx/settings.yml` and is recommended since :pull:`2291` is merged.
85For a *minimal setup*, configure like shown below – replace ``searx@$(uname
86-n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit
87``/etc/searx/settings.yml`` to your needs.
89.. kernel-include:: $DOCS_BUILD/includes/searx.rst
90 :start-after: START searx config
91 :end-before: END searx config
93.. tabs::
95 .. group-tab:: Use default settings
97 .. literalinclude:: ../../utils/templates/etc/searx/use_default_settings.yml
98 :language: yaml
100 .. group-tab:: searx/settings.yml
102 .. literalinclude:: ../../searx/settings.yml
103 :language: yaml
106Check
107=====
109To check your searx setup, optional enable debugging and start the *webapp*.
110Searx looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a
111configuration file.
113.. kernel-include:: $DOCS_BUILD/includes/searx.rst
114 :start-after: START check searx installation
115 :end-before: END check searx installation
117If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the
118debug option in ``settings.yml``. You can now exit searx user bash (enter exit
119command twice). At this point searx is not demonized; uwsgi allows this.