Skip to content

Latest commit

 

History

1,750 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DOCSight

DOCSight

Product page  •   Get Started  •   Windows Preview  •   Supported Hardware  •   Wiki  •   Data contract  •   Code signing  •   Releases

License Version Stars Image Size Featured in selfh.st Weekly

Local monitoring and diagnostic reports for your internet connection.

Keep DOCSIS signal history, speed tests, latency, events, and incident notes together to investigate intermittent problems and share reports with your ISP.

Self-hostedLocal dataMIT

DOCSight product dashboard with signal health, speed, latency and connection cards

Synthetic demo data in the real product UI: signal health, speed, latency, and connection context in one dashboard.


Get Started

The commands below require a running Docker engine. For Windows setup, see the Windows quick start. To try DOCSight without Docker, use the unsigned portable Windows Desktop Preview; for a native Python installation, see INSTALL.md.

Option 1: Try the demo

No router required. Demo mode generates synthetic DOCSIS history so you can explore the app.

docker run -d --name docsight-demo -p 8765:8765 -e DEMO_MODE=true ghcr.io/itsdnns/docsight:latest

Option 2: Connect your own modem or router

docker run -d --name docsight --restart unless-stopped -p 8765:8765 -v docsight_data:/data ghcr.io/itsdnns/docsight:latest

Open http://localhost:8765. For your own connection, follow the setup wizard to select a supported modem or Generic Router. Configuration and history are stored in the docsight_data volume.

Windows quick start | Full installation guide | Example Compose Stacks


Evidence journey

A few key views from the workflow:

See what is happening now Find the pattern
DOCSight dashboard with current signal health, speed, and active issue cards DOCSight signal trends showing long-term signal patterns
Current signal health, speed, latency, and active issues sit in one view. Review signal changes over time.
Connect the signals Bring something useful to support
DOCSight correlation view lining up signal, speed, and event history DOCSight evidence package workflow for local report generation
Signal drops, packet loss, speed dips, modem events, and notes line up in one timeline. Export a report for a selected incident or time window.

Public proof pack

See the sample complaint report PDF and proof-pack notes for an example using synthetic data. Complaint templates and BNetzA workflows focus on Germany; reports do not guarantee an ISP or legal outcome.


Your Data Stays With You

Monitoring history and generated reports stay on your own hardware. Optional integrations communicate with the services you configure. Review exports before sharing: they can contain connection details and incident notes.

See the Data contract for storage and sharing boundaries, and the Security policy for supported versions and vulnerability reporting.


Features

Core Evidence Workflow

Feature Why it matters
Live Dashboard See current signal health, active issues, and actionable diagnostics at a glance
Signal Trends Turn intermittent instability into visible long-term patterns
Connection Monitor Track latency, packet loss, outages, traceroute evidence, and raw ping logs continuously
Event Log Automatically record anomalies like modulation drops and modem restarts
Incident Journal Add notes, attachments, reviewed imports, and incident groupings
Evidence Journey Review an incident or custom time window, see ready/stale/missing evidence, and carry that exact fixed period into complaint and PDF generation
DE · TKG compensation Check possible compensation for a complete outage or missed provider appointment, calculate a possible amount, and prepare an editable provider letter locally
Before/After Comparison Compare measurements before and after a technician visit or ISP change
Correlation Analysis Combine signal, speed, and event history in one timeline
Complaint Generator Build ISP-ready evidence packages with letter text, checklist, and PDF output

Analysis, Integrations, and Power Features

Category Includes
Network analysis Gaming Quality Index, Modulation Performance, Channel Timeline, Cable Segment Utilization
External data sources Guided setup for Speedtest Integration, BQM Integration, and Smokeping Integration, plus Smart Capture and BNetzA Measurements
Platform features Home Assistant, Notifications, Backup & Restore, setup wizard, optional authentication, API tokens
Usability and extensibility Demo Mode, Theme Engine, Community Modules, In-App Glossary, AI/LLM Export with local redaction controls

The core interface supports 24 languages, light/dark themes, and PWA/offline use.


Extended screenshot gallery

See the extended screenshot gallery
Dashboard (Light) Health Assessment
Light Health
Speedtest Tracker Import (Excel/CSV)
Speedtest Import
Edit with Icon Picker Channel Timeline
Edit Channel Timeline
Event Log Settings
Events Settings
Theme Gallery BQM Integration
Themes BQM

Supported Hardware

DOCSight includes drivers for 22 modem families, including the experimental PYUR FAST3896-15 driver with reported hardware success. DOCSIS signal monitoring requires a supported cable modem. Generic Router mode supports other connections, including fiber, DSL, and satellite, with speed tests, latency monitoring, notes, and reports but no DOCSIS signal data.

Signal health and SC-QAM capacity estimates describe the physical/channel layer; they are not measurements of internet throughput or tariff speed.

Common setups

  • CGA4233 / TG3442DE cable gateways: bridge mode compatible
  • AVM FRITZ!Box Cable (6490, 6590, 6591, 6660, 6690)
  • Sercomm Ultra Hub 7 class gateways
  • CH7465 Connect Box family
  • Sagemcom F@st 3896: JSON-RPC API
  • Sagemcom F3896LG (Hub 5 / Liberty Global REST firmware): unauthenticated API, works in modem mode
  • PYUR FAST3896-15 (pyur_fast3896): experimental /api/v1 driver with reported login and collection success; see setup notes below
  • Technicolor TC4400
  • Arris SURFboard (S33, S34, SB8200): HNAP1 API
  • Arris SURFboard SB8200 (CBN firmware, SB8200v3): XML API, for units that serve the CBN web UI instead of HNAP1
  • Arris SB6183: HTTP status pages, no authentication required
  • Hitron CODA-56 and CODA-4680
  • Netgear CM3000
  • Netgear CM1000

See the full compatibility and setup docs in the wiki →

Community drivers and extensions live in docsight-modules, and you can also add your own modem support.

PYUR FAST3896-15 (experimental)

Select PYUR FAST3896-15 (experimental) in setup/settings, use http://192.168.100.1 (or your modem's configured address), and enter the modem UI password. The UI is password-only; the driver uses admin by default. This firmware uses /api/v1, unlike the Sagemcom XMO /cgi/json-req and Liberty Global /rest/v1 drivers. Select the PYUR entry for this firmware.

Support was developed using an examined capture from FAST3896-15_PYUR-RDK_83.2.4 and automated tests. With image sha-208d8b4, the reporter confirmed successful login and data collection, followed by nominal operation after one day.

Login uses a portable SHA512-crypt implementation checked against independent vectors. The captured frontend references an unavailable helper; the reported login provides hardware evidence for this implementation on the tested modem. Automated tests alone do not establish universal firmware compatibility. Reboot recovery, session expiry, channel accuracy and device uptime/firmware were not individually confirmed by the reporter. Upstream QAM has no known order; OFDM has no known profile modulation. Unavailable counters and connection rates remain unknown. Subscriber network parameters are not requested.


Community and Support

For setup help, use GitHub Discussions. See SUPPORT.md for troubleshooting steps, the local doctor command, and where to report bugs or request modem support. Report vulnerabilities through the Security policy.

Contributing

See CONTRIBUTING.md. Please open an issue or start an Ideas discussion before working on new features.

Support

You can support development through:

GitHub Sponsors Ko-fi PayPal

Brand Use

The code is MIT-licensed, but the DOCSight name, logo, and project branding are governed separately. Community forks and commercial services may say they are "based on DOCSight" or "compatible with DOCSight", but must not present themselves as the official project without permission.

See TRADEMARKS.md for the full brand and trademark policy.

Documentation

Document Scope
Wiki User guides, feature docs, setup instructions
Data contract Local storage, integrations, and export boundaries
Apprise notification sidecar Optional alert fan-out through an Apprise API sidecar
PWA Web Push notifications Optional browser/app push alerts through the installed PWA
Community proof templates Public-safe templates for setup stories, modem reports, and ISP evidence outcomes
Installation Docker, native Python, and reverse-proxy setup
GitHub Releases Versioned builds and release notes
SUPPORT.md Support routing, community channels, and issue guidance
ARCHITECTURE.md Technical architecture and extension guide
CONTRIBUTING.md Development and contribution guidelines
TRADEMARKS.md Brand, logo, and official-use policy

License

MIT

DOCSight = DOCSIS + Insight (+ a quiet sigh from every cable internet user)

About

Self-hosted DOCSIS evidence system for proving cable signal problems and bad ISP performance. Tracks incidents, signal health, and complaint-ready exports.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

282 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages