Skip to content

Modern Docker Management, Designed for Everyone

feat(backups): add recovery key dropdown with import and reset confirmation (#3884)

Neureka16db5a33747b
diff --git a/frontend/messages/en.json b/frontend/messages/en.json
index c78df8735..e7827b76b 100644
--- a/frontend/messages/en.json
+++ b/frontend/messages/en.json
@@ -3357,6 +3357,11 @@
"system_backups_recovery_key_required": "Enter the generated recovery key (8 groups of 6 characters).",
"system_backups_recovery_key_needed": "Set up a recovery key before creating system backups.",
"system_backups_reset_recovery_key": "Reset recovery key",
+ "system_backups_reset_recovery_key_confirm_message": "A new key will be generated and replace the current one. Existing system backups can only be restored with the key they were created with.",
+ "system_backups_create_recovery_key": "Create recovery key",
+ "system_backups_import_recovery_key": "Import recovery key",
+ "system_backups_import_recovery_key_description": "Enter an existing recovery key to store as this instance's recovery key.",
+ "system_backups_import_recovery_key_alert": "Arcane already has a recovery key. Existing system backups can only be opened with the key they were created with, and a different key cannot be stored while they exist.",
"system_backups_recovery_key_alert": "Save this key outside Arcane now. It will not be shown again, and without it your system backups cannot be restored.",
"system_backups_recovery_key_enter_description": "Enter the recovery key that protects this backup.",
"system_backups_recovery_key_schedule_required": "Configure a recovery key before enabling this schedule.",
diff --git a/frontend/src/routes/(app)/settings/backups/+page.svelte b/frontend/src/routes/(app)/settings/backups/+page.svelte
index 8bd2cb1c0..05a2fc3d6 100644
--- a/frontend/src/routes/(app)/settings/backups/+page.svelte
+++ b/frontend/src/routes/(app)/settings/backups/+page.svelte
@@ -7,7 +7,8 @@
import { toast } from 'svelte-sonner';
import settingsStore from '#lib/stores/config-store.js';
import { SettingsPageLayout, type SettingsActionButton } from '#lib/layouts/index.js';
- import { AlertIcon, BackupIcon, CloudStorageIcon, InfoIcon, LockIcon, ResetIcon } from '#lib/icons/index.js';
+ import { AlertIcon, BackupIcon, CloudStorageIcon, InfoIcon, LockIcon, ResetIcon, UploadIcon } from '#lib/icons/index.js';
+ import { openConfirmDialog } from '#lib/components/confirm-dialog/index.js';
import * as Alert from '#lib/components/ui/alert/index.js';
import { CopyButton } from '#lib/components/ui/copy-button/index.js';
import { Input } from '#lib/components/ui/input/index.js';
@@ -49,6 +50,9 @@
let scheduleType = $state<'system' | 'volume'>('system');
let editingScheduleId = $state<string | undefined>();
let keyOpen = $state(false);
+ let importKeyOpen = $state(false);
+ let importKeyInput = $state('');
+ let importingKey = $state(false);
let actionOpen = $state(false);
let action = $state<'create' | 'restore' | 'upload' | 'delete' | 'discover'>('create');
let selected = $state<BackupHistoryEntry | null>(null);
@@ -109,6 +113,10 @@
Boolean(restoreFilesKeyError) ||
(!policyCollection.recoveryKeyStored && !recoveryKeyPattern.test(restoreFilesRecoveryKey.trim()))
);
+ const importKeyError = $derived(
+ importKeyInput.length > 0 && !recoveryKeyPattern.test(importKeyInput.trim()) ? m.system_backups_recovery_key_required() : ''
+ );
+ const importKeyInvalid = $derived(Boolean(importKeyError) || !recoveryKeyPattern.test(importKeyInput.trim()));
const keyError = $derived(
actionNeedsTypedKey && recoveryKey.length > 0 && !recoveryKeyPattern.test(recoveryKey.trim())
? m.system_backups_recovery_key_required()
@@ -139,7 +147,7 @@
// Generating persists the key in the same step; the dialog only ever shows
// an already-saved key, with one job: get the user to store it elsewhere.
- async function openRecoveryKey() {
+ async function generateAndStoreRecoveryKey() {
newRecoveryKey = '';
generatingKey = true;
try {
@@ -162,6 +170,51 @@
}
}
+ // Rotating a stored key invalidates repositories keyed by the old one, so
+ // it must be confirmed; first-time setup has nothing to lose.
+ function openRecoveryKey() {
+ if (!policyCollection.recoveryKeyStored) {
+ void generateAndStoreRecoveryKey();
+ return;
+ }
+ openConfirmDialog({
+ title: m.system_backups_reset_recovery_key(),
+ message: m.system_backups_reset_recovery_key_confirm_message(),
+ confirm: {
+ label: m.system_backups_reset_recovery_key(),
+ destructive: true,
+ action: () => generateAndStoreRecoveryKey()
+ }
+ });
+ }
+
+ function openImportKey() {
+ importKeyInput = '';
+ importKeyOpen = true;
+ }
+
+ async function importRecoveryKey() {
+ if (importingKey || importKeyInvalid) return;
+ importingKey = true;
+ try {
+ const operationResult = await tryCatch(
+ (async () => {
+ await systemBackupService.setRecoveryKey(importKeyInput.trim());
+ policyCollection = { ...policyCollection, recoveryKeyStored: true };
+ importKeyOpen = false;
+ toast.success(m.system_backups_recovery_key_saved());
+ })()
+ );
+ if (operationResult.error !== null) {
+ const error = operationResult.error;
+
+ toast.error(error instanceof Error ? error.message : m.system_backups_recovery_key_save_failed());
+ }
+ } finally {
+ importingKey = false;
+ }
+ }
+
function openAction(next: typeof action, backup: BackupHistoryEntry | null = null) {
action = next;
selected = backup;
@@ -428,19 +481,20 @@
}
const actionButtons: SettingsActionButton[] = $derived.by(() => [
- ...(policyCollection.recoveryKeyStored && canManageRecoveryKey
- ? [
- {
- id: 'reset-recovery-key',
- action: 'refresh',
- icon: ResetIcon,
- label: m.system_backups_reset_recovery_key(),
- loading: generatingKey,
- onclick: openRecoveryKey,
- disabled: isReadOnly
- } satisfies SettingsActionButton
- ]
- : []),
+ {
+ id: 'create',
+ action: 'create',
+ label: m.common_create(),
+ disabled: isReadOnly,
+ options: [
+ { label: m.jobs_schedule(), onclick: () => openSchedule() },
+ {
+ label: m.volumes_workspace_backup(),
+ onclick: () => openAction('create'),
+ disabled: backupActivity.activeIds.length > 0
+ }
+ ]
+ },
{
id: 's3-destinations',
action: 'edit',
@@ -459,20 +513,31 @@
} satisfies SettingsActionButton
]
: []),
- {
- id: 'create',
- action: 'create',
- label: m.common_create(),
- disabled: isReadOnly,
- options: [
- { label: m.jobs_schedule(), onclick: () => openSchedule() },
- {
- label: m.volumes_workspace_backup(),
- onclick: () => openAction('create'),
- disabled: backupActivity.activeIds.length > 0
- }
- ]
- }
+ ...(canManageRecoveryKey
+ ? [
+ {
+ id: 'recovery-key',
+ action: 'edit',
+ icon: LockIcon,
+ label: m.system_backups_recovery_key(),
+ disabled: isReadOnly,
+ options: [
+ {
+ label: policyCollection.recoveryKeyStored
+ ? m.system_backups_reset_recovery_key()
+ : m.system_backups_create_recovery_key(),
+ icon: ResetIcon,
+ onclick: () => openRecoveryKey()
+ },
+ {
+ label: m.system_backups_import_recovery_key(),
+ icon: UploadIcon,
+ onclick: () => openImportKey()
+ }
+ ]
+ } satisfies SettingsActionButton
+ ]
+ : [])
]);
</script>
@@ -526,6 +591,45 @@
</ResponsiveDialog>
{/snippet}
+{#snippet importKeyDialog()}
+ <ResponsiveDialog
+ bind:open={importKeyOpen}
+ title={m.system_backups_import_recovery_key()}
+ description={m.system_backups_import_recovery_key_description()}
+ contentClass="sm:max-w-[560px]"
+ >
+ {#snippet children()}
+ <div class="space-y-3 py-2">
+ <TextInputWithLabel
+ value={importKeyInput}
+ onChange={(value) => (importKeyInput = value)}
+ error={importKeyError || null}
+ label={m.system_backups_recovery_key()}
+ description={m.system_backups_recovery_key_required()}
+ type="password"
+ autocomplete="current-password"
+ />
+ {#if policyCollection.recoveryKeyStored}
+ <Alert.Root variant="destructive">
+ <AlertIcon class="size-4" />
+ <Alert.Description>{m.system_backups_import_recovery_key_alert()}</Alert.Description>
+ </Alert.Root>
+ {/if}
+ </div>
+ {/snippet}
+ {#snippet footer()}
+ <ArcaneButton action="cancel" onclick={() => (importKeyOpen = false)} disabled={importingKey} />
+ <ArcaneButton
+ action="save"
+ customLabel={m.system_backups_import_recovery_key()}
+ onclick={importRecoveryKey}
+ loading={importingKey}
+ disabled={importingKey || importKeyInvalid}
+ />
+ {/snippet}
+ </ResponsiveDialog>
+{/snippet}
+
{#snippet actionDialog()}
<ResponsiveDialog
bind:open={actionOpen}
@@ -793,6 +897,7 @@
{/if}
{@render recoveryKeyDialog()}
+ {@render importKeyDialog()}
{@render actionDialog()}
{@render restoreFilesDialog()}
{/snippet}