summaryrefslogtreecommitdiff
path: root/docs/build-templates
AgeCommit message (Collapse)Author
2025-10-22[fix] Installation Script install fails (msgspec) (#5353)Markus Heiser
Since #5280 has been merged, msgspec, like yaml, is a fixed part of the SearXNG *settings framework* and therefore, like yaml, must be installed in the virtual environment before installing SearXNG (``searx``). The actual reason is that in SearXNG we store settings in the configuration that are required for the installation of the ``searx`` package. This means that these settings (from settings.yml) are read in during the installation, and all the necessary tools for this (pyyaml, msgspec, setuptools, etc.) must be installed beforehand (chicken or the egg dilemma). Related: - https://github.com/searxng/searxng/pull/5346 - https://github.com/searxng/searxng/pull/5280 - https://github.com/searxng/searxng/pull/5254 Closes: https://github.com/searxng/searxng/issues/5352
2024-10-03[mod] py3.8 EOL / upgrade to actions/setup-python@v5Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2024-08-21[fix] pip install -e: legacy editable install (setup.py develop) is deprecatedMarkus Heiser
From [1]: There is now a standardized mechanism [2] for an installer like pip to request an editable install of a project. pip is transitioning to using this standard only instead of invoking the deprecated `setup.py develop` command. For backward compatibility, we can use switches: --use-pep517 https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-use-pep517 --no-build-isolation https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-no-build-isolation - [1] https://github.com/pypa/pip/issues/11457 - [2] https://peps.python.org/pep-0660/ Closes: https://github.com/searxng/searxng/issues/3701 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-08-06[doc] improve documentation of make targets and ./manage scriptMarkus Heiser
BTW force modularization of the ./mange script into sub modules: - utils/lib_sxng_data.sh - utils/lib_sxng_node.sh - utils/lib_sxng_static.sh - utils/lib_sxng_test.sh - utils/lib_sxng_themes.sh Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30[doc] update documentation of the installation proceduresMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30[install scripts] rename SEARX_<name> variables to SEARXNG_<name>Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-21[doc] filtron.sh - install github.com/searxng/filtronMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-19Merge pull request #515 from return42/doc-themeMarkus Heiser
Various modification of the documentation and the theme sphinx-theme
2021-11-18[brand] SearXNG - docs rename links and fix documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-16[fix] filtron & morty - install golang binary that fits to arch & osMarkus Heiser
Closes: https://github.com/searxng/searxng/issues/507 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-11[brand] SearXNG - reference /etc/searxng/settings.ymlMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-10-02SearXNG: SEARXNG_SETTINGS_PATHAlexandre Flament
2021-09-13[brand] docs - normalize project name to SearXNGMarkus Heiser
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-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-04-25[brand] searxng -- fix links to issue tracker & WEB-GUIMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-04-22[fix] Fix typo in morty installation instructionZackptg5
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>
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-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-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-09-28[fix] migration from github.com/asciimoo/searx to github.com/searx/searx : ↵Alexandre Flament
fix URLs
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-05-21[fix] installation instructions: pip install -e searx (setup.py)Markus Heiser
In the past we did not really install searx into the virtualenv. This is a problem, since entry-points and other python installation stuff is not trigger. See discussion: https://github.com/asciimoo/searx/pull/1938#issuecomment-632056508 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-03utils/morty.sh: add generic documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-04-03utils/filtron.sh: add generic documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-31docs: use make and uitls/searx.sh in containersMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-03docs: generic documentation get templatingMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>