aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorQuentin <quentin@deuxfleurs.fr>2020-11-21 15:44:09 +0100
committerQuentin <quentin@deuxfleurs.fr>2020-11-21 15:44:09 +0100
commit92ab3eedfc03a6cd770e36745373ca188ed9ee20 (patch)
treec71d0f1892070549ac9dadfd3cbfec8937b3839b /README.md
parent0f33231ee6154a2b08f67f8107cc686ee9e9c678 (diff)
downloadgarage-92ab3eedfc03a6cd770e36745373ca188ed9ee20.tar.gz
garage-92ab3eedfc03a6cd770e36745373ca188ed9ee20.zip
Use awscli instead of s3cmd
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7c2cffaf..6d2600e4 100644
--- a/README.md
+++ b/README.md
@@ -20,14 +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 and install s3cmd. eg. `dnf install rust cargo s3cmd`
+ 1. Setup a rust/cargo environment and install `awscli`. eg. `dnf install rust cargo awscli`
2. Run `cargo build` to build the project
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`
+ 5. Run `./script/dev-bucket.sh` to create a bucket named `eprouvette` 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`).
+ 8. You can use `s3grg` to add, remove, and delete files. Try `s3grg --help`, `s3grg cp /proc/cpuinfo s3://eprouvette/cpuinfo.txt`, `s3grg ls s3://eprouvette`. `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!