update documentation, remove dumb comments

kiriwalawren · kiriwalawren · commit d3f3d38c1493 · 2025-11-04T16:09:02.000-05:00
diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ Generic NixOS Jellyfin media server configuration with the Arr stack (Sonarr, Ra
 - **Flexible Directory Management**: Configurable media and state directories with automatic setup
 - **Service Dependencies**: Configure custom systemd service dependencies
 - **Optional Nginx Reverse Proxy**: Configurable nginx integration for all services
+- [**TRaSH Guides**](trash-guides.info): Default configuration follows TRaSH guidelines
 
 ## Usage
 
diff --git a/modules/arr-common/hostConfigModule.nix b/modules/arr-common/hostConfigModule.nix
@@ -2,7 +2,6 @@
 with lib;
   types.submodule {
     options = {
-      # Connection settings
       bindAddress = mkOption {
         type = types.str;
         default = "*";
@@ -26,7 +25,6 @@ with lib;
         description = "Enable SSL";
       };
 
-      # Authentication settings
       authenticationMethod = mkOption {
         type = types.enum ["none" "basic" "forms" "external"];
         default = "forms";
@@ -51,7 +49,6 @@ with lib;
         description = "Path to password secret file";
       };
 
-      # URL settings
       urlBase = mkOption {
         type = types.str;
         default = "";
@@ -69,7 +66,6 @@ with lib;
         description = "Instance name";
       };
 
-      # Logging settings
       logLevel = mkOption {
         type = types.enum ["info" "debug" "trace"];
         default = "info";
@@ -88,7 +84,6 @@ with lib;
         description = "Console log level";
       };
 
-      # Update settings
       branch = mkOption {
         type = types.str;
         description = "Update branch";
@@ -112,7 +107,6 @@ with lib;
         description = "Update script path";
       };
 
-      # Proxy settings
       proxyEnabled = mkOption {
         type = types.bool;
         default = false;
@@ -161,7 +155,6 @@ with lib;
         description = "Proxy bypass local addresses";
       };
 
-      # SSL settings
       sslCertPath = mkOption {
         type = types.str;
         default = "";
@@ -180,7 +173,6 @@ with lib;
         description = "Certificate validation";
       };
 
-      # Backup settings
       backupFolder = mkOption {
         type = types.str;
         default = "Backups";
@@ -199,7 +191,6 @@ with lib;
         description = "Backup retention in days";
       };
 
-      # Other settings
       launchBrowser = mkOption {
         type = types.bool;
         default = false;
diff --git a/modules/arr-common/hostConfigService.nix b/modules/arr-common/hostConfigService.nix
@@ -1,9 +1,7 @@
 {
   lib,
   pkgs,
-}:
-# Helper function to create a systemd service that configures *arr basic settings via API
-serviceName: serviceConfig:
+}: serviceName: serviceConfig:
 with lib; let
   mkWaitForApiScript = import ./mkWaitForApiScript.nix {inherit lib pkgs;};
   capitalizedName = lib.toUpper (builtins.substring 0 1 serviceName) + builtins.substring 1 (-1) serviceName;
diff --git a/modules/arr-common/mkArrServiceModule.nix b/modules/arr-common/mkArrServiceModule.nix
@@ -245,7 +245,6 @@ in {
 
     systemd.services =
       {
-        # Service that waits for PostgreSQL database role to be ready
         "${serviceName}-wait-for-db" = mkIf config.services.postgresql.enable {
           description = "Wait for ${capitalizedName} PostgreSQL database role to be ready";
           after = ["postgresql.service" "postgresql-setup.service"];
@@ -272,8 +271,6 @@ in {
           '';
         };
 
-        # Ensure main service (radarr.service, etc.) starts after
-        # directories are created and configured dependencies
         ${serviceName} = {
           after =
             ["nixflix-setup-dirs.service"]
@@ -286,10 +283,8 @@ in {
             ++ (optional config.services.postgresql.enable "postgresql-ready.target");
           wants = optional config.nixflix.mullvad.enable "mullvad-config.service";
 
-          # Always use static users and configure VPN bypass
           serviceConfig =
             {
-              # DynamicUser causes issues with VPN bypass and permissions
               DynamicUser = mkForce false;
               User = cfg.user;
               Group = cfg.group;
@@ -298,21 +293,16 @@ in {
               EnvironmentFile = "/run/${serviceName}/env";
             }
             // optionalAttrs (config.nixflix.mullvad.enable && !cfg.vpn.enable) {
-              # Bypass VPN by wrapping with mullvad-exclude
               ExecStart = mkForce (pkgs.writeShellScript "${serviceName}-vpn-bypass" ''
                 exec /run/wrappers/bin/mullvad-exclude ${getExe config.services.${serviceName}.package} \
                   -nobrowser -data='${stateDir}'
               '');
-              # mullvad-exclude needs CAP_SYS_ADMIN to manipulate cgroups
               AmbientCapabilities = "CAP_SYS_ADMIN";
-              # Delegate allows the service to manage its cgroup subtree
               Delegate = mkForce true;
             };
         };
       }
-      # Only create config and rootfolders services if apiKeyPath is configured
       // optionalAttrs (cfg.config.apiKeyPath != null && cfg.config.hostConfig.passwordPath != null) {
-        # Create environment file setup service
         "${serviceName}-env" = {
           description = "Setup ${capitalizedName} environment file";
           wantedBy = ["${serviceName}.service"];
@@ -333,14 +323,11 @@ in {
           '';
         };
 
-        # Configure service via API
         "${serviceName}-config" = mkArrHostConfigService serviceName cfg.config;
       }
-      # Only create root folders service if rootFolders is not empty
       // optionalAttrs (usesMediaDirs && cfg.config.apiKeyPath != null && cfg.config.rootFolders != []) {
         "${serviceName}-rootfolders" = mkArrRootFoldersService serviceName cfg.config;
       }
-      # Only create download clients service if downloadClients is not empty
       // optionalAttrs (cfg.config.apiKeyPath != null) {
         "${serviceName}-downloadclients" = mkArrDownloadClientsService serviceName cfg.config;
       };
diff --git a/modules/arr-common/mkWaitForApiScript.nix b/modules/arr-common/mkWaitForApiScript.nix
@@ -1,9 +1,7 @@
 {
   lib,
   pkgs,
-}:
-# Helper function to create a script that waits for an *arr service API to be ready
-serviceName: serviceConfig:
+}: serviceName: serviceConfig:
 pkgs.writeShellScript "${serviceName}-wait-for-api" (let
   capitalizedName = lib.toUpper (builtins.substring 0 1 serviceName) + builtins.substring 1 (-1) serviceName;
 in ''
diff --git a/modules/arr-common/rootFoldersService.nix b/modules/arr-common/rootFoldersService.nix
@@ -1,9 +1,7 @@
 {
   lib,
   pkgs,
-}:
-# Helper function to create a systemd service that configures *arr root folders via API
-serviceName: serviceConfig:
+}: serviceName: serviceConfig:
 with lib; let
   mkWaitForApiScript = import ./mkWaitForApiScript.nix {inherit lib pkgs;};
   capitalizedName = lib.toUpper (builtins.substring 0 1 serviceName) + builtins.substring 1 (-1) serviceName;
@@ -51,9 +49,7 @@ in {
     done
 
     ${concatMapStringsSep "\n" (folderConfig: let
-        # Convert the Nix attr set to a JSON string
         folderJson = builtins.toJSON folderConfig;
-        # Extract the path for checking existence
         folderPath = folderConfig.path;
       in ''
         if ! echo "$ROOT_FOLDERS" | ${pkgs.jq}/bin/jq -e '.[] | select(.path == "${folderPath}")' >/dev/null 2>&1; then
diff --git a/modules/mullvad.nix b/modules/mullvad.nix
@@ -129,7 +129,6 @@ in {
           ''}
         '';
         ExecStop = pkgs.writeShellScript "logout-mullvad" ''
-          # Get device name and revoke it
           DEVICE_NAME=$(${mullvadPkg}/bin/mullvad account get | grep "Device name:" | sed 's/.*Device name:[[:space:]]*//')
           if [ -n "$DEVICE_NAME" ]; then
             echo "Revoking device: $DEVICE_NAME"
diff --git a/modules/nixflix.nix b/modules/nixflix.nix
@@ -141,7 +141,6 @@ in {
   config = mkIf cfg.enable {
     users.groups.media.members = cfg.mediaUsers;
 
-    # Create directories for all enabled services after dependencies are met
     systemd.services.nixflix-setup-dirs = {
       description = "Create directories for nixflix media server services";
       wantedBy = ["multi-user.target"];
@@ -154,7 +153,6 @@ in {
       };
 
       script = ''
-        # Base directories
         ${pkgs.coreutils}/bin/mkdir -p ${cfg.stateDir}
         ${pkgs.coreutils}/bin/chown root:root ${cfg.stateDir}
         ${pkgs.coreutils}/bin/chmod 0755 ${cfg.stateDir}
@@ -167,7 +165,6 @@ in {
         ${pkgs.coreutils}/bin/chown ${globals.libraryOwner.user}:${globals.libraryOwner.group} ${cfg.downloadsDir}
         ${pkgs.coreutils}/bin/chmod 0775 ${cfg.downloadsDir}
 
-        # Service-registered directories
         ${concatMapStringsSep "\n" (reg: ''
             ${pkgs.coreutils}/bin/mkdir -p ${reg.dir}
             ${pkgs.coreutils}/bin/chown ${reg.owner}:${reg.group} ${reg.dir}
diff --git a/modules/postgres.nix b/modules/postgres.nix
@@ -19,7 +19,6 @@ in {
   };
 
   config = mkIf (nixflix.enable && cfg.enable) {
-    # Register directories to be created
     nixflix.dirRegistrations = [
       {
         dir = stateDir;
diff --git a/modules/prowlarr/applicationsService.nix b/modules/prowlarr/applicationsService.nix
@@ -1,9 +1,7 @@
 {
   lib,
   pkgs,
-}:
-# Helper function to create a systemd service that configures Prowlarr applications via API
-serviceName: serviceConfig:
+}: serviceName: serviceConfig:
 with lib; let
   mkWaitForApiScript = import ../arr-common/mkWaitForApiScript.nix {inherit lib pkgs;};
   capitalizedName = lib.toUpper (builtins.substring 0 1 serviceName) + builtins.substring 1 (-1) serviceName;
diff --git a/modules/prowlarr/default.nix b/modules/prowlarr/default.nix
@@ -11,10 +11,8 @@ with lib; let
     inherit config lib pkgs;
   };
 
-  # List of arr services that can be auto-configured as applications
   arrServices = ["lidarr" "radarr" "sonarr"];
 
-  # Helper to create default application config for an enabled service
   mkDefaultApplication = serviceName: let
     serviceConfig = config.nixflix.${serviceName}.config;
     capitalizedName = lib.toUpper (builtins.substring 0 1 serviceName) + builtins.substring 1 (-1) serviceName;
@@ -36,7 +34,6 @@ with lib; let
       prowlarrUrl = mkDefault prowlarrUrl;
     };
 
-  # Generate default applications list from enabled services
   defaultApplications = filter (app: app != {}) (map mkDefaultApplication arrServices);
 
   extraConfigOptions = {
diff --git a/modules/prowlarr/indexersService.nix b/modules/prowlarr/indexersService.nix
@@ -1,9 +1,7 @@
 {
   lib,
   pkgs,
-}:
-# Helper function to create a systemd service that configures Prowlarr indexers via API
-serviceName: serviceConfig:
+}: serviceName: serviceConfig:
 with lib; let
   mkWaitForApiScript = import ../arr-common/mkWaitForApiScript.nix {inherit lib pkgs;};
   capitalizedName = lib.toUpper (builtins.substring 0 1 serviceName) + builtins.substring 1 (-1) serviceName;
diff --git a/modules/sabnzbd/default.nix b/modules/sabnzbd/default.nix
@@ -11,16 +11,13 @@ with lib; let
 
   settingsType = import ./settingsType.nix {inherit lib config;};
 
-  # Generate minimal INI with only essential startup config
-  # Everything else will be configured via API
   generateMinimalIni = settings: ''
     [misc]
     api_key = $SABNZBD_API_KEY
     nzb_key = $SABNZBD_NZB_KEY
     url_base = ${settings.url_base}
   '';
 
-  # API configuration script and service
   apiConfig = import ./configureApiService.nix {inherit pkgs lib cfg;};
 in {
   options.nixflix.sabnzbd = {
@@ -99,12 +96,10 @@ in {
   };
 
   config = mkIf (nixflix.enable && cfg.enable) {
-    # Override sabnzbd user configuration (user is created by services.sabnzbd)
     users.users.sabnzbd = {
       uid = mkForce globals.uids.sabnzbd;
     };
 
-    # Register directories to be created
     nixflix.dirRegistrations = [
       {
         dir = cfg.downloadsDir;
@@ -150,40 +145,33 @@ in {
       }
     ];
 
-    # Create minimal template file (API key and URL base only)
     environment.etc."sabnzbd/sabnzbd.ini.template".text = generateMinimalIni cfg.settings;
 
-    # Enable sabnzbd service
     services.sabnzbd = {
       inherit (cfg) user group;
       enable = true;
       configFile = "/var/lib/sabnzbd/sabnzbd.ini";
     };
 
-    # Override systemd service configuration
     systemd.services.sabnzbd = {
       after = ["nixflix-setup-dirs.service" "network-online.target"];
       requires = ["nixflix-setup-dirs.service"];
       wants = ["network-online.target"];
 
       serviceConfig = {
         ExecStartPre = pkgs.writeShellScript "sabnzbd-prestart" ''
-          # Only create config if it doesn't exist
           if [ ! -f /var/lib/sabnzbd/sabnzbd.ini ]; then
             echo "Creating initial SABnzbd configuration..."
 
-            # Export API key
             ${optionalString (cfg.apiKeyPath != null) ''
             export SABNZBD_API_KEY=$(${pkgs.coreutils}/bin/cat ${cfg.apiKeyPath})
           ''}
             ${optionalString (cfg.nzbKeyPath != null) ''
             export SABNZBD_NZB_KEY=$(${pkgs.coreutils}/bin/cat ${cfg.nzbKeyPath})
           ''}
 
-            # Substitute environment variables in template
             ${pkgs.envsubst}/bin/envsubst < /etc/sabnzbd/sabnzbd.ini.template > /var/lib/sabnzbd/sabnzbd.ini
 
-            # Set proper ownership and permissions
             ${pkgs.coreutils}/bin/chown sabnzbd:media /var/lib/sabnzbd/sabnzbd.ini
             ${pkgs.coreutils}/bin/chmod 600 /var/lib/sabnzbd/sabnzbd.ini
           else
@@ -193,10 +181,8 @@ in {
       };
     };
 
-    # Service to configure SABnzbd via API after it starts
     systemd.services.sabnzbd-config = apiConfig.serviceConfig;
 
-    # Nginx reverse proxy configuration
     services.nginx = mkIf nixflix.nginx.enable {
       virtualHosts.localhost.locations."${cfg.settings.url_base}" = {
         proxyPass = "http://127.0.0.1:${toString cfg.settings.port}";
diff --git a/modules/sabnzbd/settingsType.nix b/modules/sabnzbd/settingsType.nix

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@ in {`
`19`	`19`	`};`
`20`	`20`
`21`	`21`	`config = mkIf (nixflix.enable && cfg.enable) {`
`22`		`- # Register directories to be created`
`23`	`22`	`nixflix.dirRegistrations = [`
`24`	`23`	`{`
`25`	`24`	`dir = stateDir;`