Skip to content

Commit cc879fd

Browse files
Added backup and recovery center to admin dashboard
1 parent 92a1049 commit cc879fd

13 files changed

Lines changed: 2126 additions & 256 deletions

File tree

flake.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
outputs = { self, nixpkgs, raspberry-pi-nix, lnbits, spark-sidecar, ... }:
2323
let
24-
version = "0.1.49"; # Bump before each release tag to match the next tag name
24+
version = "0.9.0"; # Bump before each release tag to match the next tag name
2525
system = "aarch64-linux";
2626
in
2727
{

gh-pages/pages/user-guide.vue

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ const sections = [
44
{ id: 'unboxing-and-plugging-in', label: 'Unboxing and Plugging In' },
55
{ id: 'accessing-the-configurator', label: 'Initial Set-up' },
66
{ id: 'after-configuration', label: 'Managing Your LNbitsBox' },
7+
{ id: 'recovery-tool', label: 'Recovery Tool' },
78
]
89
</script>
910

@@ -261,6 +262,104 @@ const sections = [
261262
</div>
262263
</div>
263264
</section>
265+
266+
<section
267+
id="recovery-tool"
268+
class="scroll-mt-24 border border-ln-border rounded-3xl bg-ln-card/60 p-6 sm:p-8"
269+
>
270+
<p class="font-mono text-xs uppercase tracking-[0.25em] text-ln-pink mb-3">
271+
Recovery Tool
272+
</p>
273+
<h2 class="font-display font-bold text-ln-text text-2xl sm:text-3xl tracking-tight mb-6">
274+
Back up and restore your LNbitsBox safely
275+
</h2>
276+
<p class="font-display text-ln-muted text-base sm:text-lg leading-relaxed mb-6">
277+
The Recovery Tool is your main safety net for your LNbitsBox. It helps you create encrypted recovery backups,
278+
checks that a backup is usable before restoring it, and keeps regular backups running so you are better
279+
prepared if your SD card fails or you need to move to a new box.
280+
</p>
281+
282+
<div class="space-y-4">
283+
<div class="rounded-2xl border border-ln-border bg-black/10 p-5">
284+
<h3 class="font-display font-semibold text-ln-text text-lg mb-2">
285+
Open the Recovery Tool from the admin panel
286+
</h3>
287+
<p class="font-display text-ln-muted text-sm leading-relaxed">
288+
Visit <a href="http://lnbits.local/box" target="_blank" class="text-ln-pink hover:underline">lnbits.local/box</a>, sign in with your admin password, and open the
289+
Maintenance page. The Recovery Tool lets you create encrypted backups, validate a restore before applying it, and configure automatic backups.
290+
</p>
291+
</div>
292+
293+
<div class="rounded-2xl border border-ln-border bg-black/10 p-5">
294+
<h3 class="font-display font-semibold text-ln-text text-lg mb-3">
295+
Create an encrypted backup
296+
</h3>
297+
<ol class="space-y-3">
298+
<li class="flex gap-3">
299+
<span class="w-6 h-6 flex-shrink-0 rounded-lg bg-ln-pink/10 text-ln-pink font-mono text-xs flex items-center justify-center">1</span>
300+
<p class="font-display text-ln-muted text-sm leading-relaxed">
301+
Choose <strong>Full backup</strong> for the most complete snapshot. This includes LNbits data, Spark wallet files, tunnel state, and device configuration.
302+
</p>
303+
</li>
304+
<li class="flex gap-3">
305+
<span class="w-6 h-6 flex-shrink-0 rounded-lg bg-ln-pink/10 text-ln-pink font-mono text-xs flex items-center justify-center">2</span>
306+
<p class="font-display text-ln-muted text-sm leading-relaxed">
307+
Enter a backup password. Every recovery archive is password protected, so store that password somewhere safe and separate from the box.
308+
</p>
309+
</li>
310+
<li class="flex gap-3">
311+
<span class="w-6 h-6 flex-shrink-0 rounded-lg bg-ln-pink/10 text-ln-pink font-mono text-xs flex items-center justify-center">3</span>
312+
<p class="font-display text-ln-muted text-sm leading-relaxed">
313+
Use <strong>Download Backup</strong> to save the archive to your computer, or <strong>Save on This Box</strong> to keep a copy in the local recovery folder for later download.
314+
</p>
315+
</li>
316+
</ol>
317+
</div>
318+
319+
<div class="grid sm:grid-cols-2 gap-4">
320+
<div class="rounded-2xl border border-ln-border bg-black/10 p-5">
321+
<h3 class="font-display font-semibold text-ln-text text-lg mb-2">
322+
Full vs Quick backups
323+
</h3>
324+
<p class="font-display text-ln-muted text-sm leading-relaxed">
325+
Full backups are the best default for most people. Quick backups are smaller, but they skip some broader device state and are better suited to lighter routine snapshots.
326+
</p>
327+
</div>
328+
<div class="rounded-2xl border border-ln-pink/20 bg-ln-pink/5 p-5">
329+
<h3 class="font-display font-semibold text-ln-text text-lg mb-2">
330+
Keep your Spark seed phrase too
331+
</h3>
332+
<p class="font-display text-ln-muted text-sm leading-relaxed">
333+
Recovery archives help restore your box, but your Spark seed phrase is still the most important secret for recovering wallet access and funds.
334+
</p>
335+
</div>
336+
</div>
337+
338+
<div class="rounded-2xl border border-ln-border bg-black/10 p-5">
339+
<h3 class="font-display font-semibold text-ln-text text-lg mb-3">
340+
Restore carefully
341+
</h3>
342+
<p class="font-display text-ln-muted text-sm leading-relaxed mb-3">
343+
The restore flow checks the uploaded backup before making changes. You can restore from a backup file on your computer or from one already saved on the box.
344+
</p>
345+
<p class="font-display text-ln-muted text-sm leading-relaxed">
346+
After validation, choose only the components you want to restore. This gives you a chance to confirm the archive and avoid overwriting parts of the system unnecessarily.
347+
</p>
348+
</div>
349+
350+
<div class="rounded-2xl border border-ln-border bg-black/10 p-5">
351+
<h3 class="font-display font-semibold text-ln-text text-lg mb-2">
352+
Automatic backups
353+
</h3>
354+
<p class="font-display text-ln-muted text-sm leading-relaxed mb-2">
355+
If your LNbitsBox stays powered on, you can enable scheduled encrypted backups from the same Recovery Tool page.
356+
</p>
357+
<p class="font-display text-ln-muted text-sm leading-relaxed">
358+
Pick how often the backup should run, choose full or quick mode, and set the stored backup password. We still recommend occasionally downloading a copy off the box as part of your backup routine.
359+
</p>
360+
</div>
361+
</div>
362+
</section>
264363
</div>
265364
</div>
266365
</section>

0 commit comments

Comments
 (0)