1
0
mirror of https://github.com/searxng/searxng.git synced 2024-11-15 09:10:12 +01:00
searxng/docs/src
Markus Heiser 2039060b64 [mod] revision of the settings_loader
The intention of this PR is to modernize the settings_loader implementations.
The concept is old (remember, this is partly from 2014), back then we only had
one config file, meanwhile we have had a folder with config files for a very
long time.  Callers can now load a YAML configuration from this folder as
follows ::

    settings_loader.get_yaml_cfg('my-config.yml')

- BTW this is a fix of #3557.

- Further the `existing_filename_or_none` construct dates back to times when
  there was not yet a `pathlib.Path` in all Python versions we supported in the
  past.

- Typehints have been added wherever appropriate

At the same time, this patch should also be downward compatible and not
introduce a new environment variable. The localization of the folder with the
configurations is further based on:

    SEARXNG_SETTINGS_PATH (wich defaults to /etc/searxng/settings.yml)

Which means, the default config folder is `/etc/searxng/`.

ATTENTION: intended functional changes!

 If SEARXNG_SETTINGS_PATH was set and pointed to a not existing file, the
 previous implementation silently loaded the default configuration.  This
 behavior has been changed: if the file or folder does not exist, an
 EnvironmentError exception will be thrown in future.

Closes: https://github.com/searxng/searxng/issues/3557
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-07-14 18:10:06 +02:00
..
index.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
searx.babel_extract.rst [mod] add i18n infrastructure for SearXNG message files (searxng.msg) 2022-03-16 09:55:53 +01:00
searx.botdetection.rst [mod] isolation of botdetection from the limiter 2023-11-01 06:44:56 +01:00
searx.exceptions.rst [doc] Add doc-strings to searx.exceptions 2023-01-29 19:06:19 +01:00
searx.infopage.rst [mod] replace /help by /info pages and include pages in project docs 2022-03-12 11:36:31 +01:00
searx.locales.rst [mod] reduce memory footprint by not calling babel.Locale.parse at runtime 2024-02-20 10:43:20 +01:00
searx.plugins.hostnames.rst [doc] add 'hostnames' plugin to the online documentation 2024-06-07 14:42:52 +02:00
searx.plugins.tor_check.rst [mod] add tor_check plugin - convenient tor checking trough searxng 2022-07-19 07:34:54 +02:00
searx.plugins.unit_converter.rst [mod] improve unit converter plugin 2024-05-09 17:16:31 +02:00
searx.redisdb.rst move searx.shared.redisdb to searx.redisdb 2022-12-10 09:26:38 +01:00
searx.redislib.rst [mod] collection of redis functions and lua scripts (initial) 2022-05-30 11:10:30 +02:00
searx.search.processors.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
searx.search.rst [doc] update docs/dev/plugins.rst 2021-09-10 10:58:22 +02:00
searx.settings.rst [mod] revision of the settings_loader 2024-07-14 18:10:06 +02:00
searx.utils.rst [mod] add documentation about searx.utils 2022-01-29 22:49:42 +01:00