aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuentin <quentin@deuxfleurs.fr>2020-11-06 17:56:57 +0100
committerQuentin <quentin@deuxfleurs.fr>2020-11-06 17:56:57 +0100
commit6d9ea43e9aad508380295b806347d202ba1c1882 (patch)
tree7fa42d93e2bc595bdff6453fa529c58ad574519c
parent57c6e1c877799aa66efa4882322732aada3070b3 (diff)
downloadgarage-6d9ea43e9aad508380295b806347d202ba1c1882.tar.gz
garage-6d9ea43e9aad508380295b806347d202ba1c1882.zip
Add a development section in readme.md
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index b8b0287b..876653d6 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,12 @@ Non-goals include:
Our main use case is to provide a distributed storage layer for small-scale self hosted services such as [Deuxfleurs](https://deuxfleurs.fr).
+## Development
+
+ 1. Setup a rust/cargo environment
+ 2. Run `cargo build` to build the project
+ 3. Run `RUST_BACKTRACE=1 RUST_LOG=garage=debug ./target/debug/garage server -c ./config.dev.toml` to launch a garage test instance (data will be saved in `/tmp`, no encryption, only one instance)
+
## Setting up Garage
Use the `genkeys.sh` script to generate TLS keys for encrypting communications between Garage nodes.