Skip to content

Commit f4d8be9

Browse files
Added troubleshooting section to website
1 parent 6055f95 commit f4d8be9

1 file changed

Lines changed: 111 additions & 7 deletions

File tree

gh-pages/pages/user-guide.vue

Lines changed: 111 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,74 @@ const sections = [
55
{ id: 'accessing-the-configurator', label: 'Initial Set-up' },
66
{ id: 'after-configuration', label: 'Managing Your LNbitsBox' },
77
{ id: 'recovery-tool', label: 'Recovery Tool' },
8+
{ id: 'troubleshooting', label: 'Troubleshooting' },
9+
]
10+
11+
const troubleshootingItems = [
12+
{
13+
title: 'I can’t reach `lnbits.local`',
14+
solution: [
15+
'Make sure your phone or computer is on the same local network as your LNbitsBox.',
16+
'Try `http://lnbits.local` first, then try the LNbitsBox\'s local IP address if that does not load.',
17+
'If needed, use a network scanner such as Angry IP Scanner, or connect a monitor to your LNbitsBox to check its IP during boot.',
18+
],
19+
},
20+
{
21+
title: 'The LNbitsBox powers on, but never appears on my network',
22+
solution: [
23+
'Check that the Ethernet cable is connected properly, or confirm that your `wifi.txt` file was created correctly on the SD card before first boot.',
24+
'If using Wi-Fi, double-check the network name and password.',
25+
'Ethernet is the best first test because it removes Wi-Fi setup as a possible issue.',
26+
],
27+
},
28+
{
29+
title: 'The configurator page does not open',
30+
solution: [
31+
'Give the device a few minutes to fully boot on first startup.',
32+
'If `lnbits.local` still does not work, try the local IP address instead.',
33+
'A reboot can also help if the LNbitsBox did not finish startup cleanly.',
34+
],
35+
},
36+
{
37+
title: 'The browser shows certificate or security warnings',
38+
solution: [
39+
'LNbitsBox uses its own local certificate for secure access on your home network.',
40+
'Follow the certificate installation steps shown on the first setup page, then reload the site.',
41+
'If the warning continues, return to the certificate page and install the certificate again on that device.',
42+
],
43+
},
44+
{
45+
title: 'I finished setup, but now the configurator is gone',
46+
solution: [
47+
'That is expected.',
48+
'After setup is complete, LNbitsBox switches from the configurator to the normal LNbits interface.',
49+
'Use `lnbits.local` for LNbits and `lnbits.local/box` for the admin panel.',
50+
],
51+
},
52+
{
53+
title: 'I can’t log in to the admin panel',
54+
solution: [
55+
'Use the SSH password you created during setup.',
56+
'Make sure you are opening `lnbits.local/box` and not the main LNbits page.',
57+
'If you no longer know the password, recovery may require restoring from backup or reflashing the SD card.',
58+
],
59+
},
60+
{
61+
title: 'My SD card seems corrupted or the system will not boot',
62+
solution: [
63+
'Power off your LNbitsBox and remove the SD card.',
64+
'Reflash it using Raspberry Pi Imager with the latest LNbitsBox release from `https://github.com/lnbits/LNbitsBox/releases/latest`.',
65+
'If you have Recovery Tool backups or your Spark seed phrase, keep those safe before starting.',
66+
],
67+
},
68+
{
69+
title: 'How to reflash the SD card',
70+
solution: [
71+
'Download the latest LNbitsBox release from `https://github.com/lnbits/LNbitsBox/releases/latest`.',
72+
'Open Raspberry Pi Imager, choose `Use custom`, select the downloaded LNbitsBox image, choose your SD card, and write the image.',
73+
'When flashing is complete, safely eject the card, insert it into your LNbitsBox, and power the device back on.',
74+
],
75+
},
876
]
977
</script>
1078

@@ -241,7 +309,7 @@ const sections = [
241309
</h3>
242310
<p class="font-display text-ln-muted text-sm leading-relaxed mb-3">
243311
LNbitsBox supports remote access in two ways: through a paid tunnel service, or through
244-
Tor. Both are managed from the box after your initial setup is complete.
312+
Tor. Both are managed from the LNbitsBox after your initial setup is complete.
245313
</p>
246314
<p class="font-display text-ln-muted text-sm leading-relaxed">
247315
The paid tunnel is designed for straightforward remote access from a normal browser.
@@ -276,7 +344,7 @@ const sections = [
276344
<p class="font-display text-ln-muted text-base sm:text-lg leading-relaxed mb-6">
277345
The Recovery Tool is your main safety net for your LNbitsBox. It helps you create encrypted recovery backups,
278346
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.
347+
prepared if your SD card fails or you need to move to a new LNbitsBox.
280348
</p>
281349

282350
<div class="space-y-4">
@@ -304,13 +372,13 @@ const sections = [
304372
<li class="flex gap-3">
305373
<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>
306374
<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.
375+
Enter a backup password. Every recovery archive is password protected, so store that password somewhere safe and separate from the LNbitsBox.
308376
</p>
309377
</li>
310378
<li class="flex gap-3">
311379
<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>
312380
<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.
381+
Use <strong>Download Backup</strong> to save the archive to your computer, or <strong>Save on This LNbitsBox</strong> to keep a copy in the local recovery folder for later download.
314382
</p>
315383
</li>
316384
</ol>
@@ -330,7 +398,7 @@ const sections = [
330398
Keep your Spark seed phrase too
331399
</h3>
332400
<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.
401+
Recovery archives help restore your LNbitsBox, but your Spark seed phrase is still the most important secret for recovering wallet access and funds.
334402
</p>
335403
</div>
336404
</div>
@@ -340,7 +408,7 @@ const sections = [
340408
Restore carefully
341409
</h3>
342410
<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.
411+
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 LNbitsBox.
344412
</p>
345413
<p class="font-display text-ln-muted text-sm leading-relaxed">
346414
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.
@@ -355,11 +423,47 @@ const sections = [
355423
If your LNbitsBox stays powered on, you can enable scheduled encrypted backups from the same Recovery Tool page.
356424
</p>
357425
<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.
426+
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 LNbitsBox as part of your backup routine.
359427
</p>
360428
</div>
361429
</div>
362430
</section>
431+
432+
<section
433+
id="troubleshooting"
434+
class="scroll-mt-24 border border-ln-border rounded-3xl bg-ln-card/60 p-6 sm:p-8"
435+
>
436+
<p class="font-mono text-xs uppercase tracking-[0.25em] text-ln-pink mb-3">
437+
Troubleshooting
438+
</p>
439+
<h2 class="font-display font-bold text-ln-text text-2xl sm:text-3xl tracking-tight mb-6">
440+
Common issues and what to try
441+
</h2>
442+
<p class="font-display text-ln-muted text-base sm:text-lg leading-relaxed mb-6">
443+
If something is not working as expected, these are the most common issues and the fastest steps to try first.
444+
</p>
445+
446+
<div class="space-y-4">
447+
<div
448+
v-for="item in troubleshootingItems"
449+
:key="item.title"
450+
class="rounded-2xl border border-ln-border bg-black/10 p-5"
451+
>
452+
<h3 class="font-display font-semibold text-ln-text text-lg mb-3">
453+
{{ item.title }}
454+
</h3>
455+
<ul class="list-disc list-inside space-y-2">
456+
<li
457+
v-for="step in item.solution"
458+
:key="step"
459+
class="font-display text-ln-muted text-sm leading-relaxed"
460+
>
461+
{{ step }}
462+
</li>
463+
</ul>
464+
</div>
465+
</div>
466+
</section>
363467
</div>
364468
</div>
365469
</section>

0 commit comments

Comments
 (0)