From 430babca253369d82e864500118f914a9420f74b Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Sat, 2 Oct 2021 12:21:02 +0200 Subject: SearXNG: environment variables --- docs/admin/engines/settings.rst | 4 ++-- docs/dev/makefile.rst | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index 459b4b46c..7308e2733 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -74,7 +74,7 @@ Global Settings instance_name: "SearXNG" # displayed name contact_url: false # mailto:contact@example.com -``debug`` : ``$SEARX_DEBUG`` +``debug`` : ``$SEARXNG_DEBUG`` Allow a more detailed log if you run SearXNG directly. Display *detailed* error messages in the browser too, so this must be deactivated in production. @@ -119,7 +119,7 @@ Global Settings directly using ``python searx/webapp.py``. Doesn't apply to SearXNG running on Apache or Nginx. -``secret_key`` : ``$SEARX_SECRET`` +``secret_key`` : ``$SEARXNG_SECRET`` Used for cryptography purpose. ``image_proxy`` : diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 14e9b0555..77c0dddde 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -124,7 +124,7 @@ browser (:man:`xdg-open`):: $ make run PYENV OK - SEARX_DEBUG=1 ./manage.sh pyenv.cmd python ./searx/webapp.py + SEARXNG_DEBUG=1 ./manage.sh pyenv.cmd python ./searx/webapp.py ... INFO:werkzeug: * Running on http://127.0.0.1:8888/ (Press CTRL+C to quit) @@ -210,15 +210,15 @@ by underline:: make search.checker.google_news -To see HTTP requests and more use SEARX_DEBUG:: +To see HTTP requests and more use SEARXNG_DEBUG:: - make SEARX_DEBUG=1 search.checker.google_news + make SEARXNG_DEBUG=1 search.checker.google_news .. _3xx: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection To filter out HTTP redirects (3xx_):: - make SEARX_DEBUG=1 search.checker.google_news | grep -A1 "HTTP/1.1\" 3[0-9][0-9]" + make SEARXNG_DEBUG=1 search.checker.google_news | grep -A1 "HTTP/1.1\" 3[0-9][0-9]" ... Engine google news Checking https://news.google.com:443 "GET /search?q=life&hl=en&lr=lang_en&ie=utf8&oe=utf8&ceid=US%3Aen&gl=US HTTP/1.1" 302 0 -- cgit v1.2.3 From 6443ed75622e8b99ea69b60a573275617d5f87a5 Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Sat, 2 Oct 2021 16:56:11 +0200 Subject: SearXNG: SEARXNG_PORT --- docs/admin/engines/settings.rst | 2 +- docs/dev/makefile.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index 7308e2733..0e1d0d710 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -114,7 +114,7 @@ Global Settings If you change the value, don't forget to rebuild instance's environment (:ref:`utils/brand.env `) -``port`` & ``bind_address``: :ref:`buildenv SEARX_PORT & SEARX_BIND_ADDRESS ` +``port`` & ``bind_address``: :ref:`buildenv SEARXNG_PORT & SEARX_BIND_ADDRESS ` Port number and *bind address* of the SearXNG web application if you run it directly using ``python searx/webapp.py``. Doesn't apply to SearXNG running on Apache or Nginx. diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 77c0dddde..09e37502e 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -110,7 +110,7 @@ from the YAML configuration: - ``SEARX_URL`` from :ref:`server.base_url ` (aka ``PUBLIC_URL``) - ``SEARX_BIND_ADDRESS`` from :ref:`server.bind_address ` -- ``SEARX_PORT`` from :ref:`server.port ` +- ``SEARXNG_PORT`` from :ref:`server.port ` .. _make run: -- cgit v1.2.3 From 9e266ecad3cc20faf2c12cdab7862c29cf8df2ec Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Sat, 2 Oct 2021 16:58:09 +0200 Subject: SearXNG: SEARX_BIND_ADDRESS --- docs/admin/engines/settings.rst | 2 +- docs/dev/makefile.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index 0e1d0d710..8c23bb9bd 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -114,7 +114,7 @@ Global Settings If you change the value, don't forget to rebuild instance's environment (:ref:`utils/brand.env `) -``port`` & ``bind_address``: :ref:`buildenv SEARXNG_PORT & SEARX_BIND_ADDRESS ` +``port`` & ``bind_address``: :ref:`buildenv SEARXNG_PORT & SEARXNG_BIND_ADDRESS ` Port number and *bind address* of the SearXNG web application if you run it directly using ``python searx/webapp.py``. Doesn't apply to SearXNG running on Apache or Nginx. diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 09e37502e..1db3ed703 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -109,7 +109,7 @@ from the YAML configuration: - ``SEARX_URL`` from :ref:`server.base_url ` (aka ``PUBLIC_URL``) -- ``SEARX_BIND_ADDRESS`` from :ref:`server.bind_address ` +- ``SEARXNG_BIND_ADDRESS`` from :ref:`server.bind_address ` - ``SEARXNG_PORT`` from :ref:`server.port ` .. _make run: -- cgit v1.2.3 From 253b8503765b6f0d21135254277e72d17a51e04a Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Sat, 2 Oct 2021 17:18:05 +0200 Subject: SearXNG: SEARXNG_SETTINGS_PATH --- docs/admin/engines/settings.rst | 2 +- docs/admin/installation-searx.rst | 2 +- docs/build-templates/searx.rst | 16 ++++++++-------- docs/dev/lxcdev.rst | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index 8c23bb9bd..6a3256357 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -24,7 +24,7 @@ settings.yml location The initial ``settings.yml`` we be load from these locations: -1. the full path specified in the ``SEARX_SETTINGS_PATH`` environment variable. +1. the full path specified in the ``SEARXNG_SETTINGS_PATH`` environment variable. 2. ``/etc/searx/settings.yml`` If these files don't exist (or are empty or can't be read), SearXNG uses the diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index 9e9157b86..cb3cf9f05 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -107,7 +107,7 @@ Check ===== To check your SearXNG setup, optional enable debugging and start the *webapp*. -SearXNG looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a +SearXNG looks at the exported environment ``$SEARXNG_SETTINGS_PATH`` for a configuration file. .. kernel-include:: $DOCS_BUILD/includes/searx.rst diff --git a/docs/build-templates/searx.rst b/docs/build-templates/searx.rst index 70e658b4c..804514ac8 100644 --- a/docs/build-templates/searx.rst +++ b/docs/build-templates/searx.rst @@ -133,17 +133,17 @@ ${fedora_build} .. code-block:: sh - $ sudo -H mkdir -p \"$(dirname ${SEARX_SETTINGS_PATH})\" + $ sudo -H mkdir -p \"$(dirname ${SEARXNG_SETTINGS_PATH})\" $ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searx/settings.yml\" \\ - \"${SEARX_SETTINGS_PATH}\" + \"${SEARXNG_SETTINGS_PATH}\" .. group-tab:: searx/settings.yml .. code-block:: sh - $ sudo -H mkdir -p \"$(dirname ${SEARX_SETTINGS_PATH})\" + $ sudo -H mkdir -p \"$(dirname ${SEARXNG_SETTINGS_PATH})\" $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \\ - \"${SEARX_SETTINGS_PATH}\" + \"${SEARXNG_SETTINGS_PATH}\" .. tabs:: @@ -151,7 +151,7 @@ ${fedora_build} .. code-block:: sh - $ sudo -H sed -i -e \"s/ultrasecretkey/\$(openssl rand -hex 16)/g\" \"$SEARX_SETTINGS_PATH\" + $ sudo -H sed -i -e \"s/ultrasecretkey/\$(openssl rand -hex 16)/g\" \"$SEARXNG_SETTINGS_PATH\" .. END searx config @@ -164,16 +164,16 @@ ${fedora_build} .. code-block:: sh # enable debug .. - $ sudo -H sed -i -e \"s/debug : False/debug : True/g\" \"$SEARX_SETTINGS_PATH\" + $ sudo -H sed -i -e \"s/debug : False/debug : True/g\" \"$SEARXNG_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})$ export SEARXNG_SETTINGS_PATH=\"${SEARXNG_SETTINGS_PATH}\" (${SERVICE_USER})$ python searx/webapp.py # disable debug - $ sudo -H sed -i -e \"s/debug : True/debug : False/g\" \"$SEARX_SETTINGS_PATH\" + $ sudo -H sed -i -e \"s/debug : True/debug : False/g\" \"$SEARXNG_SETTINGS_PATH\" Open WEB browser and visit http://$SEARX_INTERNAL_HTTP . If you are inside a container or in a script, test with curl: diff --git a/docs/dev/lxcdev.rst b/docs/dev/lxcdev.rst index 9d5503058..12f6d7879 100644 --- a/docs/dev/lxcdev.rst +++ b/docs/dev/lxcdev.rst @@ -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 ``http``:: - env = SEARX_SETTINGS_PATH=/etc/searx/settings.yml + env = SEARXNG_SETTINGS_PATH=/etc/searx/settings.yml http = 127.0.0.1:8888 chdir = /usr/local/searx/searx-src/searx -- cgit v1.2.3