All checks were successful
CI / Lint, typecheck, test (push) Successful in 3m45s
CD / Build and push images (push) Successful in 3m49s
CI / Build container images (push) Has been skipped
CD / Deploy to Test (push) Successful in 9s
CD / Smoke tests against Test (push) Successful in 1m18s
CD / Promote to Int (push) Successful in 11s
CI / Auth e2e pack (push) Successful in 5m35s
CI / Import/export fidelity gate (push) Successful in 47s
Off-host backups for every self-hoster, configured entirely in the admin UI — supersedes the host-specific mirror plan behind #84. shared: - webdav.ts (new package entry like token-crypto): minimal WebDAV client with basic auth — PROPFIND (tolerant multistatus parser), MKCOL, PUT (streamed), GET, DELETE; Nextcloud DAV path derived from the plain server URL, explicit DAV bases pass through - backup-status.ts: additive remote-upload status in status.json, the restore-status.json contract (running/succeeded/failed + staleness bound), the backup_command/backup_maintenance NOTIFY channels, and the one-bundle-per-set naming (dorfteich-backup-<id>.tar.gz) - backup-set.ts moved here from apps/backup (api lists local sets) backup sidecar: - reads the backup.* instance settings directly from the database (admin changes apply next run; local retention row overrides the env) and the app password from the secret store - after each successful set: bundle dump + files archive + manifest into ONE self-contained tar.gz, upload via WebDAV per schedule (off/daily/weekly; manual runs always upload), prune remote bundles — never the newest — and record the outcome in status.json; upload failures alert via a new backupUploadFailed mail (de+en) - command listener on backup_command (run / restore) with a serial queue against the nightly timer - restore orchestrator: restore-status.json → maintenance NOTIFY → grace → (remote: download + manifest-verify bundle) → terminate other DB connections → shared perform-restore path (same code as restore.sh) → final status + maintenance exit api: - MaintenanceGuard (global, registered before the setup gate): 503 maintenance_mode while restore-status says running; health endpoints and the new public GET /backup/restore-status stay exempt; a stale running state (crashed sidecar) unblocks after 30 min - MaintenanceStateService watches the file and restarts the api after a successful restore (fresh caches, migrate-on-start for older dumps); main.ts refuses to touch the database while a restore runs — a container restarting mid-restore must not race pg_restore with migrate deploy - worker sweeps (conversion, mail outbox, scheduler) catch transient database failures instead of dying on an unhandled rejection — the restore's connection termination crashed the api in verification - backup admin endpoints under /admin/system/backup: settings (live connection test before save, password write-only into the secret store), nextcloud/test, sets (local via the ro backups mount + remote via WebDAV), run + restore (type-to-confirm backstop, source validation) — commands travel as NOTIFY payloads; audit actions backup.settings_changed/run_triggered/restore_requested - readyz: new warning-level backup_remote check while a target is configured (26 h daily / 170 h weekly bound) collab: - maintenance listener: on enter, persist + close every live session and refuse new connections until exit (failsafe timeout 30 min) — no in-memory document may write pre-restore content back afterwards web: - Admin → System backup section: status card with remote facts and a "Back up now" button, the Nextcloud settings form with test button, and the restore picker (local + remote sets, type-to-confirm) - global maintenance screen: any 503 maintenance_mode flips the SPA to a status page polling the exempt endpoint, reloading when the instance returns Verified end-to-end against a live stack (fresh DB, native api + sidecar, fake WebDAV server): configure → test → manual backup → bundle upload → readyz/sets/status surfaces → remote restore with maintenance gate, marker rollback and api restart; suites: shared 21, backup 9, collab 11, api 58 files green, lint + i18n:check + typecheck clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EwZ4jR4KFAPvpjWevfUGX1
84 lines
3.2 KiB
TypeScript
84 lines
3.2 KiB
TypeScript
import { Injectable } from '@nestjs/common';
|
|
import type { BackupConnectionTestResult, BackupSettingsView } from '@dorfteich/shared';
|
|
import { webdavCheck, type WebDavTarget } from '@dorfteich/shared/webdav';
|
|
|
|
import { SecretStoreService } from '../config/secret-store.service';
|
|
import { InstanceSettingsService } from '../settings/instance-settings.service';
|
|
|
|
/**
|
|
* The api's view of the Nextcloud backup target (issue #103): instance
|
|
* settings hold everything non-secret, the app password lives in the
|
|
* wizard-written secret store (security.md §Secrets) under the key the
|
|
* backup sidecar reads. This service resolves, tests, and persists the
|
|
* combination — it never returns the password.
|
|
*/
|
|
export const NEXTCLOUD_PASSWORD_SECRET_KEY = 'BACKUP_NEXTCLOUD_PASSWORD';
|
|
|
|
@Injectable()
|
|
export class BackupTargetService {
|
|
constructor(
|
|
private readonly settings: InstanceSettingsService,
|
|
private readonly secretStore: SecretStoreService,
|
|
) {}
|
|
|
|
async settingsView(): Promise<BackupSettingsView> {
|
|
return {
|
|
localRetentionDays: await this.settings.get('backup.localRetentionDays'),
|
|
remoteRetentionDays: await this.settings.get('backup.remoteRetentionDays'),
|
|
nextcloud: {
|
|
enabled: await this.settings.get('backup.nextcloud.enabled'),
|
|
baseUrl: await this.settings.get('backup.nextcloud.baseUrl'),
|
|
username: await this.settings.get('backup.nextcloud.username'),
|
|
folder: await this.settings.get('backup.nextcloud.folder'),
|
|
uploadSchedule: await this.settings.get('backup.nextcloud.uploadSchedule'),
|
|
passwordSet: Boolean(this.storedPassword()),
|
|
},
|
|
};
|
|
}
|
|
|
|
/**
|
|
* The effective WebDAV target, or null when disabled or not fully
|
|
* configured — the exact resolution the sidecar applies on its side.
|
|
*/
|
|
async resolveTarget(): Promise<WebDavTarget | null> {
|
|
const view = await this.settingsView();
|
|
const password = this.storedPassword();
|
|
const { enabled, baseUrl, username, folder } = view.nextcloud;
|
|
if (!enabled || !baseUrl || !username || !password) return null;
|
|
return { baseUrl, username, password, folder };
|
|
}
|
|
|
|
/**
|
|
* Live connection test (credentials + folder, creating missing folder
|
|
* segments) for the admin "test connection" button. An empty password
|
|
* falls back to the stored one, so a saved configuration can be re-tested
|
|
* without re-entering the secret.
|
|
*/
|
|
async testConnection(candidate: {
|
|
baseUrl: string;
|
|
username: string;
|
|
folder: string;
|
|
password?: string;
|
|
}): Promise<BackupConnectionTestResult> {
|
|
const password = candidate.password || this.storedPassword();
|
|
if (!password) return { ok: false, error: 'no app password provided or stored' };
|
|
const result = await webdavCheck({
|
|
baseUrl: candidate.baseUrl,
|
|
username: candidate.username,
|
|
folder: candidate.folder,
|
|
password,
|
|
});
|
|
return result.ok ? { ok: true } : { ok: false, error: result.error };
|
|
}
|
|
|
|
/** Stores a new app password; empty input keeps the current one. */
|
|
async storePassword(password: string): Promise<void> {
|
|
if (!password) return;
|
|
await this.secretStore.set({ [NEXTCLOUD_PASSWORD_SECRET_KEY]: password });
|
|
}
|
|
|
|
storedPassword(): string {
|
|
return this.secretStore.read()[NEXTCLOUD_PASSWORD_SECRET_KEY] ?? '';
|
|
}
|
|
}
|