Deuxfleurs
/
garage
42
39
Fork 55
Code Issues 71 Pull Requests 7 Releases 29 Wiki Activity

Add a development section in readme.md

This commit is contained in:
Quentin 2020-11-06 17:56:57 +01:00
parent 57c6e1c877
commit 6d9ea43e9a
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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.