From 57c6e1c877799aa66efa4882322732aada3070b3 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 6 Nov 2020 14:23:56 +0100 Subject: Fix README + create dev config file --- README.md | 5 ++++- config.dev.toml | 20 ++++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 config.dev.toml diff --git a/README.md b/README.md index 9cde4f6c..b8b0287b 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,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" -- cgit v1.2.3 From 6d9ea43e9aad508380295b806347d202ba1c1882 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 6 Nov 2020 17:56:57 +0100 Subject: Add a development section in readme.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) 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. -- cgit v1.2.3 From 7c3743ae2359ff3b8f512532b7b0109f4ffe4a68 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 6 Nov 2020 17:57:55 +0100 Subject: Replace tabs with spaces --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 876653d6..816a1c95 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ Our main use case is to provide a distributed storage layer for small-scale self ## 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) + 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 -- cgit v1.2.3