-
-
Notifications
You must be signed in to change notification settings - Fork 19
Quick Start
From zero to monitoring in 5 minutes.
docker run -d --name docsight -p 8765:8765 -v docsight_data:/data ghcr.io/itsdnns/docsight:latestNew to Docker? See the Installation Guide for step-by-step instructions.
Open http://localhost:8765 in your browser. The setup wizard asks for:
- Your modem type (FRITZ!Box, Vodafone Station, Technicolor TC4400, Arris SURFboard/CM8200/SB6141, Sagemcom, Hitron, Compal, Netgear, or Generic Router for fiber/DSL/satellite). See Configuration for the full list.
- Your modem's IP address (defaults are set automatically per modem type)
- Your modem login credentials (not needed for Generic Router)
Click "Test Connection" to verify. That's it.
DOCSight monitors your connection around the clock. When something goes wrong, you'll see it immediately on the dashboard.
- Health Assessment at the top: green (good), lime (tolerated), yellow (marginal), or red (critical)
- Metric Cards for downstream power, upstream power, errors, and speed
- Signal Trends showing your connection quality over time
- Event Log tracking automatic anomaly detection
| Feature | What it adds | Setup |
|---|---|---|
| Speedtest Tracker | Speed test history and charts | Connect your STT instance in Settings |
| Home Assistant | MQTT sensors for automations | Enter MQTT broker in Settings |
| BQM Integration | External latency graphs | Enter BQM URL in Settings |
| Admin Password | Protect the web UI | Set in Settings under General |
If DOCSight starts but setup or collection does not behave as expected, run the local doctor inside the container:
docker exec docsight python -m app.doctorFor shareable support output, use:
docker exec docsight python -m app.doctor --json > docsight-doctor.jsonThe doctor is passive and redacted by default. See Doctor Diagnostics for details.
docker pull ghcr.io/itsdnns/docsight:latest
docker stop docsight
docker rm docsight
docker run -d \
--name docsight \
-p 8765:8765 \
-v docsight_data:/data \
--cap-add NET_RAW \
--restart unless-stopped \
ghcr.io/itsdnns/docsight:latestYour data is stored in the docsight_data volume and survives updates.
Want to add Speedtest Tracker, BNetzA sidecar, or MQTT? See Example Compose Stacks for ready-made docker-compose.yml files.
Home | Quick Start | Configuration | API Reference | GitHub
- Quick Start
- Installation
- Running without Docker
- Podman Quadlet
- Configuration
- Reverse Proxy
- Example Compose Stacks
- Dashboard
- Connection Monitor
- Signal Trends
- Before/After Comparison
- Channel Timeline & Compare
- Event Log
- Smart Capture
- Gaming Quality Index
- Modulation Performance
- Cable Segment Utilization
- In-App Glossary
- Speedtest Tracker
- BNetzA Breitbandmessung
- ThinkBroadband BQM
- Smokeping
- Weather
- Netzbremse (Peering)
- Notifications
- Home Assistant (MQTT)
- Prometheus Metrics