aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md11
-rw-r--r--config.dev.toml20
2 files changed, 30 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`.
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"