From 8532e9a4757f97247b0d9a3c76eec552e552ac2f Mon Sep 17 00:00:00 2001 From: Alvar Penning Date: Tue, 17 Dec 2024 10:32:19 +0100 Subject: [PATCH] Docs: Redis ACL Username and Database As icinga-go-library v0.4.0 supports these now, it should be documented in Icinga DB. Closes #782. --- config.example.yml | 8 +++++++- doc/03-Configuration.md | 4 +++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/config.example.yml b/config.example.yml index 90fea96d3..a8e66b9a8 100644 --- a/config.example.yml +++ b/config.example.yml @@ -69,9 +69,15 @@ redis: # Defaults to '6380' as the Redis® open source server provided by the 'icingadb-redis' package listens on that port. # port: 6380 - # Authentication password. + # Authentication username, requires a `password` being set as well. +# username: + + # Authentication password. May be used alone or together with a `username`. # password: + # Numerical database identifier, defaults to `0`. +# database: 0 + # Icinga DB logs its activities at various severity levels and any errors that occur either # on the console or in systemd's journal. The latter is used automatically when running under systemd. # In any case, the default log level is 'info'. diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md index 093b9172b..46f1b89e4 100644 --- a/doc/03-Configuration.md +++ b/doc/03-Configuration.md @@ -15,7 +15,9 @@ therefore a dedicated Icinga DB instance that connects to it. |----------|-------------------------------------------------------------------------------------------------------------------------| | host | **Required.** Host name or address, or absolute Unix socket path. | | port | **Optional.** TCP port. Defaults to `6380` matching the Redis® open source server port in the `icingadb-redis` package. | -| password | **Optional.** Authentication password. | +| username | **Optional.** Authentication username, requires a `password` being set as well. | +| password | **Optional.** Authentication password. May be used alone or together with a `username`. | +| database | **Optional.** Numerical database identifier, defaults to `0`. | | tls | **Optional.** Whether to use TLS. | | cert | **Optional.** Path to TLS client certificate. | | key | **Optional.** Path to TLS private key. |