diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 10 insertions, 1 deletions
@@ -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`. |