diff options
| author | Alex <alex@adnab.me> | 2024-03-20 13:54:18 +0000 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2024-03-20 13:54:18 +0000 |
| commit | 30abf7e086359c914b1e083d3eec0f4e5fa37351 (patch) | |
| tree | fed2a61dd3e89bbbd3a80cd9b97d14b66eba1efd /doc/book/reference-manual | |
| parent | 26310f3242319c9ad093f5121cff0fe0c0108542 (diff) | |
| parent | 84018be8622b582ad8853df042d10f0e122e6316 (diff) | |
| download | garage-30abf7e086359c914b1e083d3eec0f4e5fa37351.tar.gz garage-30abf7e086359c914b1e083d3eec0f4e5fa37351.zip | |
Merge pull request 'Add support to logging to syslog (based on patch by @jirutka)' (#784) from syslog into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/784
Diffstat (limited to 'doc/book/reference-manual')
| -rw-r--r-- | doc/book/reference-manual/configuration.md | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md index de800ec0..e6aced6d 100644 --- a/doc/book/reference-manual/configuration.md +++ b/doc/book/reference-manual/configuration.md @@ -32,6 +32,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", @@ -82,7 +84,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), @@ -134,6 +139,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 @@ -503,7 +525,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 |