diff options
| author | Alex <alex@adnab.me> | 2020-11-06 18:29:30 +0100 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2020-11-06 18:29:30 +0100 |
| commit | c9c699d377aae1d20107efd590c22290ad2b740b (patch) | |
| tree | fa3efe4c0790ff7c78ac51f5017efe6be72b3a9e | |
| parent | 13f8e1d2f332357fba10cebecafb1967cdac2805 (diff) | |
| parent | 7c3743ae2359ff3b8f512532b7b0109f4ffe4a68 (diff) | |
| download | garage-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
| -rw-r--r-- | README.md | 11 | ||||
| -rw-r--r-- | config.dev.toml | 20 |
2 files changed, 30 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`. diff --git a/config.dev.toml b/config.dev.toml new file mode 100644 index 00000000..966bee4b --- /dev/null +++ b/config.dev.toml @@ -0,0 +1,20 @@ +block_size = 1048576 # objects are split in blocks of maximum this number of bytes + +metadata_dir = "/tmp/garage-meta" +data_dir = "/tmp/garage-data" + +rpc_bind_addr = "[::]:3901" # the port other Garage nodes will use to talk to this node + +bootstrap_peers = [] + +max_concurrent_rpc_requests = 12 +data_replication_factor = 3 +meta_replication_factor = 3 +meta_epidemic_fanout = 3 + +[s3_api] +api_bind_addr = "[::1]:3900" # the S3 API port, HTTP without TLS. Add a reverse proxy for the TLS part. +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" |