forked from zaclys/searxng
c03e4c86bc
* chg: dev: update standalone_searx parent d8a5df721b33dd8a7cc9e21dba4060f21d629f69 author rachmadaniHaryono <foreturiga@gmail.com> 1603896594 +0800 committer rachmadaniHaryono <foreturiga@gmail.com> 1603896619 +0800 chg: dev: debug engine_shortcuts chg: dev: only initilize if engine is given chg: dev: split main chg: dev: standalone_searx chg: dev: update standalone_searx chg: doc: remove unnecessary log chg: test: differentiate travis chg: test: disable shortcut chg: test: use default engine settings fix: dev: category choices fix: dev: duplicate engine shortcut fix: dev: travis python3 fix: test: use empty string as shortcut fix: test: apkm fix: test: engine shortcut fix: test: mypy fix: test: parameter fix: test: pep8 fix: test: py2 compatibilities fix: test: searx settings fix: test: travis engines new: dev: deduplicate engine new: dev: main receive engines parameter new: dev: parse_argument accept engines parameter new: dev: split search query from get_result func new: test: basic result case Suggestions: use RawTextQuery to make the suggestions URLs. Update all themes accordingly. * new: doc: searx import and init * chg: dev: parse_argument - doc - run on __main__ - simple parse_args * chg: doc: module * chg: dev: import section - remove unused python path modification - new required package * chg: dev: script run - parse_argument func return directly parsed results - main func return dict instead json text - dump directly on sys.stdout.write * chg: dev: get_search_query and get_search_query func * chg: dev: main func - move inner function outside - return dict instead of json text * new: dev: add utils to doc sys path * new: doc: standalone_searx * fix: doc: run script * chg: dev: mypy type hint * chg: dev: SearchQuery don't have attr engines * chg: dev: reset engines __init__ * chg: test: unit test update * chg: dev: pylint and flake8 * new: test: standalone_searx * chg: dev: main func and doc * chg: dev: import and type hint * new: dev: main func - remove get_result func - single func which just translate dict * chg: test: put mypy on dev requirement * chg: doc: update * new: doc: add standalone_searx module member * chg: doc: shell command line * chg: dev: remove mypy * chg: doc: module docstring
55 lines
1.4 KiB
ReStructuredText
55 lines
1.4 KiB
ReStructuredText
.. _searx_utils:
|
|
.. _toolboxing:
|
|
|
|
=======================
|
|
Tooling box ``utils/*``
|
|
=======================
|
|
|
|
In the folder :origin:`utils/` we maintain some tools useful for admins and
|
|
developers.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents
|
|
|
|
searx.sh
|
|
filtron.sh
|
|
morty.sh
|
|
lxc.sh
|
|
standalone_searx.py
|
|
|
|
.. _toolboxing common:
|
|
|
|
Common commands & environment
|
|
=============================
|
|
|
|
Scripts to maintain services often dispose of common commands and environments.
|
|
|
|
``shell`` : command
|
|
Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for
|
|
troubleshooting.
|
|
|
|
``inspect service`` : command
|
|
Shows status and log of the service, most often you have a option to enable
|
|
more verbose debug logs. Very helpful for debugging, but be careful not to
|
|
enable debugging in a production environment!
|
|
|
|
``FORCE_TIMEOUT`` : environment
|
|
Sets timeout for interactive prompts. If you want to run a script in batch
|
|
job, with defaults choices, set ``FORCE_TIMEOUT=0``. By example; to install a
|
|
reverse proxy for filtron on all containers of the :ref:`searx suite
|
|
<lxc-searx.env>` use ::
|
|
|
|
sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install
|
|
|
|
.. _toolboxing setup:
|
|
|
|
Tooling box setup
|
|
=================
|
|
|
|
The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile
|
|
setup`).
|
|
|
|
.. literalinclude:: ../../.config.sh
|
|
:language: bash
|