aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/getting_started/install.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 15:44:29 +0100
committerQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 15:44:29 +0100
commitc50113acf3fd61dcb77bc01bd6e9f226f813bf76 (patch)
treee2e4f7c5cec0233a69ba8f818eb4b80eefb1f1c3 /doc/book/src/getting_started/install.md
parent0afc701a698c4891ea0f09fae668cb06b16757d7 (diff)
downloadgarage-c50113acf3fd61dcb77bc01bd6e9f226f813bf76.tar.gz
garage-c50113acf3fd61dcb77bc01bd6e9f226f813bf76.zip
Work on structure + Getting started is reworked
Diffstat (limited to 'doc/book/src/getting_started/install.md')
-rw-r--r--doc/book/src/getting_started/install.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/book/src/getting_started/install.md b/doc/book/src/getting_started/install.md
index 39557f02..98af1283 100644
--- a/doc/book/src/getting_started/install.md
+++ b/doc/book/src/getting_started/install.md
@@ -1,3 +1,25 @@
# Installation
+Currently, only two installations procedures are supported for Garage: from Docker (x86\_64 for Linux) and from source.
+In the future, we plan to add a third one, by publishing a compiled binary (x86\_64 for Linux).
+We did not test other architecture/operating system but, as long as your architecture/operating system is supported by Rust, you should be able to run Garage (feel free to report your tests!).
+## From Docker
+
+Garage is a software that can be run only in a cluster and requires at least 3 instances.
+If you plan to run the 3 instances on your machine for test purposes, we recommend a **docker-compose** deployment.
+If you have 3 independent machines (or 3 VM on independent machines) that can communite together, a **simple docker** deployment is enough.
+In any case, you first need to pick a Docker image version.
+
+Our docker image is currently named `lxpz/garage_amd64` and is stored on the [Docker Hub](https://hub.docker.com/r/lxpz/garage_amd64/tags?page=1&ordering=last_updated).
+We encourage you to use a fixed tag (eg. `v0.1.1d`) and not the `latest` tag.
+For this example, we will use the latest published version at the time of the writing which is `v0.1.1d` but it's up to you
+to check [the most recent versions on the Docker Hub](https://hub.docker.com/r/lxpz/garage_amd64/tags?page=1&ordering=last_updated).
+
+### Single machine deployment with docker-compose
+
+
+
+### Multiple machine deployment with docker
+
+## From source