mirrors/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2024-06-13 02:39:25 +00:00
Code Issues Projects Releases Wiki Activity
searxng/docs/admin/installation-searx.rst
Markus Heiser 2964a24b3d [fix] utils/build_env.py and add documentation 
modified   docs/admin/engines/settings.rst
  - Fix documentation and add section 'brand'.
  - Add remarks about **buildenv** variables.
  - Add remarks about settings from environment variables $SEARX_DEBUG,
    $SEARX_PORT, $SEARX_BIND_ADDRESS and $SEARX_SECRET

modified   docs/admin/installation-searx.rst & docs/build-templates/searx.rst
   Fix template location /templates/etc/searx/settings.yml

modified   docs/dev/makefile.rst
  Add description of the 'make buildenv' target and describe
  - we have all SearXNG setups are centralized in the settings.yml file
  - why some tasks need a utils/brand.env (aka instance's buildenv)

modified   manage
  Settings file from repository's working tree are used by default and
  ask user if a /etc/searx/settings.yml file exists.

modified   searx/settings.yml
  Add comments about when it is needed to run 'make buildenv'

modified   searx/settings_defaults.py
  Default for server:port is taken from enviroment variable SEARX_PORT.

modified   utils/build_env.py
  - Some defaults in the settings.yml are taken from the environment,
    e.g. SEARX_BIND_ADDRESS (searx.settings_defaults.SHEMA).  When the
    'brand.env' file is created these enviroment variables should be
    unset first.
  - The CONTACT_URL enviroment is not needed in the utils/brand.env

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-21 14:38:54 +02:00

3.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 leave the (searx)$ terminal open for the tasks below.

Configuration

use_default_settings: True

  • settings global
  • settings location
  • settings use_default_settings
  • /etc/searx/settings.yml <utils/templates/etc/searx/use_default_settings.yml>

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 use default settings <settings use_default_settings> from searx/settings.yml and is recommended since 2291 is merged.

For a 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/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.