summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-12-14Merge pull request #2384 from return42/improve-docAlexandre Flament
Improve doc of the installation skripts
2020-12-13[doc] add a tip about how to brand and stash a searx instance setupMarkus Heiser
BTW: drop a trailing whitespace Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-13[doc] document why to use sudoer to run intsallation scriptsMarkus Heiser
related to: - https://gist.github.com/dalf/60450e19b042bd39b9ce470c095d89b3#gistcomment-3263827 - https://github.com/searx/searx/issues/2013#issuecomment-647132313 - https://github.com/searx/searx/issues/2017#issuecomment-647700327 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-12[doc] update developer quickstart guideMarkus Heiser
See https://github.com/searx/searx/issues/2369#issuecomment-740652878 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-11[enh] add raise_for_httperrorAlexandre Flament
check HTTP response: * detect some comme CAPTCHA challenge (no solving). In this case the engine is suspended for long a time. * otherwise raise HTTPError as before the check is done in poolrequests.py (was before in search.py). update qwant, wikipedia, wikidata to use raise_for_httperror instead of raise_for_status
2020-12-08[doc] recommend to use 'use_default_settings=True'Markus Heiser
Since #2291 is merged, it is recommend to use:: use_default_settings=True 1. Add a template file use_default_settings.yml:: SEARX_SETTINGS_TEMPLATE="${REPO_ROOT}/utils/templates/etc/searx/use_default_settings.yml" 2. In Chapter "Configuration" recommend to make use of 'use_default_settings=True' and describe it 3. Rewrite of docs/admin/settings.rst - move chapter 'settings.yml location' to the top - update and split chapter 'Global Settings' 4. Add environment SEARX_SETTINGS_TEMPLATE to .config.sh 5. Use environment $SEARX_SETTINGS_TEMPLATE in the utils/searx.sh script Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-06Merge pull request #2352 from dalf/no_httpAlexandre Flament
Remove HTTP connections as much as possible
2020-12-04[fix] wikipedia engine: don't raise an error when the query is not foundAlexandre Flament
Add a new parameter "raise_for_status", set by default to True. When True, any HTTP status code >= 300 raise an exception ( #2332 ) When False, the engine can manage the HTTP status code by itself.
2020-12-04[mod] documentations & comments: update http://* URL to https://*.Alexandre Flament
About http://lesscss.org see https://github.com/less/less-docs/issues/520
2020-12-03[enh] record details exception per engineAlexandre Flament
add an new API /stats/errors
2020-12-01Merge pull request #2291 from dalf/settings2Alexandre Flament
[enh] user settings can relied on the default settings
2020-11-30Add recoll engine (#2325)Noémi Ványi
recoll is a local search engine based on Xapian: http://www.lesbonscomptes.com/recoll/ By itself recoll does not offer web or API access, this can be achieved using recoll-webui: https://framagit.org/medoc92/recollwebui.git This engine uses a custom 'files' result template set `base_url` to the location where recoll-webui can be reached set `dl_prefix` to a location where the file hierarchy as indexed by recoll can be reached set `search_dir` to the part of the indexed file hierarchy to be searched, use an empty string to search the entire search domain
2020-11-27[enh] settings.yml: add use_default_settings option (2nd version)Alexandre Flament
2020-11-26[enh] settings.yml: add use_default_settings optionAlexandre Flament
This change is backward compatible with the existing configurations. If a settings.yml loaded from an user defined location (SEARX_SETTINGS_PATH or /etc/searx/settings.yml), then this settings can relied on the default settings.yml with this option: user_default_settings:True
2020-11-20[enh] Add multiple outgoing proxiesAlexandre Flament
credits go to @bauruine see https://github.com/searx/searx/pull/1958
2020-11-13Correct what was obviously a typo in vir(t)ualenv.Pierre Chevalier
2020-11-04Feature/standalone searx update (#1591)rachmadani haryono
* chg: dev: update standalone_searx parent d8a5df721b33dd8a7cc9e21dba4060f21d629f69 author rachmadaniHaryono <foreturiga@gmail.com> 1603896594 +0800 committer rachmadaniHaryono <foreturiga@gmail.com> 1603896619 +0800 chg: dev: debug engine_shortcuts chg: dev: only initilize if engine is given chg: dev: split main chg: dev: standalone_searx chg: dev: update standalone_searx chg: doc: remove unnecessary log chg: test: differentiate travis chg: test: disable shortcut chg: test: use default engine settings fix: dev: category choices fix: dev: duplicate engine shortcut fix: dev: travis python3 fix: test: use empty string as shortcut fix: test: apkm fix: test: engine shortcut fix: test: mypy fix: test: parameter fix: test: pep8 fix: test: py2 compatibilities fix: test: searx settings fix: test: travis engines new: dev: deduplicate engine new: dev: main receive engines parameter new: dev: parse_argument accept engines parameter new: dev: split search query from get_result func new: test: basic result case Suggestions: use RawTextQuery to make the suggestions URLs. Update all themes accordingly. * new: doc: searx import and init * chg: dev: parse_argument - doc - run on __main__ - simple parse_args * chg: doc: module * chg: dev: import section - remove unused python path modification - new required package * chg: dev: script run - parse_argument func return directly parsed results - main func return dict instead json text - dump directly on sys.stdout.write * chg: dev: get_search_query and get_search_query func * chg: dev: main func - move inner function outside - return dict instead of json text * new: dev: add utils to doc sys path * new: doc: standalone_searx * fix: doc: run script * chg: dev: mypy type hint * chg: dev: SearchQuery don't have attr engines * chg: dev: reset engines __init__ * chg: test: unit test update * chg: dev: pylint and flake8 * new: test: standalone_searx * chg: dev: main func and doc * chg: dev: import and type hint * new: dev: main func - remove get_result func - single func which just translate dict * chg: test: put mypy on dev requirement * chg: doc: update * new: doc: add standalone_searx module member * chg: doc: shell command line * chg: dev: remove mypy * chg: doc: module docstring
2020-11-02[fix] searx configuration - quote bash calls in sed replacementsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-11-02[doc] searx configuration - add 'mkdir /etc/searx' before copyMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-11-02[fix] doc - add missing quotation marks in docs/build-templatesMarkus Heiser
Escape the all the quotation marks (" --> \") in docs/build-templates. The scripts are *bash evaluated* (e.g):: eval "echo \"$(< "${REPO_ROOT}/docs/build-templates/searx.rst")\"" Backslash, quotation marks and other need to be escaped. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-10-30[mod] make docs-live - remove --port option from sphinx-autobuildMarkus Heiser
Setting port fixed to 8080 has drawbacks when this port is already in use from another application [1]. Removing this option from the command line offers the use of the sphinx-autobuild defaults which are much more flexible [2]. [1] https://github.com/searx/searx/issues/2282 [2] https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-10-19Extract to /usr/local/filtron/localrenyhp
The /usr/local/filtron/local/go directory will be created by tar.
2020-10-19Fix typo xgd-open > xdg-openrenyhp
2020-10-08Add blogpost about `command` engineNoémi Ványi
2020-10-01[fix] revert PR #2232 and #2230Alexandre Flament
2020-09-30[fix] Sphinx 3.2.1 build: call searx.engines.initialize_enginesAlexandre Flament
Fix admin/engines.html Fix #2230
2020-09-30Merge pull request #2230 from dalf/fix-sphinx-buildAlexandre Flament
[fix] Sphinx 3.2.1 build: add missing "engines" variable in the jinja context
2020-09-29[fix] Sphinx 3.2.1 build: add missing "engines" variable in the jinja contextAlexandre Flament
Fix the admin/engines.html page
2020-09-28[fix] migration from github.com/asciimoo/searx to github.com/searx/searx : ↵Alexandre Flament
fix URLs
2020-09-28[fix] missing 'alias' typo in docs/admin/installation-nginx.rstMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-09-10[fix] docker and k8s: run searxAlexandre Flament
fix #2181
2020-09-01[enh] add option to configure proxies per engine - closes #1827Adam Tauber
2020-07-28[enh] add external plugin supportAdam Tauber
2020-07-25Filtron sample: Add missing commaGardouille
2020-07-22[enh] update documentation about dockerDalf
2020-07-13[fix] minor typos in docs/admin/settings.rstMarkus Heiser
This comit is a replacement for https://github.com/asciimoo/searx/pull/2005 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-07-13[fix docs] typo in the template to create a new userMarkus Heiser
closes: https://github.com/asciimoo/searx/issues/2062 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-07-03Created new plugin type custom_results. Added new plugin bang_redirect (#2027)Lukas van den Berk
* Made first attempt at the bangs redirects plugin. * It redirects. But in a messy way via javascript. * First version with custom plugin * Added a help page and a operator to see all the bangs available. * Changed to .format because of support * Changed to .format because of support * Removed : in params * Fixed path to json file and changed bang operator * Changed bang operator back to & * Made first attempt at the bangs redirects plugin. * It redirects. But in a messy way via javascript. * First version with custom plugin * Added a help page and a operator to see all the bangs available. * Changed to .format because of support * Changed to .format because of support * Removed : in params * Fixed path to json file and changed bang operator * Changed bang operator back to & * Refactored getting search query. Also changed bang operator to ! and is now working. * Removed prints * Removed temporary bangs_redirect.js file. Updated plugin documentation * Added unit test for the bangs plugin * Fixed a unit test and added 2 more for bangs plugin * Changed back to default settings.yml * Added myself to AUTHORS.rst * Refacored working of custom plugin. * Refactored _get_bangs_data from list to dict to improve search speed. * Decoupled bangs plugin from webserver with redirect_url * Refactored bangs unit tests * Fixed unit test bangs. Removed dubbel parsing in bangs.py * Removed a dumb print statement * Refactored bangs plugin to core engine. * Removed bangs plugin. * Refactored external bangs unit tests from plugin to core. * Removed custom_results/bangs documentation from plugins.rst * Added newline in settings.yml so the PR stays clean. * Changed searx/plugins/__init__.py back to the old file * Removed newline search.py * Refactored get_external_bang_operator from utils to external_bang.py * Removed unnecessary import form test_plugins.py * Removed _parseExternalBang and _isExternalBang from query.py * Removed get_external_bang_operator since it was not necessary * Simplified external_bang.py * Simplified external_bang.py * Moved external_bangs unit tests to test_webapp.py. Fixed return in search with external_bang * Refactored query parsing to unicode to support python2 * Refactored query parsing to unicode to support python2 * Refactored bangs plugin to core engine. * Refactored search parameter to search_query in external_bang.py
2020-06-29Merge branch 'master' into blog-dev-in-lxcMarkus Heiser
2020-06-28Use gender neutral pronounsNoémi Ványi
Closes #2031
2020-06-24[add blog post] Developing in Linux containers [202006]Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-24[fix] markup of auto generated installation instruction (uWSGI part)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18[fix] sphinx 3.1 CSS issuesMarkus Heiser
See sphinx-doc project, PR 7838 & 7484 with elementary patch to the basic CSS: - https://github.com/sphinx-doc/sphinx/issues/7838#issuecomment-646009605 - https://github.com/sphinx-doc/sphinx/pull/7484#issuecomment-646058972 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18[fix] margial typo in docs/user/onf.py doc-stringMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18[fix] buildprocess of docs in LXC (containers)Markus Heiser
The $DOCS_BUILD variable (like all BUILD variables) in the lxc environment:: sudo -H ./utils/lxc.sh cmd searx-archlinux make docs is different from running build process in the HOST:: make docs with kernel-include directive we can use the environment variables in the reST documents to address the correct file location of the include. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18[enh] add 'kernel-include' reST-directiveMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18[fix] buildhosts documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18[fix] indentation of filtron's rules (json)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-01Merge branch 'master' of https://github.com/asciimoo/searx into filtronMarkus Heiser
2020-05-31add display_error_messages option to engine settingsNoémi Ványi
A new option is added to engines to hide error messages from users. It is called `display_error_messages` and by default it is set to `True`. If it is set to `False` error messages do not show up on the UI. Keep in mind that engines are still suspended if needed regardless of this setting. Closes #1828
7apu2bq3rhoylwmucxizk54afw5jyda7pho4j5zdcqpwkufke7zdzwad.onion