mirrors/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2024-11-14 14:11:05 +00:00
Code Issues Projects Releases Wiki Activity
searxng/docs/admin/installation-searx.rst
Markus Heiser a70b9b9f61 [doc] recommend to use 'use_default_settings=True' 
Since #2291 is merged, it is recommend to use::

  use_default_settings=True

1. Add a template file use_default_settings.yml::

    SEARX_SETTINGS_TEMPLATE="${REPO_ROOT}/utils/templates/etc/searx/use_default_settings.yml"

2. In Chapter "Configuration" recommend to make use of
   'use_default_settings=True' and describe it

3. Rewrite of docs/admin/settings.rst
   - move chapter 'settings.yml location' to the top
   - update and split chapter 'Global Settings'

4. Add environment SEARX_SETTINGS_TEMPLATE to .config.sh

5. Use environment $SEARX_SETTINGS_TEMPLATE in the utils/searx.sh script

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-08 20:19:10 +01:00

3 KiB
Raw Blame History

Step by step installation

Contents

Step by step installation with virtualenv. For Ubuntu, be sure to have enable universe repository.

Install packages

$DOCS_BUILD/includes/searx.rst

Hint

This installs also the packages needed by searx uwsgi

Create user

$DOCS_BUILD/includes/searx.rst

install searx & dependencies

Start a interactive shell from new created user and clone searx:

$DOCS_BUILD/includes/searx.rst

In the same shell create virtualenv:

$DOCS_BUILD/includes/searx.rst

To install searx's dependencies, exit the searx bash session you opened above and restart a new. Before install, first check if your virtualenv was sourced from the login (~/.profile):

$DOCS_BUILD/includes/searx.rst

Tip

Open a second terminal for the configuration tasks and left the (searx)$ terminal open for the tasks below.

Configuration

To create a initial /etc/searx/settings.yml you can start with a copy of the file utils/templates/etc/searx/use_default_settings.yml. This setup :optionuse default settings <settings use_default_settings> from searx/settings.yml and is recommended since 2291 is merged.

For minimal Setup, configure like shown below – replace searx@\$(uname -n) with a name of your choice, set ultrasecretkey -- and/or edit /etc/searx/settings.yml to your needs.

$DOCS_BUILD/includes/searx.rst

Use default settings

../../utils/templates/etc/searx/use_default_settings.yml

searx/settings.yml

../../searx/settings.yml

Check

To check your searx setup, optional enable debugging and start the webapp. Searx looks at the exported environment $SEARX_SETTINGS_PATH for a configuration file.

$DOCS_BUILD/includes/searx.rst

If everything works fine, hit [CTRL-C] to stop the webapp and disable the debug option in settings.yml. You can now exit searx user bash (enter exit command twice). At this point searx is not demonized; uwsgi allows this.