diff options
author | Quentin Dufour <quentin@deuxfleurs.fr> | 2021-10-29 18:05:47 +0200 |
---|---|---|
committer | Quentin Dufour <quentin@deuxfleurs.fr> | 2021-11-03 14:07:55 +0100 |
commit | eaf54efb25df598ac8db7b1a0c89a6e5be442179 (patch) | |
tree | 24352470fda13ce76665729899b6784fc4bb196c /doc/book/src/connect/index.md | |
parent | 93f8d59e4c71e6ff2f945dc2c632536f4530b13c (diff) | |
download | garage-eaf54efb25df598ac8db7b1a0c89a6e5be442179.tar.gz garage-eaf54efb25df598ac8db7b1a0c89a6e5be442179.zip |
Add doc for Nextcloud
Diffstat (limited to 'doc/book/src/connect/index.md')
-rw-r--r-- | doc/book/src/connect/index.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/book/src/connect/index.md b/doc/book/src/connect/index.md new file mode 100644 index 00000000..56c41255 --- /dev/null +++ b/doc/book/src/connect/index.md @@ -0,0 +1,38 @@ +# Connect it to + +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. + +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`. + 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. + +We will now provide example configurations for the most common clients per category: + + - [Apps](./apps.md) + - [Websites](./websites.md) + - [Repositories](./repositories.md) + - [CLI tools](./cli.md) + - [Your code](./code.md) + |