From 8ad1df71e13bbf2524d324aeadc271959a37992f Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 19 Nov 2020 15:35:02 +0100 Subject: A quickstart to setup a dev. env. --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 816a1c95..e955e213 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,31 @@ Our main use case is to provide a distributed storage layer for small-scale self ## Development +We propose the following quickstart to setup a full dev. environment as quickly as possible: + 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) + 3. Run `./example/dev-cluster.sh` to launch a test cluster (feel free to read the script) + 4. Set a convenient alias `alias grg=./target/debug/garage` + 5. Get your node IDs with `grg status` + 6. Configure them, eg. `grg node configure -d dc1 -n 10 dd79867e0f5a9e08` + 7. Create a bucket, eg. `grg bucket create éprouvette` + 8. Create a key, eg. `grg key new --name opérateur` + 9. Bind the key with the bucket, eg. `grg bucket allow éprouvette --read --write --key GK108acc0d179b13826e54442b` + 10. Install s3cmd, eg. `dnf install s3cmd` + 11. s3cmd example command: + +```bash +s3cmd \ + --host 127.0.0.1:3900 \ + --access_key=GK108acc0d179b13826e54442b \ + --secret_key=f52aac5722c48f038ddf8612d1e91e8d0a9535048f1f1cd402cd0416f9f8807f \ + --region=garage \ + --no-ssl \ + ls s3://éprouvette +``` + +Now you should be ready to start hacking on garage! ## Setting up Garage -- cgit v1.2.3 From df44d32e458b7ac2b2531ab8e4504f3d8fffcea5 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 19 Nov 2020 15:36:04 +0100 Subject: Fix indent --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e955e213..ff2e52b3 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,14 @@ We propose the following quickstart to setup a full dev. environment as quickly 1. Setup a rust/cargo environment 2. Run `cargo build` to build the project 3. Run `./example/dev-cluster.sh` to launch a test cluster (feel free to read the script) - 4. Set a convenient alias `alias grg=./target/debug/garage` - 5. Get your node IDs with `grg status` - 6. Configure them, eg. `grg node configure -d dc1 -n 10 dd79867e0f5a9e08` - 7. Create a bucket, eg. `grg bucket create éprouvette` - 8. Create a key, eg. `grg key new --name opérateur` - 9. Bind the key with the bucket, eg. `grg bucket allow éprouvette --read --write --key GK108acc0d179b13826e54442b` - 10. Install s3cmd, eg. `dnf install s3cmd` - 11. s3cmd example command: + 4. Set a convenient alias `alias grg=./target/debug/garage` + 5. Get your node IDs with `grg status` + 6. Configure them, eg. `grg node configure -d dc1 -n 10 dd79867e0f5a9e08` + 7. Create a bucket, eg. `grg bucket create éprouvette` + 8. Create a key, eg. `grg key new --name opérateur` + 9. Bind the key with the bucket, eg. `grg bucket allow éprouvette --read --write --key GK108acc0d179b13826e54442b` + 10. Install s3cmd, eg. `dnf install s3cmd` + 11. s3cmd example command: ```bash s3cmd \ -- cgit v1.2.3 From 2ea1816a4a76c41666f1af97dfb0fbd7c08620b4 Mon Sep 17 00:00:00 2001 From: Quentin Date: Thu, 19 Nov 2020 15:36:28 +0100 Subject: fix indent 2 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ff2e52b3..f170f2ca 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,11 @@ We propose the following quickstart to setup a full dev. environment as quickly ```bash s3cmd \ --host 127.0.0.1:3900 \ - --access_key=GK108acc0d179b13826e54442b \ - --secret_key=f52aac5722c48f038ddf8612d1e91e8d0a9535048f1f1cd402cd0416f9f8807f \ - --region=garage \ - --no-ssl \ - ls s3://éprouvette + --access_key=GK108acc0d179b13826e54442b \ + --secret_key=f52aac5722c48f038ddf8612d1e91e8d0a9535048f1f1cd402cd0416f9f8807f \ + --region=garage \ + --no-ssl \ + ls s3://éprouvette ``` Now you should be ready to start hacking on garage! -- cgit v1.2.3