summaryrefslogtreecommitdiff
path: root/docs/utils/morty.sh.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-02-04 13:13:17 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2020-02-04 13:13:17 +0100
commit9278f0fb45bab21247085a709c0e4bef743752db (patch)
tree7d3e3fb057f767ed10ded7c1487bdb4d6c0b6d71 /docs/utils/morty.sh.rst
parent8ca86f46d3dfd81a69d2c2d1515bb163f327826c (diff)
docs: add some documentation about the tooling box ./utils/*
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/utils/morty.sh.rst')
-rw-r--r--docs/utils/morty.sh.rst15
1 files changed, 11 insertions, 4 deletions
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