2023-06-30 18:07:02 +02:00
|
|
|
.. _settings general:
|
|
|
|
|
|
|
|
|
|
============
|
|
|
|
|
``general:``
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
.. code:: yaml
|
|
|
|
|
|
|
|
|
|
general:
|
|
|
|
|
debug: false
|
|
|
|
|
instance_name: "SearXNG"
|
|
|
|
|
privacypolicy_url: false
|
|
|
|
|
donation_url: false
|
|
|
|
|
contact_url: false
|
|
|
|
|
enable_metrics: true
|
2024-09-17 16:43:48 +02:00
|
|
|
open_metrics: ''
|
2023-06-30 18:07:02 +02:00
|
|
|
|
|
|
|
|
``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 <searx.infopage>` 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``:
|
2023-08-11 10:57:06 +02:00
|
|
|
Enabled by default. Record various anonymous metrics available at ``/stats``,
|
2023-06-30 18:07:02 +02:00
|
|
|
``/stats/errors`` and ``/preferences``.
|
2024-09-17 16:43:48 +02:00
|
|
|
|
|
|
|
|
``open_metrics``:
|
|
|
|
|
Disabled by default. Set to a secret password to expose an
|
|
|
|
|
`OpenMetrics API <https://github.com/prometheus/OpenMetrics>`_ 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.
|
