garage-unix-socket/doc/book/src/connect/index.md

39 lines
1.8 KiB
Markdown
Raw Normal View History

2021-10-29 16:05:47 +00:00
# Connect it to
2021-05-31 15:13:36 +00:00
2021-05-31 15:41:21 +00:00
To configure an S3 client to interact with Garage, you will need the following
parameters:
- An **API endpoint**: this corresponds to the HTTP or HTTPS address
used to contact the Garage server. When runing Garage locally this will usually
be `http://127.0.0.1:3900`. In a real-world setting, you would usually have a reverse-proxy
that adds TLS support and makes your Garage server available under a public hostname
such as `https://garage.example.com`.
- 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.
2021-05-31 15:41:21 +00:00
Most S3 clients can be configured easily with these parameters,
provided that you follow the following guidelines:
2021-05-31 15:41:21 +00:00
- **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`.
If this is not configured explicitly, clients usually try to talk to region `us-east-1`.
2021-05-31 15:41:21 +00:00
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.
2021-10-29 16:05:47 +00:00
We will now provide example configurations for the most common clients per category:
2021-05-31 15:41:21 +00:00
2021-10-29 16:05:47 +00:00
- [Apps](./apps.md)
- [Websites](./websites.md)
- [Repositories](./repositories.md)
- [CLI tools](./cli.md)
- [Your code](./code.md)
2021-05-31 15:13:36 +00:00