aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/quickstart_bucket.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 15:44:29 +0100
committerQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 15:44:29 +0100
commitc50113acf3fd61dcb77bc01bd6e9f226f813bf76 (patch)
treee2e4f7c5cec0233a69ba8f818eb4b80eefb1f1c3 /doc/book/src/quickstart_bucket.md
parent0afc701a698c4891ea0f09fae668cb06b16757d7 (diff)
downloadgarage-c50113acf3fd61dcb77bc01bd6e9f226f813bf76.tar.gz
garage-c50113acf3fd61dcb77bc01bd6e9f226f813bf76.zip
Work on structure + Getting started is reworked
Diffstat (limited to 'doc/book/src/quickstart_bucket.md')
-rw-r--r--doc/book/src/quickstart_bucket.md71
1 files changed, 0 insertions, 71 deletions
diff --git a/doc/book/src/quickstart_bucket.md b/doc/book/src/quickstart_bucket.md
deleted file mode 100644
index bd574e14..00000000
--- a/doc/book/src/quickstart_bucket.md
+++ /dev/null
@@ -1,71 +0,0 @@
-# Configuring a cluster
-
-First, chances are that your garage deployment is secured by TLS.
-All your commands must be prefixed with their certificates.
-I will define an alias once and for all to ease future commands.
-Please adapt the path of the binary and certificates to your installation!
-
-```
-alias grg="/garage/garage --ca-cert /secrets/garage-ca.crt --client-cert /secrets/garage.crt --client-key /secrets/garage.key"
-```
-
-Now we can check that everything is going well by checking our cluster status:
-
-```
-grg status
-```
-
-Don't forget that `help` command and `--help` subcommands can help you anywhere, the CLI tool is self-documented! Two examples:
-
-```
-grg help
-grg bucket allow --help
-```
-
-Fine, now let's create a bucket (we imagine that you want to deploy nextcloud):
-
-```
-grg bucket create nextcloud-bucket
-```
-
-Check that everything went well:
-
-```
-grg bucket list
-grg bucket info nextcloud-bucket
-```
-
-Now we will generate an API key to access this bucket.
-Note that API keys are independent of buckets: one key can access multiple buckets, multiple keys can access one bucket.
-
-Now, let's start by creating a key only for our PHP application:
-
-```
-grg key new --name nextcloud-app-key
-```
-
-You will have the following output (this one is fake, `key_id` and `secret_key` were generated with the openssl CLI tool):
-
-```
-Key { key_id: "GK3515373e4c851ebaad366558", secret_key: "7d37d093435a41f2aab8f13c19ba067d9776c90215f56614adad6ece597dbb34", name: "nextcloud-app-key", name_timestamp: 1603280506694, deleted: false, authorized_buckets: [] }
-```
-
-Check that everything works as intended (be careful, info works only with your key identifier and not with its friendly name!):
-
-```
-grg key list
-grg key info GK3515373e4c851ebaad366558
-```
-
-Now that we have a bucket and a key, we need to give permissions to the key on the bucket!
-
-```
-grg bucket allow --read --write nextcloud-bucket --key GK3515373e4c851ebaad366558
-```
-
-You can check at any times allowed keys on your bucket with:
-
-```
-grg bucket info nextcloud-bucket
-```
-