From d18ad1d1488fb5dc16563d8d28d5e948c1290853 Mon Sep 17 00:00:00 2001
From: 4o1x5 <4o1x5@4o1x5.dev>
Date: Sun, 2 Jun 2024 19:38:39 +0200
Subject: [PATCH] removed lib.mDoc as it is deprecated in nix 24.05

---
 flake.nix | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/flake.nix b/flake.nix
index 73a5698..791c24b 100644
--- a/flake.nix
+++ b/flake.nix
@@ -49,6 +49,7 @@
           cfg = config.services.prometheus.exporters.i2pd;
         in
         {
+          # todo rename lib.mdoc
           options.services.prometheus.exporters.i2pd = {
 
             enable = mkEnableOption "Enable the i2pd exporter";
@@ -56,22 +57,31 @@
             listenAddress = mkOption {
               type = types.str;
               default = "127.0.0.1";
+              description = ''
+                What address the exporter should listen to.
+              '';
             };
 
             port = mkOption {
               type = types.port;
               default = 5733;
+              description = ''
+                What port the exporter should listen on.
+              '';
             };
 
             routerAddress = mkOption {
               type = types.str;
               default = "http://127.0.0.1:7650";
+              description = ''
+                The endpoint of the router's i2pcontrol protocol. ! Has to be https
+              '';
             };
 
             openFirewall = mkOption {
               type = types.bool;
               default = false;
-              description = lib.mdDoc ''
+              description = ''
                 Open the appropriate ports in the firewall for i2pd-exporter.
               '';
             };
@@ -79,6 +89,9 @@
             routerPassword = mkOption {
               type = types.str;
               default = "itoopie";
+              description = ''
+                The password for the i2pcontrol endpoint, by default itoopie
+              '';
             };
           };