e9157b3c1a
A local development server can be launched by one of these command lines::
$ flask --app searx.webapp run
$ python -m searx.webapp
The different ways of starting the server should lead to the same result, which
is generally the case. However, if the modules are reloaded after code
changes (reload option), it must be avoided that the application is initialized
twice at startup. We have already discussed this in 2022 [1][2].
Further information on this topic can be found in [3][4][5].
To test a bash in the ./local environment was started and the follwing commands
had been executed::
$ ./manage pyenv.cmd bash --norc --noprofile
(py3) SEARXNG_DEBUG=1 flask --app searx.webapp run --reload
(py3) SEARXNG_DEBUG=1 python -m searx.webapp
Since the generic parts of the docs also initialize the app to generate doc from
it, the build of the docs was also tested::
$ make docs.clean docs.live
[1] https://github.com/searxng/searxng/pull/1656#issuecomment-1214198941
[2] https://github.com/searxng/searxng/pull/1616#issuecomment-1206137468
[3] https://flask.palletsprojects.com/en/stable/api/#flask.Flask.run
[4] https://github.com/pallets/flask/issues/5307#issuecomment-1774646119
[5] https://stackoverflow.com/a/25504196
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
49 lines
1.4 KiB
ReStructuredText
49 lines
1.4 KiB
ReStructuredText
.. _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``
|
|
In debug mode, the server provides an interactive debugger, will reload when
|
|
code is changed and activates a verbose logging.
|
|
|
|
.. attention::
|
|
|
|
The debug setting is intended for local development server. Don't
|
|
activate debug (don't use a development server) when deploying to
|
|
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``:
|
|
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 <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.
|