diff options
| author | Quentin <quentin@deuxfleurs.fr> | 2020-12-10 20:12:56 +0100 |
|---|---|---|
| committer | Quentin <quentin@deuxfleurs.fr> | 2020-12-10 20:12:56 +0100 |
| commit | e8c12072cefa37d9aec023fd6087b2d190ee3e4c (patch) | |
| tree | 88b15bfe703d2454d99550010ad04934513d25a4 /README.md | |
| parent | 51d0c14e440f00f24dbed6c3bce915a183a2bb65 (diff) | |
| parent | 022b386a5085cad79d649a82846c41cad730920b (diff) | |
| download | garage-e8c12072cefa37d9aec023fd6087b2d190ee3e4c.tar.gz garage-e8c12072cefa37d9aec023fd6087b2d190ee3e4c.zip | |
Merge branch 'master' into feature/website
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -26,12 +26,18 @@ We propose the following quickstart to setup a full dev. environment as quickly 4. Run `./script/dev-cluster.sh` to launch a test cluster (feel free to read the script) 5. Run `./script/dev-configure.sh` to configure your test cluster with default values (same datacenter, 100 tokens) 6. Run `./script/dev-bucket.sh` to create a bucket named `eprouvette` and an API key that will be stored in `/tmp/garage.s3` - 7. Run `source ./script/dev-env.sh` to configure your CLI environment + 7. Run `source ./script/dev-env-aws.sh` to configure your CLI environment 8. You can use `garage` to manage the cluster. Try `garage --help`. - 9. 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 the `aws s3` subcommand configured with the previously generated API key (the one in `/tmp/garage.s3`). + 9. You can use the `awsgrg` alias to add, remove, and delete files. Try `awsgrg help`, `awsgrg cp /proc/cpuinfo s3://eprouvette/cpuinfo.txt`, or `awsgrg ls s3://eprouvette`. `awsgrg` is a wrapper on the `aws s3` command pre-configured with the previously generated API key (the one in `/tmp/garage.s3`) and localhost as the endpoint. Now you should be ready to start hacking on garage! +## S3 compatibility + +Only a subset of S3 is supported: adding, listing, getting and deleting files in a bucket. +Bucket management, ACL and other advanced features are not (yet?) handled through the S3 API but through the `garage` CLI. +We primarily test `garage` against the `awscli` tool and `nextcloud`. + ## Setting up Garage Use the `genkeys.sh` script to generate TLS keys for encrypting communications between Garage nodes. |