@muhammedaksam/easiarr 1.1.1 → 1.1.3

package/src/apps/registry.ts

@@ -248,6 +248,17 @@ export const APPS: Record<AppId, AppDefinition> = {
       LOG_HTML: "false",
       CAPTCHA_SOLVER: "none",
     },
+    homepage: {
+      icon: "flaresolverr.png",
+      widget: "customapi",
+      widgetFields: {
+        url: "http://flaresolverr:8191",
+        mappings: JSON.stringify([
+          { field: "msg", label: "Status" },
+          { field: "version", label: "Version" },
+        ]),
+      },
+    },
   },
 
   // === DOWNLOAD CLIENTS ===
@@ -302,6 +313,62 @@ export const APPS: Record<AppId, AppDefinition> = {
     homepage: { icon: "sabnzbd.png", widget: "sabnzbd" },
   },
 
+  slskd: {
+    id: "slskd",
+    name: "Slskd",
+    description: "Soulseek client for music downloads",
+    category: "downloader",
+    defaultPort: 5030,
+    image: "slskd/slskd",
+    puid: 13016,
+    pgid: 13000,
+    volumes: (root) => [`${root}/config/slskd:/app`, `${root}/data:/data`],
+    secondaryPorts: ["5031:5031", "50300:50300"],
+    environment: {
+      SLSKD_REMOTE_CONFIGURATION: "true",
+      // Web UI authentication (use global credentials)
+      SLSKD_USERNAME: "${USERNAME_GLOBAL}",
+      SLSKD_PASSWORD: "${PASSWORD_GLOBAL}",
+      // Soulseek network credentials (separate account)
+      SLSKD_SLSK_USERNAME: "${USERNAME_SOULSEEK}",
+      SLSKD_SLSK_PASSWORD: "${PASSWORD_SOULSEEK}",
+    },
+    secrets: [
+      {
+        name: "USERNAME_SOULSEEK",
+        description: "Soulseek network username (your Soulseek account)",
+        required: true,
+      },
+      {
+        name: "PASSWORD_SOULSEEK",
+        description: "Soulseek network password",
+        required: true,
+        mask: true,
+      },
+    ],
+    homepage: { icon: "slskd.png", widget: "slskd" },
+    autoSetup: {
+      type: "partial",
+      description: "Generates slskd.yml with API key for Homepage widget and Soularr integration",
+    },
+  },
+
+  soularr: {
+    id: "soularr",
+    name: "Soularr",
+    description: "Connects Lidarr with Soulseek via Slskd",
+    category: "downloader",
+    defaultPort: 0, // No web UI
+    image: "mrusse08/soularr:latest",
+    puid: 13017,
+    pgid: 13000,
+    volumes: (root) => [`${root}/data/slskd_downloads:/downloads`, `${root}/config/soularr:/data`],
+    environment: {
+      SCRIPT_INTERVAL: "300",
+    },
+    dependsOn: ["lidarr", "slskd"],
+  },
+
   // === MEDIA SERVERS ===
   plex: {
     id: "plex",
@@ -647,7 +714,10 @@ export const APPS: Record<AppId, AppDefinition> = {
       widget: "customapi",
       widgetFields: {
         url: "http://easiarr:8080/config.json",
-        mappings: JSON.stringify([{ field: "version", label: "Installed" }]),
+        mappings: JSON.stringify([
+          { field: "version", label: "Version" },
+          { field: "apps.length", label: "Apps" },
+        ]),
       },
     },
   },

package/src/config/homepage-config.ts

@@ -24,7 +24,7 @@ export function getHomepageConfigPath(config: EasiarrConfig): string {
  * Homepage service entry
  */
 interface HomepageService {
-  href: string
+  href?: string // Optional - cloudflared has no web UI
   icon?: string
   description?: string
   ping?: string
@@ -55,6 +55,9 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
     // Skip homepage itself
     if (appDef.id === "homepage") continue
 
+    // Skip apps with no web UI (port 0) and no homepage config
+    if (appDef.defaultPort === 0 && !appDef.homepage) continue
+
     const port = appConfig.port ?? appDef.defaultPort
     const internalPort = appDef.internalPort ?? port
     // External URL for user browser access (href, ping)
@@ -63,10 +66,22 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
     const dockerUrl = `http://${appDef.id}:${internalPort}`
 
     const service: HomepageService = {
-      href: baseUrl,
       description: appDef.description,
     }
 
+    // Special cases for href/ping
+    if (appDef.id === "cloudflared") {
+      // Cloudflared has no web UI - skip href/ping
+    } else if (appDef.id === "traefik") {
+      // Traefik dashboard is on port 8083 (secondary port), not 80 (proxy)
+      const dashboardUrl = `http://${localIp}:8083`
+      service.href = dashboardUrl
+      service.ping = dashboardUrl
+    } else {
+      service.href = baseUrl
+      service.ping = baseUrl
+    }
+
     // Add icon if defined in homepage meta
     if (appDef.homepage?.icon) {
       service.icon = appDef.homepage.icon
@@ -75,9 +90,6 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
       service.icon = `${appDef.id}.png`
     }
 
-    // Add ping for monitoring
-    service.ping = baseUrl
-
     // Add widget if defined
     if (appDef.homepage?.widget) {
       const apiKey = env[`API_KEY_${appDef.id.toUpperCase()}`]
@@ -114,7 +126,10 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
         // Skip widget if no API key
       }
       // Most widgets need API key - only add if available
-      else if (apiKey || ["qbittorrent", "gluetun", "traefik", "huntarr"].includes(appDef.id)) {
+      else if (
+        apiKey ||
+        ["qbittorrent", "gluetun", "traefik", "huntarr", "easiarr", "flaresolverr"].includes(appDef.id)
+      ) {
         service.widget = {
           type: widgetType,
           url: dockerUrl,
@@ -236,7 +251,10 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
 
     for (const { name, service } of services) {
       yaml += `    - ${name}:\n`
-      yaml += `        href: ${service.href}\n`
+
+      if (service.href) {
+        yaml += `        href: ${service.href}\n`
+      }
 
       if (service.icon) {
         yaml += `        icon: ${service.icon}\n`
@@ -253,7 +271,9 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
       if (service.widget) {
         yaml += `        widget:\n`
         yaml += `          type: ${service.widget.type}\n`
-        yaml += `          url: ${service.widget.url}\n`
+        if (service.widget.url) {
+          yaml += `          url: ${service.widget.url}\n`
+        }
 
         if (service.widget.key) {
           yaml += `          key: ${service.widget.key}\n`

package/src/config/schema.ts

@@ -106,6 +106,8 @@ export type AppId =
   // Download Clients
   | "qbittorrent"
   | "sabnzbd"
+  | "slskd"
+  | "soularr"
   // Media Servers
   | "plex"
   | "jellyfin"

package/src/config/slskd-config.ts

@@ -0,0 +1,85 @@
+/**
+ * Slskd Config Generator
+ * Generates slskd.yml configuration file with API keys and settings
+ * Source: https://github.com/slskd/slskd/blob/master/docs/config.md
+ */
+
+import type { EasiarrConfig } from "./schema"
+import { readEnvSync } from "../utils/env"
+import { randomBytes } from "crypto"
+
+/**
+ * Generate a random API key (base64, 48 bytes = ~64 chars)
+ * Equivalent to: openssl rand -base64 48
+ */
+export function generateSlskdApiKey(): string {
+  return randomBytes(48).toString("base64")
+}
+
+/**
+ * Generate slskd.yml content
+ * This file should be placed in the slskd config directory (/app/slskd.yml)
+ */
+export function generateSlskdConfig(_config: EasiarrConfig): { yaml: string; apiKey: string } {
+  const env = readEnvSync()
+
+  // Generate or use existing API key
+  const apiKey = env.API_KEY_SLSKD || generateSlskdApiKey()
+
+  const yaml = `# Slskd Configuration
+# Generated by Easiarr
+# Docs: https://github.com/slskd/slskd/blob/master/docs/config.md
+
+# Directories for downloads
+directories:
+  incomplete: /data/slskd_downloads/incomplete
+  downloads: /data/slskd_downloads/complete
+
+# Shares - music directory for uploading
+shares:
+  directories:
+    - /data/media/music
+
+# Web UI Configuration
+web:
+  port: 5030
+  authentication:
+    disabled: false
+    api_keys:
+      # API key for Homepage widget and Soularr
+      easiarr:
+        key: ${apiKey}
+        role: readwrite
+        cidr: 0.0.0.0/0,::/0
+
+# Soulseek Configuration
+# Credentials are set via environment variables:
+# - SLSKD_SLSK_USERNAME
+# - SLSKD_SLSK_PASSWORD
+soulseek:
+  listen_port: 50300
+  description: "slskd user via Easiarr"
+
+# Global limits
+global:
+  upload:
+    slots: 10
+    speed_limit: 1000
+  download:
+    slots: 100
+    speed_limit: 10000
+
+# Logging
+logger:
+  disk: false
+`
+
+  return { yaml, apiKey }
+}
+
+/**
+ * Get the path where slskd.yml should be saved
+ */
+export function getSlskdConfigPath(rootDir: string): string {
+  return `${rootDir}/config/slskd/slskd.yml`
+}

package/src/config/soularr-config.ts

@@ -0,0 +1,105 @@
+/**
+ * Soularr Config Generator
+ * Generates config.ini for Soularr based on easiarr configuration
+ * Source: https://github.com/mrusse/soularr
+ */
+
+import type { EasiarrConfig } from "./schema"
+import { readEnvSync } from "../utils/env"
+
+/**
+ * Generate Soularr config.ini content
+ * This file should be placed in the Soularr config directory
+ */
+export function generateSoularrConfig(config: EasiarrConfig): string {
+  const env = readEnvSync()
+
+  const lidarrApiKey = env.API_KEY_LIDARR || "yourlidarrapikeygoeshere"
+  const slskdApiKey = env.API_KEY_SLSKD || "yourslskdapikeygoeshere"
+
+  // Find Lidarr and Slskd ports from config
+  const lidarrPort = config.apps.find((a) => a.id === "lidarr")?.port || 8686
+  const slskdPort = config.apps.find((a) => a.id === "slskd")?.port || 5030
+
+  return `[Lidarr]
+# Get from Lidarr: Settings > General > Security
+api_key = ${lidarrApiKey}
+# URL Lidarr uses (internal Docker network)
+host_url = http://lidarr:${lidarrPort}
+# Path to slskd downloads inside the Lidarr container
+download_dir = /data/slskd_downloads
+# If true, Lidarr won't auto-import from Slskd (recommended: True to avoid failed_imports issues)
+disable_sync = True
+
+[Slskd]
+# Create manually in Slskd web UI
+api_key = ${slskdApiKey}
+# URL Slskd uses (internal Docker network)
+host_url = http://slskd:${slskdPort}
+url_base = /
+# Download path inside Slskd container
+download_dir = /downloads
+# Delete search after Soularr runs
+delete_searches = False
+# Max seconds to wait for downloads (prevents infinite hangs)
+stalled_timeout = 3600
+
+[Release Settings]
+# Pick release with most common track count
+use_most_common_tracknum = True
+allow_multi_disc = True
+# Accepted release countries
+accepted_countries = Europe,Japan,United Kingdom,United States,[Worldwide],Australia,Canada
+# Don't check the region of the release
+skip_region_check = False
+# Accepted formats
+accepted_formats = CD,Digital Media,Vinyl
+
+[Search Settings]
+search_timeout = 5000
+maximum_peer_queue = 50
+# Minimum upload speed (bits/sec)
+minimum_peer_upload_speed = 0
+# Minimum match ratio between Lidarr track and Soulseek filename
+minimum_filename_match_ratio = 0.8
+# Preferred file types and qualities (most to least preferred)
+allowed_filetypes = flac 24/192,flac 16/44.1,flac,mp3 320,mp3
+ignored_users = 
+# Set to False to only search for album titles
+search_for_tracks = True
+# Prepend artist name when searching
+album_prepend_artist = False
+track_prepend_artist = True
+# Search modes: all, incrementing_page, first_page
+search_type = incrementing_page
+# Albums to process per run
+number_of_albums_to_grab = 10
+# Unmonitor album on failure
+remove_wanted_on_failure = False
+# Blacklist words in album or track titles
+title_blacklist = 
+# Lidarr search source: "missing" or "cutoff_unmet"
+search_source = missing
+# Enable search denylist to skip albums that repeatedly fail
+enable_search_denylist = False
+# Number of consecutive search failures before denylisting
+max_search_failures = 3
+
+[Download Settings]
+download_filtering = True
+use_extension_whitelist = False
+extensions_whitelist = lrc,nfo,txt
+
+[Logging]
+level = INFO
+format = [%(levelname)s|%(module)s|L%(lineno)d] %(asctime)s: %(message)s
+datefmt = %Y-%m-%dT%H:%M:%S%z
+`
+}
+
+/**
+ * Get the path where Soularr config should be saved
+ */
+export function getSoularrConfigPath(rootDir: string): string {
+  return `${rootDir}/config/soularr/config.ini`
+}

package/src/config/trash-quality-definitions.ts

@@ -0,0 +1,213 @@
+/**
+ * TRaSH Guides Quality Definitions (File Size Limits)
+ * Min/Preferred/Max in MB/min
+ * Source: ../Guides/docs/json/radarr/quality-size/movie.json
+ * Source: ../Guides/docs/json/sonarr/quality-size/series.json
+ */
+
+export interface TrashQualityDefinition {
+  quality: string
+  min: number
+  preferred: number
+  max: number
+}
+
+export const TRASH_RADARR_QUALITY_DEFINITIONS: TrashQualityDefinition[] = [
+  {
+    quality: "HDTV-720p",
+    min: 17.1,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "WEBDL-720p",
+    min: 12.5,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "WEBRip-720p",
+    min: 12.5,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "Bluray-720p",
+    min: 25.7,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "HDTV-1080p",
+    min: 33.8,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "WEBDL-1080p",
+    min: 12.5,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "WEBRip-1080p",
+    min: 12.5,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "Bluray-1080p",
+    min: 50.8,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "Remux-1080p",
+    min: 102,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "HDTV-2160p",
+    min: 85,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "WEBDL-2160p",
+    min: 34.5,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "WEBRip-2160p",
+    min: 34.5,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "Bluray-2160p",
+    min: 102,
+    preferred: 1999,
+    max: 2000,
+  },
+  {
+    quality: "Remux-2160p",
+    min: 187.4,
+    preferred: 1999,
+    max: 2000,
+  },
+]
+
+export const TRASH_SONARR_QUALITY_DEFINITIONS: TrashQualityDefinition[] = [
+  {
+    quality: "HDTV-720p",
+    min: 10,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "HDTV-1080p",
+    min: 15,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "WEBRip-720p",
+    min: 10,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "WEBDL-720p",
+    min: 10,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "Bluray-720p",
+    min: 17.1,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "WEBRip-1080p",
+    min: 15,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "WEBDL-1080p",
+    min: 15,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "Bluray-1080p",
+    min: 50.4,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "Bluray-1080p Remux",
+    min: 69.1,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "HDTV-2160p",
+    min: 25,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "WEBRip-2160p",
+    min: 25,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "WEBDL-2160p",
+    min: 25,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "Bluray-2160p",
+    min: 94.6,
+    preferred: 995,
+    max: 1000,
+  },
+  {
+    quality: "Bluray-2160p Remux",
+    min: 187.4,
+    preferred: 995,
+    max: 1000,
+  },
+]
+
+/**
+ * Lidarr Quality Definitions (Davo's Community Guide)
+ * Source: https://wiki.servarr.com/lidarr/community-guide
+ * Filters out single track rips for entire albums (FLAC/CUE files)
+ */
+export const TRASH_LIDARR_QUALITY_DEFINITIONS: TrashQualityDefinition[] = [
+  {
+    quality: "FLAC",
+    min: 0,
+    preferred: 895,
+    max: 1400,
+  },
+  {
+    quality: "FLAC 24bit",
+    min: 0,
+    preferred: 895,
+    max: 1495,
+  },
+  {
+    quality: "MP3-320",
+    min: 0,
+    preferred: 0,
+    max: 0, // No size limit for MP3
+  },
+]