@riligar/elysia-backup 1.8.2 → 1.10.0

package/README.md

@@ -41,7 +41,6 @@ const app = new Elysia()
     .use(
         r2Backup({
             sourceDir: './data',
-            configPath: './backup-config.json',
         })
     )
     .listen(3000)
@@ -60,10 +59,10 @@ On first run, you'll be guided through an onboarding wizard to configure:
 
 ### Plugin Options
 
-| Option       | Type   | Required | Description                                                   |
-| ------------ | ------ | -------- | ------------------------------------------------------------- |
-| `sourceDir`  | string | ✅       | Local directory to backup                                     |
-| `configPath` | string | ❌       | Path to save runtime config (default: `./backup-config.json`) |
+| Option       | Type   | Required | Description                                                         |
+| ------------ | ------ | -------- | ------------------------------------------------------------------- |
+| `sourceDir`  | string | ✅       | Local directory to backup                                           |
+| `configPath` | string | ❌       | Path to save runtime config (default: same directory as `sourceDir`) |
 
 ### Runtime Configuration (via UI or backup-config.json)
 
@@ -119,6 +118,27 @@ The plugin adds the following routes under `/backup`:
 | POST   | `/backup/api/totp/verify`   | Verify and enable 2FA         |
 | POST   | `/backup/api/totp/disable`  | Disable 2FA                   |
 
+## ☁️ Cloud Deployment (Fly.io, Railway, etc.)
+
+For cloud platforms with ephemeral file systems, mount a persistent volume at your `sourceDir` path. The configuration file will be automatically saved alongside your data:
+
+```javascript
+import { Elysia } from 'elysia'
+import { r2Backup } from '@riligar/elysia-backup'
+
+const app = new Elysia()
+    .use(
+        r2Backup({
+            // Mount your persistent volume here
+            // Config will be saved at /data/backup-config.json
+            sourceDir: '/data',
+        })
+    )
+    .listen(3000)
+```
+
+This ensures both your backup data and configuration persist across deployments and restarts.
+
 ## 🔐 Security Features
 
 ### Session-Based Authentication

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riligar/elysia-backup",
-  "version": "1.8.2",
+  "version": "1.10.0",
   "description": "Elysia plugin for R2/S3 backup with a built-in UI dashboard",
   "type": "module",
   "main": "src/index.js",
@@ -42,8 +42,7 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "elysia": ">=1.0.0",
-    "@elysiajs/html": ">=1.0.0"
+    "elysia": ">=1.0.0"
   },
   "dependencies": {
     "cron": "^3.5.0",

package/src/core/config.js

@@ -1,5 +1,6 @@
 import { readFileSync, existsSync } from 'node:fs'
 import { writeFile } from 'node:fs/promises'
+import { dirname, join } from 'node:path'
 
 /**
  * Load configuration from a JSON file
@@ -43,7 +44,8 @@ export const saveConfig = async (configPath, config) => {
  * @returns {Object} Configuration manager with get/set/save methods
  */
 export const createConfigManager = initialConfig => {
-    const configPath = initialConfig.configPath || './backup-config.json'
+    // If configPath not specified, save config alongside sourceDir for cloud deployments
+    const configPath = initialConfig.configPath || join(dirname(initialConfig.sourceDir), 'backup-config.json')
     const savedConfig = loadConfig(configPath)
 
     let config = { ...initialConfig, ...savedConfig }

package/src/index.js

@@ -5,7 +5,12 @@ import { authenticator } from 'otplib'
 import QRCode from 'qrcode'
 import { writeFile } from 'node:fs/promises'
 import { readFileSync, existsSync } from 'node:fs'
-import { html } from '@elysiajs/html'
+import { dirname, join } from 'node:path'
+// Helper to return HTML responses with proper Content-Type
+const htmlResponse = content =>
+    new Response(content, {
+        headers: { 'Content-Type': 'text/html; charset=utf-8' },
+    })
 
 // Import core modules
 import { createSessionManager } from './core/session.js'
@@ -32,11 +37,12 @@ const sessionManager = createSessionManager()
  * @param {string} [config.prefix] - Optional prefix for S3 keys (e.g. 'backups/')
  * @param {string} [config.cronSchedule] - Cron schedule expression
  * @param {boolean} [config.cronEnabled] - Whether the cron schedule is enabled
- * @param {string} [config.configPath] - Path to save runtime configuration (default: './backup-config.json')
+ * @param {string} [config.configPath] - Path to save runtime configuration (default: same directory as sourceDir)
  */
 export const r2Backup = initialConfig => app => {
     // State to hold runtime configuration (allows UI updates)
-    const configPath = initialConfig.configPath || './backup-config.json'
+    // If configPath not specified, save config alongside sourceDir for cloud deployments
+    const configPath = initialConfig.configPath || join(dirname(initialConfig.sourceDir), 'backup-config.json')
 
     // Load saved config if exists
     let savedConfig = {}
@@ -76,7 +82,7 @@ export const r2Backup = initialConfig => app => {
     // Setup initial cron schedule
     scheduler.setup(config.cronSchedule, config.cronEnabled !== false)
 
-    return app.use(html({ autoDoctype: 'full' })).group('/backup', app => {
+    return app.group('/backup', app => {
         // Authentication Middleware
         const authMiddleware = context => {
             // Skip auth entirely if no valid config (needs onboarding)
@@ -138,7 +144,7 @@ export const r2Backup = initialConfig => app => {
                         return
                     }
 
-                    return LoginPage({ totpEnabled: !!config.auth?.totpSecret })
+                    return htmlResponse(LoginPage({ totpEnabled: !!config.auth?.totpSecret }))
                 })
 
                 // AUTH: Login Endpoint
@@ -452,7 +458,7 @@ export const r2Backup = initialConfig => app => {
                         set.headers['Location'] = '/backup'
                         return
                     }
-                    return OnboardingPage({ sourceDir: config.sourceDir })
+                    return htmlResponse(OnboardingPage({ sourceDir: config.sourceDir }))
                 })
 
                 // ONBOARDING: Save Initial Config
@@ -535,7 +541,7 @@ export const r2Backup = initialConfig => app => {
 
                     const jobStatus = scheduler.getStatus(config.cronEnabled)
                     const hasAuth = !!(config.auth && config.auth.username && config.auth.password)
-                    return DashboardPage({ config, jobStatus, hasAuth })
+                    return htmlResponse(DashboardPage({ config, jobStatus, hasAuth }))
                 })
         )
     })