@muhammedaksam/easiarr 0.8.4 → 0.8.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muhammedaksam/easiarr",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "description": "TUI tool for generating docker-compose files for the *arr media ecosystem with 41 apps, TRaSH Guides best practices, VPN routing, and Traefik reverse proxy support",
   "module": "src/index.ts",
   "type": "module",

package/src/api/jellyfin-api.ts

@@ -136,7 +136,7 @@ export class JellyfinClient {
       "Content-Type": "application/json",
       // Jellyfin requires client identification
       "X-Emby-Authorization":
-        'MediaBrowser Client="Easiarr", Device="Server", DeviceId="easiarr-setup", Version="1.0.0"' +
+        'MediaBrowser Client="easiarr", Device="Server", DeviceId="easiarr-setup", Version="1.0.0"' +
         (this.accessToken ? `, Token="${this.accessToken}"` : ""),
       ...((options.headers as Record<string, string>) || {}),
     }

package/src/apps/registry.ts

@@ -583,17 +583,20 @@ export const APPS: Record<AppId, AppDefinition> = {
     volumes: (root) => [`${root}/config/ddns-updater:/data`],
   },
 
-  "easiarr-status": {
-    id: "easiarr-status",
-    name: "Easiarr Status",
-    description: "Exposes Easiarr version for Homepage dashboard",
+  easiarr: {
+    id: "easiarr",
+    name: "easiarr",
+    description: "Exposes easiarr config and bookmarks for Homepage dashboard",
     category: "utility",
     defaultPort: 3010,
     internalPort: 8080,
     image: "halverneus/static-file-server:latest",
     puid: 0,
     pgid: 0,
-    volumes: () => ["${HOME}/.easiarr/config.json:/web/config.json:ro"],
+    volumes: () => [
+      "${HOME}/.easiarr/config.json:/web/config.json:ro",
+      "${HOME}/.easiarr/bookmarks.html:/web/bookmarks.html:ro",
+    ],
     environment: {
       FOLDER: "/web",
       CORS: "true",
@@ -602,7 +605,7 @@ export const APPS: Record<AppId, AppDefinition> = {
       icon: "mdi-docker",
       widget: "customapi",
       widgetFields: {
-        url: "http://easiarr-status:8080/config.json",
+        url: "http://easiarr:8080/config.json",
         mappings: JSON.stringify([{ field: "version", label: "Installed" }]),
       },
     },

package/src/compose/generator.ts

@@ -1,6 +1,6 @@
 /**
  * Docker Compose Generator
- * Generates docker-compose.yml from Easiarr configuration
+ * Generates docker-compose.yml from easiarr configuration
  */
 
 import { writeFile } from "node:fs/promises"

package/src/config/bookmarks-generator.ts

@@ -0,0 +1,127 @@
+/**
+ * Bookmarks Generator
+ * Generates Netscape-format HTML bookmarks for browser import
+ */
+
+import { writeFile } from "node:fs/promises"
+import { join } from "node:path"
+import { homedir } from "node:os"
+import type { EasiarrConfig, AppCategory } from "./schema"
+import { APP_CATEGORIES } from "./schema"
+import { CATEGORY_ORDER } from "../apps/categories"
+import { getApp } from "../apps/registry"
+import { readEnvSync } from "../utils/env"
+
+interface BookmarkEntry {
+  name: string
+  url: string
+  description: string
+}
+
+type CategoryBookmarks = Map<AppCategory, BookmarkEntry[]>
+
+/**
+ * Get the URL for an app based on Traefik configuration
+ */
+function getAppUrl(appId: string, port: number, config: EasiarrConfig, useLocalUrls: boolean): string {
+  if (!useLocalUrls && config.traefik?.enabled && config.traefik.domain) {
+    return `https://${appId}.${config.traefik.domain}/`
+  }
+  // Read LOCAL_DOCKER_IP from .env file, fallback to localhost
+  const env = readEnvSync()
+  const host = env.LOCAL_DOCKER_IP || "localhost"
+  return `http://${host}:${port}/`
+}
+
+/**
+ * Generate bookmark entries grouped by category
+ */
+function generateBookmarksByCategory(config: EasiarrConfig, useLocalUrls: boolean): CategoryBookmarks {
+  const categoryBookmarks: CategoryBookmarks = new Map()
+
+  for (const appConfig of config.apps) {
+    if (!appConfig.enabled) continue
+
+    const appDef = getApp(appConfig.id)
+    if (!appDef) continue
+
+    const port = appConfig.port ?? appDef.defaultPort
+    const url = getAppUrl(appConfig.id, port, config, useLocalUrls)
+
+    const entry: BookmarkEntry = {
+      name: appDef.name,
+      url,
+      description: appDef.description,
+    }
+
+    const category = appDef.category
+    if (!categoryBookmarks.has(category)) {
+      categoryBookmarks.set(category, [])
+    }
+    categoryBookmarks.get(category)!.push(entry)
+  }
+
+  return categoryBookmarks
+}
+
+/**
+ * Generate Netscape-format HTML bookmarks
+ */
+export function generateBookmarksHtml(config: EasiarrConfig, useLocalUrls = false): string {
+  const categoryBookmarks = generateBookmarksByCategory(config, useLocalUrls)
+
+  let html = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
+<TITLE>Bookmarks</TITLE>
+<H1>Bookmarks</H1>
+<DL><p>
+    <DT><H3 PERSONAL_TOOLBAR_FOLDER="true">easiarr</H3>
+    <DL><p>
+`
+
+  // Add external resources first
+  html += `        <DT><A HREF="https://github.com/muhammedaksam/easiarr/">GitHub | easiarr Project Repo</A>\n`
+  html += `        <DT><A HREF="https://trash-guides.info/">TRaSH Guides</A>\n`
+
+  // Add apps grouped by category in defined order
+  for (const { id: categoryId } of CATEGORY_ORDER) {
+    const bookmarks = categoryBookmarks.get(categoryId)
+    if (!bookmarks || bookmarks.length === 0) continue
+
+    const categoryName = APP_CATEGORIES[categoryId]
+
+    // Add category header as a folder
+    html += `        <DT><H3>${categoryName}</H3>\n`
+    html += `        <DL><p>\n`
+
+    for (const bookmark of bookmarks) {
+      html += `            <DT><A HREF="${bookmark.url}">${bookmark.name} | ${bookmark.description}</A>\n`
+    }
+
+    html += `        </DL><p>\n`
+  }
+
+  // Close the structure
+  html += `    </DL><p>
+</DL><p>
+`
+
+  return html
+}
+
+/**
+ * Get the path to the bookmarks file
+ */
+export function getBookmarksPath(): string {
+  return join(homedir(), ".easiarr", "bookmarks.html")
+}
+
+/**
+ * Save bookmarks HTML file
+ */
+export async function saveBookmarks(config: EasiarrConfig, useLocalUrls = false): Promise<string> {
+  const html = generateBookmarksHtml(config, useLocalUrls)
+  const path = getBookmarksPath()
+  await writeFile(path, html, "utf-8")
+  return path
+}

package/src/config/homepage-config.ts

@@ -134,18 +134,18 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
   }
 
   // Build YAML output
-  let yaml = "---\n# Auto-generated by Easiarr\n# https://github.com/muhammedaksam/easiarr\n\n"
+  let yaml = "---\n# Auto-generated by easiarr\n# https://github.com/muhammedaksam/easiarr\n\n"
 
-  // Add Easiarr info section with two widgets - one for installed, one for latest
-  yaml += `- Easiarr:\n`
-  // Installed version from local easiarr-status container
+  // Add easiarr info section with two widgets - one for installed, one for latest
+  yaml += `- easiarr:\n`
+  // Installed version from local easiarr container
   yaml += `    - Installed:\n`
   yaml += `        href: https://github.com/muhammedaksam/easiarr\n`
   yaml += `        icon: mdi-docker\n`
   yaml += `        description: Your current version\n`
   yaml += `        widget:\n`
   yaml += `          type: customapi\n`
-  yaml += `          url: http://easiarr-status:8080/config.json\n`
+  yaml += `          url: http://easiarr:8080/config.json\n`
   yaml += `          refreshInterval: 3600000\n` // 1 hour
   yaml += `          mappings:\n`
   yaml += `            - field: version\n`
@@ -237,10 +237,10 @@ export async function generateServicesYaml(config: EasiarrConfig): Promise<strin
  */
 export function generateSettingsYaml(): string {
   return `---
-# Auto-generated by Easiarr
+# Auto-generated by easiarr
 # For configuration options: https://gethomepage.dev/configs/settings/
 
-title: Easiarr Dashboard
+title: easiarr Dashboard
 
 # Background: "Close-up Photography of Leaves With Droplets"
 # Photo by Sohail Nachiti: https://www.pexels.com/photo/close-up-photography-of-leaves-with-droplets-807598/

package/src/config/schema.ts

@@ -1,5 +1,5 @@
 /**
- * Easiarr Configuration Schema
+ * easiarr Configuration Schema
  * TypeScript interfaces for configuration management
  */
 
@@ -120,7 +120,7 @@ export type AppId =
   | "guacamole"
   | "guacd"
   | "ddns-updater"
-  | "easiarr-status"
+  | "easiarr"
   // VPN
   | "gluetun"
   // Monitoring & Infra

package/src/index.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env bun
 /**
- * Easiarr Entry Point
+ * easiarr Entry Point
  * TUI tool for generating docker-compose files for the *arr ecosystem
  *
  * Usage:

package/src/ui/screens/JellyfinSetup.ts

@@ -301,7 +301,7 @@ export class JellyfinSetup extends BoxRenderable {
       // Generate API key
       this.results[1].status = "configuring"
       this.refreshContent()
-      const apiKey = await this.jellyfinClient.createApiKey("Easiarr")
+      const apiKey = await this.jellyfinClient.createApiKey("easiarr")
       if (!apiKey) {
         throw new Error("Failed to create API key")
       }

package/src/ui/screens/MainMenu.ts

@@ -1,6 +1,6 @@
 /**
  * Main Menu Screen
- * Central navigation hub for Easiarr
+ * Central navigation hub for easiarr
  */
 
 import type { RenderContext, CliRenderer } from "@opentui/core"
@@ -9,6 +9,8 @@ import type { App } from "../App"
 import type { EasiarrConfig } from "../../config/schema"
 import { createPageLayout } from "../components/PageLayout"
 import { saveCompose } from "../../compose"
+import { saveBookmarks } from "../../config/bookmarks-generator"
+import { openUrl } from "../../utils/browser"
 import { ApiKeyViewer } from "./ApiKeyViewer"
 import { AppConfigurator } from "./AppConfigurator"
 import { TRaSHProfileSetup } from "./TRaSHProfileSetup"
@@ -138,6 +140,34 @@ export class MainMenu {
         action: () => this.showScreen(JellyseerrSetup),
       })
     }
+    // Bookmark generation options
+    const generateAndOpenBookmarks = async (useLocalUrls: boolean) => {
+      await saveBookmarks(this.config, useLocalUrls)
+      // Open in browser if easiarr service is enabled
+      if (this.isAppEnabled("easiarr")) {
+        const port = this.config.apps.find((a) => a.id === "easiarr")?.port ?? 3010
+        await openUrl(`http://localhost:${port}/bookmarks.html`)
+      }
+    }
+
+    if (this.config.traefik?.enabled) {
+      items.push({
+        name: "📑 Bookmarks (Local URLs)",
+        description: "Generate bookmarks using localhost addresses",
+        action: async () => generateAndOpenBookmarks(true),
+      })
+      items.push({
+        name: "📑 Bookmarks (Traefik URLs)",
+        description: `Generate bookmarks using ${this.config.traefik.domain} addresses`,
+        action: async () => generateAndOpenBookmarks(false),
+      })
+    } else {
+      items.push({
+        name: "📑 Generate Bookmarks",
+        description: "Create browser-importable bookmarks file",
+        action: async () => generateAndOpenBookmarks(true),
+      })
+    }
 
     items.push({
       name: "❌ Exit",

package/src/ui/screens/QuickSetup.ts

@@ -1,6 +1,6 @@
 /**
  * Quick Setup Wizard
- * First-time setup flow for Easiarr
+ * First-time setup flow for easiarr
  */
 import { homedir } from "node:os"
 
@@ -41,7 +41,7 @@ export class QuickSetup {
     "jellyseerr",
     "flaresolverr",
     "homepage",
-    "easiarr-status",
+    "easiarr",
   ])
 
   private rootDir: string = `${homedir()}/media`
@@ -208,7 +208,7 @@ export class QuickSetup {
       selectedBackgroundColor: "#3a4a6e",
       options: [
         { name: "▶ Start Setup", description: "Begin the configuration wizard" },
-        { name: "📖 About", description: "Learn more about Easiarr" },
+        { name: "📖 About", description: "Learn more about easiarr" },
         { name: "✕ Exit", description: "Quit the application" },
       ],
     })

package/src/utils/browser.ts

@@ -0,0 +1,26 @@
+/**
+ * Browser Utilities
+ * Open URLs in the default browser
+ */
+
+import { $ } from "bun"
+import { platform } from "node:os"
+
+/**
+ * Open a URL in the default browser
+ */
+export async function openUrl(url: string): Promise<void> {
+  const os = platform()
+
+  try {
+    if (os === "linux") {
+      await $`xdg-open ${url}`.quiet()
+    } else if (os === "darwin") {
+      await $`open ${url}`.quiet()
+    } else if (os === "win32") {
+      await $`cmd /c start ${url}`.quiet()
+    }
+  } catch {
+    // Silently fail if browser can't be opened
+  }
+}

package/src/utils/debug.ts

@@ -1,5 +1,5 @@
 /**
- * Debug logging utility for Easiarr
+ * Debug logging utility for easiarr
  *
  * Enable debug logging via:
  * - CLI flag: easiarr --debug
@@ -25,7 +25,7 @@ const logFile = join(easiarrDir, "debug.log")
 export function initDebug(): void {
   if (!DEBUG_ENABLED) return
   try {
-    writeFileSync(logFile, `=== Easiarr Debug Log - ${new Date().toISOString()} ===\n`)
+    writeFileSync(logFile, `=== easiarr Debug Log - ${new Date().toISOString()} ===\n`)
   } catch {
     // Ignore
   }

package/src/utils/migrations/1765707135_rename_easiarr_status.ts

@@ -0,0 +1,90 @@
+/**
+ * Migration: rename easiarr-status to easiarr
+ *
+ * OLD: { "id": "easiarr-status", "enabled": true }
+ * NEW: { "id": "easiarr", "enabled": true }
+ */
+
+import { existsSync, readFileSync, writeFileSync } from "node:fs"
+import { join } from "node:path"
+import { homedir } from "node:os"
+import { debugLog } from "../debug"
+
+const CONFIG_FILE = join(homedir(), ".easiarr", "config.json")
+
+export const name = "rename_easiarr_status"
+
+export function up(): boolean {
+  if (!existsSync(CONFIG_FILE)) {
+    debugLog("Migrations", "No config.json file found, skipping migration")
+    return false
+  }
+
+  try {
+    const content = readFileSync(CONFIG_FILE, "utf-8")
+    const config = JSON.parse(content)
+
+    if (!config.apps || !Array.isArray(config.apps)) {
+      debugLog("Migrations", "No apps array in config, skipping migration")
+      return false
+    }
+
+    let changed = false
+
+    for (const app of config.apps) {
+      if (app.id === "easiarr-status") {
+        app.id = "easiarr"
+        changed = true
+        debugLog("Migrations", "Renamed easiarr-status → easiarr")
+      }
+    }
+
+    if (changed) {
+      writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), "utf-8")
+      debugLog("Migrations", "Migration completed: app id renamed")
+      return true
+    }
+
+    debugLog("Migrations", "No changes needed")
+    return false
+  } catch (e) {
+    debugLog("Migrations", `Migration error: ${e}`)
+    return false
+  }
+}
+
+export function down(): boolean {
+  if (!existsSync(CONFIG_FILE)) {
+    return false
+  }
+
+  try {
+    const content = readFileSync(CONFIG_FILE, "utf-8")
+    const config = JSON.parse(content)
+
+    if (!config.apps || !Array.isArray(config.apps)) {
+      return false
+    }
+
+    let changed = false
+
+    for (const app of config.apps) {
+      if (app.id === "easiarr") {
+        app.id = "easiarr-status"
+        changed = true
+        debugLog("Migrations", "Rolled back easiarr → easiarr-status")
+      }
+    }
+
+    if (changed) {
+      writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), "utf-8")
+      debugLog("Migrations", "Rollback completed: app id restored")
+      return true
+    }
+
+    return false
+  } catch (e) {
+    debugLog("Migrations", `Rollback error: ${e}`)
+    return false
+  }
+}

package/src/utils/migrations.ts

@@ -69,6 +69,18 @@ async function loadMigrations(): Promise<Migration[]> {
     debugLog("Migrations", `Failed to load migration: ${e}`)
   }
 
+  try {
+    const m1765707135 = await import("./migrations/1765707135_rename_easiarr_status")
+    migrations.push({
+      timestamp: "1765707135",
+      name: m1765707135.name,
+      up: m1765707135.up,
+      down: m1765707135.down,
+    })
+  } catch (e) {
+    debugLog("Migrations", `Failed to load migration: ${e}`)
+  }
+
   // Add future migrations here:
   // const m2 = await import("./migrations/1734xxxxxx_xxx")
   // migrations.push({ timestamp: "...", name: m2.name, up: m2.up })