Skip to content

Commit d4c180a

Browse files
itsDNNSclaude
andcommitted
Add table of contents and collapsible sections to INSTALL.md
- Add ToC with anchor links to all sections - Wrap each installation method (CLI, Compose, Portainer, Dockhand) in collapsible <details> blocks - users only need one - Wrap Updating, Troubleshooting, and Uninstalling in collapsible blocks - Nest individual troubleshooting FAQs as collapsible sub-items - Keep What You Need, method overview table, and First-Time Setup always visible since every user needs them Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 0378423 commit d4c180a

File tree

1 file changed

+61
-12
lines changed

1 file changed

+61
-12
lines changed

INSTALL.md

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
Get DOCSight running in under 10 minutes.
44

5+
## Table of Contents
6+
7+
- [What You Need](#what-you-need)
8+
- [Choose Your Installation Method](#choose-your-installation-method)
9+
- [Docker CLI](#docker-cli)
10+
- [Docker Compose](#docker-compose)
11+
- [Portainer](#portainer)
12+
- [Dockhand](#dockhand)
13+
- [First-Time Setup](#first-time-setup)
14+
- [Updating DOCSight](#updating-docsight)
15+
- [Troubleshooting](#troubleshooting)
16+
- [Uninstalling](#uninstalling)
17+
518
## What You Need
619

720
- **A computer or NAS** with Docker installed
@@ -26,7 +39,8 @@ All four methods create the exact same container. Pick whichever fits your setup
2639

2740
---
2841

29-
## Docker CLI
42+
<details>
43+
<summary><h2>Docker CLI</h2></summary>
3044

3145
### Step 1: Open a terminal
3246

@@ -62,9 +76,12 @@ Open your browser and go to **http://localhost:8765**
6276
6377
Now continue with [First-Time Setup](#first-time-setup).
6478

79+
</details>
80+
6581
---
6682

67-
## Docker Compose
83+
<details>
84+
<summary><h2>Docker Compose</h2></summary>
6885

6986
### Step 1: Create a `docker-compose.yml` file
7087

@@ -101,9 +118,12 @@ Open your browser and go to **http://localhost:8765**
101118

102119
Now continue with [First-Time Setup](#first-time-setup).
103120

121+
</details>
122+
104123
---
105124

106-
## Portainer
125+
<details>
126+
<summary><h2>Portainer</h2></summary>
107127

108128
### Step 1: Open Portainer
109129

@@ -139,9 +159,12 @@ Open your browser and go to **http://your-nas-ip:8765**
139159

140160
Now continue with [First-Time Setup](#first-time-setup).
141161

162+
</details>
163+
142164
---
143165

144-
## Dockhand
166+
<details>
167+
<summary><h2>Dockhand</h2></summary>
145168

146169
### Step 1: Open Dockhand
147170

@@ -177,6 +200,8 @@ Open your browser and go to **http://your-nas-ip:8765**
177200

178201
Now continue with [First-Time Setup](#first-time-setup).
179202

203+
</details>
204+
180205
---
181206

182207
## First-Time Setup
@@ -221,7 +246,8 @@ Click **Complete Setup** - DOCSight starts monitoring immediately. Your dashboar
221246

222247
---
223248

224-
## Updating DOCSight
249+
<details>
250+
<summary><h2>Updating DOCSight</h2></summary>
225251

226252
Your configuration and history are stored in a Docker volume and survive updates.
227253

@@ -253,23 +279,33 @@ docker compose up -d
253279
1. Open the **docsight** stack
254280
2. Click **Redeploy**
255281

282+
</details>
283+
256284
---
257285

258-
## Troubleshooting
286+
<details>
287+
<summary><h2>Troubleshooting</h2></summary>
259288

260-
### "Can't open http://localhost:8765"
289+
<details>
290+
<summary><strong>"Can't open http://localhost:8765"</strong></summary>
261291

262292
- **Is the container running?** Check with `docker ps` - you should see a container named `docsight`
263293
- **On a NAS?** Use the NAS IP address instead of `localhost`, e.g. `http://192.168.178.15:8765`
264294
- **Firewall?** Make sure port 8765 is not blocked
265295

266-
### "Test Connection fails"
296+
</details>
297+
298+
<details>
299+
<summary><strong>"Test Connection fails"</strong></summary>
267300

268301
- **Is the URL correct?** Try opening your modem's web interface URL in your browser first (e.g. `http://192.168.178.1` for FRITZ!Box).
269302
- **Are the credentials correct?** Use the same username and password you use to log into your modem's web interface.
270303
- **Network access?** The Docker container must be able to reach your modem. If running on a remote server, ensure it's on the same network.
271304

272-
### "Port 8765 already in use"
305+
</details>
306+
307+
<details>
308+
<summary><strong>"Port 8765 already in use"</strong></summary>
273309

274310
Another application is using port 8765. Change the port mapping:
275311

@@ -286,7 +322,10 @@ ports:
286322

287323
Then open `http://localhost:9876` instead.
288324

289-
### "Container keeps restarting"
325+
</details>
326+
327+
<details>
328+
<summary><strong>"Container keeps restarting"</strong></summary>
290329

291330
Check the container logs:
292331

@@ -298,17 +337,25 @@ The logs usually indicate the problem. Common causes:
298337
- Invalid configuration - delete the volume and start fresh: `docker volume rm docsight_data`
299338
- Network issues reaching the modem
300339

301-
### "How do I check if it's working?"
340+
</details>
341+
342+
<details>
343+
<summary><strong>"How do I check if it's working?"</strong></summary>
302344

303345
```bash
304346
docker logs docsight --tail 20
305347
```
306348

307349
You should see log entries about successful polls. If the dashboard shows channel data, everything is working.
308350

351+
</details>
352+
353+
</details>
354+
309355
---
310356

311-
## Uninstalling
357+
<details>
358+
<summary><h2>Uninstalling</h2></summary>
312359

313360
### Docker CLI / Docker Compose
314361

@@ -324,3 +371,5 @@ docker volume rm docsight_data
324371
2. Delete the stack
325372

326373
This removes the container and all stored data.
374+
375+
</details>

0 commit comments

Comments
 (0)