summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-10-30[brand] SearXNG - nginx & apache searxng.conf, uwsgi searxng.confMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-30[brand] SearXNG - bash env SEARXNG_URLMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-21Merge pull request #383 from dalf/searxng-dockerAlexandre Flament
SearXNG: docker
2021-10-16[fix] engine - yahoo: rewrite and fix issuesMarkus Heiser
Languages are supported by mapping the language to a domain. If domain is not found in :py:obj:`lang2domain` URL ``<lang>.search.yahoo.com`` is used. BTW: fix issue reported at https://github.com/searx/searx/issues/3020 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
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-03Merge pull request #375 from dalf/searxng_extraAlexandre Flament
SearXNG: searx_extra
2021-10-03[mod] searxng_extras - minor improvementsMarkus Heiser
- fix docs/searxng_extra/standalone_searx.py.rst - add SPDX tag - pylint standalone_searx.py and update_wikidata_units.py Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-02SearXNG: searxng_extraAlexandre 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-09-12Merge pull request #308 from dalf/plugin_hostname_replaceMarkus Heiser
[enh] add hostname_replace plugin
2021-09-11[enh] add hostname_replace pluginAlexandre Flament
* backport of https://github.com/searx/searx/pull/2724 * allow to remove result if the replacement is the boolean value false
2021-09-10Merge pull request #306 from dalf/docs-brandMarkus Heiser
[doc] searxng brand
2021-09-10[doc] update copyright notice and HTML titleAlexandre Flament
2021-09-10Merge pull request #302 from dalf/mod_plugin_on_resultMarkus Heiser
[mod] plugin: call on_result for each result of each engines.
2021-09-10[doc] update docs/dev/plugins.rstAlexandre Flament
2021-09-09[fix] remove references to transifexAlexandre Flament
2021-09-06[fix] translation: lock weblate only when there is an actual change of ↵Alexandre Flament
messages.pot Close #290
2021-08-16[translations] ./manage rename shell functions to integrate weblateMarkus Heiser
Functions implemented to run *Weblate* workflows should use prefix 'weblate.': - babel.setup.translations.worktree --> weblate.translations.worktree Create git worktree ${TRANSLATIONS_WORKTREE} and checkout branch 'translations' from Weblate's counterpart (weblate) of the SearXNG (origin):: remote weblate https://weblate.bubu1.eu/git/searxng/searxng/ - babel.weblate.to.translations --> weblate.to.translations Update 'translations' branch of SearXNG (origin) with last additions from Weblate. - babel.translations.to.master --> weblate.translations.commit Update 'translations' branch of SearXNG (origin) with last additions from Weblate. Copy the changes to the master branch, compile translations and create a commit in the local branch (master) - babel.master.to.translations --> weblate.push.translations Push *translation changes* from SearXNG (origin) to Weblate's counterpart (weblate). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-08-16[translation] ./manage: add comments to new functions, rename jobMarkus Heiser
./mange Comment functions: - babel.setup.translations.worktree - babel.weblate.to.translations - babel.translations.to.master - babel.master.to.translations BTW: - changed some cd into pushd - removed obsolete `set -x` - remove not needed echo from `last_commit_message=$(echo ..` .github/workflows/translations-update.yml docs/dev/translation.rst Rename job to: "create PR for additons from weblate" Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-08-09[translations] WF figure rename label to "weblate clone of SearXNG origin"Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-08-09[translations] additional documentation of the Weblate workflowsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-08-07[translations] web integrationAlexandre Flament
* make babel.translations.to.master: pull weblate updates * make babel.master.to.translations: push .pot and .po files to weblate
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-04[mod] pylint & document searx.locales (settings.yml: remove locales)Markus Heiser
- Add ``# lint: pylint`` header to pylint this python file. - Fix issues reported by pylint. - Add source code documentation of modul searx.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-30version based on the git repositoryAlexandre Flament
This commit remove the need to update the brand for GIT_URL and GIT_BRANCH: there are read from the git repository. It is possible to call python -m searx.version freeze to freeze the current version. Useful when the code is installed outside git (distro package, docker, etc...)
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-07-18[mod] drop usage of the searx.brand namespace (python procs)Markus Heiser
Added function searx.get_setting(name, default=_unset): Returns the value to which ``name`` point. If there is no such name in the settings and the ``default`` is unset, a KeyError exception is raised. In all the python processes .. - make docs - make buildenv - make install (setup.py) the usage of the 'brand.*' name space is replaced by 'searx.get_setting' function. - brand.SEARX_URL --> get_setting('server.base_url') - brand.GIT_URL --> get_setting('brand.git_url') - brand.GIT_BRANCH' --> get_setting('server.base_url') - brand.ISSUE_URL --> get_setting('brand.issue_url') - brand.DOCS_URL --> get_setting('brand.docs_url') - brand.PUBLIC_INSTANCES --> get_setting('brand.public_instances') - brand.CONTACT_URL --> get_setting('general.contact_url', '') - brand.WIKI_URL --> get_setting('brand.wiki_url') - brand.TWITTER_URL --> get_setting('brand.twitter_url', '') Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-07-03[fix] add missing transifex configuration (./tx/config)Markus Heiser
BTW: update the documentation about transifex usage Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-28Merge pull request #174 from searxng/static_scriptAlexandre Flament
[mod] add make targets to manage the build files in the /searx/static directory
2021-06-28[docs] describe the usage of the static.build.* scriptsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-27[fix] .config.sh: typo SEARX_INTERNAL_URL --> SEARX_INTERNAL_HTTPMarkus Heiser
There is a typo in .config.sh that causes confusion more and more often. SEARX_INTERNAL_HTTP should be the correct name of the environment variable. First mentioned in [1] and also discussed in [2]. [1] https://github.com/searx/searx/pull/2273 [2] https://github.com/searx/searx/discussions/2863 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-23[mod] utils/lxc.sh: detect conflict of docker & LXC in the iptablesMarkus Heiser
Docker is blocking network of existing LXC containers / there is a conflict in the iptables setup of Docker & LXC. With this patch: - utils/lxc.sh checks internet connectivity (instead of silently hang) - Chapter "Internet Connectivity & Docker" describes the problem and made a suggestion for a solution a solution Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-21[docs] add documentation from the sources of the google enginesMarkus 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-09[fix] section "Overrides" in engine's documentationMarkus Heiser
[1] https://github.com/searxng/searxng/pull/97#discussion_r646094256 Suggested-by: @dalf [1] 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] move LXC blog article into developer documentation.Markus Heiser
Move article 'Developing in Linux Containers' from blog section do developer section. Since there are no more articles in the blog section, remove the section completely. 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>