nixos/alertmanager: add additional docs about envsubst

Environment variables in the alertmanager config are substituted using
envsubst. It is therefore necessary to escape $ as $$ in the config, if it
should be preserved.
This commit is contained in:
Leon Vack 2024-04-08 11:00:14 +02:00
parent 4d49db587d
commit 11f45c8362

View File

@ -51,6 +51,9 @@ in {
default = null;
description = lib.mdDoc ''
Alertmanager configuration as nix attribute set.
The contents of the resulting config file are processed using envsubst.
`$` needs to be escaped as `$$` to be preserved.
'';
};
@ -62,6 +65,9 @@ in {
defines the text that is written to alertmanager.yml. If null, the
contents of alertmanager.yml is generated from the structured config
options.
The contents of the resulting config file are processed using envsubst.
`$` needs to be escaped as `$$` to be preserved.
'';
};