aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 7 insertions, 20 deletions
diff --git a/README.md b/README.md
index 9fd31fb5..7c2cffaf 100644
--- a/README.md
+++ b/README.md
@@ -20,27 +20,14 @@ Our main use case is to provide a distributed storage layer for small-scale self
We propose the following quickstart to setup a full dev. environment as quickly as possible:
- 1. Setup a rust/cargo environment
+ 1. Setup a rust/cargo environment and install s3cmd. eg. `dnf install rust cargo s3cmd`
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:
-
-```bash
-s3cmd \
- --host 127.0.0.1:3900 \
- --access_key=GK108acc0d179b13826e54442b \
- --secret_key=f52aac5722c48f038ddf8612d1e91e8d0a9535048f1f1cd402cd0416f9f8807f \
- --region=garage \
- --no-ssl \
- ls s3://éprouvette
-```
+ 3. Run `./script/dev-cluster.sh` to launch a test cluster (feel free to read the script)
+ 4. Run `./script/dev-configure.sh` to configure your test cluster with default values (same datacenter, 100 tokens)
+ 5. Run `./script/dev-bucket.sh` to create a bucket named `éprouvette` and an API key that will be stored in `/tmp/garage.s3`
+ 6. Run `source ./script/dev-env.sh` to configure your CLI environment
+ 7. You can use `garage` to manage the cluster. Try `garage --help`.
+ 8. You can use `s3grg` to add, remove, and delete files. Try `s3grg --help`, `s3grg put /proc/cpuinfo s3://éprouvette/cpuinfo.txt`, `s3grg ls s3://éprouvette`. `s3grg` is a wrapper on `s3cmd` configured with the previously generated API key (the one in `/tmp/garage.s3`).
Now you should be ready to start hacking on garage!