@muhammedaksam/easiarr 0.5.1 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muhammedaksam/easiarr",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "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",
@@ -46,6 +46,8 @@
     "test:watch": "jest --watch",
     "check": "bun run typecheck && bun run lint && bun run format:check && bun run test",
     "fix": "bun run lint:fix && bun run format",
+    "migration:create": "bun run scripts/create-migration.ts",
+    "release": "./scripts/release.sh",
     "start": "bun run src/index.ts"
   },
   "devDependencies": {

package/src/apps/registry.ts

@@ -254,13 +254,13 @@ export const APPS: Record<AppId, AppDefinition> = {
     environment: { WEBUI_PORT: "8080" },
     secrets: [
       {
-        name: "QBITTORRENT_USER",
+        name: "USERNAME_QBITTORRENT",
         description: "Username for qBittorrent WebUI",
         required: false,
         default: "admin",
       },
       {
-        name: "QBITTORRENT_PASSWORD",
+        name: "PASSWORD_QBITTORRENT",
         description: "Password for qBittorrent WebUI",
         required: false,
         mask: true,
@@ -516,19 +516,19 @@ export const APPS: Record<AppId, AppDefinition> = {
       GUACD_HOSTNAME: "guacd",
       POSTGRESQL_HOSTNAME: "postgresql",
       POSTGRESQL_DATABASE: "guacamole",
-      POSTGRESQL_USER: "${POSTGRESQL_USERNAME}",
-      POSTGRESQL_PASSWORD: "${POSTGRESQL_PASSWORD}",
+      POSTGRESQL_USER: "${USERNAME_POSTGRESQL}",
+      POSTGRESQL_PASSWORD: "${PASSWORD_POSTGRESQL}",
     },
     dependsOn: ["guacd", "postgresql"],
     secrets: [
       {
-        name: "POSTGRESQL_USERNAME",
+        name: "USERNAME_POSTGRESQL",
         description: "PostgreSQL Username",
         required: true,
         default: "postgres",
       },
       {
-        name: "POSTGRESQL_PASSWORD",
+        name: "PASSWORD_POSTGRESQL",
         description: "PostgreSQL Password",
         required: true,
         mask: true,
@@ -576,8 +576,8 @@ export const APPS: Record<AppId, AppDefinition> = {
     volumes: (root) => [`${root}/config/gluetun:/gluetun`],
     environment: {
       VPN_SERVICE_PROVIDER: "${VPN_SERVICE_PROVIDER}",
-      OPENVPN_USER: "${VPN_USERNAME}",
-      OPENVPN_PASSWORD: "${VPN_PASSWORD}",
+      OPENVPN_USER: "${USERNAME_VPN}",
+      OPENVPN_PASSWORD: "${PASSWORD_VPN}",
       WIREGUARD_PRIVATE_KEY: "${WIREGUARD_PRIVATE_KEY}",
       HTTPPROXY: "on",
       SHADOWSOCKS: "on",
@@ -590,12 +590,12 @@ export const APPS: Record<AppId, AppDefinition> = {
         default: "custom",
       },
       {
-        name: "VPN_USERNAME",
+        name: "USERNAME_VPN",
         description: "OpenVPN Username",
         required: false,
       },
       {
-        name: "VPN_PASSWORD",
+        name: "PASSWORD_VPN",
         description: "OpenVPN Password",
         required: false,
         mask: true,
@@ -777,8 +777,8 @@ export const APPS: Record<AppId, AppDefinition> = {
       AUTHENTIK_REDIS__HOST: "valkey",
       AUTHENTIK_POSTGRESQL__HOST: "postgresql",
       AUTHENTIK_POSTGRESQL__NAME: "authentik",
-      AUTHENTIK_POSTGRESQL__USER: "${POSTGRESQL_USERNAME}",
-      AUTHENTIK_POSTGRESQL__PASSWORD: "${POSTGRESQL_PASSWORD}",
+      AUTHENTIK_POSTGRESQL__USER: "${USERNAME_POSTGRESQL}",
+      AUTHENTIK_POSTGRESQL__PASSWORD: "${PASSWORD_POSTGRESQL}",
       AUTHENTIK_SECRET_KEY: "${AUTHENTIK_SECRET_KEY}",
     },
     dependsOn: ["postgresql", "valkey", "authentik-worker"],
@@ -791,13 +791,13 @@ export const APPS: Record<AppId, AppDefinition> = {
         generate: true,
       },
       {
-        name: "POSTGRESQL_USERNAME",
+        name: "USERNAME_POSTGRESQL",
         description: "Postgres Username",
         required: true,
         default: "postgres",
       },
       {
-        name: "POSTGRESQL_PASSWORD",
+        name: "PASSWORD_POSTGRESQL",
         description: "Postgres Password",
         required: true,
         mask: true,
@@ -824,8 +824,8 @@ export const APPS: Record<AppId, AppDefinition> = {
       AUTHENTIK_REDIS__HOST: "valkey",
       AUTHENTIK_POSTGRESQL__HOST: "postgresql",
       AUTHENTIK_POSTGRESQL__NAME: "authentik",
-      AUTHENTIK_POSTGRESQL__USER: "${POSTGRESQL_USERNAME}",
-      AUTHENTIK_POSTGRESQL__PASSWORD: "${POSTGRESQL_PASSWORD}",
+      AUTHENTIK_POSTGRESQL__USER: "${USERNAME_POSTGRESQL}",
+      AUTHENTIK_POSTGRESQL__PASSWORD: "${PASSWORD_POSTGRESQL}",
       AUTHENTIK_SECRET_KEY: "${AUTHENTIK_SECRET_KEY}",
     },
     dependsOn: ["postgresql", "valkey"],
@@ -842,19 +842,19 @@ export const APPS: Record<AppId, AppDefinition> = {
     pgid: 13000,
     volumes: (root) => [`${root}/config/postgresql:/var/lib/postgresql/data`],
     environment: {
-      POSTGRES_USER: "${POSTGRESQL_USERNAME}",
-      POSTGRES_PASSWORD: "${POSTGRESQL_PASSWORD}",
+      POSTGRES_USER: "${USERNAME_POSTGRESQL}",
+      POSTGRES_PASSWORD: "${PASSWORD_POSTGRESQL}",
       POSTGRES_DB: "authentik", // Default to authentik db or user needs to change?
     },
     secrets: [
       {
-        name: "POSTGRESQL_USERNAME",
+        name: "USERNAME_POSTGRESQL",
         description: "PostgreSQL Username",
         required: true,
         default: "postgres",
       },
       {
-        name: "POSTGRESQL_PASSWORD",
+        name: "PASSWORD_POSTGRESQL",
         description: "PostgreSQL Password",
         required: true,
         mask: true,

package/src/index.ts

@@ -12,11 +12,15 @@
 import { createCliRenderer } from "@opentui/core"
 import { App } from "./ui/App"
 import { initDebug } from "./utils/debug"
+import { runMigrations } from "./utils/migrations"
 
 async function main() {
   // Initialize debug logging if enabled
   initDebug()
 
+  // Run migrations to update env variable names if needed
+  await runMigrations()
+
   const renderer = await createCliRenderer({
     consoleOptions: {
       startInDebugMode: false,

package/src/ui/screens/ApiKeyViewer.ts

@@ -188,12 +188,12 @@ export class ApiKeyViewer extends BoxRenderable {
     }
 
     // Will attempt to initialize/login when saving
-    const globalPassword = env["GLOBAL_PASSWORD"]
+    const globalPassword = env["PASSWORD_GLOBAL"]
     if (!globalPassword) {
       this.keys.push({
         appId: "portainer",
         app: "Portainer",
-        key: "No GLOBAL_PASSWORD set in .env",
+        key: "No PASSWORD_GLOBAL set in .env",
         status: "missing",
       })
       return
@@ -409,7 +409,7 @@ export class ApiKeyViewer extends BoxRenderable {
       if (this.portainerCredentials) {
         updates["API_KEY_PORTAINER"] = this.portainerCredentials.apiKey
         if (this.portainerCredentials.password) {
-          updates["PORTAINER_PASSWORD"] = this.portainerCredentials.password
+          updates["PASSWORD_PORTAINER"] = this.portainerCredentials.password
         }
       }
 
@@ -438,8 +438,8 @@ export class ApiKeyViewer extends BoxRenderable {
 
   private async initializePortainer(_updates: Record<string, string>) {
     const env = readEnvSync()
-    const globalUsername = env["GLOBAL_USERNAME"] || "admin"
-    const globalPassword = env["GLOBAL_PASSWORD"]
+    const globalUsername = env["USERNAME_GLOBAL"] || "admin"
+    const globalPassword = env["PASSWORD_GLOBAL"]
 
     if (!globalPassword) return
 
@@ -478,9 +478,10 @@ export class ApiKeyViewer extends BoxRenderable {
           portainerEntry.status = "generated"
         }
       } else {
-        // Already initialized, try login
-        await client.login(globalUsername, globalPassword)
-        const apiKey = await client.generateApiKey(globalPassword, "easiarr-api-key")
+        // Already initialized, try login with saved password if available
+        const portainerPassword = env["PASSWORD_PORTAINER"] || globalPassword
+        await client.login(globalUsername, portainerPassword)
+        const apiKey = await client.generateApiKey(portainerPassword, "easiarr-api-key")
         this.portainerCredentials = { apiKey }
 
         const portainerEntry = this.keys.find((k) => k.appId === "portainer")

package/src/ui/screens/AppConfigurator.ts

@@ -83,9 +83,9 @@ export class AppConfigurator extends BoxRenderable {
 
   private loadSavedCredentials() {
     const env = readEnvSync()
-    if (env.GLOBAL_USERNAME) this.globalUsername = env.GLOBAL_USERNAME
-    if (env.GLOBAL_PASSWORD) this.globalPassword = env.GLOBAL_PASSWORD
-    if (env.QBITTORRENT_PASSWORD) this.qbPass = env.QBITTORRENT_PASSWORD
+    if (env.USERNAME_GLOBAL) this.globalUsername = env.USERNAME_GLOBAL
+    if (env.PASSWORD_GLOBAL) this.globalPassword = env.PASSWORD_GLOBAL
+    if (env.PASSWORD_QBITTORRENT) this.qbPass = env.PASSWORD_QBITTORRENT
     if (env.SABNZBD_API_KEY) this.sabApiKey = env.SABNZBD_API_KEY
   }
 
@@ -204,8 +204,8 @@ export class AppConfigurator extends BoxRenderable {
   private async saveGlobalCredentialsToEnv() {
     try {
       const updates: Record<string, string> = {}
-      if (this.globalUsername) updates.GLOBAL_USERNAME = this.globalUsername
-      if (this.globalPassword) updates.GLOBAL_PASSWORD = this.globalPassword
+      if (this.globalUsername) updates.USERNAME_GLOBAL = this.globalUsername
+      if (this.globalPassword) updates.PASSWORD_GLOBAL = this.globalPassword
       await updateEnv(updates)
     } catch {
       // Ignore errors - not critical
@@ -610,7 +610,7 @@ export class AppConfigurator extends BoxRenderable {
     try {
       const updates: Record<string, string> = {}
       if (type === "qbittorrent" && this.qbPass) {
-        updates.QBITTORRENT_PASSWORD = this.qbPass
+        updates.PASSWORD_QBITTORRENT = this.qbPass
       } else if (type === "sabnzbd" && this.sabApiKey) {
         updates.SABNZBD_API_KEY = this.sabApiKey
       }

package/src/ui/screens/FullAutoSetup.ts

@@ -63,8 +63,8 @@ export class FullAutoSetup extends BoxRenderable {
     this.pageContainer = pageContainer
 
     this.env = readEnvSync()
-    this.globalUsername = this.env["GLOBAL_USERNAME"] || "admin"
-    this.globalPassword = this.env["GLOBAL_PASSWORD"] || ""
+    this.globalUsername = this.env["USERNAME_GLOBAL"] || "admin"
+    this.globalPassword = this.env["PASSWORD_GLOBAL"] || ""
 
     this.initKeyHandler()
     this.initSteps()
@@ -176,7 +176,7 @@ export class FullAutoSetup extends BoxRenderable {
     this.refreshContent()
 
     if (!this.globalPassword) {
-      this.updateStep("Authentication", "skipped", "No GLOBAL_PASSWORD set")
+      this.updateStep("Authentication", "skipped", "No PASSWORD_GLOBAL set")
       this.refreshContent()
       return
     }
@@ -303,11 +303,11 @@ export class FullAutoSetup extends BoxRenderable {
     try {
       const host = "localhost"
       const port = qbConfig.port || 8080
-      const user = this.env["QBITTORRENT_USER"] || "admin"
-      const pass = this.env["QBITTORRENT_PASSWORD"] || this.env["QBITTORRENT_PASS"] || ""
+      const user = this.env["USERNAME_QBITTORRENT"] || "admin"
+      const pass = this.env["PASSWORD_QBITTORRENT"] || this.env["QBITTORRENT_PASS"] || ""
 
       if (!pass) {
-        this.updateStep("qBittorrent", "skipped", "No QBITTORRENT_PASSWORD in .env")
+        this.updateStep("qBittorrent", "skipped", "No PASSWORD_QBITTORRENT in .env")
         this.refreshContent()
         return
       }
@@ -347,7 +347,7 @@ export class FullAutoSetup extends BoxRenderable {
     }
 
     if (!this.globalPassword) {
-      this.updateStep("Portainer", "skipped", "No GLOBAL_PASSWORD set")
+      this.updateStep("Portainer", "skipped", "No PASSWORD_GLOBAL set")
       this.refreshContent()
       return
     }
@@ -377,7 +377,7 @@ export class FullAutoSetup extends BoxRenderable {
 
         // Save password if it was padded (different from global)
         if (result.passwordWasPadded) {
-          envUpdates.PORTAINER_PASSWORD = result.actualPassword
+          envUpdates.PASSWORD_PORTAINER = result.actualPassword
         }
 
         await updateEnv(envUpdates)
@@ -386,8 +386,10 @@ export class FullAutoSetup extends BoxRenderable {
         // Already initialized, try to login and get API key if we don't have one
         if (!this.env["API_KEY_PORTAINER"]) {
           try {
-            await client.login(this.globalUsername, this.globalPassword)
-            const apiKey = await client.generateApiKey(this.globalPassword, "easiarr-api-key")
+            // Use saved Portainer password if available (may have been padded)
+            const portainerPassword = this.env["PASSWORD_PORTAINER"] || this.globalPassword
+            await client.login(this.globalUsername, portainerPassword)
+            const apiKey = await client.generateApiKey(portainerPassword, "easiarr-api-key")
             await updateEnv({ API_KEY_PORTAINER: apiKey })
             this.updateStep("Portainer", "success", "API key generated")
           } catch {

package/src/utils/migrations/1765626338_rename_env_variables.ts

@@ -0,0 +1,101 @@
+/**
+ * Migration: Rename env variables to new format
+ *
+ * OLD: GLOBAL_PASSWORD, QBITTORRENT_USER, etc.
+ * NEW: PASSWORD_GLOBAL, USERNAME_QBITTORRENT, etc.
+ */
+
+import { existsSync, readFileSync, writeFileSync } from "node:fs"
+import { join } from "node:path"
+import { homedir } from "node:os"
+import { parseEnvFile, serializeEnv } from "../env"
+import { debugLog } from "../debug"
+
+const ENV_FILE = join(homedir(), ".easiarr", ".env")
+
+export const name = "rename-env-variables"
+
+const renames: [string, string][] = [
+  // Global credentials
+  ["GLOBAL_PASSWORD", "PASSWORD_GLOBAL"],
+  ["GLOBAL_USERNAME", "USERNAME_GLOBAL"],
+  // qBittorrent
+  ["QBITTORRENT_PASSWORD", "PASSWORD_QBITTORRENT"],
+  ["QBITTORRENT_USER", "USERNAME_QBITTORRENT"],
+  ["QBITTORRENT_PASS", "PASSWORD_QBITTORRENT"], // Legacy alias
+  // Portainer
+  ["PORTAINER_PASSWORD", "PASSWORD_PORTAINER"],
+  // PostgreSQL
+  ["POSTGRESQL_USERNAME", "USERNAME_POSTGRESQL"],
+  ["POSTGRESQL_PASSWORD", "PASSWORD_POSTGRESQL"],
+  // VPN
+  ["VPN_USERNAME", "USERNAME_VPN"],
+  ["VPN_PASSWORD", "PASSWORD_VPN"],
+]
+
+export function up(): boolean {
+  if (!existsSync(ENV_FILE)) {
+    debugLog("Migrations", "No .env file found, skipping migration")
+    return false
+  }
+
+  try {
+    const content = readFileSync(ENV_FILE, "utf-8")
+    const env = parseEnvFile(content)
+    let changed = false
+
+    for (const [oldKey, newKey] of renames) {
+      if (env[oldKey] !== undefined && env[newKey] === undefined) {
+        env[newKey] = env[oldKey]
+        delete env[oldKey]
+        changed = true
+        debugLog("Migrations", `Renamed ${oldKey} → ${newKey}`)
+      }
+    }
+
+    if (changed) {
+      writeFileSync(ENV_FILE, serializeEnv(env), "utf-8")
+      debugLog("Migrations", "Migration completed: env variables 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(ENV_FILE)) {
+    return false
+  }
+
+  try {
+    const content = readFileSync(ENV_FILE, "utf-8")
+    const env = parseEnvFile(content)
+    let changed = false
+
+    for (const [oldKey, newKey] of renames) {
+      // Reverse operation: restore oldKey from newKey
+      if (env[newKey] !== undefined && env[oldKey] === undefined) {
+        env[oldKey] = env[newKey]
+        delete env[newKey]
+        changed = true
+        debugLog("Migrations", `Rolled back ${newKey} → ${oldKey}`)
+      }
+    }
+
+    if (changed) {
+      writeFileSync(ENV_FILE, serializeEnv(env), "utf-8")
+      debugLog("Migrations", "Rollback completed: env variables restored")
+      return true
+    }
+
+    return false
+  } catch (e) {
+    debugLog("Migrations", `Rollback error: ${e}`)
+    return false
+  }
+}

package/src/utils/migrations.ts

@@ -0,0 +1,110 @@
+/**
+ * Migration Runner
+ * Sequelize-style migrations with Unix timestamp naming
+ *
+ * Migration files: src/utils/migrations/{timestamp}_{name}.ts
+ * Each migration exports: name, up()
+ */
+
+import { existsSync, readFileSync, writeFileSync } from "node:fs"
+import { join } from "node:path"
+import { homedir } from "node:os"
+import { debugLog } from "./debug"
+
+const EASIARR_DIR = join(homedir(), ".easiarr")
+const MIGRATIONS_FILE = join(EASIARR_DIR, ".migrations.json")
+
+interface MigrationState {
+  applied: string[] // List of applied migration timestamps
+  lastRun: string
+}
+
+interface Migration {
+  timestamp: string
+  name: string
+  up: () => boolean
+  down: () => boolean
+}
+
+/**
+ * Get the current migration state
+ */
+function getMigrationState(): MigrationState {
+  if (!existsSync(MIGRATIONS_FILE)) {
+    return { applied: [], lastRun: "" }
+  }
+
+  try {
+    const content = readFileSync(MIGRATIONS_FILE, "utf-8")
+    return JSON.parse(content) as MigrationState
+  } catch {
+    return { applied: [], lastRun: "" }
+  }
+}
+
+/**
+ * Save the migration state
+ */
+function saveMigrationState(state: MigrationState): void {
+  state.lastRun = new Date().toISOString()
+  writeFileSync(MIGRATIONS_FILE, JSON.stringify(state, null, 2), "utf-8")
+}
+
+/**
+ * Load all migration modules
+ */
+async function loadMigrations(): Promise<Migration[]> {
+  const migrations: Migration[] = []
+
+  // Import migrations directly - bundled at build time
+  try {
+    const m1 = await import("./migrations/1765626338_rename_env_variables")
+    migrations.push({
+      timestamp: "1765626338",
+      name: m1.name,
+      up: m1.up,
+      down: m1.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 })
+
+  return migrations.sort((a, b) => a.timestamp.localeCompare(b.timestamp))
+}
+
+/**
+ * Run all pending migrations
+ */
+export async function runMigrations(): Promise<void> {
+  const state = getMigrationState()
+  const migrations = await loadMigrations()
+
+  let hasChanges = false
+
+  for (const migration of migrations) {
+    if (state.applied.includes(migration.timestamp)) {
+      continue
+    }
+
+    debugLog("Migrations", `Running migration ${migration.timestamp}_${migration.name}`)
+
+    try {
+      migration.up()
+      state.applied.push(migration.timestamp)
+      hasChanges = true
+      debugLog("Migrations", `Migration ${migration.timestamp} completed`)
+    } catch (e) {
+      debugLog("Migrations", `Migration ${migration.timestamp} failed: ${e}`)
+    }
+  }
+
+  if (hasChanges) {
+    saveMigrationState(state)
+  } else {
+    debugLog("Migrations", "No pending migrations")
+  }
+}