summaryrefslogtreecommitdiff
path: root/docs/build-templates
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-12-08 20:19:10 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2020-12-08 20:19:10 +0100
commita70b9b9f616d75507bd404f036b95ce91cefefa4 (patch)
tree2f332b6e1836b0e994c393dd2820a5f9ecc7957e /docs/build-templates
parentc1a97322687546a066dacffb472d87a86eaadbd4 (diff)
downloadsearxng-a70b9b9f616d75507bd404f036b95ce91cefefa4.tar.gz
searxng-a70b9b9f616d75507bd404f036b95ce91cefefa4.zip
[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>
Diffstat (limited to 'docs/build-templates')
-rw-r--r--docs/build-templates/searx.rst20
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/build-templates/searx.rst b/docs/build-templates/searx.rst
index 080de293f..fe82ec3d0 100644
--- a/docs/build-templates/searx.rst
+++ b/docs/build-templates/searx.rst
@@ -128,12 +128,28 @@ ${fedora_build}
.. tabs::
- .. group-tab:: bash
+ .. group-tab:: Use default settings
+
+ .. code-block:: sh
+
+ $ sudo -H mkdir -p \"$(dirname ${SEARX_SETTINGS_PATH})\"
+ $ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searx/use_default_settings.yml\" \\
+ \"${SEARX_SETTINGS_PATH}\"
+
+ .. group-tab:: searx/settings.yml
.. code-block:: sh
$ sudo -H mkdir -p \"$(dirname ${SEARX_SETTINGS_PATH})\"
- $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \"${SEARX_SETTINGS_PATH}\"
+ $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \\
+ \"${SEARX_SETTINGS_PATH}\"
+
+.. tabs::
+
+ .. group-tab:: minimal setup
+
+ .. code-block:: sh
+
$ 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\"