[brand] SearXNG - reference /etc/searxng/settings.yml

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2021-10-11 10:56:50 +02:00 committed by Markus Heiser
parent 3fad483b7a
commit 60edf2623d
9 changed files with 23 additions and 14 deletions

View file

@ -23,7 +23,7 @@
# #
# $ ./utils/searx.sh --help # $ ./utils/searx.sh --help
# ---- SearXNG instance setup (already installed) # ---- SearXNG instance setup (already installed)
# SEARXNG_SETTINGS_PATH : /etc/searx/settings.yml # SEARXNG_SETTINGS_PATH : /etc/searxng/settings.yml
# SEARX_SRC : /usr/local/searx/searx-src # SEARX_SRC : /usr/local/searx/searx-src
# #
# [1] https://searxng.github.io/searxng/admin/engines/settings.html # [1] https://searxng.github.io/searxng/admin/engines/settings.html

View file

@ -339,7 +339,7 @@ use_default_settings
- :ref:`settings location` - :ref:`settings location`
- :ref:`use_default_settings.yml` - :ref:`use_default_settings.yml`
- :origin:`/etc/searxng/settings.yml <utils/templates/etc/searx/use_default_settings.yml>` - :origin:`/etc/searxng/settings.yml <utils/templates/etc/searxng/settings.yml>`
The user defined ``settings.yml`` is loaded from the :ref:`settings location` The user defined ``settings.yml`` is loaded from the :ref:`settings location`
and can relied on the default configuration :origin:`searx/settings.yml` using: and can relied on the default configuration :origin:`searx/settings.yml` using:

View file

@ -75,12 +75,12 @@ Configuration
- :ref:`settings global` - :ref:`settings global`
- :ref:`settings location` - :ref:`settings location`
- :ref:`settings use_default_settings` - :ref:`settings use_default_settings`
- :origin:`/etc/searxng/settings.yml <utils/templates/etc/searx/use_default_settings.yml>` - :origin:`/etc/searxng/settings.yml <utils/templates/etc/searxng/settings.yml>`
To create a initial ``/etc/searxng/settings.yml`` you can start with a copy of the To create a initial ``/etc/searxng/settings.yml`` you can start with a copy of
file :origin:`utils/templates/etc/searx/use_default_settings.yml`. This setup the file :origin:`utils/templates/etc/searxng/settings.yml`. This setup
:ref:`use default settings <settings use_default_settings>` from :ref:`use default settings <settings use_default_settings>` from
:origin:`searx/settings.yml` and is recommended since :pull-searx:`2291` is merged. :origin:`searx/settings.yml`.
For a *minimal setup*, configure like shown below replace ``searx@$(uname For a *minimal setup*, configure like shown below replace ``searx@$(uname
-n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit -n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit
@ -94,7 +94,7 @@ For a *minimal setup*, configure like shown below replace ``searx@$(uname
.. group-tab:: Use default settings .. group-tab:: Use default settings
.. literalinclude:: ../../utils/templates/etc/searx/settings.yml .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml
:language: yaml :language: yaml
.. group-tab:: searx/settings.yml .. group-tab:: searx/settings.yml

View file

@ -134,7 +134,7 @@ ${fedora_build}
.. code-block:: sh .. code-block:: sh
$ sudo -H mkdir -p \"$(dirname ${SEARXNG_SETTINGS_PATH})\" $ sudo -H mkdir -p \"$(dirname ${SEARXNG_SETTINGS_PATH})\"
$ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searx/settings.yml\" \\ $ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searxng/settings.yml\" \\
\"${SEARXNG_SETTINGS_PATH}\" \"${SEARXNG_SETTINGS_PATH}\"
.. group-tab:: searx/settings.yml .. group-tab:: searx/settings.yml

View file

@ -261,7 +261,7 @@ In this section we will see how to change the *"Fully functional SearXNG suite"*
from a LXC container (which is quite ready for production) into a developer from a LXC container (which is quite ready for production) into a developer
suite. For this, we have to keep an eye on the :ref:`installation basic`: suite. For this, we have to keep an eye on the :ref:`installation basic`:
- SearXNG setup in: ``/etc/searx/settings.yml`` - SearXNG setup in: ``/etc/searxng/settings.yml``
- SearXNG user's home: ``/usr/local/searx`` - SearXNG user's home: ``/usr/local/searx``
- virtualenv in: ``/usr/local/searx/searx-pyenv`` - virtualenv in: ``/usr/local/searx/searx-pyenv``
- SearXNG software in: ``/usr/local/searx/searx-src`` - SearXNG software in: ``/usr/local/searx/searx-src``
@ -288,7 +288,7 @@ The uWSGI-App for the archlinux dsitros is configured in
least you should attend the settings of ``uid``, ``chdir``, ``env`` and least you should attend the settings of ``uid``, ``chdir``, ``env`` and
``http``:: ``http``::
env = SEARXNG_SETTINGS_PATH=/etc/searx/settings.yml env = SEARXNG_SETTINGS_PATH=/etc/searxng/settings.yml
http = 127.0.0.1:8888 http = 127.0.0.1:8888
chdir = /usr/local/searx/searx-src/searx chdir = /usr/local/searx/searx-src/searx

6
manage
View file

@ -31,7 +31,7 @@ pylint.FILES() {
YAMLLINT_FILES=() YAMLLINT_FILES=()
while IFS= read -r line; do while IFS= read -r line; do
YAMLLINT_FILES+=("$line") YAMLLINT_FILES+=("$line")
done <<< "$(git ls-files './tests/*.yml' './searx/*.yml' './utils/templates/etc/searx/*.yml')" done <<< "$(git ls-files './tests/*.yml' './searx/*.yml' './utils/templates/etc/searxng/*.yml')"
PYLINT_SEARX_DISABLE_OPTION="\ PYLINT_SEARX_DISABLE_OPTION="\
I,C,R,\ I,C,R,\
@ -107,6 +107,10 @@ buildenv() {
# settings file from repository's working tree are used by default # settings file from repository's working tree are used by default
SEARXNG_SETTINGS_PATH="${REPO_ROOT}/searx/settings.yml" SEARXNG_SETTINGS_PATH="${REPO_ROOT}/searx/settings.yml"
if [ -f /etc/searx/settings.yml ]; then
err_msg "settings.yml in /etc/searx/ is deprecated, move file to folder /etc/searxng/"
fi
if [ -r '/etc/searxng/settings.yml' ]; then if [ -r '/etc/searxng/settings.yml' ]; then
if ask_yn "should settings read from: /etc/searxng/settings.yml"; then if ask_yn "should settings read from: /etc/searxng/settings.yml"; then
SEARXNG_SETTINGS_PATH='/etc/searxng/settings.yml' SEARXNG_SETTINGS_PATH='/etc/searxng/settings.yml'

View file

@ -155,6 +155,10 @@ install_searx_get_state(){
# - user: ${SERVICE_USER} # - user: ${SERVICE_USER}
# - pyenv: ${SEARX_PYENV} # - pyenv: ${SEARX_PYENV}
if [ -f /etc/searx/settings.yml ]; then
err_msg "settings.yml in /etc/searx/ is deprecated, move file to folder /etc/searxng/"
fi
if ! [ -r "${SEARX_SRC}" ]; then if ! [ -r "${SEARX_SRC}" ]; then
echo "missing-searx-clone" echo "missing-searx-clone"
return return

View file

@ -28,7 +28,7 @@ SERVICE_GROUP="${SERVICE_USER}"
GIT_BRANCH="${GIT_BRANCH:-master}" GIT_BRANCH="${GIT_BRANCH:-master}"
SEARX_PYENV="${SERVICE_HOME}/searx-pyenv" SEARX_PYENV="${SERVICE_HOME}/searx-pyenv"
SEARX_SRC="${SERVICE_HOME}/searx-src" SEARX_SRC="${SERVICE_HOME}/searx-src"
SEARXNG_SETTINGS_PATH="/etc/searx/settings.yml" SEARXNG_SETTINGS_PATH="/etc/searxng/settings.yml"
SEARX_UWSGI_APP="searx.ini" SEARX_UWSGI_APP="searx.ini"
# shellcheck disable=SC2034 # shellcheck disable=SC2034
SEARX_UWSGI_SOCKET="/run/uwsgi/app/searx/socket" SEARX_UWSGI_SOCKET="/run/uwsgi/app/searx/socket"

View file

@ -21,11 +21,12 @@ search:
# use codes from 'languages.py' # use codes from 'languages.py'
default_lang: '' default_lang: ''
# remove format to deny access, use lower case. # remove format to deny access, use lower case.
formats: [html, csv, json, rss] formats:
- html
server: server:
secret_key: "ultrasecretkey" # change this! secret_key: "ultrasecretkey" # change this!
# Proxying image results through searx # Proxying image results through SearXNG
image_proxy: false image_proxy: false
# result_proxy: # result_proxy: