aboutsummaryrefslogtreecommitdiff
path: root/doc/book/reference-manual
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2023-10-03 16:23:02 +0000
committerAlex <alex@adnab.me>2023-10-03 16:23:02 +0000
commit1243db87f2090a3302c7c8beb386e68ddf9b66b5 (patch)
tree7280b64fd8ef63be32f27f44f26f0ee7c8ca44be /doc/book/reference-manual
parent16aa418e473a5e9ef229060d20f6eb280df272a2 (diff)
parent6f8a87814be502ecaee49cd37616ec7fe4c5b588 (diff)
downloadgarage-1243db87f2090a3302c7c8beb386e68ddf9b66b5.tar.gz
garage-1243db87f2090a3302c7c8beb386e68ddf9b66b5.zip
Merge pull request 'Add support for binding to unix domain sockets' (#640) from networkException/garage:unix-sockets into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/640
Diffstat (limited to 'doc/book/reference-manual')
-rw-r--r--doc/book/reference-manual/configuration.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index 08c013f7..3110aab7 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -410,6 +410,8 @@ manually.
The IP and port on which to bind for accepting S3 API calls.
This endpoint does not suport TLS: a reverse proxy should be used to provide it.
+Alternatively, since `v0.8.5`, a path can be used to create a unix socket with 0222 mode.
+
### `s3_region`
Garage will accept S3 API calls that are targetted to the S3 region defined here.
@@ -439,6 +441,8 @@ The IP and port on which to bind for accepting HTTP requests to buckets configur
for website access.
This endpoint does not suport TLS: a reverse proxy should be used to provide it.
+Alternatively, since `v0.8.5`, a path can be used to create a unix socket with 0222 mode.
+
### `root_domain`
The optional suffix appended to bucket names for the corresponding HTTP Host.
@@ -458,6 +462,9 @@ If specified, Garage will bind an HTTP server to this port and address, on
which it will listen to requests for administration features.
See [administration API reference](@/documentation/reference-manual/admin-api.md) to learn more about these features.
+Alternatively, since `v0.8.5`, a path can be used to create a unix socket. Note that for security reasons,
+the socket will have 0220 mode. Make sure to set user and group permissions accordingly.
+
### `metrics_token`, `metrics_token_file` or `GARAGE_METRICS_TOKEN` (env)
The token for accessing the Metrics endpoint. If this token is not set, the