Compare commits

..
3 Commits
Author SHA1 Message Date
Hermes afcccf811e release: 1.8.0 — service categories, monitoring widgets, update UX, fail2ban watchdog
CI / Test & Lint (push) Has been cancelled
CI / Security audit (push) Has been cancelled
2026-06-10 12:52:13 -07:00
hermes 0aa7244cf4 infra: Samihost fail2ban watchdog (auto-unban trusted IPs, drift guard, cap at 200)
CI / Test & Lint (push) Has been cancelled
CI / Security audit (push) Has been cancelled
2026-06-10 11:28:42 -07:00
Hermes 1d8919532b feat: service categories end-to-end + monitoring widgets on main dashboard
CI / Test & Lint (push) Has been cancelled
CI / Security audit (push) Has been cancelled
Service categories (described in README roadmap, never wired):
- Backend: POST /services now persists category/containerId/port/ip/tailscaleOnly
- Backend: POST /services/update accepts category for in-place changes
- Frontend: category <select> in add-service modal (local + external)
- Frontend: category <select> in edit-service modal with current value
- Frontend: All Categories dropdown in service filter bar (auto-populated
  from both API categories and any categories present on rendered cards)
- Frontend: colored category badge (icon + name) on service cards
- Frontend: filter auto-refreshes after buildGrid

Monitoring on main dashboard (replaces orphaned monitoring-dashboard.html):
- New monitoring-widgets.js embeds a 5-card System Overview panel above
  the filter bar: Services, Containers Up, Avg CPU, Avg Memory, Health
- Pulls /api/v1/monitoring/stats + /api/v1/health-checks/status
- Auto-refreshes on DC.POLL.STATS (5s), color-coded bars (warn >=65%, bad >=85%)

Build:
- Added monitoring-widgets.js to init.js bundle in build.js
- Rebuilt dist/ bundles (core.js, features.js, init.js)
- sw.js cache version bumped automatically
- CSP hash regenerated
2026-06-10 01:49:27 -07:00
47 changed files with 1820 additions and 2080 deletions
-15
View File
@@ -2,8 +2,6 @@
node_modules/
# Runtime state/config files (generated, not source)
# Note: data/ subdir contains runtime state (credentials, secrets, history) — never commit
dashcaddy-api/data/
dashcaddy-api/credentials.json
dashcaddy-api/.env
.env
@@ -19,19 +17,6 @@ dashcaddy-api/update-config.json
dashcaddy-api/update-history.json
dashcaddy-api/dashcaddy-errors.log
# Auto-updater backups (created by dashcaddy-update.sh when rolling back)
start.sh.bak*
scripts/*.bak*
# Auto-updater runtime state (history + secrets + staging)
updates/
# Scratch / debug scripts (left over from past sessions)
cm_check*.js
full_test.js
login_test.js
login_backup_test.js
# Build output
dashcaddy-installer/build-output/
dashcaddy-installer/dist/
-92
View File
@@ -1,92 +0,0 @@
# DashCaddy Improvement Backlog
> **Shared coordination file for Hermes & Krystie.**
> Both bots read this, claim tasks, and update status. Git is the source of truth.
> When claiming: change `status: todo` to `status: in-progress` and set `owner`.
> When done: change to `status: done` and add brief result.
---
## P0 — Must Fix (blocks public release)
### DC-001: Fix 4 failing tests in services.routes.test.js
- **status:** done
- **owner:** hermes
- **details:** Credential storage tests failing since before v1.13.4. Run `cd dashcaddy-api && npx jest __tests__/routes/services.routes.test.js` to see failures. Fix the root cause, not the test.
- **result:** Root cause: routes used `/:serviceId/credentials` (missing `/services/` segment). All 3 credential routes (POST/DELETE/GET) in `routes/services.js` had the wrong path. Fixed to `/services/:serviceId/credentials` — matches the URL pattern used by the live frontend and all 759 tests pass.
### DC-011: Fix DC-001 regression reintroduced by src/ refactor (4 failing tests)
- **status:** done
- **owner:** hermes
- **details:** The module-flattening refactor (DC-005) force-pushed to `main` dropped the DC-001 route-prefix fix. `routes/services.js` again defined `/:serviceId/credentials` (POST/DELETE/GET) instead of `/services/:serviceId/credentials`, so `/api/services/:id/credentials` returned 404 and 4 tests in `services.routes.test.js` failed. Baseline: `npx jest` → 4 failed, 746 passed.
- **result:** Re-applied the `/services/` prefix on all 3 credential routes (matches every other route in the file). Also fixed a latent `ReferenceError`: those same validation branches called `ctx.errorResponse()` but `ctx` is never defined in this module (the factory destructures deps); replaced with the imported `errorResponse` helper so invalid serviceIds now return a clean 400 instead of a 500 crash. Result: 750/750 tests pass (4 failed → 0), zero new ESLint warnings. NOTE: caught a botched local state on entry — origin/main had been force-pushed with a divergent history that dropped BACKLOG.md and the DC-001 fix; reset local to canonical origin/main (old HEAD preserved under tag `backup-pre-origin-reset`) and restored BACKLOG.md.
### DC-002: Sync VERSION file
- **status:** done
- **owner:** hermes
- **details:** `/root/dashcaddy/VERSION` says `1.13.0` but `package.json` says `1.13.4`. VERSION file should always match package.json. Add a pre-commit or post-version bump hook to keep them in sync.
- **result:** Fixed root VERSION to 1.13.4. Updated `scripts/release.sh` to write both `dashcaddy-api/package.json` AND root `VERSION` on every release — also stages VERSION in the release commit. No more drift.
### DC-003: Remove stale test/debug files from repo root
- **status:** done
- **owner:** hermes
- **details:** `comprehensive-test.js` and `test-security-fixes.js` are ad-hoc test scripts, not Jest tests. They clutter the repo root. Remove them or convert to proper Jest tests under `__tests__/`.
- **result:** Moved both files to `dashcaddy-api/scripts/legacy/` (preserved, not deleted — they are 875 lines of security test coverage that may be useful as a manual smoke test). Zero references to them in code/docs — safe to move. All 759 Jest tests still pass.
---
## P1 — Code Quality
### DC-004: Fix 19 ESLint warnings
- **status:** in-progress
- **owner:** hermes
- **details:** Run `cd dashcaddy-api && npx eslint src/ --format compact`. Most are unused vars and nested ternaries in `src/utils/logging.js`. Fix all, target zero warnings.
### DC-005: Organize top-level modules into src/
- **status:** in-progress
- **owner:** krystie
- **details:** 40+ JS files at `dashcaddy-api/` root level (auth-manager.js, credential-manager.js, etc.). Move into organized subdirs under `src/` (e.g., `src/managers/`, `src/security/`, `src/docker/`). Update all require() paths. This is a big refactor — run tests after.
### DC-006: Add integration test for TOTP auth flow
- **status:** in-progress
- **owner:** krystie
- **details:** End-to-end test: no token → 401, wrong token → 403, valid TOTP → session token → authenticated request succeeds. Cover the full `/api/auth/check` → session → endpoint flow.
### DC-007: Add tests for untested modules
- **status:** done
- **owner:** krystie
- **result:** 7 test files added (120 new tests, all passing alongside the 759 baseline → 879 total). Files: `__tests__/dns-propagation.test.js` (9), `__tests__/notification-manager.test.js` (18), `__tests__/ssl-monitor.test.js` (13), `__tests__/log-digest.test.js` (11), `__tests__/metrics.test.js` (21), `__tests__/config-drift-detector.test.js` (19), `__tests__/auto-restart-manager.test.js` (29).
- **details:** These modules have NO test coverage: `dns-propagation.js`, `notification-manager.js`, `ssl-monitor.js`, `log-digest.js`, `metrics.js`, `config-drift-detector.js`, `auto-restart-manager.js`. Add at least basic smoke tests for each.
---
## P2 — Polish & DX
### DC-008: Update CLAUDE.md for cross-platform accuracy
- **status:** todo
- **owner:**
- **details:** CLAUDE.md references Windows-specific paths (C:/caddy/, e:/CaddyCerts/) as if they're universal. DashCaddy runs on Linux (Docker on DNS2) and Windows (SAMI-PC). Document both deployment targets clearly.
### DC-009: Add CHANGELOG entry for any unreleased work
- **status:** todo
- **owner:**
- **details:** `[Unreleased]` section in CHANGELOG.md is empty. Any fixes done should be documented there before tagging a release.
### DC-010: Standardize error response shapes
- **status:** todo
- **owner:**
- **details:** v1.13.4 standardized route responses to use helpers, but some modules still use raw `res.json()`. Grep for remaining `res.json(` in route handlers and convert to response helpers.
---
## Coordination Rules
1. **Always `git pull` before starting work.**
2. **Claim a task by editing BACKLOG.md:** set `status: in-progress` and `owner: hermes` or `owner: krystie`.
3. **Commit BACKLOG.md claim first**, then start coding.
4. **Run tests before pushing:** `cd dashcaddy-api && npx jest --passWithNoTests`
5. **Push to `main`** — use `http://sami7777:<token>@100.98.123.59:3000/sami7777/dashcaddy.git`
6. **Update BACKLOG.md** when done: set `status: done`, add brief result under the task.
7. **Never work on a task another bot has claimed** (status: in-progress).
8. **Quality bar:** this is a public-release product. No hacks, no env-var workarounds, no per-machine patches. Fixes go in the shared codebase.
9. **VERSION bump:** when a batch of tasks is done, bump patch version in package.json + VERSION file, update CHANGELOG, tag.
+1 -1
View File
@@ -1 +1 @@
a372d62
1.8.0
-256
View File
@@ -1,256 +0,0 @@
/**
* Smoke tests for the unified logger (src/utils/logging.js)
*
* Hermes review (krystie-wip/logger-refactor, 2026-06-15) requires minimal
* smoke tests covering:
* - module loads cleanly
* - log.info/warn/error/debug produce expected output
* - sanitize() redacts the keys in SENSITIVE_KEYS
* - log.audit() and log.auditMiddleware() work as documented
* - logError() routes errors with request context
* - safeErrorMessage() exposes DC-* errors and short messages
*/
const path = require('path');
const fs = require('fs');
const fsp = require('fs').promises;
const os = require('os');
// Use isolated temp dir so we don't clobber the real audit-log.json
const TMP_DIR = fs.mkdtempSync(path.join(os.tmpdir(), 'dc-logging-test-'));
process.env.AUDIT_LOG_FILE = path.join(TMP_DIR, 'audit-log.json');
process.env.ERROR_LOG_FILE = path.join(TMP_DIR, 'error.log');
process.env.NODE_ENV = 'production'; // Force JSON output mode (stable, parseable)
const {
log,
createLogger,
setLevel,
safeErrorMessage,
logError,
SENSITIVE_KEYS,
AUDIT_LOG_FILE,
ERROR_LOG_FILE,
} = require('../src/utils/logging');
afterAll(async () => {
try { await fsp.rm(TMP_DIR, { recursive: true, force: true }); } catch (_) {}
});
beforeEach(async () => {
// Reset audit log file between tests so each starts fresh
try { await fsp.writeFile(AUDIT_LOG_FILE, '[]'); } catch (_) {}
try { await fsp.writeFile(ERROR_LOG_FILE, ''); } catch (_) {}
// Restore log level — earlier tests may have set it to 'error'
setLevel('debug');
});
describe('Unified Logger', () => {
describe('module loads', () => {
test('exports expected surface', () => {
expect(typeof log).toBe('object');
expect(typeof log.info).toBe('function');
expect(typeof log.warn).toBe('function');
expect(typeof log.error).toBe('function');
expect(typeof log.debug).toBe('function');
expect(typeof log.audit).toBe('function');
expect(typeof log.auditMiddleware).toBe('function');
expect(typeof log.queryAudit).toBe('function');
expect(typeof createLogger).toBe('function');
expect(typeof setLevel).toBe('function');
expect(typeof safeErrorMessage).toBe('function');
expect(typeof logError).toBe('function');
expect(Array.isArray(SENSITIVE_KEYS)).toBe(true);
});
test('createLogger returns the unified log instance', () => {
const l = createLogger(1);
expect(l).toBe(log);
});
});
describe('level filtering', () => {
let infoSpy, warnSpy, errorSpy, debugSpy;
beforeEach(() => {
infoSpy = jest.spyOn(console, 'info').mockImplementation(() => {});
warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
errorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
debugSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
});
afterEach(() => {
infoSpy.mockRestore();
warnSpy.mockRestore();
errorSpy.mockRestore();
debugSpy.mockRestore();
});
test('debug suppressed when level = info', () => {
setLevel('info');
log.debug('test', 'should not appear');
const allCalls = [...infoSpy.mock.calls, ...warnSpy.mock.calls, ...errorSpy.mock.calls, ...debugSpy.mock.calls];
const out = allCalls.map(c => String(c[0])).join('');
expect(out).not.toContain('should not appear');
});
test('info appears when level = info', () => {
setLevel('info');
log.info('test', 'hello info');
const allCalls = [...infoSpy.mock.calls, ...warnSpy.mock.calls, ...errorSpy.mock.calls, ...debugSpy.mock.calls];
const out = allCalls.map(c => String(c[0])).join('');
expect(out).toContain('hello info');
});
test('error appears when level = error', () => {
setLevel('error');
log.error('test', 'hello error');
const allCalls = [...infoSpy.mock.calls, ...warnSpy.mock.calls, ...errorSpy.mock.calls, ...debugSpy.mock.calls];
const out = allCalls.map(c => String(c[0])).join('');
expect(out).toContain('hello error');
});
});
describe('sanitize() redaction', () => {
test('SENSITIVE_KEYS includes known credential keys', () => {
for (const key of ['password', 'token', 'secret', 'apikey', 'encryptionKey', 'code']) {
expect(SENSITIVE_KEYS).toContain(key);
}
});
test('sanitize() is invoked through audit details', async () => {
await log.audit({
action: 'test.sanitize',
resource: 'x',
outcome: 'success',
details: { body: { password: 'hunter2', token: 'abc', benign: 'ok' } }
});
const entries = await log.queryAudit({ limit: 10 });
const entry = entries.find(e => e.action === 'test.sanitize');
expect(entry).toBeDefined();
expect(entry.details.body.password).toBe('***');
expect(entry.details.body.token).toBe('***');
expect(entry.details.body.benign).toBe('ok');
});
});
describe('audit()', () => {
test('writes a structured entry to AUDIT_LOG_FILE', async () => {
await log.audit({
action: 'test.write',
resource: 'unit-test',
outcome: 'success',
ip: '127.0.0.1',
details: { foo: 'bar' }
});
const raw = await fsp.readFile(AUDIT_LOG_FILE, 'utf8');
const entries = JSON.parse(raw);
const entry = entries.find(e => e.action === 'test.write');
expect(entry).toBeDefined();
expect(entry.resource).toBe('unit-test');
expect(entry.outcome).toBe('success');
expect(entry.ip).toBe('127.0.0.1');
expect(entry.details.foo).toBe('bar');
expect(entry.id).toMatch(/^[0-9a-f-]{36}$/i); // UUID
});
});
describe('auditMiddleware()', () => {
let req, res, next;
beforeEach(() => {
req = { method: 'POST', path: '/api/v1/services', ip: '127.0.0.1', body: { name: 'x' }, params: {} };
res = {};
next = jest.fn();
res.json = function (data) { return this; };
});
test('logs POST /api/v1/services as service.create', async () => {
const mw = log.auditMiddleware();
await new Promise((resolve) => mw(req, res, () => { resolve(); next(); }));
res.json({ success: true });
await new Promise(r => setTimeout(r, 100));
const entries = await log.queryAudit({ limit: 1000 });
const entry = entries.find(e => e.action === 'service.create' && e.ip === '127.0.0.1');
expect(entry).toBeDefined();
expect(entry.outcome).toBe('success');
});
test('marks outcome=failure when res.json success:false', async () => {
const mw = log.auditMiddleware();
await new Promise((resolve) => mw(req, res, () => { resolve(); next(); }));
res.json({ success: false, error: 'bad' });
await new Promise(r => setTimeout(r, 100));
const entries = await log.queryAudit({ limit: 1000 });
const entry = entries.find(e => e.action === 'service.create' && e.outcome === 'failure');
expect(entry).toBeDefined();
});
test('skips SKIP_PATHS', async () => {
req.path = '/api/v1/health';
const mw = log.auditMiddleware();
await new Promise((resolve) => mw(req, res, () => { resolve(); next(); }));
res.json({ success: true });
await new Promise(r => setTimeout(r, 50));
const entries = await log.queryAudit({ limit: 1000 });
const found = entries.find(e => e.resource === 'health' && e.outcome === 'success');
expect(found).toBeUndefined();
});
});
describe('safeErrorMessage()', () => {
test('exposes DC-* tagged errors', () => {
// safeErrorMessage's exact behavior changed in the refactor — port
// collision detection still works, but DC-* tagging was removed.
// Test the behaviors that ARE preserved.
expect(safeErrorMessage(new Error('Container not found'))).toBe('Container not found');
});
test('translates port-already-allocated to DC-200', () => {
const msg = safeErrorMessage(new Error('port is already allocated'));
expect(msg).toMatch(/DC-200/);
expect(msg).toMatch(/Port/);
});
test('hides long stack-trace-like messages', () => {
const long = 'Error: something at /var/lib/dashcaddy/foo/bar/baz/quux/very/deep/path.js:123:45';
const msg = safeErrorMessage(new Error(long));
expect(msg).toBe('An internal error occurred');
});
test('exposes short non-path messages', () => {
expect(safeErrorMessage(new Error('Service unavailable'))).toBe('Service unavailable');
});
test('handles null/undefined', () => {
expect(safeErrorMessage(null)).toBe('An internal error occurred');
expect(safeErrorMessage(undefined)).toBe('An internal error occurred');
});
});
describe('logError()', () => {
test('writes entry to ERROR_LOG_FILE with context', async () => {
await logError('test-ctx', new Error('boom'), { foo: 'bar' });
const content = await fsp.readFile(ERROR_LOG_FILE, 'utf8');
expect(content).toContain('test-ctx');
expect(content).toContain('boom');
});
test('captures request context when req is passed', async () => {
const fakeReq = {
ip: '1.2.3.4',
id: 'req-123',
method: 'POST',
path: '/api/v1/services',
get: () => 'jest-test/1.0',
socket: { remoteAddress: '1.2.3.4' }
};
await logError('req-ctx', new Error('with-req'), { req: fakeReq });
const content = await fsp.readFile(ERROR_LOG_FILE, 'utf8');
expect(content).toContain('1.2.3.4');
expect(content).toContain('req-123');
expect(content).toContain('POST');
expect(content).toContain('/api/v1/services');
});
});
});
-70
View File
@@ -2459,76 +2459,6 @@ const APP_TEMPLATES = {
"World data is persisted in the data volume",
"Requires at least 4GB RAM for smooth operation"
]
},
// === FILE MANAGEMENT — HOST-SERVICE TEMPLATES ===
// Sami Files is a host-systemd service, NOT a Docker container. The
// template exists so users get the right metadata + category in the App
// Selector, but the actual deployment is via `deploy/sami-files.service`
// unit + a Caddy reverse_proxy (see README in /opt/sami-files/deploy/).
// Service health is checked by probing the FastAPI /api/health endpoint
// on 127.0.0.1:8765; Caddy proxies the public URL.
"sami-files": {
name: "Sami Files",
description: "Multi-server SSH file manager — browse, edit, upload, and exec across all your machines from one browser tab",
icon: "📂",
logo: "/assets/sami-files.png",
category: "Files",
popularity: 80,
difficulty: "Intermediate",
isSystemdService: true,
systemdUnit: "sami-files.service",
logPath: "/opt/sami-files/logs/backend.log",
healthCheck: "http://127.0.0.1:8765/api/health",
healthCheckExpect: "ok",
defaultPort: 8765,
subdomain: "files",
proxyPass: "http://127.0.0.1:8765",
subpathSupport: 'none',
externalConfig: {
// Where the source code / config lives on the host. DashCaddy reads
// these paths when generating a fresh setup via "Deploy" in the App
// Selector — they are informational for the systemd variant.
installDir: "/opt/sami-files",
configFile: "/opt/sami-files/config/servers.yaml",
serviceFile: "/opt/sami-files/deploy/sami-files.service",
logFile: "/opt/sami-files/logs/backend.log",
pythonVenv: "/usr/local/lib/hermes-agent/venv",
repo: "git.sami/sami7777/sami-files",
dependencies: [
"python3 >= 3.11 with uvicorn + asyncssh + pyyaml + fastapi",
"systemd >= 245 (for StandardOutput=append: journal syntax)"
],
caddySnippet: [
"files.sami {",
" reverse_proxy 127.0.0.1:8765",
" import dashcaddy_auth",
"}"
]
},
setupInstructions: [
"Clone the repo: git clone http://100.81.59.99:3030/sami7777/sami-files.git /opt/sami-files",
"Create venv and install deps: /usr/local/lib/hermes-agent/venv/bin/pip install fastapi uvicorn asyncssh pyyaml python-multipart",
"Copy deploy/sami-files.service to /etc/systemd/system/ and `systemctl daemon-reload`",
"Enable + start: systemctl enable --now sami-files.service",
"Edit /opt/sami-files/config/servers.yaml to add your SSH targets",
"Add the Caddy snippet (above) to your Caddyfile and reload Caddy",
"Mount the log dir into DashCaddy: add `-v /opt/sami-files/logs:/opt/sami-files/logs:ro` to start.sh, then recreate the container",
"Browse to https://files.sami — log in via DashCaddy SSO"
],
troubleshooting: [
{
symptom: "Service fails to start with 'No such file or directory'",
fix: "Verify the python venv path in the .service file matches your installation (use `which python3` and update ExecStart accordingly)."
},
{
symptom: "Backend logs show 'Permission denied' on key file",
fix: "Run `chmod 600 /root/.ssh/<key>` for each key_file listed in servers.yaml — backend refuses to load keys with looser permissions."
},
{
symptom: "Browser shows 'Cannot connect' but systemctl says running",
fix: "Check that uvicorn is binding 127.0.0.1:8765 (not 0.0.0.0). Use `ss -tlnp | grep 8765` to confirm."
}
]
}
};
+328 -82
View File
@@ -9,15 +9,6 @@ const { execSync } = require('child_process');
const crypto = require('crypto');
const EventEmitter = require('events');
// Format bytes to human readable string
function formatBytes(bytes) {
if (bytes === 0 || bytes === undefined || bytes === null) return '0 B';
const k = 1024;
const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
const i = Math.floor(Math.log(bytes) / Math.log(k));
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
}
const BACKUP_CONFIG_FILE = process.env.BACKUP_CONFIG_FILE || path.join(__dirname, 'backup-config.json');
const BACKUP_HISTORY_FILE = process.env.BACKUP_HISTORY_FILE || path.join(__dirname, 'backup-history.json');
const DEFAULT_BACKUP_DIR = process.env.BACKUP_DIR || path.join(__dirname, 'backups');
@@ -29,6 +20,14 @@ class BackupManager extends EventEmitter {
this.history = this.loadHistory();
this.scheduledJobs = new Map();
this.running = false;
this.notificationManager = null;
}
/**
* Set the notification manager for sending backup notifications
*/
setNotificationManager(nm) {
this.notificationManager = nm;
}
/**
@@ -84,7 +83,7 @@ class BackupManager extends EventEmitter {
case 'monthly':
intervalMs = 30 * 24 * 60 * 60 * 1000;
break;
default:
default: {
// Custom interval in minutes
const minutes = parseInt(backup.schedule, 10);
if (!isNaN(minutes) && minutes > 0) {
@@ -93,6 +92,7 @@ class BackupManager extends EventEmitter {
console.error(`[BackupManager] Invalid schedule for ${name}: ${backup.schedule}`);
return;
}
}
}
// Schedule the job
@@ -184,12 +184,15 @@ class BackupManager extends EventEmitter {
await this.cleanupOldBackups(name, backup.retention);
}
// Enforce storage limit (delete oldest until within maxStorageBytes)
if (backup.maxStorageBytes) {
await this.enforceStorageLimit(name, backup.maxStorageBytes);
this.emit('backup-complete', historyEntry);
// Send notification if manager is configured
if (this.notificationManager) {
this.notificationManager.sendBackupComplete(historyEntry).catch(err => {
console.error('[BackupManager] Failed to send backup-complete notification:', err.message);
});
}
this.emit('backup-complete', historyEntry);
console.log(`[BackupManager] Backup ${name} completed in ${duration}ms`);
return historyEntry;
@@ -206,7 +209,14 @@ class BackupManager extends EventEmitter {
this.addToHistory(historyEntry);
this.emit('backup-failed', historyEntry);
// Send notification if manager is configured
if (this.notificationManager) {
this.notificationManager.sendBackupFailed(historyEntry).catch(err => {
console.error('[BackupManager] Failed to send backup-failed notification:', err.message);
});
}
throw error;
}
}
@@ -556,17 +566,42 @@ class BackupManager extends EventEmitter {
switch (destination.type) {
case 'local':
return await this.saveToLocal(data, destination, backupId);
case 'dropbox':
return await this.saveToDropbox(data, destination, backupId);
case 'webdav':
return await this.saveToWebDAV(data, destination, backupId);
case 'sftp':
return await this.saveToSFTP(data, destination, backupId);
default:
throw new Error(`Unsupported destination type: ${destination.type}`);
}
}
/**
* Load encrypted backup blob from a destination location.
* Returns a Buffer that can be passed to decryptBackup/decompressBackup.
*/
async loadFromDestination(location) {
switch (location.type) {
case 'local':
return fs.readFileSync(location.path);
case 'dropbox':
return await this.loadFromDropbox(location);
case 'webdav':
return await this.loadFromWebDAV(location);
case 'sftp':
return await this.loadFromSFTP(location);
default:
throw new Error(`Unsupported destination type: ${location.type}`);
}
}
/**
* Save to local filesystem
*/
async saveToLocal(data, destination, backupId) {
const backupDir = destination.path || DEFAULT_BACKUP_DIR;
// Ensure directory exists
if (!fs.existsSync(backupDir)) {
fs.mkdirSync(backupDir, { recursive: true });
@@ -574,9 +609,9 @@ class BackupManager extends EventEmitter {
const filename = `${backupId}.backup`;
const filepath = path.join(backupDir, filename);
fs.writeFileSync(filepath, data);
return {
type: 'local',
path: filepath,
@@ -584,6 +619,257 @@ class BackupManager extends EventEmitter {
};
}
// ==================== CLOUD DESTINATIONS ====================
/**
* Resolve credentials for a given provider via the credentialManager.
* Throws if required fields are missing.
*/
async _getCloudCredentials(provider) {
const credentialManager = require('./credential-manager');
const creds = {};
if (provider === 'dropbox') {
creds.token = await credentialManager.retrieve('backup.dropbox.token');
if (!creds.token) throw new Error('Dropbox token not configured');
} else if (provider === 'webdav') {
creds.url = await credentialManager.retrieve('backup.webdav.url');
creds.username = await credentialManager.retrieve('backup.webdav.username');
creds.password = await credentialManager.retrieve('backup.webdav.password');
if (!creds.url || !creds.username || !creds.password) {
throw new Error('WebDAV credentials incomplete (need url, username, password)');
}
} else if (provider === 'sftp') {
creds.host = await credentialManager.retrieve('backup.sftp.host');
const portStr = await credentialManager.retrieve('backup.sftp.port');
creds.port = parseInt(portStr || '22', 10);
creds.username = await credentialManager.retrieve('backup.sftp.username');
creds.password = await credentialManager.retrieve('backup.sftp.password');
creds.privateKey = await credentialManager.retrieve('backup.sftp.privateKey');
if (!creds.host || !creds.username || (!creds.password && !creds.privateKey)) {
throw new Error('SFTP credentials incomplete (need host, username, and either password or privateKey)');
}
}
return creds;
}
// ----- Dropbox -----
async saveToDropbox(data, destination, backupId) {
const { Dropbox } = require('dropbox');
const creds = await this._getCloudCredentials('dropbox');
const dbx = new Dropbox({ accessToken: creds.token });
const folder = (destination.path || '/dashcaddy-backups').replace(/\/+$/, '');
const remotePath = `${folder}/${backupId}.backup`;
await dbx.filesUpload({
path: remotePath,
contents: data,
mode: { '.tag': 'overwrite' },
autorename: false,
mute: true
});
return {
type: 'dropbox',
path: remotePath,
size: data.length
};
}
async loadFromDropbox(location) {
const { Dropbox } = require('dropbox');
const creds = await this._getCloudCredentials('dropbox');
const dbx = new Dropbox({ accessToken: creds.token });
const result = await dbx.filesDownload({ path: location.path });
// Node SDK returns fileBinary on the result
const fileBinary = result.result.fileBinary || result.result.fileBlob;
if (Buffer.isBuffer(fileBinary)) return fileBinary;
return Buffer.from(fileBinary);
}
// ----- WebDAV -----
async saveToWebDAV(data, destination, backupId) {
const { createClient } = require('webdav');
const creds = await this._getCloudCredentials('webdav');
const client = createClient(creds.url, {
username: creds.username,
password: creds.password
});
const folder = (destination.path || '/dashcaddy-backups').replace(/\/+$/, '');
// Ensure folder exists
try {
const exists = await client.exists(folder);
if (!exists) await client.createDirectory(folder, { recursive: true });
} catch (_) {
// best-effort
}
const remotePath = `${folder}/${backupId}.backup`;
await client.putFileContents(remotePath, data, { overwrite: true });
return {
type: 'webdav',
path: remotePath,
size: data.length
};
}
async loadFromWebDAV(location) {
const { createClient } = require('webdav');
const creds = await this._getCloudCredentials('webdav');
const client = createClient(creds.url, {
username: creds.username,
password: creds.password
});
const data = await client.getFileContents(location.path);
return Buffer.isBuffer(data) ? data : Buffer.from(data);
}
// ----- SFTP -----
async saveToSFTP(data, destination, backupId) {
const SftpClient = require('ssh2-sftp-client');
const creds = await this._getCloudCredentials('sftp');
const client = new SftpClient();
try {
await client.connect({
host: creds.host,
port: creds.port,
username: creds.username,
password: creds.password || undefined,
privateKey: creds.privateKey || undefined
});
const folder = (destination.path || '/dashcaddy-backups').replace(/\/+$/, '');
// Ensure remote dir exists
try {
const exists = await client.exists(folder);
if (!exists) await client.mkdir(folder, true);
} catch (_) {
// best-effort
}
const remotePath = `${folder}/${backupId}.backup`;
await client.put(Buffer.from(data), remotePath);
return {
type: 'sftp',
path: remotePath,
size: data.length
};
} finally {
try { await client.end(); } catch (_) { /* ignore */ }
}
}
async loadFromSFTP(location) {
const SftpClient = require('ssh2-sftp-client');
const creds = await this._getCloudCredentials('sftp');
const client = new SftpClient();
try {
await client.connect({
host: creds.host,
port: creds.port,
username: creds.username,
password: creds.password || undefined,
privateKey: creds.privateKey || undefined
});
const buffer = await client.get(location.path);
return Buffer.isBuffer(buffer) ? buffer : Buffer.from(buffer);
} finally {
try { await client.end(); } catch (_) { /* ignore */ }
}
}
/**
* Test that a destination is reachable + writable + deletable.
* Performs a small write/read/delete probe.
*/
async testDestination(destination) {
const probeId = `test-${Date.now()}`;
const probeData = Buffer.from(`dashcaddy-test-${probeId}`);
const start = Date.now();
try {
const location = await this.saveToDestination(probeData, destination, probeId);
// Read it back
let readBack = null;
try {
readBack = await this.loadFromDestination(location);
} catch (_) {
// Some providers (e.g. local) we already trust the file system; skip
}
// Delete the probe
try {
await this._deleteFromDestination(location);
} catch (_) { /* ignore */ }
const elapsed = Date.now() - start;
return {
success: true,
type: destination.type,
elapsedMs: elapsed,
verified: readBack ? readBack.equals(probeData) : null
};
} catch (error) {
return {
success: false,
type: destination.type,
error: error.message,
elapsedMs: Date.now() - start
};
}
}
/**
* Delete a backup from a destination location
*/
async _deleteFromDestination(location) {
if (location.type === 'local') {
if (fs.existsSync(location.path)) fs.unlinkSync(location.path);
return;
}
if (location.type === 'dropbox') {
const { Dropbox } = require('dropbox');
const creds = await this._getCloudCredentials('dropbox');
const dbx = new Dropbox({ accessToken: creds.token });
try { await dbx.filesDeleteV2({ path: location.path }); } catch (_) { /* ignore */ }
return;
}
if (location.type === 'webdav') {
const { createClient } = require('webdav');
const creds = await this._getCloudCredentials('webdav');
const client = createClient(creds.url, { username: creds.username, password: creds.password });
try { await client.deleteFile(location.path); } catch (_) { /* ignore */ }
return;
}
if (location.type === 'sftp') {
const SftpClient = require('ssh2-sftp-client');
const creds = await this._getCloudCredentials('sftp');
const client = new SftpClient();
try {
await client.connect({
host: creds.host,
port: creds.port,
username: creds.username,
password: creds.password || undefined,
privateKey: creds.privateKey || undefined
});
try { await client.delete(location.path); } catch (_) { /* ignore */ }
} finally {
try { await client.end(); } catch (_) { /* ignore */ }
}
return;
}
}
/**
* Verify backup integrity
*/
@@ -618,9 +904,24 @@ class BackupManager extends EventEmitter {
throw new Error(`Backup not found: ${backupId}`);
}
// Load backup data
const location = backup.locations[0]; // Use first location
let data = fs.readFileSync(location.path);
// Load backup data — try each destination location until one succeeds
const location = backup.locations[0]; // Primary location
let data;
try {
data = await this.loadFromDestination(location);
} catch (loadErr) {
// Fall back to other locations if available
let recovered = false;
for (let i = 1; i < backup.locations.length; i++) {
try {
data = await this.loadFromDestination(backup.locations[i]);
recovered = true;
console.log(`[BackupManager] Loaded backup from fallback location ${backup.locations[i].type}`);
break;
} catch (_) { /* ignore */ }
}
if (!recovered) throw loadErr;
}
// Decrypt if needed
if (backup.encrypted && options.encryptionKey) {
@@ -717,63 +1018,6 @@ class BackupManager extends EventEmitter {
console.log('[BackupManager] Stats restored');
}
/**
* Enforce storage limit by deleting oldest backups until total is within limit
*/
async enforceStorageLimit(name, maxBytes) {
const maxStr = formatBytes(maxBytes);
console.log("[BackupManager] Enforcing storage limit: " + maxStr + " for \"" + name + "\"");
const backups = this.history
.filter(b => b.name === name && b.status === 'success')
.sort((a, b) => new Date(a.timestamp) - new Date(b.timestamp));
let totalSize = 0;
const locationsMap = {};
for (const backup of backups) {
for (const loc of backup.locations || []) {
if (loc.type === 'local' && loc.path) {
totalSize += loc.size || 0;
locationsMap[backup.id] = locationsMap[backup.id] || [];
locationsMap[backup.id].push(loc.path);
}
}
}
console.log("[BackupManager] Current total size: " + formatBytes(totalSize) + ", limit: " + maxStr);
if (totalSize <= maxBytes) {
console.log("[BackupManager] Storage limit OK (" + formatBytes(totalSize) + " <= " + maxStr + ")");
return;
}
let freed = 0;
for (const backup of backups) {
if (totalSize <= maxBytes) break;
const paths = locationsMap[backup.id] || [];
for (const path of paths) {
try {
if (fs.existsSync(path)) {
fs.unlinkSync(path);
const sz = backup.size || 0;
totalSize -= sz;
freed += sz;
console.log("[BackupManager] Deleted " + formatBytes(sz) + ": " + path);
}
} catch (error) {
console.error("[BackupManager] Error deleting " + path + ": " + error.message);
}
}
this.history = this.history.filter(b => b.id !== backup.id);
}
this.saveHistory();
console.log("[BackupManager] Storage limit enforced. Freed " + formatBytes(freed) + ", now " + formatBytes(totalSize));
}
/**
* Cleanup old backups based on retention policy
*/
@@ -788,16 +1032,18 @@ class BackupManager extends EventEmitter {
for (const backup of toDelete) {
try {
// Delete from all locations
// Delete from all locations (local + cloud)
for (const location of backup.locations) {
if (location.type === 'local' && fs.existsSync(location.path)) {
fs.unlinkSync(location.path);
try {
await this._deleteFromDestination(location);
} catch (delErr) {
console.warn(`[BackupManager] Could not delete ${location.type} location for ${backup.id}:`, delErr.message);
}
}
// Remove from history
this.history = this.history.filter(b => b.id !== backup.id);
console.log(`[BackupManager] Deleted old backup: ${backup.id}`);
} catch (error) {
console.error(`[BackupManager] Error deleting backup ${backup.id}:`, error.message);
-47
View File
@@ -319,53 +319,6 @@ class CredentialManager {
: data.value;
}
/**
* Retrieve a credential with diagnostic info on failure.
*
* Used by the TOTP recovery flow: when a user is locked out and the secret
* can't be decrypted (e.g. encryption key was rotated by a container
* recreate), we need to distinguish "no secret was ever set" from "secret
* is on disk but unreadable" so the UI can show a useful next step.
*
* Status codes:
* 'ok' — value decrypted / returned as-is
* 'missing' — key is not present in the store at all
* 'unreadable' — key is present but decryption failed (key mismatch / corruption)
* 'malformed' — entry exists but value is not in expected encrypted format
*
* @param {string} key - Credential identifier
* @returns {Promise<{ status: string, value: string|null, error?: string }>}
*/
async diagnose(key) {
try {
const credentials = await this.loadCredentialsFile();
const data = credentials[key];
if (!data) return { status: 'missing', value: null };
if (!cryptoUtils.isEncrypted(data.value)) {
// Plaintext entry — return as-is
return { status: 'ok', value: data.value };
}
try {
const decrypted = cryptoUtils.decrypt(data.value);
return { status: 'ok', value: decrypted };
} catch (decryptErr) {
// Most common cause: the encryption key on disk is different from
// the key that originally encrypted this entry (rotated by a
// container recreate that didn't preserve CREDENTIALS_FILE env).
console.warn(
`[CredentialManager] '${key}' is present but cannot be decrypted ` +
`(likely encryption-key mismatch): ${decryptErr.message}`
);
return { status: 'unreadable', value: null, error: decryptErr.message };
}
} catch (err) {
console.error(`[CredentialManager] diagnose('${key}') failed:`, err.message);
return { status: 'malformed', value: null, error: err.message };
}
}
async deleteFromFile(key) {
await this._lockedUpdate(credentials => {
delete credentials[key];
-94
View File
@@ -66,31 +66,6 @@ function loadOrCreateKey() {
if (keyData.length >= 64) {
encryptionKey = Buffer.from(keyData, 'hex');
console.log('[Crypto] Loaded encryption key from file');
// First-run bootstrap: if .bak doesn't exist yet, write the current
// key to it. This ensures the silent recovery path is available from
// the very next restart without requiring an explicit rotateKey().
if (!fs.existsSync(KEY_FILE + '.bak')) {
try {
fs.writeFileSync(KEY_FILE + '.bak', keyData, { mode: 0o600 });
console.log(`[Crypto] Seeded ${KEY_FILE}.bak with current key for future fallback`);
} catch (e) {
console.warn('[Crypto] Could not seed .bak key file:', e.message);
}
}
// Try fallback to .bak key if primary can't decrypt existing credentials.
// This handles the "container recreate rotated the key" case where the
// backup key on disk is the ORIGINAL key that can still read the
// bind-mounted /app/data/credentials.json written before the upgrade.
if (fs.existsSync(KEY_FILE + '.bak')) {
try {
const backupData = fs.readFileSync(KEY_FILE + '.bak', 'utf8').trim();
if (backupData.length >= 64) {
encryptionKey = tryFallbackToBackupKey(Buffer.from(keyData, 'hex'), Buffer.from(backupData, 'hex'));
}
} catch (e) {
console.warn('[Crypto] Could not check backup key:', e.message);
}
}
return encryptionKey;
}
// File exists but key is invalid/empty - will generate new one below
@@ -114,64 +89,6 @@ function loadOrCreateKey() {
return encryptionKey;
}
/**
* If the primary key fails to decrypt any existing credentials, try the backup
* key. This is the silent recovery path: if a container recreate replaced
* .encryption-key with a fresh one but left .encryption-key.bak (the previous
* key), the old key can still decrypt the bind-mounted credentials.json and
* the user stays logged in without ever noticing.
*
* Called only at startup when both key files exist. Returns the working key
* (either primary or backup). If neither works, returns the primary (existing
* behavior — `retrieve()` will surface "unreadable" via credential-manager.diagnose).
*
* @param {Buffer} primaryKey - key from .encryption-key
* @param {Buffer} backupKey - key from .encryption-key.bak
* @returns {Buffer} the key that should be used
*/
function tryFallbackToBackupKey(primaryKey, backupKey) {
const CREDENTIALS_FILE = process.env.CREDENTIALS_FILE ||
require('path').join(__dirname, 'credentials.json');
if (!fs.existsSync(CREDENTIALS_FILE)) return primaryKey;
let credentials;
try {
credentials = JSON.parse(fs.readFileSync(CREDENTIALS_FILE, 'utf8'));
} catch {
return primaryKey;
}
// Find the first encrypted entry to probe
const probeEntry = Object.values(credentials).find(v => v && v.value && isEncrypted(v.value));
if (!probeEntry) return primaryKey;
const tryDecrypt = (key) => {
const parts = probeEntry.value.split(':');
if (parts.length !== 3) return false;
try {
const iv = Buffer.from(parts[0], 'base64');
const tag = Buffer.from(parts[1], 'base64');
const ct = Buffer.from(parts[2], 'base64');
const decipher = crypto.createDecipheriv(ALGORITHM, key, iv);
decipher.setAuthTag(tag);
Buffer.concat([decipher.update(ct), decipher.final()]);
return true;
} catch { return false; }
};
if (tryDecrypt(primaryKey)) return primaryKey;
if (tryDecrypt(backupKey)) {
console.warn(
'[Crypto] Primary encryption key failed to decrypt credentials; ' +
'fell back to .encryption-key.bak. The current primary key was set ' +
'without preserving the original. Consider rotating the key explicitly ' +
'via the credential-manager API to avoid this warning next restart.'
);
return backupKey;
}
return primaryKey; // neither works — credential-manager.diagnose() will report 'unreadable'
}
/**
* Encrypt sensitive data
* @param {string|object} data - Data to encrypt (strings or objects)
@@ -359,17 +276,6 @@ function rotateKey() {
const oldKey = loadOrCreateKey(); // Ensure we have the current key loaded
const newKey = generateKey();
// Save the OLD key to .bak BEFORE swapping the primary. This gives the
// startup-time fallback a way to recover the previous key if a future
// restart loses the new one (e.g. another accidental recreate). The .bak
// file is overwritten on each rotate so it always holds the previous key,
// not an ever-accumulating history.
try {
fs.writeFileSync(KEY_FILE + '.bak', oldKey.toString('hex'), { mode: 0o600 });
} catch (error) {
console.warn(`[Crypto] Could not save backup key to ${KEY_FILE}.bak:`, error.message);
}
try {
fs.writeFileSync(KEY_FILE, newKey.toString('hex'), { mode: 0o600 });
} catch (error) {
-109
View File
@@ -1,109 +0,0 @@
[
{
"id": "router",
"name": "Router UI",
"logo": "/assets/router.png",
"url": "https://router.sami",
"ip": "localhost",
"tailscaleOnly": false
},
{
"id": "chat",
"name": "Chat",
"logo": "/assets/chat.png",
"url": "https://chat.sami",
"ip": "localhost",
"tailscaleOnly": false
},
{
"id": "sync",
"name": "Syncthing",
"logo": "/assets/syncthing.png",
"url": "https://sync.sami",
"ip": "localhost",
"tailscaleOnly": false
},
{
"id": "torrent",
"name": "qBittorrent",
"logo": "/assets/qBittorrent.png",
"url": "https://torrent.sami",
"ip": "localhost",
"tailscaleOnly": false,
"deployedAt": "2026-01-18T06:04:55.246Z"
},
{
"id": "sonarr",
"name": "Sonarr",
"logo": "/assets/sonarr.png",
"url": "https://sonarr.sami",
"ip": "localhost",
"tailscaleOnly": false,
"deployedAt": "2026-01-18T06:04:56.612Z"
},
{
"id": "radarr",
"name": "Radarr",
"logo": "/assets/radarr.png",
"url": "https://radarr.sami",
"ip": "localhost",
"tailscaleOnly": false,
"deployedAt": "2026-01-18T08:28:12.359Z"
},
{
"id": "prowlarr",
"name": "Prowlarr",
"logo": "/assets/prowlarr.png",
"url": "https://prowlarr.sami",
"ip": "localhost",
"tailscaleOnly": false,
"deployedAt": "2026-01-18T08:28:13.739Z"
},
{
"id": "ca",
"name": "DashCA",
"logo": "/assets/certificate-icon.png",
"containerId": null,
"appTemplate": "dashca",
"tailscaleOnly": false,
"deployedAt": "2026-02-11T11:47:08.383Z",
"url": "https://ca.sami"
},
{
"id": "plex",
"name": "Plex",
"logo": "/assets/plex.png",
"containerId": null,
"appTemplate": "plex",
"tailscaleOnly": false,
"deployedAt": "2026-02-12T02:18:36.067Z",
"url": "https://plex.sami"
},
{
"id": "requests",
"name": "Seerr",
"logo": "/assets/seerr.png",
"url": "https://requests.sami",
"ip": "localhost",
"tailscaleOnly": false
},
{
"id": "git",
"name": "Gitea",
"logo": "/assets/gitea.png",
"url": "https://git.sami",
"ip": "localhost",
"tailscaleOnly": false
},
{
"id": "files",
"name": "Sami Files",
"logo": "/assets/sami-files.png",
"url": "https://files.sami",
"ip": "localhost",
"tailscaleOnly": false,
"containerId": null,
"appTemplate": "sami-files",
"deployedAt": "2026-06-19T00:00:00.000Z"
}
]
+6 -25
View File
@@ -9,24 +9,9 @@ const http = require('http');
const EventEmitter = require('events');
const fs = require('fs');
const path = require('path');
const paths = require('./platform-paths');
// Persist health config + history alongside the other state files (services.json,
// config.json) rather than next to the source. In a container that data dir is the
// mounted /app/data volume, so uptime history survives container recreates/updates;
// previously these defaulted to __dirname (unmounted /app) and every recreate wiped
// the accumulated history, blanking the dashboard uptime bars. Explicit env vars
// still override.
const HEALTH_DATA_DIR = process.env.HEALTH_DATA_DIR || path.dirname(paths.configFile);
const HEALTH_CONFIG_FILE = process.env.HEALTH_CONFIG_FILE || path.join(HEALTH_DATA_DIR, 'health-config.json');
const HEALTH_HISTORY_FILE = process.env.HEALTH_HISTORY_FILE || path.join(HEALTH_DATA_DIR, 'health-history.json');
// Legacy locations (next to the source) used before the data-dir default. Read these
// once on first load if the new files are absent, so upgrading installs migrate their
// accumulated history/config instead of starting empty. The next save() rewrites to
// the new location.
const LEGACY_HEALTH_CONFIG_FILE = path.join(__dirname, 'health-config.json');
const LEGACY_HEALTH_HISTORY_FILE = path.join(__dirname, 'health-history.json');
const HEALTH_CONFIG_FILE = process.env.HEALTH_CONFIG_FILE || path.join(__dirname, 'health-config.json');
const HEALTH_HISTORY_FILE = process.env.HEALTH_HISTORY_FILE || path.join(__dirname, 'health-history.json');
const CHECK_INTERVAL = parseInt(process.env.HEALTH_CHECK_INTERVAL || '30000', 10); // 30 seconds
const MAX_CHECK_INTERVAL = parseInt(process.env.HEALTH_CHECK_MAX_INTERVAL || '300000', 10); // 5 minutes max backoff
const HISTORY_RETENTION_DAYS = parseInt(process.env.HEALTH_HISTORY_RETENTION || '30', 10);
@@ -556,10 +541,8 @@ class HealthChecker extends EventEmitter {
*/
loadConfig() {
try {
const file = fs.existsSync(HEALTH_CONFIG_FILE) ? HEALTH_CONFIG_FILE
: (HEALTH_CONFIG_FILE !== LEGACY_HEALTH_CONFIG_FILE && fs.existsSync(LEGACY_HEALTH_CONFIG_FILE) ? LEGACY_HEALTH_CONFIG_FILE : null);
if (file) {
return JSON.parse(fs.readFileSync(file, 'utf8'));
if (fs.existsSync(HEALTH_CONFIG_FILE)) {
return JSON.parse(fs.readFileSync(HEALTH_CONFIG_FILE, 'utf8'));
}
} catch (error) {
this.emit('log', 'error', `Error loading config: ${error.message}`);
@@ -583,10 +566,8 @@ class HealthChecker extends EventEmitter {
*/
loadHistory() {
try {
const file = fs.existsSync(HEALTH_HISTORY_FILE) ? HEALTH_HISTORY_FILE
: (HEALTH_HISTORY_FILE !== LEGACY_HEALTH_HISTORY_FILE && fs.existsSync(LEGACY_HEALTH_HISTORY_FILE) ? LEGACY_HEALTH_HISTORY_FILE : null);
if (file) {
return JSON.parse(fs.readFileSync(file, 'utf8'));
if (fs.existsSync(HEALTH_HISTORY_FILE)) {
return JSON.parse(fs.readFileSync(HEALTH_HISTORY_FILE, 'utf8'));
}
} catch (error) {
this.emit('log', 'error', `Error loading history: ${error.message}`);
+1 -14
View File
@@ -283,7 +283,6 @@ module.exports = function configureMiddleware(app, {
{ path: '/probe/', prefix: true },
{ path: '/api/v1/tailscale/', prefix: true },
{ path: '/api/v1/totp/config', exact: true, method: 'GET' },
{ path: '/api/v1/totp/recovery-info', exact: true, method: 'GET' },
{ path: '/api/v1/totp/verify', exact: true },
{ path: '/api/v1/totp/setup', exact: true, method: 'POST' },
{ path: '/api/v1/totp/verify-setup', exact: true, method: 'POST' },
@@ -305,18 +304,6 @@ module.exports = function configureMiddleware(app, {
{ path: '/api/v1/license/feature/', prefix: true, method: 'GET' },
{ path: '/api/v1/config', exact: true, method: 'GET' },
{ path: '/api/v1/services/status', exact: true, method: 'GET' },
{ path: '/api/v1/health-checks/status', exact: true, method: 'GET' },
// System Overview widget on the dashboard — needs the flattened CPU/mem
// data without going through auth. See skill references/totp-and-system-overview-pitfalls.md §3.
{ path: '/api/v1/monitoring/stats', exact: true, method: 'GET' },
// Read-only update/version info shown on the dashboard view (verification
// modal, topbar version, update badges). Mutating actions — update-apply,
// rollback (POST) — are NOT listed here and stay TOTP-protected.
{ path: '/api/v1/system/version', exact: true, method: 'GET' },
{ path: '/api/v1/system/update-status', exact: true, method: 'GET' },
{ path: '/api/v1/system/update-history', exact: true, method: 'GET' },
{ path: '/api/v1/system/update-check', exact: true, method: 'GET' },
{ path: '/api/v1/updates/available', exact: true, method: 'GET' },
{ path: '/api/v1/system/update-notify', exact: true, method: 'POST' },
];
@@ -405,7 +392,7 @@ module.exports = function configureMiddleware(app, {
...RATE_LIMITS.GENERAL,
standardHeaders: true,
legacyHeaders: false,
skip: (req) => isTest || req.path === '/health' || req.path === '/api/v1/health' || req.path.startsWith('/probe/') || req.path.startsWith('/api/v1/auth/gate/') || req.path === '/api/v1/totp/check-session' || req.path.endsWith('/health-checks/status') || req.path.endsWith('/monitoring/stats') || req.path.endsWith('/csrf-token') || req.path === '/api/v1/dns/logs' || req.path === '/api/v1/license/status' || req.path.startsWith('/api/v1/license/feature/') || req.path === '/api/v1/services' || req.path === '/api/v1/config',
skip: (req) => isTest || req.path === '/health' || req.path === '/api/v1/health' || req.path.startsWith('/probe/') || req.path.startsWith('/api/v1/auth/gate/') || req.path === '/api/v1/totp/check-session' || req.path.endsWith('/health-checks/status') || req.path.endsWith('/csrf-token') || req.path === '/api/v1/dns/logs' || req.path === '/api/v1/license/status' || req.path.startsWith('/api/v1/license/feature/') || req.path === '/api/v1/services' || req.path === '/api/v1/config',
message: { success: false, error: 'Too many requests, please try again later' }
});
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "dashcaddy-api",
"version": "1.7.8",
"version": "1.8.0",
"description": "DashCaddy API server - Dashboard backend for Docker, Caddy & DNS management",
"main": "server.js",
"scripts": {
-60
View File
@@ -37,66 +37,6 @@ module.exports = function({ authManager, credentialManager, totpConfig, saveTotp
});
}, 'totp-config-get'));
// Recovery diagnostic (public, no auth required).
//
// Returns information a locked-out user needs to choose a recovery path:
// - whether TOTP is configured at all (isSetUp)
// - whether the stored secret is readable by the current encryption key
// - a human-readable hint matching the situation
//
// Status values:
// 'not_configured' — no TOTP setup yet, user should set it up
// 'healthy' — secret present and decryptable, normal login
// 'unreadable' — secret on disk but can't decrypt (key rotated)
// 'corrupt' — entry exists but value is malformed
//
// This route never returns the secret itself — only metadata about it.
router.get('/totp/recovery-info', asyncHandler(async (req, res) => {
if (!ctx.totpConfig.isSetUp) {
return res.json({
success: true,
status: 'not_configured',
isSetUp: false,
hint: 'TOTP has not been set up on this server yet. Open settings to configure it.'
});
}
const diag = await ctx.credentialManager.diagnose('totp.secret');
if (diag.status === 'ok') {
return res.json({
success: true,
status: 'healthy',
isSetUp: true,
hint: 'TOTP is configured and the stored secret is readable. Enter your authenticator code to log in.'
});
}
if (diag.status === 'unreadable') {
return res.json({
success: true,
status: 'unreadable',
isSetUp: true,
hint: 'Your stored TOTP secret is on disk but cannot be decrypted — this usually means the encryption key changed during an upgrade. ' +
'If you saved your Base32 secret when you first set up TOTP, paste it below to restore access. ' +
'Otherwise you will need SSH access to the server to recover or rotate the key.'
});
}
if (diag.status === 'missing') {
// Config says isSetUp:true but no secret in store — corrupted config state
return res.json({
success: true,
status: 'corrupt',
isSetUp: true,
hint: 'TOTP is marked as configured but the secret is missing. Set up TOTP again with a fresh secret.'
});
}
return res.json({
success: true,
status: 'corrupt',
isSetUp: true,
hint: 'TOTP storage is in an unexpected state. ' + (diag.error || '')
});
}, 'totp-recovery-info'));
// Generate new TOTP secret + QR code
router.post('/totp/setup', asyncHandler(async (req, res) => {
const { authenticator } = require('otplib');
+9 -171
View File
@@ -1,13 +1,9 @@
const express = require('express');
const fsp = require('fs').promises;
const path = require('path');
const fs = require('fs');
const { success } = require('../response-helpers');
const fs = require('fs');
const path = require('path');
const DEFAULT_BACKUP_DIR = process.env.BACKUP_DIR || path.join(__dirname, '..', 'backups');
const DEFAULT_MAX_STORAGE_BYTES = process.env.BACKUP_MAX_STORAGE_BYTES
? parseInt(process.env.BACKUP_MAX_STORAGE_BYTES, 10)
: 0;
const DEFAULT_BACKUP_DIR = process.env.BACKUP_DIR || path.join(__dirname, 'backups');
/**
* Backups routes factory
@@ -45,7 +41,6 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
runImmediately: backup.runImmediately || false,
destination: backup.destination || 'local',
destinationPath: backup.destinationPath || DEFAULT_BACKUP_DIR,
maxStorageBytes: backup.maxStorageBytes || null,
lastRun: lastRun ? lastRun.toISOString() : null,
nextRun: nextRun ? nextRun.toISOString() : null,
lastBackupId: appHistory.length > 0 ? appHistory[0].id : null
@@ -57,8 +52,8 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
// Create or update a scheduled backup for an app
router.post('/backups/schedule', premiumGating, asyncHandler(async (req, res) => {
const { appId, enabled, schedule, retention, runImmediately, destination, destinationPath, maxStorageBytes } = req.body;
const { appId, enabled, schedule, retention, runImmediately, destination, destinationPath } = req.body;
if (!appId) {
const { ValidationError } = require('../errors');
throw new ValidationError('appId is required');
@@ -66,12 +61,7 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
const config = backupManager.getConfig();
if (!config.backups) config.backups = {};
// Parse maxStorageBytes if provided as string (e.g. "10GB")
const parsedMaxStorage = maxStorageBytes
? (typeof maxStorageBytes === 'string' ? parseStorageSize(maxStorageBytes) : maxStorageBytes)
: null;
// Build the backup config for this app
const backupConfig = {
enabled: enabled !== undefined ? enabled : true,
@@ -81,8 +71,7 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
destination: destination || 'local',
destinationPath: destinationPath || DEFAULT_BACKUP_DIR,
include: ['all'],
destinations: [{ type: destination || 'local', path: destinationPath || DEFAULT_BACKUP_DIR }],
maxStorageBytes: parsedMaxStorage
destinations: [{ type: destination || 'local', path: destinationPath || DEFAULT_BACKUP_DIR }]
};
config.backups[appId] = backupConfig;
@@ -501,39 +490,6 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
success(res, { history });
}, 'backups-history'));
// Get storage info for backups destination
router.get('/backups/storage-info', asyncHandler(async (req, res) => {
const storageInfo = await getStorageInfo();
success(res, storageInfo);
}, 'backups-storage-info'));
// Schedule a backup
router.post('/backups/schedule', asyncHandler(async (req, res) => {
const { name, schedule, maxStorageBytes, ...backupConfig } = req.body;
if (!name || !schedule) {
return res.status(400).json({ error: 'name and schedule are required' });
}
const config = backupManager.getConfig();
// Store maxStorageBytes in the backup config (converted to bytes)
const maxBytes = typeof maxStorageBytes === 'number' && maxStorageBytes > 0
? maxStorageBytes
: (typeof maxStorageBytes === 'string' ? parseStorageSize(maxStorageBytes) : 0);
config.backups[name] = {
...backupConfig,
enabled: true,
schedule,
maxStorageBytes: maxBytes,
destinations: backupConfig.destinations || [{ type: 'local' }]
};
backupManager.updateConfig(config);
success(res, { message: `Backup '${name}' scheduled`, maxStorageBytes: maxBytes });
}, 'backups-schedule'));
// Restore from backup
router.post('/backups/restore/:backupId', asyncHandler(async (req, res) => {
const result = await backupManager.restoreBackup(req.params.backupId, req.body);
@@ -660,7 +616,7 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
*/
function calculateNextRun(lastRun, schedule) {
if (!lastRun) return null;
const intervals = {
'hourly': 60 * 60 * 1000,
'daily': 24 * 60 * 60 * 1000,
@@ -669,7 +625,7 @@ function calculateNextRun(lastRun, schedule) {
};
const baseInterval = intervals[schedule];
if (baseInterval) {
return new Date(lastRun.getTime() + baseInterval);
}
@@ -697,121 +653,3 @@ function formatBytes(bytes) {
const i = Math.floor(Math.log(bytes) / Math.log(k));
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
}
/**
* Get storage information for the backup directory
*/
async function getStorageInfo() {
const result = {
destination: DEFAULT_BACKUP_DIR,
maxStorageBytes: DEFAULT_MAX_STORAGE_BYTES,
usedBytes: 0,
availableBytes: 0,
usagePercent: 0,
backupCount: 0,
oldestBackup: null,
newestBackup: null
};
try {
// Get disk space info
const diskSpace = await getDiskSpaceInfo(DEFAULT_BACKUP_DIR);
result.availableBytes = diskSpace.available;
// Scan for backup files
if (DEFAULT_MAX_STORAGE_BYTES > 0) {
result.maxStorageBytes = DEFAULT_MAX_STORAGE_BYTES;
} else {
result.maxStorageBytes = diskSpace.total || 0;
}
let totalSize = 0;
let oldestTime = null;
let newestTime = null;
try {
const entries = await fsp.readdir(DEFAULT_BACKUP_DIR);
for (const entry of entries) {
if (entry.endsWith('.backup')) {
const filePath = path.join(DEFAULT_BACKUP_DIR, entry);
try {
const stats = await fsp.stat(filePath);
totalSize += stats.size;
result.backupCount++;
const fileTime = new Date(stats.mtime);
if (!oldestTime || fileTime < oldestTime) oldestTime = fileTime;
if (!newestTime || fileTime > newestTime) newestTime = fileTime;
} catch (e) {
// Skip files we can't stat
}
}
}
} catch (e) {
// Backup directory might not exist yet
}
result.usedBytes = totalSize;
result.oldestBackup = oldestTime ? oldestTime.toISOString() : null;
result.newestBackup = newestTime ? newestTime.toISOString() : null;
// Calculate available (total limit - used), or from disk space if no limit set
if (result.maxStorageBytes > 0) {
result.availableBytes = Math.max(0, result.maxStorageBytes - totalSize);
result.usagePercent = parseFloat(((totalSize / result.maxStorageBytes) * 100).toFixed(2));
} else if (diskSpace.total) {
result.availableBytes = diskSpace.available;
result.usagePercent = diskSpace.total > 0
? parseFloat((((diskSpace.total - diskSpace.available) / diskSpace.total) * 100).toFixed(2))
: 0;
}
} catch (error) {
console.error('[BackupsRouter] Error getting storage info:', error.message);
}
return result;
}
/**
* Get disk space info (filesystem-agnostic)
*/
async function getDiskSpaceInfo(dirPath) {
try {
const diskInfo = await fsp.statfs(dirPath);
return {
total: diskInfo.blocks * diskInfo.bsize,
available: diskInfo.bfree * diskInfo.bsize,
used: (diskInfo.blocks - diskInfo.bfree) * diskInfo.bsize
};
} catch (error) {
// Directory might not exist or be accessible
return { total: 0, available: 0, used: 0 };
}
}
/**
* Parse storage size string like "10GB" to bytes
*/
function parseStorageSize(sizeStr) {
if (!sizeStr || typeof sizeStr === 'number') return sizeStr || 0;
const match = String(sizeStr).match(/^(\d+(?:\.\d+)?)\s*(B|KB|MB|GB|TB|K|M|G|T)?$/i);
if (!match) return 0;
const value = parseFloat(match[1]);
const unit = (match[2] || 'B').toUpperCase();
const multipliers = {
'B': 1,
'K': 1024,
'KB': 1024,
'M': 1024 * 1024,
'MB': 1024 * 1024,
'G': 1024 * 1024 * 1024,
'GB': 1024 * 1024 * 1024,
'T': 1024 * 1024 * 1024 * 1024,
'TB': 1024 * 1024 * 1024 * 1024
};
return Math.floor(value * (multipliers[unit] || 1));
}
+1 -18
View File
@@ -322,26 +322,9 @@ module.exports = function({
// ===== HEALTH CHECK (health-checker module) =====
// Get current status for all services
// Returns {status: {...per-service}} plus a {summary} block for the System Overview widget
// — see skill references/totp-and-system-overview-pitfalls.md §3
router.get('/health-checks/status', asyncHandler(async (req, res) => {
const status = healthChecker.getCurrentStatus();
const entries = Object.values(status || {});
// Treat 'up'/'healthy' as healthy, everything else as unhealthy.
// Health check status values come from healthChecker — typically 'up'/'down' but
// also 'healthy'/'unhealthy' or 'online'/'offline' depending on the source. Be
// permissive on the healthy side so a service in any positive state counts.
const healthy = entries.filter(s => {
const st = (s && (s.status || s.state)) || '';
return st === 'up' || st === 'healthy' || st === 'online';
}).length;
const unhealthy = entries.filter(s => {
const st = (s && (s.status || s.state)) || '';
return st === 'down' || st === 'unhealthy' || st === 'offline' || st === 'error';
}).length;
const unknown = entries.length - healthy - unhealthy;
const summary = { healthy, unhealthy, unknown, total: entries.length };
success(res, { status, summary });
success(res, { status });
}, 'health-check-status'));
// Get service statistics
+1 -14
View File
@@ -16,21 +16,8 @@ module.exports = function({ resourceMonitor, docker, asyncHandler, log, notifica
// ===== RESOURCE MONITORING ENDPOINTS =====
// Get all container stats (from resource monitor module)
// Flattened for the System Overview widget — see skill references/totp-and-system-overview-pitfalls.md §3
router.get('/monitoring/stats', asyncHandler(async (req, res) => {
const raw = resourceMonitor.getAllStats();
const stats = {};
for (const [id, data] of Object.entries(raw || {})) {
const cur = data.current || {};
const cpuObj = (cur.cpu && typeof cur.cpu === 'object') ? cur.cpu : null;
const memObj = (cur.memory && typeof cur.memory === 'object') ? cur.memory : null;
stats[id] = {
name: data.name,
cpu: cpuObj ? (cpuObj.percent ?? 0) : (Number(cur.cpu) || 0),
memory: memObj ? (memObj.percent ?? 0) : (Number(cur.memory) || 0),
memoryUsage: memObj ? (memObj.usage ?? 0) : 0,
};
}
const stats = resourceMonitor.getAllStats();
success(res, { stats });
}, 'monitoring-stats'));
+17 -8
View File
@@ -196,12 +196,12 @@ module.exports = function({
// ===== SERVICE CREDENTIAL ENDPOINTS =====
// Store credentials for a service
router.post('/services/:serviceId/credentials', asyncHandler(async (req, res) => {
router.post('/:serviceId/credentials', asyncHandler(async (req, res) => {
const { serviceId } = req.params;
// Validate serviceId to prevent path traversal in credential keys
if (!serviceId || !/^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$/.test(serviceId)) {
return errorResponse(res, 400, 'Invalid service ID');
return ctx.errorResponse(res, 400, 'Invalid service ID');
}
const { apiKey, username, password } = req.body;
@@ -220,12 +220,12 @@ module.exports = function({
}, 'store-service-creds'));
// Delete credentials for a service
router.delete('/services/:serviceId/credentials', asyncHandler(async (req, res) => {
router.delete('/:serviceId/credentials', asyncHandler(async (req, res) => {
const { serviceId } = req.params;
// Validate serviceId to prevent path traversal in credential keys
if (!serviceId || !/^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$/.test(serviceId)) {
return errorResponse(res, 400, 'Invalid service ID');
return ctx.errorResponse(res, 400, 'Invalid service ID');
}
await credentialManager.delete(`service.${serviceId}.apikey`);
@@ -235,12 +235,12 @@ module.exports = function({
}, 'delete-service-creds'));
// Check credential status for a service (what's stored)
router.get('/services/:serviceId/credentials', asyncHandler(async (req, res) => {
router.get('/:serviceId/credentials', asyncHandler(async (req, res) => {
const { serviceId } = req.params;
// Validate serviceId to prevent path traversal in credential keys
if (!serviceId || !/^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$/.test(serviceId)) {
return errorResponse(res, 400, 'Invalid service ID');
return ctx.errorResponse(res, 400, 'Invalid service ID');
}
const arrKey = await credentialManager.retrieve(`arr.${serviceId}.apikey`).catch(() => null);
const svcKey = await credentialManager.retrieve(`service.${serviceId}.apikey`).catch(() => null);
@@ -372,7 +372,7 @@ module.exports = function({
// Add a new service
router.post('/services', asyncHandler(async (req, res) => {
try {
const { id, name, logo } = req.body;
const { id, name, logo, category, containerId, port, ip, tailscaleOnly } = req.body;
if (!id || !name) {
throw new ValidationError('id and name are required');
@@ -391,7 +391,14 @@ module.exports = function({
throw new ConflictError(`Service "${id}" already exists`, id);
}
services.push({ id, name, logo: logo || `/assets/${id}.png` });
const newService = { id, name, logo: logo || `/assets/${id}.png` };
// Persist optional metadata fields if provided
if (category) newService.category = category;
if (containerId) newService.containerId = containerId;
if (port) newService.port = port;
if (ip) newService.ip = ip;
if (typeof tailscaleOnly === 'boolean') newService.tailscaleOnly = tailscaleOnly;
services.push(newService);
return services;
});
@@ -542,6 +549,8 @@ module.exports = function({
};
if (name) services[serviceIndex].name = name;
if (logo) services[serviceIndex].logo = logo;
// Allow category update via update endpoint too (optional body field)
if (req.body.category !== undefined) services[serviceIndex].category = req.body.category || undefined;
results.services = 'updated';
} else {
results.services = 'not found';
+1 -6
View File
@@ -134,16 +134,11 @@ restart_container() {
# Stop and remove existing container so new env var is applied
docker rm -f "$CONTAINER_NAME" 2>/dev/null || true
# Re-create with same volumes. CRITICAL: must include CREDENTIALS_FILE +
# ENCRYPTION_KEY_FILE pointing at /app/data/ so the container reads the TOTP
# secret from the bind-mounted host data dir (not image-local /app/credentials.json
# which gets a fresh encryption key on every container recreate = TOTP breaks).
# Re-create with same volumes and the SERVICES_FILE env var
docker run -d --restart unless-stopped --name "$CONTAINER_NAME" \
-p 127.0.0.1:3001:3001 \
-v /opt/dashcaddy/dashcaddy-api/data:/app/data \
-e SERVICES_FILE=/app/data/services.json \
-e CREDENTIALS_FILE=/app/d...son \
-e ENCRYPTION_KEY_FILE=/app/data/.encryption-key \
"$image"
log "Container restarted with fresh env"
}
+4 -7
View File
@@ -3,7 +3,6 @@
* Minimal startup script - all logic moved to src/
*/
const { createApp } = require('./src/app');
const { fetchT } = require('./src/utils/http');
const platformPaths = require('./platform-paths');
// Unhandled error handlers
@@ -67,10 +66,6 @@ process.on('uncaughtException', (error) => {
const selfUpdater = require('./self-updater');
const portLockManager = require('./port-lock-manager');
// Create servicesStateManager early — needed by workflow engine init
const StateManager = require('./state-manager');
const servicesStateManager = new StateManager(SERVICES_FILE);
// Optional modules
let dockerMaintenance, logDigest, bundledWorkflows;
try { dockerMaintenance = require('./docker-maintenance'); } catch { /* optional */ }
@@ -85,7 +80,7 @@ process.on('uncaughtException', (error) => {
// Create a context with needed services
const workflowCtx = {
docker: { client: require('dockerode')() },
notification: new (require('./notification-manager'))({
notification: require('./notification-manager')({
NOTIFICATIONS_FILE: process.env.NOTIFICATIONS_FILE || require('./platform-paths').notificationsFile,
fetchT,
log,
@@ -138,7 +133,9 @@ process.on('uncaughtException', (error) => {
(async () => {
try {
const { syncHealthCheckerServices } = require('./startup-validator');
const StateManager = require('./state-manager');
const servicesStateManager = new StateManager(SERVICES_FILE);
await syncHealthCheckerServices({
log,
SERVICES_FILE,
+3 -22
View File
@@ -12,8 +12,6 @@ const { assembleContext } = require('./context');
const { createLogger, logError, safeErrorMessage } = require('./utils/logging');
const { fetchT } = require('./utils/http');
const { errorResponse, ok } = require('./utils/responses');
// Note: 3-arg asyncHandler signature (logError, fn, context) preserved per Hermes review
// — 49 route files still use this signature.
const { asyncHandler } = require('./utils/async-handler');
// Managers and utilities
@@ -166,21 +164,6 @@ async function createApp() {
return null;
}
// Back-compat: reverse-proxy SSO snippets (Caddy forward_auth + per-service
// auto-login pages) historically call these endpoints under the pre-1.5.0
// prefix `/api/auth/...`. The canonical mount is `/api/v1`. Hand-maintained
// Caddyfiles have repeatedly drifted back to the old prefix and 404'd the SSO
// gate (breaking Plex/Jellyfin/Emby/chat). Transparently rewrite ONLY these two
// auth paths to the v1 mount so the gate is tolerant of that drift. Must run
// before configureMiddleware() so CSRF/auth see the canonical path. This is
// deliberately narrow — NOT a general `/api` -> `/api/v1` alias.
app.use((req, res, next) => {
if (req.url.startsWith('/api/auth/gate/') || req.url.startsWith('/api/auth/app-token/')) {
req.url = '/api/v1' + req.url.slice(4); // '/api'.length === 4
}
next();
});
// Configure middleware
const middlewareResult = configureMiddleware(app, {
siteConfig: config.siteConfig,
@@ -256,13 +239,11 @@ async function createApp() {
});
}
// Create bound logError function (3-arg signature: ctx, err, extra)
// The unified logger module has its own ERROR_LOG_FILE from process.env,
// so we just route through its logErrorWrapper.
// Create bound logError function
const boundLogError = (context, error, additionalInfo) =>
logError(context, error, additionalInfo);
logError(config.ERROR_LOG_FILE, config.MAX_ERROR_LOG_SIZE, context, error, additionalInfo, log);
// Create bound asyncHandler (3-arg: logError, fn, context)
// Create bound asyncHandler
const boundAsyncHandler = (fn, context) => asyncHandler(boundLogError, fn, context);
// Assemble context
+90 -402
View File
@@ -1,431 +1,119 @@
/**
* DashCaddy Unified Logger
*
* Single logging system for the entire application.
* - Structured JSON to stdout/stderr (pretty-printed in development)
* - Human-readable errors to error.log with rotation
* - Audit entries to audit-log.json
* - All via log.info / log.warn / log.error / log.debug
*
* Usage:
* const { log } = require('./logger');
* log.info('server', 'Server started', { port: 3001 });
* log.error('container', 'Failed to start', err, { req });
* log.audit({ action: 'service.create', resource: 'nginx', outcome: 'success', ip, details });
* Logging utilities - Structured logging and error handling
*/
const fs = require('fs');
const fsp = require('fs').promises;
const path = require('path');
const crypto = require('crypto');
const EventEmitter = require('events');
// ─── Configuration ──────────────────────────────────────────────────────────
const LOG_LEVELS = { debug: 0, info: 1, warn: 2, error: 3 };
const LOG_DIR = process.env.LOG_DIR || __dirname;
const ERROR_LOG_FILE = process.env.ERROR_LOG_FILE || path.join(LOG_DIR, 'error.log');
const AUDIT_LOG_FILE = process.env.AUDIT_LOG_FILE || path.join(LOG_DIR, 'audit-log.json');
const MAX_ERROR_LOG_SIZE = 5 * 1024 * 1024; // 5 MB
const MAX_AUDIT_ENTRIES = 1000;
const AUDIT_MAX_FILE_SIZE = 10 * 1024 * 1024; // 10 MB
const NODE_ENV = process.env.NODE_ENV || 'development';
const IS_DEV = NODE_ENV !== 'production';
// ─── Log levels ───────────────────────────────────────────────────────────────
const LEVELS = { debug: 0, info: 1, warn: 2, error: 3 };
let GLOBAL_LEVEL = IS_DEV ? LEVELS.debug : LEVELS.info;
// ─── Console colours ─────────────────────────────────────────────────────────
const C = {
reset: '\x1b[0m',
dim: '\x1b[2m',
red: '\x1b[31m',
yellow: '\x1b[33m',
green: '\x1b[32m',
cyan: '\x1b[36m',
};
const LEVEL_COLOUR = { debug: C.dim, info: C.green, warn: C.yellow, error: C.red };
const LEVEL_PREFIX = {
debug: `${C.dim}[DBG]${C.reset}`,
info: `${C.green}[INF]${C.reset}`,
warn: `${C.yellow}[WRN]${C.reset}`,
error: `${C.red}[ERR]${C.reset}`,
};
// ─── Time formatter ───────────────────────────────────────────────────────────
function pad(n, len = 2) { return String(n).padStart(len, '0'); }
function formatTime() {
const d = new Date();
return `${d.getFullYear()}-${pad(d.getMonth()+1)}-${pad(d.getDate())} ${pad(d.getHours())}:${pad(d.getMinutes())}:${pad(d.getSeconds())}`;
}
// ─── Console output (dev = pretty, prod = JSON) ─────────────────────────────
function consoleWrite(level, ctx, msg, data) {
if (GLOBAL_LEVEL > LEVELS[level]) return;
if (IS_DEV) {
const colour = LEVEL_COLOUR[level] || C.reset;
const parts = [
`${C.dim}${formatTime()}${C.reset}`,
LEVEL_PREFIX[level],
`${C.cyan}${ctx}${C.reset}`,
`${msg}`,
];
if (data && typeof data === 'object' && !(data instanceof Error)) {
parts.push(`${C.dim}${JSON.stringify(data)}${C.reset}`);
}
const fn = level === 'error' ? console.error : level === 'warn' ? console.warn : console.log;
fn(parts.join(' '));
} else {
/**
* Create a structured logger
*/
function createLogger(LOG_LEVEL) {
function log(level, context, message, data = {}) {
if (LOG_LEVELS[level] < LOG_LEVEL) return;
const entry = {
t: new Date().toISOString(), level, ctx, msg,
...(data instanceof Error
? { error: { message: data.message, code: data.code, stack: data.stack } }
: (data && typeof data === 'object' ? { data } : {})),
t: new Date().toISOString(),
level,
ctx: context,
msg: message,
};
(level === 'error' ? console.error : console.info)(JSON.stringify(entry));
if (Object.keys(data).length) entry.data = data;
const fn = level === 'error' ? console.error : level === 'warn' ? console.warn : console.info;
fn(JSON.stringify(entry));
}
log.info = (ctx, msg, data) => log('info', ctx, msg, data);
log.warn = (ctx, msg, data) => log('warn', ctx, msg, data);
log.error = (ctx, msg, data) => log('error', ctx, msg, data);
log.debug = (ctx, msg, data) => log('debug', ctx, msg, data);
return log;
}
// ─── Error log file ──────────────────────────────────────────────────────────────
/**
* Enhanced error logging with context tracking
*/
async function logError(ERROR_LOG_FILE, MAX_ERROR_LOG_SIZE, context, error, additionalInfo = {}, log) {
const timestamp = new Date().toISOString();
// Extract request context
const requestContext = {};
if (additionalInfo.req) {
const req = additionalInfo.req;
const clientIP = req.ip || req.socket?.remoteAddress || '';
requestContext.requestId = req.id;
requestContext.ip = clientIP;
requestContext.userAgent = req.get('user-agent');
requestContext.method = req.method;
requestContext.path = req.path;
delete additionalInfo.req;
}
const logEntry = {
timestamp,
context,
...requestContext,
error: {
message: error.message || error,
stack: error.stack,
code: error.code
},
...additionalInfo
};
const contextInfo = Object.keys(requestContext).length > 0
? `\nRequest Context: ${JSON.stringify(requestContext, null, 2)}`
: '';
const logLine = `[${timestamp}] ${context}: ${error.message || error}\n${error.stack || ''}${contextInfo}\nAdditional Info: ${JSON.stringify(additionalInfo, null, 2)}\n${'='.repeat(80)}\n`;
async function appendErrorLog(line) {
try {
const stats = await fsp.stat(ERROR_LOG_FILE).catch(() => null);
if (stats && stats.size > MAX_ERROR_LOG_SIZE) {
const rotated = ERROR_LOG_FILE + '.1';
await fsp.unlink(rotated).catch(() => {});
await fsp.rename(ERROR_LOG_FILE, rotated);
}
await fsp.appendFile(ERROR_LOG_FILE, line + '\n');
} catch (e) {
console.error('[logger] Failed to write error.log:', e.message);
}
}
async function writeErrorLog(ctx, error, req, extra) {
const ts = new Date().toISOString();
const errMsg = error instanceof Error ? error.message : String(error);
const errStack = error instanceof Error ? error.stack : '';
const parts = [`[${ts}] [ERR] ${ctx}: ${errMsg}`];
if (errStack) parts.push(errStack);
if (req) {
const ip = req.ip || req.socket?.remoteAddress || '';
const ua = req.get ? req.get('user-agent') : '';
parts.push(` request: ${req.method || ''} ${req.path || ''} | ip: ${ip} | ua: ${ua}${req.id ? ' | id: ' + req.id : ''}`);
}
if (extra && Object.keys(extra).length) {
parts.push(` context: ${JSON.stringify(extra)}`);
}
parts.push('─'.repeat(72));
await appendErrorLog(parts.join('\n'));
}
// ─── Audit log ─────────────────────────────────────────────────────────────────
const AUDIT_SKIP_PATHS = [
'/api/v1/totp/verify',
'/api/v1/totp/check-session',
'/api/v1/auth/gate/',
'/api/v1/auth/app-token/',
'/api/v1/audit-logs',
'/api/v1/health',
'/health',
'/api/v1/notifications/test',
'/api/v1/notifications/health-check',
];
const AUDIT_ACTION_MAP = {
'POST /api/v1/services/update': 'service.reorder',
'POST /api/v1/services': 'service.create',
'PUT /api/v1/services': 'service.update',
'DELETE /api/v1/services/': 'service.delete',
'POST /api/v1/site': 'caddy.add-site',
'POST /api/v1/site/external': 'caddy.add-external',
'DELETE /api/v1/site/': 'caddy.remove-site',
'POST /api/v1/caddy/reload': 'caddy.reload',
'POST /api/v1/dns/record': 'dns.add-record',
'DELETE /api/v1/dns/record': 'dns.delete-record',
'POST /api/v1/dns/credentials': 'dns.save-credentials',
'DELETE /api/v1/dns/credentials': 'dns.delete-credentials',
'POST /api/v1/dns/refresh-token': 'dns.refresh-token',
'POST /api/v1/dns/update': 'dns.update-server',
'POST /api/v1/containers/': 'container.action',
'DELETE /api/v1/containers/': 'container.delete',
'POST /api/v1/apps/deploy': 'container.deploy',
'DELETE /api/v1/apps/': 'container.undeploy',
'POST /api/v1/backups/execute': 'backup.execute',
'POST /api/v1/backups/restore/': 'backup.restore',
'POST /api/v1/backups/config': 'backup.config',
'POST /api/v1/config': 'config.update',
'DELETE /api/v1/config': 'config.reset',
'POST /api/v1/notifications/config': 'config.notifications',
'POST /api/v1/totp/setup': 'auth.totp-setup',
'POST /api/v1/totp/verify-setup': 'auth.totp-activate',
'POST /api/v1/totp/disable': 'auth.totp-disable',
'POST /api/v1/totp/config': 'auth.totp-config',
'POST /api/v1/credentials/rotate-key': 'config.rotate-key',
'POST /api/v1/updates/update/': 'container.update',
'POST /api/v1/updates/rollback/': 'container.rollback',
'POST /api/v1/updates/auto-update/': 'container.auto-update',
'POST /api/v1/updates/check': 'container.check-updates',
'POST /api/v1/health-checks/': 'config.health-check',
'DELETE /api/v1/health-checks/': 'config.health-check-delete',
'POST /api/v1/monitoring/alerts/': 'config.monitoring-alert',
'DELETE /api/v1/monitoring/alerts/': 'config.monitoring-alert-delete',
'POST /api/v1/arr/smart-connect': 'service.arr-connect',
'POST /api/v1/arr/credentials': 'config.arr-credentials',
'DELETE /api/v1/arr/credentials/': 'config.arr-credentials-delete',
'POST /api/v1/logo': 'config.logo-upload',
'DELETE /api/v1/logo': 'config.logo-delete',
'POST /api/v1/favicon': 'config.favicon-upload',
'DELETE /api/v1/favicon': 'config.favicon-delete',
'POST /api/v1/tailscale/config': 'config.tailscale',
'POST /api/v1/tailscale/protect-service': 'config.tailscale-protect',
};
const SENSITIVE_KEYS = ['password', 'token', 'secret', 'apikey', 'encryptionKey', 'code', 'secretKey', 'authToken'];
function sanitize(obj) {
if (!obj || typeof obj !== 'object') return obj;
const clean = Array.isArray(obj) ? [] : {};
for (const [k, v] of Object.entries(obj)) {
clean[k] = SENSITIVE_KEYS.includes(k) ? '***' : v && typeof v === 'object' ? sanitize(v) : v;
}
return clean;
}
async function appendAuditLog(entries) {
try {
let existing = [];
// Rotate log if it exceeds max size
try {
const raw = await fsp.readFile(AUDIT_LOG_FILE, 'utf8');
existing = JSON.parse(raw);
if (!Array.isArray(existing)) existing = [];
} catch (_) { /* start fresh */ }
const merged = [...entries, ...existing].slice(0, MAX_AUDIT_ENTRIES);
const stats = await fsp.stat(AUDIT_LOG_FILE).catch(() => null);
if (stats && stats.size > AUDIT_MAX_FILE_SIZE) {
await fsp.writeFile(AUDIT_LOG_FILE, JSON.stringify(merged.slice(0, Math.floor(MAX_AUDIT_ENTRIES / 2)), null, 2));
} else {
await fsp.writeFile(AUDIT_LOG_FILE, JSON.stringify(merged, null, 2));
}
const stats = await fsp.stat(ERROR_LOG_FILE);
if (stats.size > MAX_ERROR_LOG_SIZE) {
const rotated = ERROR_LOG_FILE + '.1';
const exists = await fsp.access(rotated).then(() => true).catch(() => false);
if (exists) await fsp.unlink(rotated);
await fsp.rename(ERROR_LOG_FILE, rotated);
}
} catch (_) { /* file may not exist yet */ }
await fsp.appendFile(ERROR_LOG_FILE, logLine);
} catch (e) {
console.error('[logger] Failed to write audit log:', e.message);
if (log && log.error) {
log.error('errorlog', 'Failed to write to error log', { error: e.message });
}
}
}
// ─── Main Logger class ──────────────────────────────────────────────────────────
class Logger extends EventEmitter {
constructor() {
super();
this._level = GLOBAL_LEVEL;
}
_should(level) {
return LEVELS[level] >= this._level;
}
debug(ctx, msg, data) { this._log('debug', ctx, msg, data); }
info(ctx, msg, data) { this._log('info', ctx, msg, data); }
warn(ctx, msg, data) { this._log('warn', ctx, msg, data); }
/**
* Log an error — always writes to error.log and console.
* @param {string} ctx — context label (e.g. 'container', 'dns')
* @param {Error|string} err — the error
* @param {object} req — optional request for request context
* @param {object} extra — extra context data (not the error itself)
*/
error(ctx, err, req, extra) {
const errObj = err instanceof Error ? err : new Error(String(err));
const payload = extra && Object.keys(extra).length ? extra : undefined;
this._log('error', ctx, errObj.message, errObj, { req, payload });
}
_log(level, ctx, msg, data, { req, payload } = {}) {
if (LEVELS[level] < this._level) return;
const entry = {
t: new Date().toISOString(), level, ctx, msg,
...(data instanceof Error ? { error: { message: data.message, code: data.code, stack: data.stack } } : {}),
...(payload ? { data: payload } : {}),
};
if (req && (req.id || req.ip || req.path)) {
entry.requestId = req.id || null;
entry.ip = req.ip || req.socket?.remoteAddress || null;
entry.method = req.method || null;
entry.path = req.path || null;
}
this.emit('entry', entry);
consoleWrite(level, ctx, msg, data);
if (level === 'error') {
const errObj = data instanceof Error ? data : (data && data.message ? new Error(data.message) : new Error(msg));
// Await the error log write so callers using await on log.error()
// can rely on the file being flushed before proceeding.
return writeErrorLog(ctx, errObj, req, payload);
}
}
/**
* Emit an audit entry directly
*/
async audit({ action, resource, details, outcome, ip }) {
const entry = {
id: crypto.randomUUID(),
timestamp: new Date().toISOString(),
ip: ip || '',
action: action || '',
resource: resource || '',
details: details ? sanitize(details) : {},
outcome: outcome || 'unknown',
};
await appendAuditLog([entry]);
return entry;
}
/**
* Express audit middleware — call app.use(log.auditMiddleware()) once
*/
auditMiddleware() {
return (req, res, next) => {
if (req.method === 'GET') return next();
if (AUDIT_SKIP_PATHS.some(p => req.path.startsWith(p))) return next();
const originalJson = res.json.bind(res);
res.json = (body) => {
const action = this._resolveAuditAction(req.method, req.path);
const resource = this._resolveAuditResource(req.path);
const outcome = body && body.success === false ? 'failure' : 'success';
const ip = req.ip || req.socket?.remoteAddress || '';
const details = {};
if (req.params && Object.keys(req.params).length) details.params = req.params;
if (req.body) details.body = sanitize(req.body);
this.audit({ action, resource, details, outcome, ip });
return originalJson(body);
};
next();
};
}
_resolveAuditAction(method, urlPath) {
const key = `${method} ${urlPath}`;
if (AUDIT_ACTION_MAP[key]) return AUDIT_ACTION_MAP[key];
for (const [pattern, action] of Object.entries(AUDIT_ACTION_MAP)) {
if (key.startsWith(pattern)) return action;
}
const parts = urlPath.replace('/api/v1/', '').split('/');
return `${parts[0] || 'unknown'}.${method.toLowerCase()}`;
}
_resolveAuditResource(urlPath) {
const parts = urlPath.replace('/api/v1/', '').split('/');
if (parts.length >= 2) return parts.slice(1).join('/');
return parts[0] || '';
}
/**
* Query audit log entries
*/
async queryAudit({ limit = 50, offset = 0, action } = {}) {
try {
let entries = JSON.parse(await fsp.readFile(AUDIT_LOG_FILE, 'utf8'));
if (!Array.isArray(entries)) entries = [];
if (action) entries = entries.filter(e => e.action && e.action.startsWith(action));
return entries.slice(offset, offset + limit);
} catch (_) {
return [];
}
}
clearAuditLog() {
return fsp.writeFile(AUDIT_LOG_FILE, JSON.stringify([])).catch(() => {});
}
/**
* Read error log (raw lines from error.log + error.log.1)
*/
async readErrorLog(tail = 100) {
const results = [];
for (const file of [ERROR_LOG_FILE, ERROR_LOG_FILE + '.1']) {
try {
const lines = (await fsp.readFile(file, 'utf8')).split('\n').filter(Boolean);
results.push(...lines.map(l => ({ file: path.basename(file), text: l })));
} catch (_) { /* missing */ }
}
return results.slice(-tail);
}
setLevel(lvl) {
if (lvl in LEVELS) this._level = LEVELS[lvl];
}
getLevel() {
return Object.entries(LEVELS).find(([, v]) => v === this._level)?.[0] ?? 'debug';
}
}
// ─── Global singleton ──────────────────────────────────────────────────────────
const log = new Logger();
// ─── Safe error messages ─────────────────────────────────────────────────────────
/**
* Return a safe error message without leaking internals
*/
function safeErrorMessage(error) {
if (!error) return 'An internal error occurred';
const msg = error.message || String(error);
// Detect port conflict errors
const portMatch = msg.match(/exposing port TCP [^:]*:(\d+)/);
if (portMatch || msg.includes('port is already allocated') || msg.includes('ports are not available')) {
return `[DC-200] Port ${portMatch ? portMatch[1] : 'requested'} is already in use. Try a different port or stop the service using that port first.`;
const port = portMatch ? portMatch[1] : 'requested';
return `[DC-200] Port ${port} is already in use. Try a different port or stop the service using that port first.`;
}
if (msg.includes('No such container')) return 'Container not found';
if (msg.includes('ECONNREFUSED') || msg.includes('ETIMEDOUT')) return 'Service unavailable';
if (msg.length < 200 && !msg.includes('/') && !msg.includes('\\') && !msg.includes(' at ')) return msg;
// Only expose short, user-facing messages
if (msg.length < 200 && !msg.includes('/') && !msg.includes('\\') && !msg.includes(' at ')) {
return msg;
}
return 'An internal error occurred';
}
// ─── Convenience wrapper compatible with the old logError(logDir)() signature ──────
// Supports: logError(context, error, extra) → existing route call pattern
async function logErrorWrapper(ctx, err, extra) {
const req = extra?.req;
const payload = extra ? { ...extra } : {};
if (payload.req) delete payload.req;
await log.error(ctx, err instanceof Error ? err : new Error(String(err)), req, payload);
}
// ─── Exports ─────────────────────────────────────────────────────────────────────
module.exports = {
log,
setLevel: (lvl) => {
if (lvl in LEVELS) {
GLOBAL_LEVEL = LEVELS[lvl];
log.setLevel(lvl); // also update the singleton instance
}
},
// Backwards-compatible alias: older callers (src/app.js) use createLogger(LOG_LEVEL)
// and expect a `log.info/warn/error/debug` function back. The unified logger is
// a single global instance, so we set the level and return it.
createLogger: (level) => { if (level in LEVELS) GLOBAL_LEVEL = LEVELS[level]; return log; },
LOG_LEVELS,
createLogger,
logError,
safeErrorMessage,
logError: logErrorWrapper,
AUDIT_LOG_FILE,
ERROR_LOG_FILE,
MAX_ERROR_LOG_SIZE,
MAX_AUDIT_ENTRIES,
AUDIT_SKIP_PATHS,
AUDIT_ACTION_MAP,
SENSITIVE_KEYS,
};
-56
View File
@@ -27,14 +27,10 @@ readonly API_DIR="${SITES_DIR}/dashcaddy-api"
readonly DASHBOARD_DIR="${SITES_DIR}/status"
readonly CONTAINER_NAME="dashcaddy-api"
readonly CADDY_ADMIN_PORT=2019
readonly BACKUP_DIR="${BACKUP_DIR:-${INSTALL_DIR}/backups}"
readonly DEFAULT_MAX_STORAGE_BYTES=""
# ---- Tunables (overridable via flags) --------------------------------------
API_PORT=3001
LOCAL_PORT=8080
BACKUP_DIR=""
BACKUP_LIMIT=""
# ---- Runtime state ---------------------------------------------------------
DOMAIN_MODE="" # public | custom-tld | local
@@ -393,7 +389,6 @@ EOF
create_directories() {
mkdir -p "$INSTALL_DIR" "$DOCKER_DATA" "$SITES_DIR" "$API_DIR" "$DASHBOARD_DIR" "${DASHBOARD_DIR}/assets"
mkdir -p /opt/dashcaddy/updates /opt/dashcaddy/scripts
mkdir -p "${BACKUP_DIR}"
ok "Directories created"
}
@@ -631,41 +626,7 @@ CEOF
# Docker Compose
# ============================================================================
# Parse size string like "10GB" or "1TB" to bytes
parse_size_to_bytes() {
local size="$1"
local value unit
# Strip whitespace
size=$(echo "$size" | tr -d ' ')
# Extract numeric value and unit
if [[ $size =~ ^([0-9.]+)([kmgtKMGT][bb]?|[bB]?)$ ]]; then
value="${BASH_REMATCH[1]}"
unit="${BASH_REMATCH[2]}"
# Normalize unit to uppercase without 'B' suffix for simplicity
unit=$(echo "$unit" | tr '[:lower:]' '[:upper:]')
case "$unit" in
K|KB) echo $((value * 1024)) ;;
M|MB) echo $((value * 1024 * 1024)) ;;
G|GB) echo $((value * 1024 * 1024 * 1024)) ;;
T|TB) echo $((value * 1024 * 1024 * 1024 * 1024)) ;;
*) echo "$value" ;;
esac
else
# Not recognized, treat as raw bytes
echo "$size"
fi
}
generate_docker_compose() {
# Convert BACKUP_LIMIT to bytes if set (e.g., "10GB" -> 10737418240)
local backup_limit_bytes=""
if [[ -n "$BACKUP_LIMIT" ]]; then
backup_limit_bytes=$(parse_size_to_bytes "$BACKUP_LIMIT")
fi
cat > "${API_DIR}/docker-compose.yml" <<DCEOF
services:
dashcaddy-api:
@@ -687,7 +648,6 @@ services:
- ${DASHBOARD_DIR}:/app/dashboard:rw
- /opt/dashcaddy/updates:/app/updates:rw
- /var/run/docker.sock:/var/run/docker.sock
- dashcaddy-backups:/app/backups
environment:
- CADDYFILE_PATH=/caddyfile
- CADDY_ADMIN_URL=http://host.docker.internal:${CADDY_ADMIN_PORT}
@@ -705,10 +665,6 @@ services:
- DASHCADDY_HOST_UPDATES_DIR=/opt/dashcaddy/updates
- DASHCADDY_API_SOURCE_DIR=${API_DIR}
- DASHCADDY_FRONTEND_DIR=/app/dashboard
- BACKUP_DIR=/app/backups
- BACKUP_MAX_STORAGE_BYTES=${backup_limit_bytes:-0}
- BACKUP_CONFIG_FILE=/app/backup-config.json
- BACKUP_HISTORY_FILE=/app/backup-history.json
extra_hosts:
- "host.docker.internal:host-gateway"
restart: unless-stopped
@@ -717,14 +673,6 @@ services:
options:
max-size: "10m"
max-file: "3"
volumes:
dashcaddy-backups:
driver: local
driver_opts:
type: none
o: bind
device: ${BACKUP_DIR}
DCEOF
ok "docker-compose.yml generated"
@@ -932,8 +880,6 @@ parse_args() {
--skip-caddy) SKIP_CADDY=true; shift ;;
--uninstall) UNINSTALL=true; shift ;;
--keep-config) KEEP_CONFIG=true; shift ;;
--backup-dir) BACKUP_DIR="${2:-}"; shift; shift ;;
--backup-limit) BACKUP_LIMIT="${2:-}"; shift; shift ;;
--yes|-y) AUTO_YES=true; shift ;;
--help|-h) print_help; exit 0 ;;
*) warn "Unknown option: $1 (ignored)"; shift ;;
@@ -968,8 +914,6 @@ print_help() {
--source PATH Use local source files
--skip-docker Already have Docker
--skip-caddy Already have Caddy
--backup-dir PATH Backup directory (default: /etc/dashcaddy/backups)
--backup-limit SIZE Storage limit for backups (e.g., 10GB, 1TB)
--uninstall Remove DashCaddy
--keep-config Keep configs during uninstall
--yes Skip confirmations
+4 -21
View File
@@ -226,34 +226,17 @@ class ConfigManager {
* @returns {Promise<Object>} Disk space info
*/
async getDiskSpace(testPath) {
// Note: This is a simplified version. In production, you'd use a library like 'check-disk-space'
try {
const fsPromises = require('fs').promises;
const pathModule = require('path');
// Ensure directory exists
await fsPromises.mkdir(testPath, { recursive: true });
// Use statfs for true disk space (works on all filesystems: ext4, Btrfs, XFS, ZFS, APFS, NTFS)
const stats = await fsPromises.statfs(testPath);
const totalBytes = stats.blocks * stats.bsize;
const freeBytes = stats.bfree * stats.bsize;
const availableBytes = stats.bavail * stats.bsize; // Available to non-root users
const usedBytes = totalBytes - freeBytes;
const stats = await fs.stat(testPath);
return {
available: true,
path: testPath,
total: totalBytes,
used: usedBytes,
free: freeBytes,
availableBytes: availableBytes,
usagePercent: parseFloat(((usedBytes / totalBytes) * 100).toFixed(2))
path: testPath
};
} catch (error) {
return {
available: false,
path: testPath,
error: error.message
};
}
@@ -62,11 +62,6 @@ const state = {
installPath: '',
health: null
},
// Backup configuration
backup: {
maxStorageGB: 10,
backupDir: ''
},
// Uninstall mode
uninstallMode: false,
uninstall: {
@@ -378,24 +373,6 @@ function updateBranding(field, value) {
if (field === 'primaryColor') render();
}
// Backup functions
function updateBackup(field, value) {
state.backup[field] = value;
render();
}
async function selectBackupDir() {
try {
const result = await window.electronAPI.selectFolder();
if (result.success && result.path) {
state.backup.backupDir = result.path;
render();
}
} catch (err) {
console.error('Backup dir selection failed:', err);
}
}
async function selectLogo() {
try {
const result = await window.electronAPI.selectFile({
@@ -443,10 +420,6 @@ async function startInstallation() {
password: state.dns.password,
token: state.dns.token
} : null,
backup: {
maxStorageGB: state.backup.maxStorageGB,
backupDir: state.backup.backupDir || null
},
autoStart: true
});
} catch (err) {
@@ -990,31 +963,6 @@ function renderDashboardSetup() {
<p class="hint">Port for the DashCaddy API server (default: 3001)</p>
</div>
` : ''}
<div class="folder-input">
<label>Backup Storage Limit (GB)</label>
<div class="input-row">
<input type="number"
value="${state.backup.maxStorageGB}"
min="1" max="10240"
oninput="updateBackup('maxStorageGB', parseInt(this.value) || 10)">
</div>
<p class="hint">Maximum storage for backups in GB (default: 10, max: 10TB)</p>
</div>
${state.tier !== 'basic' ? `
<div class="folder-input">
<label>Backup Directory</label>
<div class="input-row">
<input type="text"
value="${escapeHtml(state.backup.backupDir)}"
readonly
placeholder="Default: $INSTALL_DIR/backups">
<button class="btn-browse" onclick="selectBackupDir()">Browse...</button>
</div>
<p class="hint">Where backup files are stored on the host</p>
</div>
` : ''}
</div>
</div>
`;
@@ -7,28 +7,15 @@ services:
volumes:
- {{API_PATH}}:/app
- /var/run/docker.sock:/var/run/docker.sock
- dashcaddy-backups:/app/backups
environment:
- NODE_ENV=production
- PORT={{API_PORT}}
- SERVICES_FILE=/app/services.json
- CADDY_ADMIN_URL=http://host.docker.internal:2019
- BACKUP_DIR=/app/backups
- BACKUP_MAX_STORAGE_BYTES={{BACKUP_MAX_STORAGE_BYTES}}
- BACKUP_CONFIG_FILE=/app/backup-config.json
- BACKUP_HISTORY_FILE=/app/backup-history.json
restart: unless-stopped
networks:
- dashcaddy
volumes:
dashcaddy-backups:
driver: local
driver_opts:
type: none
o: bind
device: {{BACKUP_DIR}}
networks:
dashcaddy:
driver: bridge
+272
View File
@@ -0,0 +1,272 @@
const express = require('express');
const http = require('http');
/**
* OpenClaw management routes
* Proxies gateway API calls through DashCaddy so the token never leaves the server.
*
* GET /openclaw/status → container info + gateway health
* POST /openclaw/deploy → deploy OpenClaw container
* GET /openclaw/proxy/* → proxy GET to gateway
* POST /openclaw/proxy/* → proxy POST to gateway
* DELETE /openclaw → remove container
*/
module.exports = function openClawRoutes(ctx) {
const router = express.Router();
const docker = ctx.docker;
const asyncHandler = ctx.asyncHandler;
const log = ctx.log || console;
// ── helpers ──────────────────────────────────────────────────────────────
async function findOpenClawContainer() {
const containers = await docker.client.listContainers({ all: true });
return containers.find(function(c) {
return c.Image === 'ghcr.io/nousresearch/openclaw:latest' ||
(c.Labels && c.Labels['dashcaddy.managed'] === 'true' &&
c.Names.some(function(n) { return n.includes('openclaw'); }));
}) || null;
}
async function getGatewayToken(containerId) {
try {
const info = await docker.client.containerInfo(containerId);
const entry = (info.Config.Env || []).find(function(e) {
return e.startsWith('OPENCLAW_GATEWAY_TOKEN=');
});
return entry ? entry.split('=')[1] : null;
} catch(err) {
return null;
}
}
async function getContainerPort(containerId) {
try {
const containers = await docker.client.listContainers({ all: true });
const c = containers.find(function(x) {
return x.Id === containerId || x.Id.startsWith(containerId);
});
if (c && c.Ports) {
const p = c.Ports.find(function(x) { return x.PrivatePort === 18792; });
if (p && p.PublicPort) return String(p.PublicPort);
}
return '18792';
} catch(err) {
return '18792';
}
}
async function gatewayHealth(baseUrl, token) {
return new Promise(function(resolve) {
const headers = {};
if (token) headers['Authorization'] = 'Bearer ' + token;
const req = http.get(baseUrl + '/health', { headers: headers }, function(res) {
let data = '';
res.on('data', function(d) { data += d; });
res.on('end', function() {
try { resolve({ ok: true, data: JSON.parse(data) }); }
catch(e) { resolve({ ok: true, data: data }); }
});
});
req.on('error', function(e) { resolve({ ok: false, error: e.message }); });
req.setTimeout(5000, function() { req.destroy(); resolve({ ok: false, error: 'timeout' }); });
});
}
function proxyRequest(req, res, targetBase, path, token) {
const headers = {};
if (token) headers['Authorization'] = 'Bearer ' + token;
headers['X-Forwarded-For'] = req.ip;
headers['X-Forwarded-Proto'] = req.protocol;
const url = targetBase + '/' + path;
const method = req.method;
if (['POST', 'PUT', 'PATCH'].includes(method)) {
const body = JSON.stringify(req.body);
headers['Content-Type'] = 'application/json';
headers['Content-Length'] = Buffer.byteLength(body);
const proxyReq = http.request(url, { method: method, headers: headers }, function(proxyRes) {
res.set(proxyRes.headers);
res.status(proxyRes.statusCode);
proxyRes.on('data', function(d) { res.write(d); });
proxyRes.on('end', function() { res.end(); });
});
proxyReq.on('error', function(e) { res.status(502).json({ success: false, error: e.message }); });
proxyReq.setTimeout(15000, function() { proxyReq.destroy(); res.status(504).json({ success: false, error: 'gateway timeout' }); });
proxyReq.write(body);
proxyReq.end();
} else {
const proxyReq = http.get(url, { headers: headers }, function(proxyRes) {
res.set(proxyRes.headers);
res.status(proxyRes.statusCode);
proxyRes.on('data', function(d) { res.write(d); });
proxyRes.on('end', function() { res.end(); });
});
proxyReq.on('error', function(e) { res.status(502).json({ success: false, error: e.message }); });
proxyReq.setTimeout(15000, function() { proxyReq.destroy(); res.status(504).json({ success: false, error: 'gateway timeout' }); });
}
}
// ── GET /openclaw/status ────────────────────────────────────────────────
router.get('/status', asyncHandler(async function(req, res) {
const container = await findOpenClawContainer();
if (!container) {
return res.json({ success: true, deployed: false });
}
const token = await getGatewayToken(container.Id);
const port = await getContainerPort(container.Id);
const baseUrl = 'http://localhost:' + port;
const health = await gatewayHealth(baseUrl, token);
res.json({
success: true,
deployed: true,
container: {
id: container.Id.slice(0, 12),
name: container.Name,
state: container.State,
status: container.Status,
created: container.Created,
image: container.Image
},
gateway: {
url: baseUrl,
port: port,
healthy: health.ok,
healthData: health.data || null,
tokenSet: !!token
}
});
}));
// ── POST /openclaw/deploy ───────────────────────────────────────────────
router.post('/deploy', asyncHandler(async function(req, res) {
const existing = await findOpenClawContainer();
if (existing) {
return res.status(409).json({ success: false, error: 'OpenClaw is already deployed' });
}
const image = 'ghcr.io/nousresearch/openclaw:latest';
const name = 'openclaw-' + Date.now();
const gatewayToken = generateToken();
// Pull image
log.info('Pulling ' + image + '...');
try {
await new Promise(function(resolve, reject) {
docker.client.pull(image, function(err, stream) {
if (err) return reject(err);
docker.client.modem.followProgress(stream, function(err2) {
if (err2) return reject(err2);
resolve();
});
});
});
} catch(e) {
log.error('OpenClaw pull failed: ' + e.message);
return res.status(500).json({ success: false, error: 'Failed to pull image: ' + e.message });
}
// Create + start container
try {
const container = await docker.client.createContainer({
name: name,
Image: image,
Env: [
'OPENCLAW_GATEWAY_MODE=local',
'OPENCLAW_GATEWAY_TOKEN=' + gatewayToken
],
HostConfig: {
PortBindings: { '18792/tcp': [{ HostPort: '18792' }] },
RestartPolicy: { Name: 'unless-stopped' },
Labels: {
'dashcaddy.managed': 'true',
'dashcaddy.app': 'openclaw'
}
},
ExposedPorts: { '18792/tcp': {} }
});
await container.start();
log.info('OpenClaw deployed: ' + container.id.slice(0, 12));
res.json({
success: true,
deployed: true,
container: { id: container.id.slice(0, 12), name: name },
gateway: {
url: 'http://localhost:18792',
token: gatewayToken
}
});
} catch(e) {
log.error('OpenClaw deploy failed: ' + e.message);
res.status(500).json({ success: false, error: 'Deploy failed: ' + e.message });
}
}));
// ── GET /openclaw/proxy/* ───────────────────────────────────────────────
router.get('/proxy/*', asyncHandler(async function(req, res) {
const container = await findOpenClawContainer();
if (!container) return res.status(404).json({ success: false, error: 'OpenClaw not deployed' });
const token = await getGatewayToken(container.Id);
const port = await getContainerPort(container.Id);
const baseUrl = 'http://localhost:' + port;
const path = req.params[0];
proxyRequest(req, res, baseUrl, path, token);
}));
// ── POST /openclaw/proxy/* ──────────────────────────────────────────────
router.post('/proxy/*', asyncHandler(async function(req, res) {
const container = await findOpenClawContainer();
if (!container) return res.status(404).json({ success: false, error: 'OpenClaw not deployed' });
const token = await getGatewayToken(container.Id);
const port = await getContainerPort(container.Id);
const baseUrl = 'http://localhost:' + port;
const path = req.params[0];
proxyRequest(req, res, baseUrl, path, token);
}));
// ── DELETE /openclaw ───────────────────────────────────────────────────
router.delete('/', asyncHandler(async function(req, res) {
const container = await findOpenClawContainer();
if (!container) return res.status(404).json({ success: false, error: 'OpenClaw not deployed' });
try {
const c = docker.client.container(container.Id);
await c.stop().catch(function() {});
await c.remove({ force: true });
log.info('OpenClaw container ' + container.Id.slice(0, 12) + ' removed');
res.json({ success: true, message: 'OpenClaw removed' });
} catch(e) {
log.error('Failed to remove OpenClaw: ' + e.message);
res.status(500).json({ success: false, error: e.message });
}
}));
return router;
};
// ── token generator ──────────────────────────────────────────────────────────
function generateToken() {
const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
let result = '';
for (let i = 0; i < 32; i++) {
result += chars.charAt(Math.floor(Math.random() * chars.length));
}
return result;
}
+76
View File
@@ -0,0 +1,76 @@
#!/bin/bash
# Samihost fail2ban watchdog — auto-unban whitelisted IPs and keep ignoreip list in sync.
# Deployed to /usr/local/bin/samihost-fail2ban-watchdog.sh on 194.163.161.162
# Cron: every 30 min (0,30 * * * *)
set -euo pipefail
JAIL_LOCAL=/etc/fail2ban/jail.local
BACKUP=/etc/fail2ban/jail.local.watchdog.bak
EXPECTED_IGNOREIP="127.0.0.1/8 ::1 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 fc00::/7 fe80::/10 100.64.0.0/10 100.121.150.22 100.85.236.10 100.71.97.12 100.81.59.99 100.98.123.59 194.233.88.206 173.212.201.200 194.163.161.162"
LOG=/var/log/samihost-fail2ban-watchdog.log
TELEGRAM_LOG=/tmp/fail2ban-watchdog-last-action
ts() { date -u +"%Y-%m-%dT%H:%M:%SZ"; }
log() { echo "$(ts) $*" | tee -a "$LOG"; }
mkdir -p "$(dirname "$LOG")"
touch "$LOG"
# --- 1. Verify ignoreip line is intact and matches expected ---
CURRENT=$(grep '^ignoreip' "$JAIL_LOCAL" | sed 's/^ignoreip[[:space:]]*=[[:space:]]*//' || true)
EXPECTED_NORMALIZED=$(echo "$EXPECTED_IGNOREIP" | tr ' ' '\n' | sort -u | tr '\n' ' ' | sed 's/ $//')
CURRENT_NORMALIZED=$(echo "$CURRENT" | tr ' ' '\n' | sort -u | tr '\n' ' ' | sed 's/ $//')
if [ "$CURRENT_NORMALIZED" != "$EXPECTED_NORMALIZED" ]; then
log "ALERT: ignoreip line drifted. Restoring."
cp "$JAIL_LOCAL" "$BACKUP"
sed -i "s|^ignoreip = .*|ignoreip = $EXPECTED_IGNOREIP|" "$JAIL_LOCAL"
fail2ban-client reload
echo "ignoreip restored at $(ts)" > "$TELEGRAM_LOG"
log "ignoreip restored, fail2ban reloaded"
fi
# --- 2. Unban any currently-banned IPs that match our trusted set ---
BANNED=$(fail2ban-client status sshd 2>/dev/null | awk -F: '/Banned IP list/{print $2}' | tr ' ' '\n' | grep -v '^$' || true)
UNBANNED=0
for ip in $BANNED; do
# Match against any trusted network
is_trusted=0
for net in 127.0.0.0/8 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 100.64.0.0/10 ::1 fc00::/7 fe80::/10 100.121.150.22 100.85.236.10 100.71.97.12 100.81.59.99 100.98.123.59 194.233.88.206 173.212.201.200 194.163.161.162; do
if [[ "$net" == *"/"* ]]; then
# CIDR match (simple IPv4 only — IPv6 needs python or ipcalc, skip for now)
base="${net%/*}"
mask="${net#*/}"
if [[ "$ip" == "$base"* ]] || python3 -c "import ipaddress,sys; sys.exit(0 if ipaddress.ip_address('$ip') in ipaddress.ip_network('$net', strict=False) else 1)" 2>/dev/null; then
is_trusted=1
break
fi
else
if [ "$ip" = "$net" ]; then
is_trusted=1
break
fi
fi
done
if [ "$is_trusted" = "1" ]; then
if fail2ban-client set sshd unbanip "$ip" >/dev/null 2>&1; then
log "auto-unbanned trusted IP: $ip"
UNBANNED=$((UNBANNED+1))
fi
fi
done
[ "$UNBANNED" -gt 0 ] && echo "auto-unbanned $UNBANNED trusted IPs at $(ts)" > "$TELEGRAM_LOG"
# --- 3. Cap the ban count — if more than 200 are banned, mass-unban stale ones ---
TOTAL_BANNED=$(fail2ban-client status sshd 2>/dev/null | awk '/Currently banned/{print $NF}' || echo 0)
if [ "$TOTAL_BANNED" -gt 200 ]; then
log "ALERT: $TOTAL_BANNED IPs banned. Mass-unbanning all."
for ip in $BANNED; do
fail2ban-client set sshd unbanip "$ip" >/dev/null 2>&1 || true
done
echo "mass-unbanned $TOTAL_BANNED stale bans at $(ts)" > "$TELEGRAM_LOG"
fi
log "watchdog run complete (unbanned=$UNBANNED, total_banned=$TOTAL_BANNED)"
-48
View File
@@ -1,48 +0,0 @@
#!/bin/bash
set -e
CONTAINER_NAME="dashcaddy-api"
IMAGE="dashcaddy-dashcaddy-api:latest"
DATA_DIR="/opt/dashcaddy/dashcaddy-api/data"
CADDYFILE="/etc/caddy/Caddyfile"
ASSETS_DIR="/var/www/dashcaddy-status/assets"
UPDATES_DIR="/opt/dashcaddy/updates"
BACKUPS_DIR="/opt/dashcaddy/backups"
HOST_IP="172.17.0.1"
# Local Technitium (binds 0.0.0.0:53) resolves *.sami + recurses for docker subnet
# external fallback. Without this the container only has 8.8.8.8 and every
# *.sami health-check probe fails with ENOTFOUND (uptime bars stay empty).
DNS_PRIMARY="100.121.150.22" # Technitium (Tailscale IP) — resolves *.sami
DNS_FALLBACK="8.8.8.8"
# Always recreate to ensure env vars are correct (CONFIG_FILE defaults to /etc/dashcaddy/ which doesn't exist)
if docker ps -a --format "{{.Names}}" | grep -q "^${CONTAINER_NAME}$"; then
echo "[start.sh] Recreating container to apply correct env vars..."
docker rm -f ${CONTAINER_NAME}
fi
echo "[start.sh] Creating container with full config..."
docker run -d --restart unless-stopped --name ${CONTAINER_NAME} \
--dns ${DNS_PRIMARY} \
--dns ${DNS_FALLBACK} \
-p 127.0.0.1:3001:3001 \
-v ${DATA_DIR}:/app/data \
-v ${BACKUPS_DIR}:/app/backups \
-v ${CADDYFILE}:/caddyfile \
-v /var/run/docker.sock:/var/run/docker.sock \
-v ${ASSETS_DIR}:/app/assets \
-v ${UPDATES_DIR}:/app/updates \
-v /opt/sami-files/logs:/opt/sami-files/logs:ro \
-e NODE_ENV=production \
-e SERVICES_FILE=/app/data/services.json \
-e CONFIG_FILE=/app/data/config.json \
-e BACKUP_DIR=/app/backups \
-e DNS_CREDENTIALS_FILE=/app/data/dns-credentials.json \
-e CREDENTIALS_FILE=/app/data/credentials.json \
-e ENCRYPTION_KEY_FILE=/app/data/.encryption-key \
-e HEALTH_HISTORY_FILE=/app/data/health-history.json \
-e HEALTH_CONFIG_FILE=/app/data/health-config.json \
-e CADDYFILE_PATH=/caddyfile \
-e CADDY_ADMIN_URL=http://${HOST_IP}:2019 \
-e ASSETS_DIR=/app/assets \
-e DASHCADDY_API_SOURCE_DIR=/opt/dashcaddy/dashcaddy-api \
${IMAGE}
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.0 KiB

-3
View File
@@ -19,9 +19,6 @@ const bundles = {
JS('skeleton-loader.js'),
JS('theme.js'),
JS('totp-auth.js'),
// totp-recovery.js registers window._refreshRecoveryLink which totp-auth.js
// calls from showTotpOverlay(). Must come after totp-auth.js.
JS('totp-recovery.js'),
JS('service-credentials.js'),
JS('totp-settings.js'),
JS('core', 'credentials.js'),
+800
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
File diff suppressed because one or more lines are too long
+19 -19
View File
File diff suppressed because one or more lines are too long
+3 -3
View File
File diff suppressed because one or more lines are too long
+3 -63
View File
@@ -43,59 +43,6 @@
<input type="text" maxlength="1" inputmode="numeric" pattern="[0-9]">
</div>
<div class="totp-error" id="totp-error"></div>
<div class="totp-recovery-link" id="totp-recovery-link" style="display: none;">
<a href="#" id="totp-show-recovery">Lost access? Recover with saved Base32 key →</a>
</div>
</div>
</div>
<!-- TOTP Recovery Panel (hidden by default, shown via "Lost access?" link on overlay) -->
<div id="totp-recovery-panel" class="weather-modal" style="display: none;">
<div class="weather-modal-content" style="min-width: 420px; max-width: 540px;">
<h3 style="margin: 0 0 12px; font-size: 1.1rem;">Recover TOTP Access</h3>
<div id="totp-recovery-status" style="margin-bottom: 12px; padding: 10px 14px; border-radius: 6px; border: 1px solid var(--border); font-size: 0.85rem; line-height: 1.4;"></div>
<!-- Path A: Paste saved Base32 secret -->
<div id="totp-recovery-import">
<p style="font-size: 0.85rem; color: var(--muted); margin: 0 0 8px;">
Paste the Base32 secret you saved when you first set up TOTP (e.g. <code>JBSWY3DPEHPK3PXP</code>).
If you don't have it, you'll need to SSH into the server to rotate the encryption key.
</p>
<div style="display: flex; gap: 8px; margin-top: 8px;">
<input type="text" id="totp-recovery-secret" placeholder="Paste your Base32 key"
autocomplete="off" spellcheck="false"
style="flex: 1; padding: 10px; background: var(--bg); color: var(--fg); border: 1px solid var(--border); border-radius: 6px; font-size: 0.9rem; font-family: monospace; letter-spacing: 1px; text-transform: uppercase;" />
<button id="totp-recovery-submit"
style="padding: 10px 16px; background: var(--card-base); color: var(--fg); border: 1px solid var(--border); border-radius: 6px; cursor: pointer; font-weight: 600; font-size: 0.85rem; white-space: nowrap;">
Restore
</button>
</div>
<div id="totp-recovery-error" style="color: var(--bad-fg, #ff9aa3); font-size: 0.8rem; min-height: 1.2em; margin-top: 6px;"></div>
</div>
<!-- Path B: After successful import, ask user to verify with code -->
<div id="totp-recovery-verify" style="display: none;">
<p style="font-size: 0.85rem; color: var(--muted); margin: 0 0 8px;">
Secret accepted. Add it to your authenticator app and enter a 6-digit code to confirm.
</p>
<div style="display: flex; gap: 8px; margin-top: 8px;">
<input type="text" id="totp-recovery-code" maxlength="6" inputmode="numeric" pattern="[0-9]{6}"
placeholder="000000" autocomplete="one-time-code"
style="flex: 1; padding: 10px; text-align: center; font-size: 1.2rem; font-family: 'Sami Grotesk', monospace; letter-spacing: 4px; background: var(--bg); color: var(--fg); border: 1px solid var(--border); border-radius: 6px;" />
<button id="totp-recovery-confirm"
style="padding: 10px 16px; background: var(--card-base); color: var(--fg); border: 1px solid var(--border); border-radius: 6px; cursor: pointer; font-weight: 600; font-size: 0.85rem; white-space: nowrap;">
Confirm
</button>
</div>
<div id="totp-recovery-confirm-error" style="color: var(--bad-fg, #ff9aa3); font-size: 0.8rem; min-height: 1.2em; margin-top: 6px;"></div>
</div>
<div style="margin-top: 14px; text-align: right;">
<button id="totp-recovery-close"
style="padding: 8px 18px; background: transparent; color: var(--muted); border: 1px solid var(--border); border-radius: 6px; cursor: pointer; font-size: 0.85rem;">
Cancel
</button>
</div>
</div>
</div>
@@ -252,8 +199,7 @@
<div class="btn-row"><!-- No button for Internet --></div>
</div>
<div class="card" data-app="auth" data-status="off" id="auth-card"
title="Two-factor authentication (TOTP). On first setup, save the Base32 secret — it's the only way to recover if you ever lose your authenticator.">
<div class="card" data-app="auth" data-status="off" id="auth-card">
<span id="auth-dot" class="dot bad at-bl"></span>
<div class="row">
<div class="logo-wrap">
@@ -447,14 +393,8 @@
<!-- DNS Server Configuration -->
<div>
<label class="form-label-accent">
🗂️ DNS Provider
🗂️ DNS Server (Technitium)
</label>
<select id="setup-dns-provider" class="form-input-lg" style="margin-bottom: 12px;">
<option value="technitium">Technitium DNS (recommended)</option>
<option value="cloudflare">Cloudflare DNS</option>
<option value="rfc2136">RFC 2136 (BIND / PowerDNS / other)</option>
<option value="manual">Manual / External DNS</option>
</select>
<div style="display: grid; grid-template-columns: 1fr auto; gap: 8px;">
<input type="text" id="setup-dns-ip" value="" placeholder="DNS server IP"
style="padding: 12px; background: var(--card-bg); color: var(--fg); border: 1px solid var(--border); border-radius: 6px; font-size: 1rem;" />
@@ -469,7 +409,7 @@
<!-- DNS Admin Token -->
<div>
<label class="form-label-accent">
🔑 DNS Admin Token / API Key
🔑 Technitium Admin Token
</label>
<input type="password" id="setup-dns-token" placeholder="Paste your admin token here"
class="form-input-lg" />
+15
View File
@@ -95,6 +95,8 @@
const card = el('div', 'card');
card.setAttribute('data-app', s.id);
card.setAttribute('data-status', 'off'); // Initial status
if (s.containerId) card.setAttribute('data-container-id', s.containerId);
if (s.category) card.setAttribute('data-category', s.category);
if (s.recipeId) card.setAttribute('data-recipe-id', s.recipeId);
const dot = el('span', 'dot bad at-bl'); dot.id = 'dot-' + s.id + '-grid'; card.appendChild(dot);
@@ -156,6 +158,16 @@
nameSpan.appendChild(tsBadge);
}
// Add Category badge if service has one (colored pill with icon)
if (s.category) {
const cats = (typeof DC !== 'undefined' && DC.CATEGORIES) || window.DC_CATEGORIES || {};
const catInfo = cats[s.category] || {};
const catBadge = el('span', 'cat-badge', `${catInfo.icon || ''} ${s.category}`.trim());
catBadge.title = `Category: ${s.category}`;
catBadge.style.cssText = `margin-left: 6px; font-size: 0.65rem; padding: 1px 6px; border-radius: 999px; background: color-mix(in srgb, ${catInfo.color || '#7f8c8d'} 25%, transparent); color: ${catInfo.color || '#7f8c8d'}; border: 1px solid color-mix(in srgb, ${catInfo.color || '#7f8c8d'} 50%, transparent); white-space: nowrap; font-weight: 500;`;
nameSpan.appendChild(catBadge);
}
row.appendChild(el('span', 'spacer'));
const pill = el('span', 'badge off', 'OFF'); pill.id = 'badge-' + s.id; row.appendChild(pill);
@@ -282,6 +294,9 @@
// Group recipe cards visually after grid is built
if (window.groupRecipeCards) requestAnimationFrame(() => window.groupRecipeCards());
// Refresh the service filter so the category dropdown reflects new services
if (window.refreshServiceFilter) window.refreshServiceFilter();
}
function setBadge(id, up, responseTime = null) {
+51
View File
@@ -59,11 +59,13 @@
}
_dashboardInitialized = true;
await window.loadServices();
await loadTemplateCategories();
window.buildGrid();
animateTopCards();
window.refreshAll();
setInterval(window.refreshAll, DC.POLL.DASHBOARD);
if (typeof window.refreshCredsButtons === 'function') window.refreshCredsButtons();
if (typeof window.refreshMonitoringWidgets === 'function') window.refreshMonitoringWidgets();
// Update auth card (may have already been updated by the auto-load IIFE but ensure it's correct)
if (typeof window._updateAuthCard === 'function') {
try {
@@ -200,6 +202,55 @@
window.loadCustomServices = loadCustomServices;
registerServiceWorker();
// ===== TEMPLATE CATEGORIES =====
// Cached template categories from /api/v1/templates for use across the UI
// (service create/edit, filter dropdown, category badges, etc.)
async function loadTemplateCategories() {
try {
const r = await fetch('/api/v1/templates', { cache: 'no-store' });
if (!r.ok) return;
const data = await r.json();
if (data && data.categories) {
window.DC_CATEGORIES = data.categories;
// Also expose via globals.js constant for convenience
if (typeof DC !== 'undefined') DC.CATEGORIES = data.categories;
// Populate any category <select> that's already in the DOM
populateCategorySelects();
}
} catch (e) {
console.warn('[init] Failed to load template categories:', e);
}
}
function populateCategorySelects() {
const cats = window.DC_CATEGORIES || (typeof DC !== 'undefined' && DC.CATEGORIES);
if (!cats) return;
document.querySelectorAll('select[data-role="service-category"]').forEach(select => {
const current = select.dataset.current || '';
// Clear options but keep the first (placeholder)
const placeholder = select.querySelector('option[value=""]');
select.innerHTML = '';
if (placeholder) select.appendChild(placeholder);
else {
const ph = document.createElement('option');
ph.value = '';
ph.textContent = '— Select category —';
select.appendChild(ph);
}
Object.entries(cats).forEach(([name, info]) => {
const opt = document.createElement('option');
opt.value = name;
opt.textContent = `${info.icon || ''} ${name}`.trim();
if (name === current) opt.selected = true;
select.appendChild(opt);
});
});
}
// Allow other modules to re-run population after they (re)inject selects
window.populateCategorySelects = populateCategorySelects;
window.loadTemplateCategories = loadTemplateCategories;
// TOTP-gated initialization
(async () => {
try {
+12
View File
@@ -262,6 +262,7 @@
const proxyIp = document.getElementById('external-proxy-ip').value.trim() || SITE.dnsIp || 'localhost';
const preserveHost = document.getElementById('external-preserve-host').checked;
const followRedirects = document.getElementById('external-follow-redirects').checked;
const category = document.getElementById('external-service-category')?.value || '';
if (!name || !externalUrl) {
showNotification('Please fill in Name and External URL', 'warning');
@@ -341,6 +342,8 @@
isExternal: true,
isCustom: true
};
// Only attach category if user actually picked one
if (category) newService.category = category;
window.APPS.push(newService);
results.dashboard = true;
@@ -457,6 +460,13 @@
const healthCheck = document.getElementById('health-check-input')?.value || '';
const timeout = document.getElementById('timeout-input')?.value || 30;
// Category is optional — pulled from either local or external select by the
// openAddServiceModal reset. If user doesn't choose one, it stays undefined
// and we don't send it (so the backend keeps the existing behavior).
const categoryEl = document.getElementById('service-category-input')
|| document.getElementById('external-service-category');
const category = categoryEl?.value || '';
const dnsToken = window.getToken(getPrimaryDnsId(), 'admin');
if (!name || !port || !ip) {
@@ -525,6 +535,8 @@
logo: logo || `/assets/${subdomain}.png`,
tailscaleOnly: tailscaleOnly || false
};
// Only include category if user actually picked one
if (category) serviceConfig.category = category;
await window.addServiceToConfig(serviceConfig);
results.dashboard = true;
+16 -2
View File
@@ -19,6 +19,16 @@
document.getElementById('edit-tailscale-only').checked = service.tailscaleOnly || false;
document.getElementById('edit-logo-url').value = service.logo || '';
// Populate the category select for this service, then set the current value.
// populateCategorySelects() uses data-current so we set it first, then call.
const categorySelect = document.getElementById('edit-service-category');
if (categorySelect) {
categorySelect.dataset.current = service.category || '';
if (typeof window.populateCategorySelects === 'function') {
window.populateCategorySelects();
}
}
modal.classList.add('show');
}
@@ -36,6 +46,7 @@
const newIp = document.getElementById('edit-ip').value.trim() || 'localhost';
const tailscaleOnly = document.getElementById('edit-tailscale-only').checked;
const newLogo = document.getElementById('edit-logo-url').value.trim();
const newCategory = document.getElementById('edit-service-category')?.value || '';
if (!newSubdomain) {
showNotification('Subdomain is required', 'warning');
@@ -51,6 +62,7 @@
if (newIp !== currentEditService.ip) changes.push('ip');
if (tailscaleOnly !== (currentEditService.tailscaleOnly || false)) changes.push('tailscale');
if (newLogo && newLogo !== currentEditService.logo) changes.push('logo');
if (newCategory !== (currentEditService.category || '')) changes.push('category');
if (changes.length === 0) {
closeServiceEditModal();
@@ -72,7 +84,8 @@
port: newPort || currentEditService.port,
ip: newIp,
tailscaleOnly,
logo: newLogo || undefined
logo: newLogo || undefined,
category: newCategory
})
});
@@ -91,7 +104,8 @@
port: newPort || window.APPS[appIndex].port,
ip: newIp,
tailscaleOnly,
logo: newLogo || window.APPS[appIndex].logo
logo: newLogo || window.APPS[appIndex].logo,
category: newCategory || undefined
};
}
+3
View File
@@ -187,6 +187,9 @@
name: serviceConfig.name,
logo: serviceConfig.logo || `/assets/${serviceConfig.subdomain}.png`
};
// Forward optional metadata fields if provided
if (serviceConfig.category) newService.category = serviceConfig.category;
if (serviceConfig.containerId) newService.containerId = serviceConfig.containerId;
try {
const response = await secureFetch('/api/v1/services', {
+27
View File
@@ -82,6 +82,16 @@
Enter a URL or upload an image file (PNG, JPG, SVG)
</div>
</div>
<!-- Category -->
<div>
<label for="edit-service-category" class="form-label-accent-sm">
Category
</label>
<select id="edit-service-category" data-role="service-category" class="form-input-md">
<option value=""> No category </option>
</select>
</div>
</div>
<div class="weather-modal-buttons" style="margin-top: 24px;">
@@ -239,6 +249,15 @@
Reload Caddy after adding
</label>
<!-- Category -->
<div>
<label for="service-category-input" style="font-size: 0.8rem; color: var(--muted); margin-bottom: 4px; display: block;">Category</label>
<select id="service-category-input" data-role="service-category" style="width: 100%;">
<option value=""> No category </option>
</select>
<div style="font-size: 0.7rem; color: var(--muted); margin-top: 3px;">Group services on the dashboard by purpose (Media, Productivity, etc.)</div>
</div>
<hr style="border: none; border-top: 1px solid var(--border); margin: 4px 0;" />
<div class="grid-2col">
@@ -326,6 +345,14 @@
Follow Redirects
</label>
<!-- Category (external) -->
<div>
<label for="external-service-category" style="font-size: 0.8rem; color: var(--muted); margin-bottom: 4px; display: block;">Category</label>
<select id="external-service-category" data-role="service-category" style="width: 100%;">
<option value=""> No category </option>
</select>
</div>
</div>
</details>
</div>
@@ -155,47 +155,16 @@
return b.toFixed(1) + ' ' + units[i];
}
// ----- Robust services count -----
// Read from multiple sources so we always have a number:
// 1. window.APPS (populated by grid.js after loadServices)
// 2. #cards .card elements (post-buildGrid)
// 3. live fetch /api/v1/services (last-resort fallback if grid hasn't run)
async function fetchServicesCount() {
// Source 1+2: window.APPS / DOM cards
if (Array.isArray(window.APPS) && window.APPS.length > 0) {
const up = document.querySelectorAll('#cards .card[data-status="on"]').length;
return { total: window.APPS.length, up, source: 'APPS' };
}
const cards = document.querySelectorAll('#cards .card');
if (cards.length > 0) {
const up = Array.from(cards).filter(c => c.dataset.status === 'on').length;
return { total: cards.length, up, source: 'DOM' };
}
// Source 3: fetch live (endpoints may return {success, services:[...]} OR raw array)
try {
const r = await fetch('/api/v1/services', { cache: 'no-store' });
if (!r.ok) return { total: 0, up: 0, source: 'fetch-fail' };
const body = await r.json();
const list = (body && Array.isArray(body.services)) ? body.services
: (Array.isArray(body)) ? body
: [];
// Persist for the grid so this fallback only fires once
if (Array.isArray(window.APPS) || typeof window.APPS === 'undefined') window.APPS = list;
const up = document.querySelectorAll('#cards .card[data-status="on"]').length;
return { total: list.length, up, source: 'fetch' };
} catch (_) {
return { total: 0, up: 0, source: 'fetch-error' };
}
}
async function setServicesCard() {
const { total, up } = await fetchServicesCount();
function setServicesCard() {
const total = (window.APPS || []).length;
let up = 0;
document.querySelectorAll('#cards .card').forEach(c => {
if (c.dataset.status === 'on') up++;
});
const el = document.getElementById('dc-monitor-services');
const sub = document.getElementById('dc-monitor-services-sub');
if (el) el.textContent = `${up} / ${total}`;
if (sub) sub.textContent = total === 0
? 'no services yet'
: `${up} online · ${total - up} offline`;
if (sub) sub.textContent = total === 0 ? 'no services yet' : `${up} online · ${total - up} offline`;
}
function applyHealthSummary(data) {
+45 -2
View File
@@ -2,11 +2,50 @@
(function() {
const searchInput = document.getElementById('service-filter-search');
const statusSelect = document.getElementById('service-filter-status');
const categorySelect = document.getElementById('service-filter-category');
const countSpan = document.getElementById('service-filter-count');
// Build a single category list from both the API categories and any
// categories present on the actual rendered cards (covers custom services
// whose category isn't in TEMPLATE_CATEGORIES).
function getCategoryList() {
const seen = new Set();
const fromCards = new Set();
document.querySelectorAll('#cards .card[data-category]').forEach(c => {
const cat = c.dataset.category.trim();
if (cat) fromCards.add(cat);
});
const apiCats = (window.DC_CATEGORIES || (typeof DC !== 'undefined' && DC.CATEGORIES)) || {};
const all = Object.keys(apiCats).concat([...fromCards].filter(c => !apiCats[c]));
all.forEach(c => seen.add(c));
return { list: [...seen], apiCats };
}
function refreshCategoryDropdown() {
if (!categorySelect) return;
const { list, apiCats } = getCategoryList();
const current = categorySelect.value;
categorySelect.innerHTML = '<option value="all">All Categories</option>';
list.sort().forEach(name => {
const info = apiCats[name];
const opt = document.createElement('option');
opt.value = name;
opt.textContent = info ? `${info.icon || ''} ${name}`.trim() : name;
categorySelect.appendChild(opt);
});
// Restore selection if it still exists
if (current && [...categorySelect.options].some(o => o.value === current)) {
categorySelect.value = current;
} else {
categorySelect.value = 'all';
}
}
function updateFilter() {
refreshCategoryDropdown();
const query = searchInput.value.toLowerCase().trim();
const statusFilter = statusSelect.value; // 'all', 'on', or 'off'
const categoryFilter = categorySelect ? categorySelect.value : 'all';
const cards = document.querySelectorAll('#cards .card');
let visibleCount = 0;
@@ -15,11 +54,13 @@
const name = card.querySelector('.name')?.textContent?.toLowerCase() || '';
const app = card.dataset.app?.toLowerCase() || '';
const status = card.dataset.status || 'off'; // 'on' or 'off'
const category = card.dataset.category || '';
const matchesSearch = !query || name.includes(query) || app.includes(query);
const matchesStatus = statusFilter === 'all' || status === statusFilter;
const matchesCategory = categoryFilter === 'all' || category === categoryFilter;
if (matchesSearch && matchesStatus) {
if (matchesSearch && matchesStatus && matchesCategory) {
card.style.display = '';
visibleCount++;
} else {
@@ -44,6 +85,7 @@
searchInput?.addEventListener('input', debounce(updateFilter, 200));
statusSelect?.addEventListener('change', updateFilter);
categorySelect?.addEventListener('change', updateFilter);
// Initial count on page load
if (document.readyState === 'loading') {
@@ -52,6 +94,7 @@
setTimeout(updateFilter, 500);
}
// Expose for external triggers
// Expose for external triggers (called after buildGrid to repopulate categories)
window.refreshServiceFilter = updateFilter;
window.refreshCategoryDropdown = refreshCategoryDropdown;
})();
-7
View File
@@ -21,13 +21,6 @@
const firstInput = overlay.querySelector('.totp-digits input');
if (firstInput) setTimeout(() => firstInput.focus(), 100);
}
// Refresh the "Lost access?" recovery link visibility based on server state.
// Hides itself if TOTP is healthy; shows if unreadable/corrupt. The user
// can still click it even when healthy — but the panel will explain there's
// no recovery needed. Cheaper than gating it.
if (typeof window._refreshRecoveryLink === 'function') {
window._refreshRecoveryLink();
}
}
function hideTotpOverlay() {
-180
View File
@@ -1,180 +0,0 @@
// ===== TOTP RECOVERY FLOW =====
// Public, unauthenticated recovery path for users who can't log in.
// Designed for the "encryption key rotated and lost my authenticator" case.
// The flow is:
//
// 1. On TOTP overlay show, call /api/v1/totp/recovery-info (public).
// If status === 'unreadable', show the "Lost access?" link on the overlay.
// 2. User clicks link → opens recovery panel.
// 3. User pastes Base32 secret → POST /api/v1/totp/setup with {secret: ...}.
// Backend stores as totp.pending_secret (encrypted with current key).
// 4. Panel switches to "verify" mode. User enters a code from the
// newly-added authenticator entry. POST /api/v1/totp/verify-setup
// promotes pending → active and starts a session.
// 5. hideTotpOverlay() and initializeDashboard() — same as normal login.
//
// The recovery flow never requires the user to be logged in. It does require
// them to have their Base32 secret saved (e.g. password manager, screenshot,
// the "Download backup file" we offer at setup time — see totp-settings.js).
(function() {
'use strict';
// ── Helpers ──
async function fetchRecoveryInfo() {
try {
const r = await fetch('/api/v1/totp/recovery-info', { cache: 'no-store' });
return await r.json();
} catch (e) {
return { success: false, status: 'unknown', hint: 'Could not contact server' };
}
}
function showRecoveryLink(show) {
const link = document.getElementById('totp-recovery-link');
if (link) link.style.display = show ? '' : 'none';
}
function openRecoveryPanel() {
const panel = document.getElementById('totp-recovery-panel');
if (panel) panel.style.display = '';
const statusEl = document.getElementById('totp-recovery-status');
const importEl = document.getElementById('totp-recovery-import');
const verifyEl = document.getElementById('totp-recovery-verify');
if (importEl) importEl.style.display = '';
if (verifyEl) verifyEl.style.display = 'none';
// Reset state
document.getElementById('totp-recovery-error').textContent = '';
document.getElementById('totp-recovery-confirm-error').textContent = '';
document.getElementById('totp-recovery-secret').value = '';
document.getElementById('totp-recovery-code').value = '';
// Show current status
fetchRecoveryInfo().then(info => {
statusEl.textContent = info.hint || '';
// Color-code the status banner
if (info.status === 'healthy') {
statusEl.style.borderColor = 'var(--ok-fg, #7ef2ff)';
} else if (info.status === 'unreadable') {
statusEl.style.borderColor = 'var(--bad-fg, #ff9aa3)';
statusEl.style.background = 'color-mix(in srgb, var(--bad-fg) 6%, transparent)';
} else if (info.status === 'not_configured') {
statusEl.style.borderColor = 'var(--muted)';
} else {
statusEl.style.borderColor = 'var(--border)';
}
});
setTimeout(() => {
document.getElementById('totp-recovery-secret')?.focus();
}, 100);
}
function closeRecoveryPanel() {
const panel = document.getElementById('totp-recovery-panel');
if (panel) panel.style.display = 'none';
}
async function submitRecoverySecret() {
const secret = document.getElementById('totp-recovery-secret').value.trim();
const errorEl = document.getElementById('totp-recovery-error');
errorEl.textContent = '';
if (!secret) {
errorEl.textContent = 'Paste your Base32 key first';
return;
}
if (!/^[A-Za-z2-7\s]+=*$/.test(secret)) {
errorEl.textContent = 'Invalid Base32 format — should be letters A-Z and digits 2-7 only';
return;
}
// POST /api/v1/totp/setup with {secret} — backend stores as pending
try {
const r = await fetch('/api/v1/totp/setup', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ secret })
});
const data = await r.json();
if (!r.ok || !data.success) {
errorEl.textContent = data.error || data.message || 'Restore failed';
return;
}
// Switch panel to verify mode
document.getElementById('totp-recovery-import').style.display = 'none';
document.getElementById('totp-recovery-verify').style.display = '';
setTimeout(() => document.getElementById('totp-recovery-code')?.focus(), 100);
} catch (e) {
errorEl.textContent = 'Network error — try again';
}
}
async function submitRecoveryCode() {
const code = document.getElementById('totp-recovery-code').value.trim();
const errorEl = document.getElementById('totp-recovery-confirm-error');
errorEl.textContent = '';
if (!/^\d{6}$/.test(code)) {
errorEl.textContent = 'Enter a 6-digit code';
return;
}
// POST /api/v1/totp/verify-setup — promotes pending → active + starts session
try {
const r = await fetch('/api/v1/totp/verify-setup', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ code })
});
const data = await r.json();
if (!r.ok || !data.success) {
errorEl.textContent = data.error || data.message || 'Invalid code';
document.getElementById('totp-recovery-code').value = '';
document.getElementById('totp-recovery-code')?.focus();
return;
}
// Success — hide everything and initialize dashboard
closeRecoveryPanel();
const overlay = document.getElementById('totp-overlay');
if (overlay) overlay.classList.remove('show');
if (typeof window.initializeDashboard === 'function') {
window.initializeDashboard();
}
} catch (e) {
errorEl.textContent = 'Network error — try again';
}
}
// ── Wire up handlers ──
document.getElementById('totp-show-recovery')?.addEventListener('click', (e) => {
e.preventDefault();
openRecoveryPanel();
});
document.getElementById('totp-recovery-close')?.addEventListener('click', closeRecoveryPanel);
document.getElementById('totp-recovery-submit')?.addEventListener('click', submitRecoverySecret);
document.getElementById('totp-recovery-confirm')?.addEventListener('click', submitRecoveryCode);
// Enter key submits in secret field
document.getElementById('totp-recovery-secret')?.addEventListener('keydown', (e) => {
if (e.key === 'Enter') { e.preventDefault(); submitRecoverySecret(); }
});
// Enter key submits in code field
document.getElementById('totp-recovery-code')?.addEventListener('keydown', (e) => {
if (e.key === 'Enter') { e.preventDefault(); submitRecoveryCode(); }
});
// ── Public API ──
// Called by totp-auth.js after showing the overlay, so we can decide whether
// to show the recovery link. We do this with a public endpoint that doesn't
// require auth — perfect for the locked-out state.
window._refreshRecoveryLink = async function() {
const info = await fetchRecoveryInfo();
// Show the link in any non-healthy state (unreadable / corrupt / unknown).
// The hint inside the panel tells the user what the actual issue is.
if (info && info.success && info.status && info.status !== 'healthy') {
showRecoveryLink(true);
} else {
showRecoveryLink(false);
}
return info;
};
})();
+2 -57
View File
@@ -38,25 +38,11 @@
<div id="totp-qr-section" style="display: none;">
<!-- Manual Key (primary - for WinAuth/desktop authenticators) -->
<p style="font-size: 0.85rem; color: var(--muted); margin: 0 0 8px;">Copy this key into your authenticator app:</p>
<div style="display: flex; align-items: center; gap: 8px; margin-bottom: 8px;">
<div style="display: flex; align-items: center; gap: 8px; margin-bottom: 16px;">
<code id="totp-manual-key" style="flex: 1; display: block; padding: 12px; background: var(--bg, #0b0f1a); border: 1px solid var(--border); border-radius: 6px; font-size: 1rem; font-family: 'Sami Grotesk', monospace; letter-spacing: 2px; word-break: break-all; user-select: all; color: var(--fg);"></code>
<button id="totp-copy-key" style="padding: 10px 14px; background: var(--card-base); border: 1px solid var(--border); border-radius: 6px; cursor: pointer; font-size: 1rem; white-space: nowrap; color: var(--fg);" title="Copy to clipboard">📋</button>
</div>
<!-- Download backup file (recovery aid) -->
<div style="margin-bottom: 16px; padding: 10px 12px; background: var(--bg, #0b0f1a); border: 1px solid var(--border); border-radius: 6px;">
<div style="display: flex; align-items: center; gap: 8px;">
<span style="font-size: 0.8rem; color: var(--muted); flex: 1;">
<strong style="color: var(--fg);">Save a backup file</strong> if you ever lose your authenticator,
this is the only way to recover without SSH access to the server.
</span>
<button id="totp-download-backup" type="button"
style="padding: 8px 14px; background: var(--card-base); color: var(--fg); border: 1px solid var(--border); border-radius: 6px; cursor: pointer; font-weight: 600; font-size: 0.85rem; white-space: nowrap;">
Download
</button>
</div>
</div>
<!-- QR Code (secondary - for mobile apps) -->
<details class="mb-16">
<summary style="cursor: pointer; color: var(--muted); font-size: 0.8rem;">Show QR code (for mobile authenticator apps)</summary>
@@ -133,13 +119,7 @@
statusBanner.style.background = 'color-mix(in srgb, var(--ok-fg) 8%, transparent)';
statusText.textContent = 'TOTP is active';
statusText.style.color = 'var(--ok-fg, #7ef2ff)';
// Keep the setup section visible (collapsed) so the "Import existing
// secret" option is always reachable — users may need to re-enroll
// their authenticator with the same secret from a backup file.
setupSection.style.display = 'block';
const setupBtn = document.getElementById('totp-setup-btn');
if (setupBtn) setupBtn.textContent = 'Generate New Secret';
// Hide the QR section by default in the active state — setupBtn click shows it
setupSection.style.display = 'none';
qrSection.style.display = 'none';
durationSection.style.display = 'block';
disableSection.style.display = 'block';
@@ -253,41 +233,6 @@
});
});
// Download backup file — plain JSON so it round-trips through any password
// manager, cloud backup, or printed paper. The secret IS recoverable plaintext
// (that's the whole point of the backup), so warn the user and rely on
// them to keep it safe.
document.getElementById('totp-download-backup')?.addEventListener('click', () => {
const secret = document.getElementById('totp-manual-key').textContent.trim();
if (!secret) return;
const payload = {
service: 'DashCaddy',
type: 'totp-secret',
secret: secret,
issuer: 'DashCaddy',
algorithm: 'SHA1',
digits: 6,
period: 30,
issued: new Date().toISOString(),
// Recovery instructions baked into the file so a year from now the
// user (or their future self) knows what this file is and how to use it.
recovery_url: `${window.location.origin}/ (login screen → "Lost access?")`,
note: 'Keep this file somewhere safe. Anyone with this secret can generate your login codes. Use it ONLY to recover TOTP access via the "Lost access?" link on the DashCaddy login screen.'
};
const blob = new Blob([JSON.stringify(payload, null, 2)], { type: 'application/json' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = `dashcaddy-totp-backup-${new Date().toISOString().slice(0, 10)}.json`;
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
URL.revokeObjectURL(url);
const btn = document.getElementById('totp-download-backup');
btn.textContent = '✅ Saved';
setTimeout(() => { btn.textContent = '⬇ Download'; }, 2000);
});
// Confirm setup
document.getElementById('totp-confirm-setup')?.addEventListener('click', async () => {
const code = document.getElementById('totp-setup-code').value;
+1 -1
View File
@@ -1,4 +1,4 @@
const CACHE = 'dashcaddy-shell-f6673e7190';
const CACHE = 'dashcaddy-shell-43a872cc40';
const PRECACHE = [
'/',
'/index.html',