Unverified Commit 0bb15142 authored by Maximilian Bosch's avatar Maximilian Bosch
Browse files

nixos/alertmanager-ntfy: improve documentation about topic option 

This cannot be left unset, otherwise the evaluation would fail. However,
it should be treated as secret. Update description to reflect that.
parent fba6f87e

nixos/modules/services/monitoring/prometheus/alertmanager-ntfy.nix

+5 −0
Original line number Diff line number Diff line
@@ -53,6 +53,11 @@ in 
              topic = lib.mkOption {

                type = lib.types.str;

                description = ''

                  __Note:__ when using ntfy.sh and other public instances

                  it is recommended to set this option to an empty string and set the actual topic via

                  [](#opt-services.prometheus.alertmanager-ntfy.extraConfigFiles) since

                  the `topic` in `ntfy.sh` is essentially a password.



                  The topic to which alerts should be published.

                  Can either be a hardcoded string or a gval expression that evaluates to a string.

                '';