aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2020-11-06 18:29:30 +0100
committerAlex <alex@adnab.me>2020-11-06 18:29:30 +0100
commitc9c699d377aae1d20107efd590c22290ad2b740b (patch)
treefa3efe4c0790ff7c78ac51f5017efe6be72b3a9e /README.md
parent13f8e1d2f332357fba10cebecafb1967cdac2805 (diff)
parent7c3743ae2359ff3b8f512532b7b0109f4ffe4a68 (diff)
downloadgarage-c9c699d377aae1d20107efd590c22290ad2b740b.tar.gz
garage-c9c699d377aae1d20107efd590c22290ad2b740b.zip
Merge pull request 'Make on-boarding easier' (#8) from feature/on-boarding into master
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/8
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9cde4f6c..816a1c95 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.
@@ -67,7 +73,10 @@ node_key = "/path/to/garage/pki/garage.key"
[s3_api]
api_bind_addr = "[::1]:3900" # the S3 API port, HTTP without TLS. Add a reverse proxy for the TLS part.
-region = "garage" # set this to anything. S3 API calls will fail if they are not made against the region set here.
+s3_region = "garage" # set this to anything. S3 API calls will fail if they are not made against the region set here.
+
+[s3_web]
+web_bind_addr = "[::1]:3902"
```
Build Garage using `cargo build --release`.