aboutsummaryrefslogtreecommitdiff
path: root/doc/book
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2024-03-26 16:34:40 +0100
committerAlex Auvolat <alex@adnab.me>2024-03-26 16:34:40 +0100
commitf7cd4eb60093910fe23745fce69db49fce591c32 (patch)
tree9d219453954f7616874d7bfa76e93fa843dfaa4e /doc/book
parentcdde0f19ee37848370d4a138d95c55bfaca820ed (diff)
parent95eb8808e8ede5439cf6352ce4f9a148fac2f236 (diff)
downloadgarage-f7cd4eb60093910fe23745fce69db49fce591c32.tar.gz
garage-f7cd4eb60093910fe23745fce69db49fce591c32.zip
Merge branch 'main' into next-0.10
Diffstat (limited to 'doc/book')
-rw-r--r--doc/book/cookbook/from-source.md1
-rw-r--r--doc/book/reference-manual/configuration.md24
2 files changed, 24 insertions, 1 deletions
diff --git a/doc/book/cookbook/from-source.md b/doc/book/cookbook/from-source.md
index f0e185a4..7105c999 100644
--- a/doc/book/cookbook/from-source.md
+++ b/doc/book/cookbook/from-source.md
@@ -90,5 +90,6 @@ The following feature flags are available in v0.8.0:
| `kubernetes-discovery` | optional | Enable automatic registration and discovery<br>of cluster nodes through the Kubernetes API |
| `metrics` | *by default* | Enable collection of metrics in Prometheus format on the admin API |
| `telemetry-otlp` | optional | Enable collection of execution traces using OpenTelemetry |
+| `syslog` | optional | Enable logging to Syslog |
| `lmdb` | *by default* | Enable using LMDB to store Garage's metadata |
| `sqlite` | *by default* | Enable using Sqlite3 to store Garage's metadata |
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index a21f945b..6fbe829f 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -31,6 +31,8 @@ rpc_bind_addr = "[::]:3901"
rpc_bind_outgoing = false
rpc_public_addr = "[fc00:1::1]:3901"
+allow_world_readable_secrets = false
+
bootstrap_peers = [
"563e1ac825ee3323aa441e72c26d1030d6d4414aeb3dd25287c531e7fc2bc95d@[fc00:1::1]:3901",
"86f0f26ae4afbd59aaf9cfb059eefac844951efd5b8caeec0d53f4ed6c85f332@[fc00:1::2]:3901",
@@ -81,7 +83,10 @@ The following gives details about each available configuration option.
### Index
+[Environment variables](#env_variables).
+
Top-level configuration options:
+[`allow_world_readable_secrets`](#allow_world_readable_secrets),
[`block_size`](#block_size),
[`bootstrap_peers`](#bootstrap_peers),
[`compression_level`](#compression_level),
@@ -132,6 +137,23 @@ The `[admin]` section:
[`admin_token`/`admin_token_file`](#admin_token),
[`trace_sink`](#admin_trace_sink),
+### Environment variables {#env_variables}
+
+The following configuration parameter must be specified as an environment
+variable, it does not exist in the configuration file:
+
+- `GARAGE_LOG_TO_SYSLOG` (since v0.9.4): set this to `1` or `true` to make the
+ Garage daemon send its logs to `syslog` (using the libc `syslog` function)
+ instead of printing to stderr.
+
+The following environment variables can be used to override the corresponding
+values in the configuration file:
+
+- [`GARAGE_ALLOW_WORLD_READABLE_SECRETS`](#allow_world_readable_secrets)
+- [`GARAGE_RPC_SECRET` and `GARAGE_RPC_SECRET_FILE`](#rpc_secret)
+- [`GARAGE_ADMIN_TOKEN` and `GARAGE_ADMIN_TOKEN_FILE`](#admin_token)
+- [`GARAGE_METRICS_TOKEN` and `GARAGE_METRICS_TOKEN`](#admin_metrics_token)
+
### Top-level configuration options
@@ -502,7 +524,7 @@ be obtained by running `garage node id` and then included directly in the
key will be returned by `garage node id` and you will have to add the IP
yourself.
-### `allow_world_readable_secrets`
+### `allow_world_readable_secrets` or `GARAGE_ALLOW_WORLD_READABLE_SECRETS` (env) {#allow_world_readable_secrets}
Garage checks the permissions of your secret files to make sure they're not
world-readable. In some cases, the check might fail and consider your files as