summaryrefslogtreecommitdiff
path: root/searx/settings.yml
AgeCommit message (Collapse)Author
2025-01-28[refactor] typification of SearXNG (initial) / result items (part 1)Markus Heiser
Typification of SearXNG ======================= This patch introduces the typing of the results. The why and how is described in the documentation, please generate the documentation .. $ make docs.clean docs.live and read the following articles in the "Developer documentation": - result types --> http://0.0.0.0:8000/dev/result_types/index.html The result types are available from the `searx.result_types` module. The following have been implemented so far: - base result type: `searx.result_type.Result` --> http://0.0.0.0:8000/dev/result_types/base_result.html - answer results --> http://0.0.0.0:8000/dev/result_types/answer.html including the type for translations (inspired by #3925). For all other types (which still need to be set up in subsequent PRs), template documentation has been created for the transition period. Doc of the fields used in Templates =================================== The template documentation is the basis for the typing and is the first complete documentation of the results (needed for engine development). It is the "working paper" (the plan) with which further typifications can be implemented in subsequent PRs. - https://github.com/searxng/searxng/issues/357 Answer Templates ================ With the new (sub) types for `Answer`, the templates for the answers have also been revised, `Translation` are now displayed with collapsible entries (inspired by #3925). !en-de dog Plugins & Answerer ================== The implementation for `Plugin` and `Answer` has been revised, see documentation: - Plugin: http://0.0.0.0:8000/dev/plugins/index.html - Answerer: http://0.0.0.0:8000/dev/answerers/index.html With `AnswerStorage` and `AnswerStorage` to manage those items (in follow up PRs, `ArticleStorage`, `InfoStorage` and .. will be implemented) Autocomplete ============ The autocompletion had a bug where the results from `Answer` had not been shown in the past. To test activate autocompletion and try search terms for which we have answerers - statistics: type `min 1 2 3` .. in the completion list you should find an entry like `[de] min(1, 2, 3) = 1` - random: type `random uuid` .. in the completion list, the first item is a random UUID Extended Types ============== SearXNG extends e.g. the request and response types of flask and httpx, a module has been set up for type extensions: - Extended Types --> http://0.0.0.0:8000/dev/extended_types.html Unit-Tests ========== The unit tests have been completely revised. In the previous implementation, the runtime (the global variables such as `searx.settings`) was not initialized before each test, so the runtime environment with which a test ran was always determined by the tests that ran before it. This was also the reason why we sometimes had to observe non-deterministic errors in the tests in the past: - https://github.com/searxng/searxng/issues/2988 is one example for the Runtime issues, with non-deterministic behavior .. - https://github.com/searxng/searxng/pull/3650 - https://github.com/searxng/searxng/pull/3654 - https://github.com/searxng/searxng/pull/3642#issuecomment-2226884469 - https://github.com/searxng/searxng/pull/3746#issuecomment-2300965005 Why msgspec.Struct ================== We have already discussed typing based on e.g. `TypeDict` or `dataclass` in the past: - https://github.com/searxng/searxng/pull/1562/files - https://gist.github.com/dalf/972eb05e7a9bee161487132a7de244d2 - https://github.com/searxng/searxng/pull/1412/files - https://github.com/searxng/searxng/pull/1356 In my opinion, TypeDict is unsuitable because the objects are still dictionaries and not instances of classes / the `dataclass` are classes but ... The `msgspec.Struct` combine the advantages of typing, runtime behaviour and also offer the option of (fast) serializing (incl. type check) the objects. Currently not possible but conceivable with `msgspec`: Outsourcing the engines into separate processes, what possibilities this opens up in the future is left to the imagination! Internally, we have already defined that it is desirable to decouple the development of the engines from the development of the SearXNG core / The serialization of the `Result` objects is a prerequisite for this. HINT: The threads listed above were the template for this PR, even though the implementation here is based on msgspec. They should also be an inspiration for the following PRs of typification, as the models and implementations can provide a good direction. Why just one commit? ==================== I tried to create several (thematically separated) commits, but gave up at some point ... there are too many things to tackle at once / The comprehensibility of the commits would not be improved by a thematic separation. On the contrary, we would have to make multiple changes at the same places and the goal of a change would be vaguely recognizable in the fog of the commits. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-01-26[feat] engines: add NixOS WikiDenperidge
Co-authored-by: Bnyro <bnyro@tutanota.com>
2025-01-26[docs] settings_search.rst: add missing autocompletion providersBnyro
2025-01-20[feat] engines: add ipernity (images)Bnyro
2025-01-20[feat] engines: public domain image archiveDenperidge
2025-01-16[feat]: engines: add astrophysical data systemDanielMowitz
2024-12-25[feat] engines: re-add alexandria.orgAustin-Olacsi
2024-12-01[feat] search: add url formatting preferenceBnyro
2024-11-28[fix] crowdview engine: html tags in title and contentBnyro
2024-11-26[chore] drop sjp engine: WEB side has changed a long time agoMarkus Heiser
The WEB page (PL only) has changed and there is now also a kind of CAPTCHA. There is currently no possibility to restore the function of this engine. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-11-26[chore] remove invalid base_url from settings.yml enginesMarkus Heiser
The engines do not have / do not need a property `base_url`, lets remove it from the settings.yml Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-11-24[feat] metrics: support for open metricsBnyro
2024-11-24[feat] engine: add adobe stock video and audio enginesMarkus Heiser
The engine has been revised; there is now the option ``adobe_content_types`` with which it is possible to configure engines for video and audio from the adobe stock. BTW this patch adds documentation to the engine. To test all three engines in one use a search term like:: !asi !asv !asa sound Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-11-24[feat] engine: add adobe stock photosBnyro
2024-11-23[clean] Internet Archive Scholar search API no longer existsMarkus Heiser
Engine was added in #2733 but the API does no longer exists. Related: - https://github.com/searxng/searxng/issues/4038 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-11-10[fix] settings.yml - enabled_plugins: document to reflect default settingsLeo Liu
Remove 'Autodetect search language', which is no longer valid, from settings, and add 'Unit converter plugin', which is now default enabled, to settings.
2024-10-15[feat] engine: support for openlibraryBnyro
2024-10-05[feat] add favicons to result urlsBrock Vojkovic
2024-10-03[feat] implement mariadb engineGrant Lanham
2024-09-23add Cloudflare AI Gateway engineZhijie He
add Cloudflare AI Gateway engine add settings for Cloudflare AI Gateway engine set utf8 encode for data, fix non english char cause 500 error format json data fixed indentation and config format error fix line-length limitation in CI reformatted code for CI reformatted code for CI limit system prompts to less 120 chars cleanup unused variable & format code
2024-09-15[fix] drop engine alexandria.orgMarkus
The origin alexandria.org is broken: https://www.alexandria.org/?c=&r=&a=0&q=foo returns "504 Gateway Time-out" - Closes: https://github.com/searxng/searxng/issues/3786 Signed-off-by: Markus <markus@venom.fritz.box>
2024-09-15[fix] drop engine gpodderMarkus
gpodder is ultra slow on search terms like foo https://gpodder.net/search.json?q=foo takes up to a minute to return an empty json response. - Closes: https://github.com/searxng/searxng/issues/3785 Signed-off-by: Markus <markus@venom.fritz.box>
2024-09-15[feat] gitlab: implement dedicated moduleBnyro
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
2024-09-12[feat] engine: add right daoFinn Steffens
* [feat] engine: add right dao * [enh] right dao engine: allow additional classes Allow additional classes while parsing to prevent the engine from breaking in the future if additional classes are added to the elements. Co-authored-by: Bnyro <bnyro@tutanota.com> --------- Co-authored-by: Bnyro <bnyro@tutanota.com>
2024-09-03[engine] bahnhof.de: remove engineBnyro
2024-09-03[mod] enable calculator and allow plugin on public instancesMarkus Heiser
Remove quirks that prevented the Calculator from being used on public instances. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-08-21[feat] engine: implementation of yandex (web, images)Austin-Olacsi
It's set to inactive in settings.yml because of CAPTCHA. You need to remove that from the settings.yml to get in use. Closes: https://github.com/searxng/searxng/issues/961
2024-07-28[feat] engine: implementation of encyclosearchAustin-Olacsi
2024-07-27[fix] engine yacy images: increase timout from 3 to 5secMarkus Heiser
Its a leftover from 657dcb97 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-07-27[feat] engine: implementation of geizhals.deBnyro
2024-07-20[fix] engine yacy: update list of base URLsMarkus Heiser
https://search.lomig.me Poor results / tested `!yacy :en hello` and got zero results https://yacy.ecosys.eu Slow response (> 6sec for trivial search terms) https://search.webproject.link Dead instance / URL offline Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-07-14[feat] engine: implementation of alpine linux packagesBnyro
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
2024-07-07Implement google/brave switch in Mullvad LetaGrant Lanham
cleanup Import annontations
2024-07-03[fix] gentoo: use mediawiki engineBnyro
2024-06-28[fix] disable Reddit engine by defaultMarkus Heiser
Reddit is enabled by default .. many bot request will go through Reddit .. we should disable Reddit by default to cool down the IP [1]. [1] https://github.com/searxng/searxng/issues/3444#issuecomment-2180415057 Closes: https://github.com/searxng/searxng/issues/3444 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-06-14[feat] docker: add env vars for common public instance settingsholysoles
2024-06-07[feat] hostname replace plugin: support for external list fileBnyro
2024-06-07[feat] hostname replace plugin: possibility to prioritize certain websitesBnyro
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
2024-06-07[feat] mojeek: implement dedicated moduleBnyro
2024-06-07[feat] add engines for discourse forums (python, caddy, pi-hole)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-05-30[fix] comment in settings.yml 'Calculator plugin' --> 'Basic Calculator'Markus Heiser
Reported by @GitTimeraider in [1] [1] https://github.com/searxng/searxng/discussions/3529#discussioncomment-9605018 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-05-28[feat] engine: implementation of findthatmemeAustin-Olacsi
2024-05-28[mod] engine hex: add sort_criteria & page_size to configurationDaniel Kukula
2024-05-17[feat] engine: implementation of cargo search (crates.io)Daniel Kukula
2024-05-15[refactor] codeberg: use gitea engineBnyro
2024-05-15[feat] engine: implementation of giteaBnyro
2024-05-09[mod] yacy engine: pick base_url randomly from a list of instancesMarkus Heiser
Inspired by post [1] in the disscussion we had, while yacy.searchlab.eu was broken. [1] https://github.com/searxng/searxng/issues/3428#issuecomment-2101080101 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-05-09[feat] plugins: new calculator pluginBnyro
2024-05-04[feat] wikimedia commons: support for videos, audio and other filesBnyro
2024-05-03[feat] engine: implementation of https://hex.pmDaniel Kukula
The package manager for the Erlang ecosystem Find packages. Co-authored-by: Bnyro <82752168+Bnyro@users.noreply.github.com>