diff options
Diffstat (limited to 'nixos/modules/services/monitoring/parsedmarc.nix')
| -rw-r--r-- | nixos/modules/services/monitoring/parsedmarc.nix | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index a146e7ab95435..9191a4a697e0b 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -20,16 +20,16 @@ in { options.services.parsedmarc = { - enable = lib.mkEnableOption (lib.mdDoc '' + enable = lib.mkEnableOption '' parsedmarc, a DMARC report monitoring service - ''); + ''; provision = { localMail = { enable = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether Postfix and Dovecot should be set up to receive mail locally. parsedmarc will be configured to watch the local inbox as the automatically created user specified in @@ -40,7 +40,7 @@ in recipientName = lib.mkOption { type = lib.types.str; default = "dmarc"; - description = lib.mdDoc '' + description = '' The DMARC mail recipient name, i.e. the name part of the email address which receives DMARC reports. @@ -54,7 +54,7 @@ in default = config.networking.fqdn; defaultText = lib.literalExpression "config.networking.fqdn"; example = "monitoring.example.com"; - description = lib.mdDoc '' + description = '' The hostname to use when configuring Postfix. Should correspond to the host's fully qualified domain @@ -68,7 +68,7 @@ in geoIp = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable and configure the [geoipupdate](#opt-services.geoipupdate.enable) service to automatically fetch GeoIP databases. Not crucial, but recommended for full functionality. @@ -82,7 +82,7 @@ in elasticsearch = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to set up and use a local instance of Elasticsearch. ''; }; @@ -95,7 +95,7 @@ in config.${opt.provision.elasticsearch} && config.${options.services.grafana.enable} ''; apply = x: x && cfg.provision.elasticsearch; - description = lib.mdDoc '' + description = '' Whether the automatically provisioned Elasticsearch instance should be added as a grafana datasource. Has no effect unless @@ -108,7 +108,7 @@ in type = lib.types.bool; default = config.services.grafana.enable; defaultText = lib.literalExpression "config.services.grafana.enable"; - description = lib.mdDoc '' + description = '' Whether the official parsedmarc grafana dashboard should be provisioned to the local grafana instance. ''; @@ -135,7 +135,7 @@ in }; } ''; - description = lib.mdDoc '' + description = '' Configuration parameters to set in {file}`parsedmarc.ini`. For a full list of available parameters, see @@ -159,7 +159,7 @@ in save_aggregate = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Save aggregate report data to Elasticsearch and/or Splunk. ''; }; @@ -167,7 +167,7 @@ in save_forensic = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Save forensic report data to Elasticsearch and/or Splunk. ''; }; @@ -177,7 +177,7 @@ in watch = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Use the IMAP IDLE command to process messages as they arrive. ''; }; @@ -185,7 +185,7 @@ in delete = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc '' + description = '' Delete messages after processing them, instead of archiving them. ''; }; @@ -195,7 +195,7 @@ in host = lib.mkOption { type = lib.types.str; default = "localhost"; - description = lib.mdDoc '' + description = '' The IMAP server hostname or IP address. ''; }; @@ -203,7 +203,7 @@ in port = lib.mkOption { type = lib.types.port; default = 993; - description = lib.mdDoc '' + description = '' The IMAP server port. ''; }; @@ -211,7 +211,7 @@ in ssl = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Use an encrypted SSL/TLS connection. ''; }; @@ -219,7 +219,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = lib.mdDoc '' + description = '' The IMAP server username. ''; }; @@ -227,7 +227,7 @@ in password = lib.mkOption { type = with lib.types; nullOr (either path (attrsOf path)); default = null; - description = lib.mdDoc '' + description = '' The IMAP server password. Always handled as a secret whether the value is @@ -243,7 +243,7 @@ in host = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = lib.mdDoc '' + description = '' The SMTP server hostname or IP address. ''; }; @@ -251,7 +251,7 @@ in port = lib.mkOption { type = with lib.types; nullOr port; default = null; - description = lib.mdDoc '' + description = '' The SMTP server port. ''; }; @@ -259,7 +259,7 @@ in ssl = lib.mkOption { type = with lib.types; nullOr bool; default = null; - description = lib.mdDoc '' + description = '' Use an encrypted SSL/TLS connection. ''; }; @@ -267,7 +267,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = lib.mdDoc '' + description = '' The SMTP server username. ''; }; @@ -275,7 +275,7 @@ in password = lib.mkOption { type = with lib.types; nullOr (either path (attrsOf path)); default = null; - description = lib.mdDoc '' + description = '' The SMTP server password. Always handled as a secret whether the value is @@ -289,7 +289,7 @@ in from = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = lib.mdDoc '' + description = '' The `From` address to use for the outgoing mail. ''; @@ -298,7 +298,7 @@ in to = lib.mkOption { type = with lib.types; nullOr (listOf str); default = null; - description = lib.mdDoc '' + description = '' The addresses to send outgoing mail to. ''; apply = x: if x == [] then null else lib.concatStringsSep "," x; @@ -310,7 +310,7 @@ in default = []; type = with lib.types; listOf str; apply = x: if x == [] then null else lib.concatStringsSep "," x; - description = lib.mdDoc '' + description = '' A list of Elasticsearch hosts to push parsed reports to. ''; @@ -319,7 +319,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = lib.mdDoc '' + description = '' Username to use when connecting to Elasticsearch, if required. ''; @@ -328,7 +328,7 @@ in password = lib.mkOption { type = with lib.types; nullOr (either path (attrsOf path)); default = null; - description = lib.mdDoc '' + description = '' The password to use when connecting to Elasticsearch, if required. @@ -343,7 +343,7 @@ in ssl = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to use an encrypted SSL/TLS connection. ''; }; @@ -351,7 +351,7 @@ in cert_path = lib.mkOption { type = lib.types.path; default = "/etc/ssl/certs/ca-certificates.crt"; - description = lib.mdDoc '' + description = '' The path to a TLS certificate bundle used to verify the server's certificate. ''; |