summaryrefslogtreecommitdiff
path: root/docs/admin/installation-searx.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-01-02 19:56:26 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2021-01-11 22:12:38 +0100
commit4853a2980322ccd84597a6502dce3ca7f5c76af0 (patch)
treeb451fc45e0776e1b7d214da3b9c04760dc42f68b /docs/admin/installation-searx.rst
parentd0338cb5041f409f94a971d767bc5d8b9b0f23a8 (diff)
[mod] improve settings documentation
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin/installation-searx.rst')
-rw-r--r--docs/admin/installation-searx.rst13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst
index 3f8904a1d..512a185a7 100644
--- a/docs/admin/installation-searx.rst
+++ b/docs/admin/installation-searx.rst
@@ -70,13 +70,20 @@ from the login (*~/.profile*):
Configuration
=============
+.. sidebar:: ``use_default_settings: True``
+
+ - :ref:`settings global`
+ - :ref:`settings location`
+ - :ref:`settings use_default_settings`
+ - :origin:`/etc/searx/settings.yml <utils/templates/etc/searx/use_default_settings.yml>`
+
To create a initial ``/etc/searx/settings.yml`` you can start with a copy of the
file :origin:`utils/templates/etc/searx/use_default_settings.yml`. This setup
-:option: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:`2291` is merged.
-For minimal Setup, configure like shown below – replace ``searx@\$(uname -n)``
-with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit
+For a *minimal setup*, configure like shown below – replace ``searx@$(uname
+-n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit
``/etc/searx/settings.yml`` to your needs.
.. kernel-include:: $DOCS_BUILD/includes/searx.rst