summaryrefslogtreecommitdiff
path: root/docs/dev/makefile.rst
AgeCommit message (Collapse)Author
2021-09-13[brand] docs - normalize project name to SearXNGMarkus Heiser
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-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[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-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-04-23[doc] modify docs to fit to the new build boilerplateMarkus 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-24[doc] describe 'make books/{name}.html' and 'books/{name}.pdf'Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-11-13Correct what was obviously a typo in vir(t)ualenv.Pierre Chevalier
2020-03-30docs: document Makefile setup and 'buildenv' (aka brand)Markus Heiser
Add documentation of the Makefile environment (aka brand, buildenv), introduced in PR #1900. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-29build environment: add GIT_BRANCH variableMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-29tooling box: simplify build enviromentsMarkus Heiser
- no more need for a .config.mk - docs: use searx.brands environment - searx.sh, filtron.sh & morty.sh are sourcing utils/brand.env Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-04docs: add some documentation about the tooling box ./utils/*Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-01-08build requirements: add a shell script static analysis toolMarkus Heiser
ShellCheck: https://github.com/koalaman/shellcheck Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19doc: add reST primer (inital / WIP)Markus Heiser
preview: https://return42.github.io/searx/dev/reST.html includes: - :class: rst-example // admonitions with (rendered) reST markup example - extlinks to docutils Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-18edoc: -- makefile.rst fix typo and add extlinks['man']Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-18doc: describe Makefile targetsMarkus Heiser
With the aim to simplify development cycles, started with PR #1756 a Makefile based boilerplate was added. This patch adds the missing developer documentation. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-04 22:20:11 +0000