From 2964a24b3d82651cfd9e30f2ba659bf0f5b2579a Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 29 Jun 2021 19:46:06 +0200 Subject: [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 --- utils/brand.env | 1 - 1 file changed, 1 deletion(-) (limited to 'utils/brand.env') diff --git a/utils/brand.env b/utils/brand.env index e0c670a01..a8491d15d 100644 --- a/utils/brand.env +++ b/utils/brand.env @@ -4,5 +4,4 @@ export GIT_BRANCH='master' export ISSUE_URL='https://github.com/searxng/searxng/issues' export DOCS_URL='https://searxng.github.io/searxng' export PUBLIC_INSTANCES='https://searx.space' -export CONTACT_URL='' export WIKI_URL='https://github.com/searxng/searxng/wiki' -- cgit v1.2.3 From b6a55e223ce0e287adeeafce8164e411154b5423 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 20 Jul 2021 13:16:21 +0200 Subject: [mod] reduce enviroment variables in shell scripts to what is needed Not all settings from the 'brand:' section of the YAML files are needed in the shell scripts. This patch reduce the variables in ./utils/brand.env to what is needed. The following ('brand:' settings) can be removed from this file: - ISSUE_URL - DOCS_URL - PUBLIC_INSTANCES - WIKI_URL Tasks running outside of an *installed instance*, need the following settings from the YAML configuration: - GIT_URL <--> brand.git_url - GIT_BRANCH <--> brand.git_branch - SEARX_URL <--> server.base_url (aka PUBLIC_URL) - SEARX_PORT <--> server.port - SEARX_BIND_ADDRESS <--> server.bind_address Signed-off-by: Markus Heiser --- utils/brand.env | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'utils/brand.env') diff --git a/utils/brand.env b/utils/brand.env index a8491d15d..2075a2bf4 100644 --- a/utils/brand.env +++ b/utils/brand.env @@ -1,7 +1,5 @@ -export SEARX_URL='' export GIT_URL='https://github.com/searxng/searxng' export GIT_BRANCH='master' -export ISSUE_URL='https://github.com/searxng/searxng/issues' -export DOCS_URL='https://searxng.github.io/searxng' -export PUBLIC_INSTANCES='https://searx.space' -export WIKI_URL='https://github.com/searxng/searxng/wiki' +export SEARX_URL='' +export SEARX_PORT='8888' +export SEARX_BIND_ADDRESS='127.0.0.1' -- cgit v1.2.3 From e946c3462c2b44fb154d0b6595f4f42605a326e5 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 20 Jul 2021 13:50:01 +0200 Subject: [brand] !!DO NOT MERGE!! this patch uses branch fix-searx.sh @return42 Do not merge this patch in master branch of SearXNG! This branch exists only for testing the feature branch fix-searx.sh @return42. This patch changes the buildenv to:: GIT_URL='https://github.com/return42/searxng' GIT_BRANCH='fix-searx.sh' SEARX_PORT='7777' SEARX_BIND_ADDRESS='127.0.0.12' To test installation procedure, clone feature branch (fix-searx.sh):: $ cd ~/Downloads $ git clone --branch fix-searx.sh https://github.com/return42/searxng searxng $ cd searxng $ ./utils/searx.sh install all ... Signed-off-by: Markus Heiser --- utils/brand.env | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'utils/brand.env') diff --git a/utils/brand.env b/utils/brand.env index 2075a2bf4..c09ea9d2f 100644 --- a/utils/brand.env +++ b/utils/brand.env @@ -1,5 +1,5 @@ -export GIT_URL='https://github.com/searxng/searxng' -export GIT_BRANCH='master' +export GIT_URL='https://github.com/return42/searxng' +export GIT_BRANCH='fix-searx.sh' export SEARX_URL='' -export SEARX_PORT='8888' -export SEARX_BIND_ADDRESS='127.0.0.1' +export SEARX_PORT='7777' +export SEARX_BIND_ADDRESS='127.0.0.12' -- cgit v1.2.3