summaryrefslogtreecommitdiff
path: root/docs/utils/morty.sh.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-02-03 13:25:51 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2020-02-03 13:25:51 +0100
commit94ac560dcc85e2e75d3b14706a65eb9488643eb4 (patch)
tree40ff812809c2b96964c58c3aa630e73a9e112d46 /docs/utils/morty.sh.rst
parente7401796f652c946f52faf12b1b7c871ceaa7211 (diff)
downloadsearxng-94ac560dcc85e2e75d3b14706a65eb9488643eb4.tar.gz
searxng-94ac560dcc85e2e75d3b14706a65eb9488643eb4.zip
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 <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/utils/morty.sh.rst')
-rw-r--r--docs/utils/morty.sh.rst31
1 files changed, 31 insertions, 0 deletions
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
+