summaryrefslogtreecommitdiff
path: root/docs/admin
AgeCommit message (Collapse)Author
2021-10-12SearXNG: dockerAlexandre Flament
2021-10-11[brand] SearXNG - reference /etc/searxng/settings.ymlMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-11SearXNG: partial update: reference /etc/searxng/settings.ymlAlexandre Flament
2021-10-02SearXNG: SEARXNG_SETTINGS_PATHAlexandre Flament
2021-10-02SearXNG: SEARX_BIND_ADDRESSAlexandre Flament
2021-10-02SearXNG: SEARXNG_PORTAlexandre Flament
2021-10-02SearXNG: environment variablesAlexandre Flament
2021-09-13[brand] docs - normalize project name to SearXNGMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-08-04[docs] admin/engines/settings.rst remove 'locales' sectionMarkus Heiser
'locales' setting has been removed in: - f30d01ff [mod] settings.yml: remove locales Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-08-01[fix] documentation - remove brand.git_url & brand.git_branchMarkus Heiser
In commit 4b43775c9 the brand.git_url & brand.git_branch has been removed, with this patch these settings are removed from the documentation. docs/admin/engines/settings.rst - Remove brand.git_url & brand.git_branch docs/dev/makefile.rst - Remove brand.git_url & brand.git_branch modified docs/dev/lxcdev.rst - Remove brand.git_url & brand.git_branch - fix searXNG to SearXNG Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-27Merge pull request #216 from return42/fix-searx.shMarkus Heiser
normalize environment of installation tasks (shell) with YAML settings
2021-07-25[docs] document NoSLQ engines MongoDB and redisNoémi Ványi
Slightly modified merge of commit [3b192e638] [3b192e638] https://github.com/searx/searx/commit/3b192e638 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-24[mod] reduce enviroment variables in shell scripts to what is neededMarkus Heiser
Not all settings from the 'brand:' section of the YAML files are needed in the shell scripts. This patch reduce the variables in ./utils/brand.env to what is needed. The following ('brand:' settings) can be removed from this file: - ISSUE_URL - DOCS_URL - PUBLIC_INSTANCES - WIKI_URL Tasks running outside of an *installed instance*, need the following settings from the YAML configuration: - GIT_URL <--> brand.git_url - GIT_BRANCH <--> brand.git_branch - SEARX_URL <--> server.base_url (aka PUBLIC_URL) - SEARX_PORT <--> server.port - SEARX_BIND_ADDRESS <--> server.bind_address Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-21[mod] normalize .config.sh with settings.ymlMarkus Heiser
In commit 94851790 we have centralized all SearXNG setups in the settings.yml file: 94851790 [mod] move brand options from Makefile to settings.yml This step has not yet been completed for the installation procedures! Since all SearXNG setups are done in the settings.yml these environment variables needs to be removed from the ./conf.sh file. Scripts and other tasks running outside of an instance got the needed values from the ./utils/brand.env file. By example: ATM the environment variables of the ./config.sh file are in conflict with them from settings.yml: - PUBLIC_URL --> {server:base_url} - SEARX_INTERNAL_HTTP --> {server:bind_address}.{server:port} - GIT_BRANCH --> {brand:GIT_URL} These environment variable of a SearXNG instance and additional - SEARX_SETTINGS_TEMPLATE has been remove from the '.config.sh' file. With this patch, the main focus of ./conf.sh resists on environment variables needed for the installation of morty, filtron software. modified .config.sh: - removed no longer supported variables (see above) - add comment about: SearXNG setup in settings.yml modified utils/searx.sh: - SEARX_INTERNAL_HTTP no longer take from .config.sh - SEARX_SETTINGS_PATH /etc/searx/settings.yml - SEARX_SETTINGS_TEMPLATE obsolete modified utils/lib_install.sh: Initialize environment variables SEARX_PYENV, SEARX_SETTINGS_PATH and PUBLIC_URL. modified: utils/morty.sh Add missing hint about SEARX_SETTINGS_PATH and move PUBLIC_URL to utils/lib_install.sh modified: utils/morty.sh Move PUBLIC_URL to utils/lib_install.sh Renamed utils/templates/etc/searx/use_default_settings.yml -> settings.yml - removed option which can't be modified after installation - add some comments with examples Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-21[fix] utils/build_env.py and add documentationMarkus Heiser
modified docs/admin/engines/settings.rst - Fix documentation and add section 'brand'. - Add remarks about **buildenv** variables. - Add remarks about settings from environment variables $SEARX_DEBUG, $SEARX_PORT, $SEARX_BIND_ADDRESS and $SEARX_SECRET modified docs/admin/installation-searx.rst & docs/build-templates/searx.rst Fix template location /templates/etc/searx/settings.yml modified docs/dev/makefile.rst Add description of the 'make buildenv' target and describe - we have all SearXNG setups are centralized in the settings.yml file - why some tasks need a utils/brand.env (aka instance's buildenv) modified manage Settings file from repository's working tree are used by default and ask user if a /etc/searx/settings.yml file exists. modified searx/settings.yml Add comments about when it is needed to run 'make buildenv' modified searx/settings_defaults.py Default for server:port is taken from enviroment variable SEARX_PORT. modified utils/build_env.py - Some defaults in the settings.yml are taken from the environment, e.g. SEARX_BIND_ADDRESS (searx.settings_defaults.SHEMA). When the 'brand.env' file is created these enviroment variables should be unset first. - The CONTACT_URL enviroment is not needed in the utils/brand.env Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-21[mod] drop unused setting option brand:twitter_urlMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-15[doc] admin manual - describe installation of external pluginsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] revision of the section 'Command Line Engines'Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] revision of the blog article about local search enginesMarkus Heiser
The blog article 'Query your local search engines' has been renamed 'Local Search Engines', revised and moved into admin's chapter 'Engine & Settings'. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] rename 'Recoll' to 'Recoll Engine'Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move 'settings.yml' into admin's 'Engines & Settings'Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] rename 'General Engine Settings' to 'Configured Engines'Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] revision of the article "settings.yml"Markus Heiser
This patch is a marginal revision of the article "settings.yml", most changes are from normalizing the YAML syntax. 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] 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-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-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-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-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-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-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-27[mod] documentation: change the jinja context doesn't depend on searx.webappAlexandre Flament
Before this commit, in the documentation, the jinja context is 'webapp' and contains the global variable in the searx.webapp module. This commit changes this to include only the mandatory variables to build the documentation.
2020-12-17[mod] split searx.search into different processorsAlexandre Flament
see searx.search.processors.abstract.EngineProcessor First the method searx call the get_params method. If the return value is not None, then the searx call the method search.
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-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-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-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
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-04 14:01:10 +0000