aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/cookbook/clients.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2021-05-31 23:55:51 +0200
committerAlex Auvolat <alex@adnab.me>2021-05-31 23:55:51 +0200
commit42f692b1e0f73699b62f6ed20a08b40dd25b3f6a (patch)
tree38ba8a3ba965800d98f5a618a585c4daeaf61292 /doc/book/src/cookbook/clients.md
parent14fd3df65464d268a2223363da91ebcf1b61feca (diff)
downloadgarage-42f692b1e0f73699b62f6ed20a08b40dd25b3f6a.tar.gz
garage-42f692b1e0f73699b62f6ed20a08b40dd25b3f6a.zip
Documentation fixes (typo and small reorganization)
Diffstat (limited to 'doc/book/src/cookbook/clients.md')
-rw-r--r--doc/book/src/cookbook/clients.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/book/src/cookbook/clients.md b/doc/book/src/cookbook/clients.md
index 7a3a50df..364c982c 100644
--- a/doc/book/src/cookbook/clients.md
+++ b/doc/book/src/cookbook/clients.md
@@ -12,16 +12,19 @@ parameters:
- An **API access key** and its associated **secret key**. These usually look something
like this: `GK3515373e4c851ebaad366558` (access key),
`7d37d093435a41f2aab8f13c19ba067d9776c90215f56614adad6ece597dbb34` (secret key).
+ These keys are created and managed using the `garage` CLI, as explained in the
+ [quick start](../quick_start/index.md) guide.
-Most S3 clients can be configured easily, provided that you follow the following guidelines:
+Most S3 clients can be configured easily with these parameters,
+provided that you follow the following guidelines:
- **Force path style:** Garage does not support DNS-style buckets, which are now by default
on Amazon S3. Instead, Garage uses the legacy path-style bucket addressing.
Remember to configure your client to acknowledge this fact.
- **Configuring the S3 region:** Garage requires your client to talk to the correct "S3 region",
- which is set in the configuration file. This is often set just to `garage`. Remember to
- configure your client correctly for this as otherwise it will talk to `us-east-1`.
+ which is set in the configuration file. This is often set just to `garage`.
+ If this is not configured explicitly, clients usually try to talk to region `us-east-1`.
Garage should normally redirect your client to the correct region,
but in case your client does not support this you might have to configure it manually.