searxngRebrandZaclys/searx.rst at a70b9b9f616d75507bd404f036b95ce91cefefa4

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

4.4 KiB

Raw Blame History

Ubuntu / debian

$ sudo -H apt-get install -y \\

${debian}

Arch Linux

$ sudo -H pacman -S --noconfirm \\

${arch}

Fedora / RHEL

$ sudo -H dnf install -y \\

${fedora}

Ubuntu / debian

$ sudo -H apt-get install -y \\

${debian_build}

Arch Linux

$ sudo -H pacman -S --noconfirm \\

${arch_build}

Fedora / RHEL

$ sudo -H dnf install -y \\

${fedora_build}

bash

$ sudo -H useradd --shell /bin/bash --system \\
    --home-dir \"$SERVICE_HOME\" \\
    --comment 'Privacy-respecting metasearch engine' $SERVICE_USER

$ sudo -H mkdir \"$SERVICE_HOME\"
$ sudo -H chown -R \"$SERVICE_GROUP:$SERVICE_GROUP\" \"$SERVICE_HOME\"

bash

$ sudo -H -u ${SERVICE_USER} -i
(${SERVICE_USER})$ git clone \"https://github.com/searx/searx.git\" \"$SEARX_SRC\"

bash

(${SERVICE_USER})$ python3 -m venv \"${SEARX_PYENV}\"
(${SERVICE_USER})$ echo \". ${SEARX_PYENV}/bin/activate\" >>  \"$SERVICE_HOME/.profile\"

bash

$ sudo -H -u ${SERVICE_USER} -i

(${SERVICE_USER})$ command -v python && python --version
$SEARX_PYENV/bin/python
Python 3.8.1

# update pip's boilerplate ..
pip install -U pip
pip install -U setuptools
pip install -U wheel

# jump to searx's working tree and install searx into virtualenv
(${SERVICE_USER})$ cd \"$SEARX_SRC\"
(${SERVICE_USER})$ pip install -e .

Use default settings

$ sudo -H mkdir -p \"$(dirname ${SEARX_SETTINGS_PATH})\"
$ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searx/use_default_settings.yml\" \\
             \"${SEARX_SETTINGS_PATH}\"

searx/settings.yml

$ sudo -H mkdir -p \"$(dirname ${SEARX_SETTINGS_PATH})\"
$ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \\
             \"${SEARX_SETTINGS_PATH}\"

minimal setup

$ sudo -H sed -i -e \"s/ultrasecretkey/\$(openssl rand -hex 16)/g\" \"$SEARX_SETTINGS_PATH\"
$ sudo -H sed -i -e \"s/{instance_name}/searx@\$(uname -n)/g\" \"$SEARX_SETTINGS_PATH\"

bash

# enable debug ..
$ sudo -H sed -i -e \"s/debug : False/debug : True/g\" \"$SEARX_SETTINGS_PATH\"

# start webapp
$ sudo -H -u ${SERVICE_USER} -i
(${SERVICE_USER})$ cd ${SEARX_SRC}
(${SERVICE_USER})$ export SEARX_SETTINGS_PATH=\"${SEARX_SETTINGS_PATH}\"
(${SERVICE_USER})$ python searx/webapp.py

# disable debug
$ sudo -H sed -i -e \"s/debug : True/debug : False/g\" \"$SEARX_SETTINGS_PATH\"

Open WEB browser and visit http://$SEARX_INTERNAL_URL . If you are inside a container or in a script, test with curl:

WEB browser

$ xdg-open http://$SEARX_INTERNAL_URL

curl

$ curl --location --verbose --head --insecure $SEARX_INTERNAL_URL

*   Trying 127.0.0.1:8888...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 8888 (#0)
> HEAD / HTTP/1.1
> Host: 127.0.0.1:8888
> User-Agent: curl/7.68.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
* HTTP 1.0, assume close after body
< HTTP/1.0 200 OK
HTTP/1.0 200 OK
...

4.4 KiB Raw Blame History

4.4 KiB

Raw Blame History