Improved docs

nixarr/jellyfin/default.nix

@@ -14,6 +14,7 @@ in with lib; {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/jellyfin";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/jellyfin"'';
       description = "The state directory for Jellyfin.";
     };
 

nixarr/lidarr/default.nix

@@ -13,6 +13,7 @@ in {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/lidarr";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/lidarr"'';
       description = "The state directory for Lidarr";
     };
 

nixarr/nixarr.nix

@@ -141,7 +141,6 @@ in {
       }
     ];
 
-    # TODO: move this to modules, at least the "*Arrs"...
     users.groups = {
       media = {};
       streamer = {};

nixarr/prowlarr/default.nix

@@ -19,6 +19,7 @@ in {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/prowlarr";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/prowlarr"'';
       description = "The state directory for Prowlarr.";
     };
 

nixarr/radarr/default.nix

@@ -15,6 +15,7 @@ in {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/radarr";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/radarr"'';
       description = "The state directory for radarr.";
     };
 

nixarr/readarr/default.nix

@@ -13,6 +13,7 @@ in {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/readarr";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/readarr"'';
       description = "The state directory for Readarr";
     };
 

nixarr/sonarr/default.nix

@@ -19,6 +19,7 @@ in {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/sonarr";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/sonarr"'';
       description = "The state directory for Sonarr.";
     };
 

nixarr/transmission/default.nix

@@ -66,6 +66,7 @@ in {
     stateDir = mkOption {
       type = types.path;
       default = "${nixarr.stateDir}/transmission";
+      defaultText = literalExpression ''"''${nixarr.stateDir}/transmission"'';
       description = ''
         The state directory for Transmission.
       '';
@@ -74,6 +75,7 @@ in {
     downloadDir = mkOption {
       type = types.path;
       default = "${nixarr.mediaDir}/torrents";
+      defaultText = literalExpression ''"''${nixarr.mediaDir}/torrents"'';
       description = ''
         The directory for Transmission to download to.
       '';
@@ -120,6 +122,7 @@ in {
         stateDir = mkOption {
           type = types.path;
           default = "${nixarr.stateDir}/cross-seed";
+          defaultText = literalExpression ''"''${nixarr.stateDir}/cross-seed"'';
           description = ''
             The state directory for Transmission.
           '';
@@ -128,6 +131,7 @@ in {
         indexIds = mkOption {
           type = with types; listOf int;
           default = [];
+          example = [ 1 3 7 ];
           description = ''
             List of indexer-ids, from prowlarr. These are from the RSS links
             for the indexers, located by the "radio" or "RSS" logo on the
@@ -142,6 +146,10 @@ in {
         extraSettings = mkOption {
           type = types.attrs;
           default = {};
+          example = {
+            port = 3000;
+            delay = 20;
+          };
           description = ''
             Extra settings for the cross-seed
             service, see [the cross-seed options
@@ -180,6 +188,9 @@ in {
     extraSettings = mkOption {
       type = types.attrs;
       default = {};
+      example = {
+        trash-original-torrent-files = true;
+      };
       description = ''
         Extra config settings for the Transmission service.
 
@@ -232,6 +243,8 @@ in {
         transmissionRpcUrl = "http://localhost:${builtins.toString cfg.uiPort}/transmission/rpc";
         rssCadence = "20 minutes";
 
+        action = "inject";
+
         # Enable infrequent periodic searches
         searchCadence = "1 week";
         excludeRecentSearch = "1 year";