Skip to content

Home

Jump to bottom
Chris edited this page Apr 3, 2026 · 7 revisions

EXStreamTV Documentation

Architecture diagrams: docs/architecture/DIAGRAMS.md — Mermaid-only, 19 standardized diagrams (includes schedule history memento flow, §19).

Version: 2.6.0
Last Updated: 2026-04-01

Welcome to the EXStreamTV documentation. This guide will help you set up, configure, and use EXStreamTV for your IPTV streaming needs.

Quick Links

Document Description
Project README (GitHub) Root readme — wiki badge and docs section if the Wiki tab is hidden in the UI (LL-037)
Platform Guide Full architecture, streaming, HDHomeRun, AI, observability
Quick Start Get started in 10 minutes
Installation Complete installation guide
API Reference REST API documentation
System Design Architecture overview
Pattern refactor sources Refactor inventory + Alembic stamp note
ADR: ChannelManager DB sessions Sync vs async SQLAlchemy boundaries
UI architecture (Track B) React app in frontend/ — routes, personas, Tailwind

Documentation Structure

docs/
├── README.md                    # This file
├── PLATFORM_GUIDE.md            # Master platform document (architecture, streaming, AI, observability)
├── OBSERVABILITY.md             # Prometheus metrics reference
├── OPERATIONAL_GUIDE.md         # Diagnosis and verification
├── INVARIANTS.md                # Formal invariants
├── FEATURE_FLAGS.md             # Config toggles
├── VERSION                      # Documentation version
├── CHANGELOG.md                 # Documentation changes
│
├── guides/                      # User Guides
│   ├── QUICK_START.md          # Getting started
│   ├── INSTALLATION.md         # Installation
│   ├── AI_SETUP.md             # AI configuration
│   ├── CHANNEL_CREATION_GUIDE.md # Channel creation
│   ├── LOCAL_MEDIA.md          # Local media setup
│   ├── HW_TRANSCODING.md       # Hardware transcoding
│   ├── MACOS_APP_GUIDE.md      # macOS app
│   ├── NAVIGATION_GUIDE.md     # UI navigation
│   ├── ONBOARDING.md           # Onboarding
│   ├── STREAMING_STABILITY.md  # Streaming features (NEW)
│   └── ADVANCED_SCHEDULING.md  # Scheduling features (NEW)
│
├── api/                         # API Documentation
│   └── README.md               # Complete API reference
│
├── architecture/                # Architecture Documentation
│   ├── SYSTEM_DESIGN.md        # System architecture
│   ├── DIAGRAMS.md             # 19 Mermaid diagrams (canonical)
│   ├── PATTERN_REFACTOR_SOURCES.md
│   ├── ADR-channel-manager-database-sessions.md
│   └── TUNARR_DIZQUETV_INTEGRATION.md # v2.6.0 integration
│
├── development/                 # Development Documentation
│   └── DISTRIBUTION.md         # Distribution guide
│
├── confluence/                  # Confluence-Ready Documentation (NEW)
│   ├── README.md               # Upload instructions
│   ├── 00-HOME.confluence.md   # Documentation home
│   ├── 01-SYSTEM-DESIGN.confluence.md
│   ├── 02-TUNARR-INTEGRATION.confluence.md
│   ├── 03-API-REFERENCE.confluence.md
│   ├── 04-STREAMING-STABILITY.confluence.md
│   ├── 05-ADVANCED-SCHEDULING.confluence.md
│   ├── 06-AI-SETUP.confluence.md
│   ├── 07-QUICK-START.confluence.md
│   └── 08-BUILD-PROGRESS.confluence.md
│
└── BUILD_PROGRESS.md           # Build tracking

Getting Started

New Users

  1. Installation Guide - Install EXStreamTV on your system
  2. Quick Start - Create your first channel in 10 minutes
  3. AI Setup - Configure AI for smart channel creation

Intermediate Users

  1. Channel Creation Guide - Advanced channel options
  2. Local Media Setup - Add your own media libraries
  3. Hardware Transcoding - GPU acceleration setup

Advanced Users

  1. Advanced Scheduling - Time slots and balance scheduling
  2. Streaming Stability - Session management and throttling
  3. API Reference - Build integrations

New in v2.6.0

EXStreamTV v2.6.0 introduces major enhancements from the Tunarr/dizqueTV integration:

Streaming Stability

flowchart LR
    Client[Client]
    SM[SessionManager]
    ST[StreamThrottler]
    ESG[ErrorScreenGenerator]
    
    Client --> SM
    SM --> ST
    ST -.-> ESG
    ESG -.-> Client
Loading
  • Session Management - Track and manage client connections
  • Stream Throttling - Prevent buffer overruns
  • Error Screens - Graceful fallback during failures

📖 Streaming Stability Guide

Advanced Scheduling

flowchart LR
    Channel[Channel]
    TSS[TimeSlotScheduler]
    BS[BalanceScheduler]
    Content[Content]
    
    Channel --> TSS
    Channel --> BS
    TSS --> Content
    BS --> Content
Loading
  • Time Slot Scheduling - Time-of-day programming blocks
  • Balance Scheduling - Weight-based content distribution

📖 Advanced Scheduling Guide

AI Self-Healing

flowchart LR
    Logs[Logs]
    Collector[LogCollector]
    Detector[PatternDetector]
    Resolver[AutoResolver]
    
    Logs --> Collector
    Collector --> Detector
    Detector --> Resolver
Loading
  • Unified Log Collector - Multi-source log aggregation
  • FFmpeg AI Monitor - Intelligent process monitoring
  • Pattern Detector - ML-based issue detection
  • Auto Resolver - Autonomous issue resolution

📖 AI Setup Guide

Database Backup

  • Scheduled Backups - Automatic daily backups
  • Backup Rotation - Keep N most recent
  • Compression - Gzip for space savings
  • Easy Restore - One-click restoration

📖 AI Setup Guide

Architecture Overview

flowchart TB
    subgraph "Client Layer"
        Clients[IPTV Clients]
    end
    
    subgraph "Application Layer"
        WebUI[WebUI]
        API[REST API]
        HDHomeRun[HDHomeRun Emulator]
    end
    
    subgraph "Streaming Layer"
        SM[SessionManager]
        CM[ChannelManager]
        ST[StreamThrottler]
    end
    
    subgraph "Scheduling Layer"
        TSS[TimeSlotScheduler]
        BS[BalanceScheduler]
    end
    
    subgraph "Media Layer"
        SSP[SubtitlePicker]
        ASP[AudioPicker]
        FFmpeg[FFmpeg Pipeline]
    end
    
    subgraph "AI Layer"
        ULC[UnifiedLogCollector]
        FFM[FFmpegAIMonitor]
        PD[PatternDetector]
        AR[AutoResolver]
    end
    
    subgraph "Data Layer"
        DCM[DatabaseConnectionManager]
        DBM[DatabaseBackupManager]
        DB[(Database)]
    end
    
    Clients --> WebUI
    Clients --> API
    Clients --> HDHomeRun
    
    API --> SM
    SM --> CM
    CM --> ST
    CM --> TSS
    CM --> BS
    
    TSS --> SSP
    BS --> SSP
    SSP --> FFmpeg
    ASP --> FFmpeg
    
    FFmpeg --> ULC
    ULC --> PD
    FFM --> PD
    PD --> AR
    AR --> CM
    
    CM --> DCM
    DCM --> DB
    DBM --> DB
Loading

📖 System Design | Tunarr/dizqueTV Integration

API Overview

The EXStreamTV API provides complete control over your streaming server:

Category Endpoints Description
Channels /api/channels Channel CRUD, filler, deco
Playlists /api/playlists Playlist management
Schedules /api/schedules Schedule configuration
Playouts /api/playouts Playout control
Blocks /api/blocks Time-based blocks
Templates /api/templates Reusable schedules
AI /api/ai AI self-healing, health
System /api/health System monitoring

📖 Complete API Reference

Component Versions

Component Version Last Modified
backend_core 2.6.0 2026-01-31
streaming 2.6.0 2026-01-31
database 2.6.0 2026-01-31
ai_agent 2.6.0 2026-01-31
scheduling 2.6.0 2026-01-31
ffmpeg 2.6.0 2026-01-31
docs 2.6.0 2026-01-31

Confluence Export

All documentation is available in Confluence-ready format in the confluence/ folder.

Confluence Files

File Description
00-HOME.confluence.md Documentation home page
01-SYSTEM-DESIGN.confluence.md System architecture
02-TUNARR-INTEGRATION.confluence.md v2.6.0 integration details
03-API-REFERENCE.confluence.md REST API documentation
04-STREAMING-STABILITY.confluence.md Streaming features
05-ADVANCED-SCHEDULING.confluence.md Scheduling features
06-AI-SETUP.confluence.md AI configuration
07-QUICK-START.confluence.md Getting started
08-BUILD-PROGRESS.confluence.md Development status

Upload Instructions

  1. Install the "Mermaid Diagrams for Confluence" app
  2. Create a new page in Confluence
  3. Use "Insert" → "Markup" → "Markdown"
  4. Copy/paste content from .confluence.md files

See confluence/README.md for detailed instructions.

Support

  • GitHub Issues: Report bugs and request features
  • Documentation: This documentation site
  • Logs: Check Settings > Logs for troubleshooting

Related Resources

Last Revised: 2026-03-21

Repo root AGENTS.md and per-module exstreamtv/*/AGENTS.md complement .cursor/rules/ for human and AI contributors. Wiki pages are synced from docs/ with scripts/sync_docs_to_wiki.py.

Documentation

Getting Started

Guides

Reference

Operations

Changelog & Migration

Clone this wiki locally