You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Quick Start: docker run as primary, docker compose as alternative
- Generalize FritzBox references to Modem in descriptions
- Add ADMIN_PASSWORD to env var table
- Add auth and light/dark mode to features list
- Fix Reference Values column header (Bad -> Poor)
- Add Contributing and License links
- Remove hardcoded auto-refresh interval
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+40-37Lines changed: 40 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,57 +12,76 @@
12
12
13
13
## Features
14
14
15
-
-**Per-Channel Sensors**: Every downstream/upstream DOCSIS channel becomes its own Home Assistant sensor with full attributes (frequency, modulation, SNR, errors, DOCSIS version)
15
+
-**Web Dashboard**: Real-time channel data with health assessment, trend charts, and calendar navigation
16
+
-**Per-Channel Sensors**: Every downstream/upstream DOCSIS channel becomes its own Home Assistant sensor with full attributes
-**Health Assessment**: Automatic traffic-light evaluation based on industry-standard thresholds
18
-
-**Web UI**: Built-in dashboard on port 8765 with timeline navigation and light/dark mode
18
+
-**Health Assessment**: Automatic traffic-light evaluation with actionable recommendations
19
19
-**Setup Wizard**: Browser-based configuration - no .env file needed
20
20
-**Settings Page**: Change all settings at runtime, test connections, toggle themes
21
21
-**Internationalization**: English and German UI
22
-
-**LLM Export**: Generate structured reports for AI analysis
22
+
-**LLM Export**: Generate structured reports for AI analysis (ChatGPT, Claude, Gemini, etc.)
23
23
-**MQTT Auto-Discovery**: Zero-config integration with Home Assistant
24
+
-**Optional Authentication**: Password-protected web UI with scrypt hashing
25
+
-**Light/Dark Mode**: Persistent theme toggle
24
26
25
27
## Quick Start
26
28
29
+
```bash
30
+
docker run -d --name docsight -p 8765:8765 -v docsight_data:/data ghcr.io/itsdnns/docsight:latest
31
+
```
32
+
33
+
Open `http://localhost:8765` - the setup wizard guides you through configuration.
34
+
35
+
### Using Docker Compose
36
+
27
37
```bash
28
38
git clone https://github.com/itsDNNS/docsight.git
29
39
cd docsight
30
40
docker compose up -d
31
41
```
32
42
33
-
Open `http://localhost:8765` - the setup wizard guides you through configuration.
34
-
35
43
## Configuration
36
44
37
-
Configuration is stored in `config.json` inside the Docker volume and persists across restarts. You can also use environment variables (they override config.json values).
45
+
Configuration is stored in `config.json` inside the Docker volume and persists across restarts. Environment variables override config.json values.
38
46
39
47
### Via Web UI (recommended)
40
48
41
49
1. Start the container - the setup wizard opens automatically
42
-
2. Enter FritzBox URL, username, and password - test the connection
43
-
3. Optionally enter MQTT broker details - test the connection
44
-
4. Set poll interval and history retention
50
+
2. Enter your modem URL, username, and password - test the connection
51
+
3. Optionally configure MQTT broker for Home Assistant integration
52
+
4. Set poll interval, history retention, and language
45
53
5. Done - monitoring starts immediately
46
54
47
-
Access `/settings` at any time to change configuration or toggle light/dark mode.
55
+
Access `/settings` at any time to change configuration, set an admin password, or toggle light/dark mode.
0 commit comments