aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/getting_started/binary.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 17:24:11 +0100
committerQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 17:24:11 +0100
commit60f994a118afdde241d9a2296e2e8e090e08674d (patch)
tree249af0fa111e0c3ee9548c4d8ad95d0b30156db8 /doc/book/src/getting_started/binary.md
parent002538f92c1d9f95f2d699337f7d891c6aa0c9a4 (diff)
downloadgarage-60f994a118afdde241d9a2296e2e8e090e08674d.tar.gz
garage-60f994a118afdde241d9a2296e2e8e090e08674d.zip
Working on the getting started guide
Diffstat (limited to 'doc/book/src/getting_started/binary.md')
-rw-r--r--doc/book/src/getting_started/binary.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/book/src/getting_started/binary.md b/doc/book/src/getting_started/binary.md
new file mode 100644
index 00000000..ba8838b6
--- /dev/null
+++ b/doc/book/src/getting_started/binary.md
@@ -0,0 +1,22 @@
+# Get a binary
+
+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
+
+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).
+
+For example:
+
+```
+sudo docker pull lxpz/garage_amd64:v0.1.1d
+```
+
+## From source
+
+