summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-06-04[fix] docs/conf.py - docutils docs moved to docutils.sourceforge.ioMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] add engine "Demo Online Engine"Markus Heiser
This engine just exists for documentation purpose. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move blog article "private engines" to admin/engines/Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] reorder chapter "Engines & Settings"Markus Heiser
- Split chapter "Engines" and rename it into "Engines & Settings" - Move docs/admin/engines.rst -> docs/admin/engines/engine_settings.rst Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move article "XPath Engine" to to admin/engines/Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] revision of the article "Offline engines"Markus Heiser
This patch is a a complete revision of the article "Offline engines", which also merges the content from the searx-wiki [1] into this article. [1] https://github.com/searx/searx/wiki/Offline-engines Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] add engine "Demo Offline Engine"Markus Heiser
This engine just exists for documentation purpose. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move blog article "Offline engines" to dev/offline_engines.rstMarkus Heiser
The article "Offline engines" should be in developer's documentation next to chapter "Engine overview". Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] remove blog article 'Introducing Python 3 support'Markus Heiser
This article is obsolete since a long time: Python 2 support has been dropped and these days, virtualenv is managed by ``make pyenv.install``. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move blog article "SQL engines" to admin/engines/Markus Heiser
The article "SQL engines" should be in admin's engine documentation (like the recoll engine). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move blog article "Command line engines" to admin/engines/Markus Heiser
The article "Command line engines" should be in admin's engine documentation (like the recoll engine). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] remove blog article about searx-adminMarkus Heiser
- https://github.com/kvch/searx-admin last maintained 4 years ago - searx-admin does not support 'use_default_settings' [1] (b4b81a5e) [1] https://searxng.github.io/searxng/admin/settings.html#use-default-settings Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[mod] "make docs" doesn't initialize the enginesAlexandre Flament
avoid external HTTP requests with "make docs"
2021-06-01[docs] highlight source code linked from *automodule* contentMarkus Heiser
sphinx.ext.viewcode won't highlight when 'highlight_language' [1] is set to string 'none' [2] [1] https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html [2] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-highlight_language Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-01[docs] add new rubric 'Source-Code'Markus Heiser
- document namespace: searx.engines - move docs/dev/xpath_engine.rst -> docs/src/searx.engines.xpath.rst Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-28[doc] add blog post about SQL serversMarkus Heiser
Modified merge of [22a79a4] from searx. [22a79a4] https://github.com/searx/searx/commit/22a79a48961d07d8b7c47cebc3f51a57a5ef5cfc Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-26[fix] webapp.py - running without installation is not supportedMarkus Heiser
Remove extension of the sys.path (aka PYTHONPATH). Running instance directly from repository's folder is a relict from the early beginning in 2014 (fd651083f) and is no longer supported. Since commit dd46629 was merged the command line 'searx-run' exists and should be used. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-23[doc] use a hint instead of a warning about searxngMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-23[doc] add documentation about the XPath engineMarkus Heiser
- pylint searx/engines/xpath.py - fix indentation of some long lines - add logging - add doc-strings Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-17[doc] docker: revision and preparation of the documentationMarkus Heiser
- add sidebars with addition infos about commands and docker in general - fix long lines & indentation - correct link to https://github.com/searxng/searxng-docker Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-17[mod] docker-entrypoint.sh - add script to make test.sh (shellcheck)Markus Heiser
Add script docker-entrypoint.sh to shellcheck and try to _simplify_ and _normalize_ some parts: - fix issues reported by shellcheck - don't mix tab and space indent - command 'help' replaced by '-h': ./dockerfiles/docker-entrypoint.sh -h - replace printf in help() by 'cat <<EOF' Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-14[fix] sphinx-tabs should not overlap sidebarMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-04-28[docker] multiarch support: linux/amd64,linux/arm64,linux/arm/v7Alexandre Flament
make docker.buildx : build and push multiarch build. (it can't be only build) use buildx with the --cache-from and --cache-to options to cache the layers (only the last built is cached)
2021-04-25[brand] searxng -- fix links to issue tracker & WEB-GUIMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-04-24[fix doc] manage.sh update_packages does not exists anymoreMarkus Heiser
Reported-by: https://github.com/searx/searx/issues/2776 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-04-23[doc] modify docs to fit to the new build boilerplateMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-04-23[mod] replace makefile boilerplate by 'manage' scriptMarkus Heiser
Replaces the make targets with the bash scripts Signed-off-by: Markus Heiser <markus@darmarit.de>
2021-04-22searxng brandAlexandre Flament
2021-04-22[fix] Fix typo in morty installation instructionZackptg5
2021-04-12Merge pull request #1 from metasearch-lab/httpx_networksAlexandre Flament
Httpx networks
2021-04-12[httpx] replace searx.poolrequests by searx.networkAlexandre Flament
settings.yml: * outgoing.networks: * can contains network definition * propertiers: enable_http, verify, http2, max_connections, max_keepalive_connections, keepalive_expiry, local_addresses, support_ipv4, support_ipv6, proxies, max_redirects, retries * retries: 0 by default, number of times searx retries to send the HTTP request (using different IP & proxy each time) * local_addresses can be "192.168.0.1/24" (it supports IPv6) * support_ipv4 & support_ipv6: both True by default see https://github.com/searx/searx/pull/1034 * each engine can define a "network" section: * either a full network description * either reference an existing network * all HTTP requests of engine use the same HTTP configuration (it was not the case before, see proxy configuration in master)
2021-04-09correct typo/grammatical mistakeColonisationCaptain
2021-04-07Add blogpost about Elasticsearch, Meilisearch and SolrNoémi Ványi
2021-03-08[mod] by default allow only HTTPS, not HTTPAlexandre Flament
Related to https://github.com/searx/searx/pull/2373
2021-03-05Merge pull request #2600 from dalf/searx-extraAlexandre Flament
Add searx_extra package
2021-03-04Add searx_extra packageAlexandre Flament
Split the utils directory into: * searx_extra contains update scripts, standalone_searx.py * utils contains the files to build and setup searx.
2021-03-03Fix security vulnerabilities in suggested nginx configurationAlex Balgavy
The suggested configurations for nginx found in the documentation and templates lead to vulnerabilities allowing host spoofing [1] and path traversal [2], as reported by Gixy [3]. This commit fixes those issues. [1] https://github.com/yandex/gixy/blob/master/docs/en/plugins/hostspoofing.md [2] https://github.com/yandex/gixy/blob/master/docs/en/plugins/aliastraversal.md [3] https://github.com/yandex/gixy
2021-02-12[fix] duckduckgo engine: "!ddg !g" do not redirect to googleAlexandre Flament
* searx understand "!ddg !g time" as : send "!g time" to DDG * !g a DDG bang for Google: DDG return a HTTP redirect to Google This commit adds a the allows_redirect param not to follow HTTP redirect. The DDG engine returns a empty result as before without HTTP redirect.
2021-02-02[fix] make books/user.pdfMarkus Heiser
Error: Configuration error: There is a programmable error in your configuration file: ... NameError: name 'DOCS_URL' is not defined make: *** [utils/makefile.sphinx:156: books/user.latex] Fehler 2 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-02-01[mod] dynamically set language_support variableAlexandre Flament
The language_support variable is set to True by default, and set to False in only 5 engines. Except the documentation and the /config URL, this variable is not used. This commit remove the variable definition in the engines, and set value according to supported_languages length: False when the length is 0, True otherwise. Close #2485
2021-01-27Merge pull request #2479 from Tobi823/masterAlexandre Flament
Document workaround for using 2 languages simultaneously #1508
2021-01-27[doc] improve admin-docs about result proxy (morty) configurationMarkus Heiser
[1] https://github.com/searx/searx/pull/1872#issuecomment-768107138 Suggested-by @dalf [1] Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-01-18Document workaround for using 2 languages simultaneously #1508Tobi823
2021-01-16[fix] setup.py requires pyyaml installedMarkus Heiser
pip install -e . ... Obtaining file:///usr/local/searx/searx-src ERROR: Command errored out with exit status 1: command: /usr/local/searx/searx-pyenv/bin/python3 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/usr/local/searx/searx-src/setup.py'"'"'; __file__='"'"'/usr/local/searx/searx-src/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'rn'"'"', '"'"'n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /tmp/pip-pip-egg-info-vzer91m2 cwd: /usr/local/searx/searx-src/ Complete output (9 lines): Traceback (most recent call last): File "<string>", line 1, in <module> File "/usr/local/searx/searx-src/setup.py", line 10, in <module> from searx.version import VERSION_STRING File "/usr/local/searx/searx-src/searx/__init__.py", line 19, in <module> import searx.settings_loader File "/usr/local/searx/searx-src/searx/settings_loader.py", line 8, in <module> import yaml ModuleNotFoundError: No module named 'yaml' ---------------------------------------- ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-01-12Merge pull request #2408 from return42/rm-brand-makeAlexandre Flament
[mod] move brand options from Makefile to settings.yml
2021-01-12Fixed typoArchie
2021-01-11[mod] improve settings documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-01-11[mod] move brand options from Makefile to settings.ymlMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-27Merge pull request #2411 from dalf/update-secret-key-checkAlexandre Flament
Update secret key check
2020-12-27Revert "[fix] sphinx 3.1 CSS issues"Markus Heiser
This reverts commit 0616684baa58b86cac5df6546432d4372f965fe2. Since PR https://github.com/sphinx-doc/sphinx/pull/7878 has been merged into Spinx-doc (v3.1.2), this patch is no longer needed: 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>