aboutsummaryrefslogtreecommitdiff
path: root/docs/install.md
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-02-24 10:14:05 -0300
committerSilvio Rhatto <rhatto@riseup.net>2024-02-24 10:14:05 -0300
commita3e8aa6c319e38606e7d10562c793e3027c57ff4 (patch)
tree4a0c28db7967fc14336167b3211f3234ccf60769 /docs/install.md
parent4395ba1f645d36fa0a29e63f43d6a14e5c052372 (diff)
downloadhydra-a3e8aa6c319e38606e7d10562c793e3027c57ff4.tar.gz
hydra-a3e8aa6c319e38606e7d10562c793e3027c57ff4.tar.bz2
Feat: migrate docs to MkDocs
Diffstat (limited to 'docs/install.md')
-rw-r--r--docs/install.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 0000000..4bf9fc0
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,30 @@
+# Installation
+
+## Clone
+
+First, clone the code:
+
+ git clone https://git.fluxo.info/hydra
+
+You can use the following to check the integrity of the latest release:
+
+ /usr/bin/git -C hydra verify-commit HEAD
+
+Note that `/usr/bin/git` is called to avoid any other `git` wrappers or aliases
+you might have available on your shell.
+
+There are some ways you can install the suite in your system:
+
+* Adding the whole `hydra` folder into your `PATH`.
+* By symlinking `hydra`, `hydractl` and optionally `hydras` into your `~/bin` folder.
+* By doing a system-wide install at `/usr/local` simply running
+
+ ./hydractl install
+
+## Dependencies
+
+Major direct upstreams:
+
+* `Debian <https://www.debian.org>`_
+* `Puppet <http://docs.puppetlabs.com>`_
+* `Git <https://git-scm.com/>`_