diff options
Diffstat (limited to 'nixos/modules/services/monitoring/zabbix-agent.nix')
-rw-r--r-- | nixos/modules/services/monitoring/zabbix-agent.nix | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/services/monitoring/zabbix-agent.nix b/nixos/modules/services/monitoring/zabbix-agent.nix index c48b973f1ef..b497ecbcdb6 100644 --- a/nixos/modules/services/monitoring/zabbix-agent.nix +++ b/nixos/modules/services/monitoring/zabbix-agent.nix @@ -29,13 +29,13 @@ in options = { services.zabbixAgent = { - enable = mkEnableOption "the Zabbix Agent"; + enable = mkEnableOption (lib.mdDoc "the Zabbix Agent"); package = mkOption { type = types.package; default = pkgs.zabbix.agent; defaultText = literalExpression "pkgs.zabbix.agent"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -43,15 +43,15 @@ in default = with pkgs; [ nettools ]; defaultText = literalExpression "with pkgs; [ nettools ]"; example = literalExpression "with pkgs; [ nettools mysql ]"; - description = '' - Packages to be added to the Zabbix <envar>PATH</envar>. + description = lib.mdDoc '' + Packages to be added to the Zabbix {env}`PATH`. Typically used to add executables for scripts, but can be anything. ''; }; modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -71,7 +71,7 @@ in server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The IP address or hostname of the Zabbix server to connect to. ''; }; @@ -80,7 +80,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the agent should listen on. ''; }; @@ -88,7 +88,7 @@ in port = mkOption { type = types.port; default = 10050; - description = '' + description = lib.mdDoc '' Agent will listen on this port for connections from the server. ''; }; @@ -97,7 +97,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Agent. ''; }; @@ -105,9 +105,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Agent configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd> for details on supported values. ''; example = { |