summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-07-20 13:16:21 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2021-07-24 16:28:15 +0200
commitb6a55e223ce0e287adeeafce8164e411154b5423 (patch)
tree2aefa8e0614361d4562ea4591e4bb7a89fbc52d8 /docs
parent57b8f340a6689fafd0c8d92aebd2b263b090af18 (diff)
downloadsearxng-b6a55e223ce0e287adeeafce8164e411154b5423.tar.gz
searxng-b6a55e223ce0e287adeeafce8164e411154b5423.zip
[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 <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/admin/engines/settings.rst37
-rw-r--r--docs/dev/makefile.rst10
2 files changed, 32 insertions, 15 deletions
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index 7325ea3ba..cab4ee493 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -42,9 +42,6 @@ Global Settings
``brand:``
------------
-If you change a value in this section, don't forget to rebuild instance's
-environment (:ref:`utils/brand.env <make buildenv>`)
-
.. code:: yaml
brand:
@@ -55,19 +52,24 @@ environment (:ref:`utils/brand.env <make buildenv>`)
public_instances: https://searx.space
wiki_url: https://github.com/searxng/searxng/wiki
-``git_url`` & ``git_branch`` : :ref:`buildenv GIT_URL & GIT_BRANCH<make buildenv>`
+.. sidebar:: buildenv
+
+ Changing a value tagged by :ref:`buildenv <make buildenv>`, needs to
+ rebuild instance's environment :ref:`utils/brand.env <make buildenv>`.
+
+``git_url`` & ``git_branch`` : :ref:`buildenv GIT_URL & GIT_BRANCH <make buildenv>`
Changes this, to point to your searx fork (branch).
-``issue_url`` : :ref:`buildenv ISSUE_URL<make buildenv>`
+``issue_url`` :
If you host your own issue tracker change this URL.
-``docs_url`` : :ref:`buildenv DOCS_URL<make buildenv>`
+``docs_url`` :
If you host your own documentation change this URL.
-``public_instances`` : :ref:`buildenv PUBLIC_INSTANCES<make buildenv>`
+``public_instances`` :
If you host your own https://searx.space change this URL.
-``wiki_url`` : :ref:`buildenv WIKI_URL<make buildenv>`
+``wiki_url`` :
Link to your wiki (or ``false``)
.. _settings global general:
@@ -98,10 +100,10 @@ environment (:ref:`utils/brand.env <make buildenv>`)
.. code:: yaml
server:
+ base_url: false # set custom base_url (or false)
port: 8888
bind_address: "127.0.0.1" # address to listen on
secret_key: "ultrasecretkey" # change this!
- base_url: false # set custom base_url (or false)
image_proxy: false # proxying image results through searx
default_locale: "" # default interface locale
default_theme: oscar # ui theme
@@ -112,19 +114,24 @@ environment (:ref:`utils/brand.env <make buildenv>`)
X-Robots-Tag : noindex, nofollow
Referrer-Policy : no-referrer
-``port`` & ``bind_address``: ``$SEARX_PORT`` & ``$SEARX_BIND_ADDRESS``
- Port number and *bind address* of the searx web application if you run it
- directly using ``python searx/webapp.py``. Doesn't apply to searx running on
- Apache or Nginx.
+.. sidebar:: buildenv
-``secret_key`` : ``$SEARX_SECRET``
- Used for cryptography purpose.
+ Changing a value tagged by :ref:`buildenv <make buildenv>`, needs to
+ rebuild instance's environment :ref:`utils/brand.env <make buildenv>`.
``base_url`` : :ref:`buildenv SEARX_URL <make buildenv>`
The base URL where searx is deployed. Used to create correct inbound links.
If you change the value, don't forget to rebuild instance's environment
(:ref:`utils/brand.env <make buildenv>`)
+``port`` & ``bind_address``: :ref:`buildenv SEARX_PORT & SEARX_BIND_ADDRESS <make buildenv>`
+ Port number and *bind address* of the searx web application if you run it
+ directly using ``python searx/webapp.py``. Doesn't apply to searx running on
+ Apache or Nginx.
+
+``secret_key`` : ``$SEARX_SECRET``
+ Used for cryptography purpose.
+
``image_proxy`` :
Allow your instance of searx of being able to proxy images. Uses memory space.
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst
index 2c10181be..5bf3c13b2 100644
--- a/docs/dev/makefile.rst
+++ b/docs/dev/makefile.rst
@@ -104,6 +104,16 @@ The ``make buildenv`` target will update the *build environment* in:
- :origin:`utils/brand.env`
+Tasks running outside of an *installed instance*, need the following settings
+from the YAML configuration:
+
+- ``GIT_URL`` from :ref:`brand.git_url <settings global brand>`
+- ``GIT_BRANCH`` from :ref:`brand.git_branch <settings global brand>`
+
+- ``SEARX_URL`` from :ref:`server.base_url <settings global server>` (aka
+ ``PUBLIC_URL``)
+- ``SEARX_BIND_ADDRESS`` from :ref:`server.bind_address <settings global server>`
+- ``SEARX_PORT`` from :ref:`server.port <settings global server>`
.. _make run: