summaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2022-07-02 13:50:06 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2022-07-02 13:50:06 +0200
commitfaf56d4f96ed1afb12ef37980ef382f2ec82fc58 (patch)
treeb13cf6b16b2f9912dd96c0c024a531f8ccdd5fb1 /docs/admin
parentf8f239fe1fb0439635086713e9fd2a14d35a70ed (diff)
downloadsearxng-faf56d4f96ed1afb12ef37980ef382f2ec82fc58.tar.gz
searxng-faf56d4f96ed1afb12ef37980ef382f2ec82fc58.zip
[docs] add documentation about the `general.donation_url:` setting
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/engines/settings.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index b43802d11..ac0d3b4cc 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -70,15 +70,23 @@ Global Settings
.. code:: yaml
general:
- debug: false # Debug mode, only for development
- instance_name: "SearXNG" # displayed name
- privacypolicy_url: false # https://example.com/privacy
- contact_url: false # mailto:contact@example.com
+ debug: false
+ instance_name: "SearXNG"
+ privacypolicy_url: false
+ donation_url: https://docs.searxng.org/donate.html
+ contact_url: false
+ enable_metrics: true
``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.
+``donation_url`` :
+ At default the donation link points to the `SearXNG project
+ <https://docs.searxng.org/donate.html>`_. Set value to ``true`` to use your
+ own donation page written in the :ref:`searx/info/en/donate.md
+ <searx.infopage>` and use ``false`` to disable the donation link altogether.
+
``privacypolicy_url``:
Link to privacy policy.