aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..270d616
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# mknet
+
+Show usage:
+
+```help
+python3 main.py
+```
+
+## Example
+
+```bash
+sudo rm -rf /tmp/garage-testnet/ # always start by deleting previous run
+sudo python3 main.py create ./config.yml
+sudo python3 main.py run-all example/deploy_garage.sh
+sudo python3 main.py run dc1:dc1s1 garage -c /tmp/garage-testnet/dc1/dc1s1/garage.toml status
+sudo python3 main.py destroy
+```
+
+## Instrumented daemons
+
+If you want to use the scripts provided in the `example` folder,
+you must add to your path some tools.
+
+### Garage (`deploy_garage.sh`)
+
+```bash
+# see versions on https://garagehq.deuxfleurs.fr/_releases.html
+export GRG_ARCH=x86_64-unknown-linux-musl
+export GRG_VERSION=v0.5.0
+
+sudo wget https://garagehq.deuxfleurs.fr/_releases/${GRG_VERSION}/${GRG_ARCH}/garage -O /usr/local/bin/garage
+sudo chmod +x /usr/local/bin/garage
+
+garage help
+```
+
+### Minio (`deploy_minio.py`)
+
+```
+sudo wget https://dl.min.io/server/minio/release/linux-amd64/minio -O /usr/local/bin/minio
+sudo chmod +x /usr/local/bin/minio
+```
+