From cb199d893e15748a7488377007aa464757a4f6e9 Mon Sep 17 00:00:00 2001 From: return42 Date: Mon, 6 Jan 2025 16:15:21 +0000 Subject: [doc] build from commit 6dab7fe78be3c8872b8a6d99cf00c597813171ba --- _sources/admin/settings/settings_general.rst.txt | 42 ++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 _sources/admin/settings/settings_general.rst.txt (limited to '_sources/admin/settings/settings_general.rst.txt') diff --git a/_sources/admin/settings/settings_general.rst.txt b/_sources/admin/settings/settings_general.rst.txt new file mode 100644 index 000000000..75acb4f6d --- /dev/null +++ b/_sources/admin/settings/settings_general.rst.txt @@ -0,0 +1,42 @@ +.. _settings general: + +============ +``general:`` +============ + +.. code:: yaml + + general: + debug: false + instance_name: "SearXNG" + privacypolicy_url: false + donation_url: false + contact_url: false + enable_metrics: true + open_metrics: '' + +``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`` : + Set value to ``true`` to use your own donation page written in the + :ref:`searx/info/en/donate.md ` and use ``false`` to disable + the donation link altogether. + +``privacypolicy_url``: + Link to privacy policy. + +``contact_url``: + Contact ``mailto:`` address or WEB form. + +``enable_metrics``: + Enabled by default. Record various anonymous metrics available at ``/stats``, + ``/stats/errors`` and ``/preferences``. + +``open_metrics``: + Disabled by default. Set to a secret password to expose an + `OpenMetrics API `_ at ``/metrics``, + e.g. for usage with Prometheus. The ``/metrics`` endpoint is using HTTP Basic Auth, + where the password is the value of ``open_metrics`` set above. The username used for + Basic Auth can be randomly chosen as only the password is being validated. -- cgit v1.2.3-54-g00ecf