From a2025a46f44ec8cf2f39db3eb5ecf7f742598b44 Mon Sep 17 00:00:00 2001
From: rasmus-kirk <mail@rasmuskirk.com>
Date: Sun, 3 Mar 2024 18:02:00 +0100
Subject: [PATCH] Improved docs

---
 nixarr/jellyfin/default.nix     |  1 +
 nixarr/lidarr/default.nix       |  1 +
 nixarr/nixarr.nix               |  1 -
 nixarr/prowlarr/default.nix     |  1 +
 nixarr/radarr/default.nix       |  1 +
 nixarr/readarr/default.nix      |  1 +
 nixarr/sonarr/default.nix       |  1 +
 nixarr/transmission/default.nix | 10 ++++++++++
 8 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/nixarr/jellyfin/default.nix b/nixarr/jellyfin/default.nix
index 4d973d6..2b5cb69 100644
--- a/nixarr/jellyfin/default.nix
+++ b/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.";
     };
 
diff --git a/nixarr/lidarr/default.nix b/nixarr/lidarr/default.nix
index 39c1425..c4cdc75 100644
--- a/nixarr/lidarr/default.nix
+++ b/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";
     };
 
diff --git a/nixarr/nixarr.nix b/nixarr/nixarr.nix
index d558ffd..82d80ff 100644
--- a/nixarr/nixarr.nix
+++ b/nixarr/nixarr.nix
@@ -141,7 +141,6 @@ in {
       }
     ];
 
-    # TODO: move this to modules, at least the "*Arrs"...
     users.groups = {
       media = {};
       streamer = {};
diff --git a/nixarr/prowlarr/default.nix b/nixarr/prowlarr/default.nix
index 2040544..cdf61ff 100644
--- a/nixarr/prowlarr/default.nix
+++ b/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.";
     };
 
diff --git a/nixarr/radarr/default.nix b/nixarr/radarr/default.nix
index 1957555..b8dbb06 100644
--- a/nixarr/radarr/default.nix
+++ b/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.";
     };
 
diff --git a/nixarr/readarr/default.nix b/nixarr/readarr/default.nix
index 9cd83e6..f8265c2 100644
--- a/nixarr/readarr/default.nix
+++ b/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";
     };
 
diff --git a/nixarr/sonarr/default.nix b/nixarr/sonarr/default.nix
index e74c861..1edd307 100644
--- a/nixarr/sonarr/default.nix
+++ b/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.";
     };
 
diff --git a/nixarr/transmission/default.nix b/nixarr/transmission/default.nix
index f77b626..88b683d 100644
--- a/nixarr/transmission/default.nix
+++ b/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
@@ -232,6 +240,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";