diff options
author | Alex Auvolat <alex@adnab.me> | 2022-01-31 12:44:47 +0100 |
---|---|---|
committer | Alex Auvolat <alex@adnab.me> | 2022-01-31 12:44:47 +0100 |
commit | 242fcc297903c2e47c35946da5f99f97d091de0a (patch) | |
tree | 97ae176f98015a2006986ba9d69cc930bab6286f /content/documentation/connect | |
parent | 143c9403e6c94585de1ab65e631798994d01eb41 (diff) | |
download | garagehq.deuxfleurs.fr-242fcc297903c2e47c35946da5f99f97d091de0a.tar.gz garagehq.deuxfleurs.fr-242fcc297903c2e47c35946da5f99f97d091de0a.zip |
Add sections as documentation pages
Diffstat (limited to 'content/documentation/connect')
-rw-r--r-- | content/documentation/connect/_index.md | 46 |
1 files changed, 44 insertions, 2 deletions
diff --git a/content/documentation/connect/_index.md b/content/documentation/connect/_index.md index ff3976a..8ae3e60 100644 --- a/content/documentation/connect/_index.md +++ b/content/documentation/connect/_index.md @@ -2,5 +2,47 @@ title = "Integrations" weight = 3 sort_by = "weight" -redirect_to = "documentation/connect/apps/" -+++
\ No newline at end of file +template = "documentation.html" ++++ + + + +Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs. + +In particular, you will find here instructions to connect it with: + + - [web applications](./apps.md) + - [website hosting](./websites.md) + - [software repositories](./repositories.md) + - [CLI tools](./cli.md) + - [your own code](./code.md) + +### Generic instructions + +To configure S3-compatible software 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. |