From 57df9c6e2d806c55d29faffaac241a153c0d9bcb Mon Sep 17 00:00:00 2001 From: Trinity Pointard Date: Thu, 11 Nov 2021 11:56:08 +0100 Subject: [PATCH] add s3_api.root_domain to doc book --- doc/book/src/cookbook/real_world.md | 1 + doc/book/src/quick_start/index.md | 1 + doc/book/src/reference_manual/configuration.md | 8 ++++++++ 3 files changed, 10 insertions(+) diff --git a/doc/book/src/cookbook/real_world.md b/doc/book/src/cookbook/real_world.md index 70262cc..7864274 100644 --- a/doc/book/src/cookbook/real_world.md +++ b/doc/book/src/cookbook/real_world.md @@ -83,6 +83,7 @@ bootstrap_peers = [] [s3_api] s3_region = "garage" api_bind_addr = "[::]:3900" +root_domain = ".s3.garage" [s3_web] bind_addr = "[::]:3902" diff --git a/doc/book/src/quick_start/index.md b/doc/book/src/quick_start/index.md index 9ff8be7..8de3fd8 100644 --- a/doc/book/src/quick_start/index.md +++ b/doc/book/src/quick_start/index.md @@ -48,6 +48,7 @@ bootstrap_peers = [] [s3_api] s3_region = "garage" api_bind_addr = "[::]:3900" +root_domain = ".s3.garage" [s3_web] bind_addr = "[::]:3902" diff --git a/doc/book/src/reference_manual/configuration.md b/doc/book/src/reference_manual/configuration.md index e165eb8..7eb64c1 100644 --- a/doc/book/src/reference_manual/configuration.md +++ b/doc/book/src/reference_manual/configuration.md @@ -30,6 +30,7 @@ sled_flush_every_ms = 2000 [s3_api] api_bind_addr = "[::]:3900" s3_region = "garage" +root_domain = ".3.garage" [s3_web] bind_addr = "[::]:3902" @@ -176,6 +177,13 @@ Garage will accept S3 API calls that are targetted to the S3 region defined here API calls targetted to other regions will fail with a AuthorizationHeaderMalformed error message that redirects the client to the correct region. +#### `root_domain` + +The optionnal suffix to access bucket using vhost-style instead of path-style API calls. + +For instance, if `root_domain` is `s3.garage.eu`, a bucket called `deuxfleurs.fr` +can be interacted with with hostname `deuxfleurs.fr.s3.garage.eu`. Note however you +can't interact with it using hostname `deuxfleurs.fr` directly. ## The `[s3_web]` section