diff options
| author | networkException <git@nwex.de> | 2023-10-03 17:36:10 +0200 |
|---|---|---|
| committer | networkException <git@nwex.de> | 2023-10-03 17:56:34 +0200 |
| commit | 6f8a87814be502ecaee49cd37616ec7fe4c5b588 (patch) | |
| tree | e7fb1591038a666dda56d20b560765b208a7ac66 | |
| parent | 7907a09acc812f857f283d64c988c69d08acd041 (diff) | |
| download | garage-6f8a87814be502ecaee49cd37616ec7fe4c5b588.tar.gz garage-6f8a87814be502ecaee49cd37616ec7fe4c5b588.zip | |
doc: add documentation for specifying unix socket paths
| -rw-r--r-- | doc/book/reference-manual/configuration.md | 7 |
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 |