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/morty.sh.rst | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/utils/morty.sh.rst (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst new file mode 100644 index 000000000..64ebda574 --- /dev/null +++ b/docs/utils/morty.sh.rst @@ -0,0 +1,31 @@ + +.. _morty.sh: + +.. _morty: https://github.com/asciimoo/morty +.. _morty's README: https://github.com/asciimoo/morty + +================== +``utils/morty.sh`` +================== + +To simplify installation and maintenance of a morty_ instance you can use the +script :origin:`utils/morty.sh`. In most cases you will install morty_ simply by +running the command: + +.. code:: bash + + sudo -H ./utils/morty.sh install all + +The script adds a ``${SERVICE_USER}`` (default:``morty``) and installs morty_ +into this user account. + +.. hint:: + + To add morty to your searx instance read chapter :reF:`searx_morty`. + + +The ``--help`` output of the script is largely +self-explanatory: + +.. program-output:: ../utils/morty.sh --help + -- 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/morty.sh.rst | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 64ebda574..988b16935 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -1,13 +1,17 @@ -.. _morty.sh: - .. _morty: https://github.com/asciimoo/morty .. _morty's README: https://github.com/asciimoo/morty +.. _morty.sh: + ================== ``utils/morty.sh`` ================== +.. sidebar:: further reading + + - :ref:`architecture` + To simplify installation and maintenance of a morty_ instance you can use the script :origin:`utils/morty.sh`. In most cases you will install morty_ simply by running the command: @@ -24,8 +28,11 @@ into this user account. To add morty to your searx instance read chapter :reF:`searx_morty`. -The ``--help`` output of the script is largely -self-explanatory: +Overview +======== + +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): .. program-output:: ../utils/morty.sh --help -- 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/morty.sh.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 988b16935..9997ffec5 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -10,6 +10,7 @@ .. sidebar:: further reading + - :ref:`installation` - :ref:`architecture` To simplify installation and maintenance of a morty_ instance you can use the -- cgit v1.2.3 From 387c6a77691fec514704bdf178b9ab94ad4abb40 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 6 Mar 2020 14:47:00 +0100 Subject: docs: improve description of uwsgi & ngingx setup Signed-off-by: Markus Heiser --- docs/utils/morty.sh.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 9997ffec5..5ab6ee982 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -26,7 +26,7 @@ into this user account. .. hint:: - To add morty to your searx instance read chapter :reF:`searx_morty`. + To add morty to your searx instance read chapter :ref:`searx morty`. Overview -- 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/morty.sh.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 5ab6ee982..2bdc4d9c8 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -1,6 +1,7 @@ .. _morty: https://github.com/asciimoo/morty .. _morty's README: https://github.com/asciimoo/morty +.. _Go: https://golang.org/ .. _morty.sh: @@ -22,7 +23,15 @@ running the command: sudo -H ./utils/morty.sh install all The script adds a ``${SERVICE_USER}`` (default:``morty``) and installs morty_ -into this user account. +into this user account: + +#. Create a separated user account (``morty``). +#. Download and install Go_ binary in user's $HOME (``~morty``). +#. Install morty_ with the package management from Go_ (``go get -v -u + github.com/asciimoo/morty``) +#. Setup a systemd service unit :origin:`[ref] + ` + (``/lib/systemd/system/morty.service``). .. hint:: -- cgit v1.2.3 From e32b08f61681da42104bc94b7b3266e41a79c58b Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 3 Apr 2020 20:26:20 +0200 Subject: utils/morty.sh: add generic documentation Signed-off-by: Markus Heiser --- docs/utils/morty.sh.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 2bdc4d9c8..34f0c9b5e 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -13,6 +13,7 @@ - :ref:`installation` - :ref:`architecture` + - :ref:`searx morty` To simplify installation and maintenance of a morty_ instance you can use the script :origin:`utils/morty.sh`. In most cases you will install morty_ simply by @@ -37,6 +38,34 @@ into this user account: To add morty to your searx instance read chapter :ref:`searx morty`. +Create user +=========== + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START create user + :end-before: END create user + + +Install go +========== + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install go + :end-before: END install go + + +Install morty +============= + +Install morty software and systemd unit: + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install morty + :end-before: END install morty + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install systemd unit + :end-before: END install systemd unit Overview ======== -- cgit v1.2.3 From ebde9d10fd84de74ea99385dae4d95bcf932bcf3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 9 Apr 2020 15:04:23 +0200 Subject: docs: proofreading of all the installation topics Signed-off-by: Markus Heiser --- docs/utils/morty.sh.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 34f0c9b5e..89629bea0 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -11,8 +11,9 @@ .. sidebar:: further reading - - :ref:`installation` - :ref:`architecture` + - :ref:`installation` (:ref:`nginx ` & :ref:`apache + `) - :ref:`searx morty` To simplify installation and maintenance of a morty_ instance you can use the @@ -67,6 +68,8 @@ Install morty software and systemd unit: :start-after: START install systemd unit :end-before: END install systemd unit +.. _morty.sh overview: + Overview ======== -- cgit v1.2.3 From bfef2c3b65aea8dd3485e0959e068d460577a841 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:52:45 +0200 Subject: [fix] buildprocess of docs in LXC (containers) The $DOCS_BUILD variable (like all BUILD variables) in the lxc environment:: sudo -H ./utils/lxc.sh cmd searx-archlinux make docs is different from running build process in the HOST:: make docs with kernel-include directive we can use the environment variables in the reST documents to address the correct file location of the include. Signed-off-by: Markus Heiser --- docs/utils/morty.sh.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/utils/morty.sh.rst') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 89629bea0..3bdf9bdd3 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -42,7 +42,7 @@ into this user account: Create user =========== -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START create user :end-before: END create user @@ -50,7 +50,7 @@ Create user Install go ========== -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START install go :end-before: END install go @@ -60,11 +60,11 @@ Install morty Install morty software and systemd unit: -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START install morty :end-before: END install morty -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START install systemd unit :end-before: END install systemd unit -- cgit v1.2.3