From 94ac560dcc85e2e75d3b14706a65eb9488643eb4 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 3 Feb 2020 13:25:51 +0100 Subject: doc: add descriptions of our tooling box in ./utils Initial started with the scripts for searx, filtron and morty installations. Signed-off-by: Markus Heiser --- docs/utils/index.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/utils/index.rst (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst new file mode 100644 index 000000000..4836ac652 --- /dev/null +++ b/docs/utils/index.rst @@ -0,0 +1,23 @@ + +.. _searx_utils: + +====================== +Tooling box ``utils/`` +====================== + +In the folder :origin:`utils/` we maintain some tools useful for admins and +developers. + +.. toctree:: + :maxdepth: 1 + + searx.sh + filtron.sh + morty.sh + +.. hint:: + + ATM :ref:`filtron.sh` and :ref:`searx.sh` do supports only systemd init + process used by debian, ubuntu and many other dists. If you have working + init.d files to start/stop services, please contribute / thanks! + -- cgit v1.2.3 From 9278f0fb45bab21247085a709c0e4bef743752db Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 4 Feb 2020 13:13:17 +0100 Subject: docs: add some documentation about the tooling box ./utils/* Signed-off-by: Markus Heiser --- docs/utils/index.rst | 43 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 36 insertions(+), 7 deletions(-) (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 4836ac652..9905d755f 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -1,9 +1,10 @@ .. _searx_utils: +.. _toolboxing: -====================== -Tooling box ``utils/`` -====================== +======================= +Tooling box ``utils/*`` +======================= In the folder :origin:`utils/` we maintain some tools useful for admins and developers. @@ -15,9 +16,37 @@ developers. filtron.sh morty.sh -.. hint:: +.. admonition:: Work needed! - ATM :ref:`filtron.sh` and :ref:`searx.sh` do supports only systemd init - process used by debian, ubuntu and many other dists. If you have working - init.d files to start/stop services, please contribute / thanks! + Our scripts to maintain services do most support only systemd init process + used by debian, ubuntu and many other dists. In general our scripts are only + partially usable on debian systems. We are working on this limitation, if + you have any contribution, please send us your :pull:`PR <../pulls>`, see + :ref:`how to contribute`. +.. _toolboxing common: + +Common commands +=============== + +Scripts to maintain services often dispose of common commands and environments. + +``shell``: + Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for + troubleshooting. + +``inspect service``: + 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! + +.. _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 -- cgit v1.2.3 From eedd63ccd504099836d9f528d02daffa6bc826ad Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 4 Feb 2020 16:42:13 +0100 Subject: docs: revision of the installation instructions Signed-off-by: Markus Heiser --- docs/utils/index.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 9905d755f..97e2c875f 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -6,24 +6,25 @@ Tooling box ``utils/*`` ======================= +.. sidebar:: Work needed! + + Our scripts to maintain services do most support only systemd init process + used by debian, ubuntu and many other dists. In general our scripts are only + partially usable on debian systems. We are working on this limitation, if + you have any contribution, please send us your :pull:`PR <../pulls>`, see + :ref:`how to contribute`. + In the folder :origin:`utils/` we maintain some tools useful for admins and developers. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents searx.sh filtron.sh morty.sh -.. admonition:: Work needed! - - Our scripts to maintain services do most support only systemd init process - used by debian, ubuntu and many other dists. In general our scripts are only - partially usable on debian systems. We are working on this limitation, if - you have any contribution, please send us your :pull:`PR <../pulls>`, see - :ref:`how to contribute`. - .. _toolboxing common: Common commands -- cgit v1.2.3 From a99c65dd018f092a8b7adc6ff7a12961334b40f3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 5 Feb 2020 07:37:26 +0100 Subject: docs: misc marginal fixes Signed-off-by: Markus Heiser --- docs/utils/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 97e2c875f..338914715 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -6,6 +6,9 @@ Tooling box ``utils/*`` ======================= +In the folder :origin:`utils/` we maintain some tools useful for admins and +developers. + .. sidebar:: Work needed! Our scripts to maintain services do most support only systemd init process @@ -14,9 +17,6 @@ Tooling box ``utils/*`` you have any contribution, please send us your :pull:`PR <../pulls>`, see :ref:`how to contribute`. -In the folder :origin:`utils/` we maintain some tools useful for admins and -developers. - .. toctree:: :maxdepth: 2 :caption: Contents -- cgit v1.2.3 From c3e4753ce951f759844db13d98f9ad5b226f84b6 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 2 Mar 2020 19:00:19 +0100 Subject: docs: generic documentation from the installation scripts Signed-off-by: Markus Heiser --- docs/utils/index.rst | 9 --------- 1 file changed, 9 deletions(-) (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 338914715..1c77cbfcd 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -1,4 +1,3 @@ - .. _searx_utils: .. _toolboxing: @@ -9,14 +8,6 @@ Tooling box ``utils/*`` In the folder :origin:`utils/` we maintain some tools useful for admins and developers. -.. sidebar:: Work needed! - - Our scripts to maintain services do most support only systemd init process - used by debian, ubuntu and many other dists. In general our scripts are only - partially usable on debian systems. We are working on this limitation, if - you have any contribution, please send us your :pull:`PR <../pulls>`, see - :ref:`how to contribute`. - .. toctree:: :maxdepth: 2 :caption: Contents -- cgit v1.2.3 From dd53c45a2cb46f882a856869de26215942749cba Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 30 Mar 2020 18:47:01 +0200 Subject: docs: add utils/lxc.sh docs, normalize filtron, morty & searx docs Signed-off-by: Markus Heiser --- docs/utils/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 1c77cbfcd..088586e43 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -15,6 +15,7 @@ developers. searx.sh filtron.sh morty.sh + lxc.sh .. _toolboxing common: -- cgit v1.2.3 From f693149cded4f783380f8f02154bd9288b72cdd5 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 8 Apr 2020 18:38:36 +0200 Subject: Changes from the installation tests on (all) LXC containers. Tested and fixed HTTP & uWSGI installation on: ubu1604 ubu1804 ubu1910 ubu2004 fedora31 archlinux Signed-off-by: Markus Heiser --- docs/utils/index.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'docs/utils/index.rst') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 088586e43..13914af28 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -19,20 +19,28 @@ developers. .. _toolboxing common: -Common commands -=============== +Common commands & environment +============================= Scripts to maintain services often dispose of common commands and environments. -``shell``: +``shell`` : command Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for troubleshooting. -``inspect service``: +``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 + ` use :: + + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install + .. _toolboxing setup: Tooling box setup -- cgit v1.2.3