huge doc rewrite

This commit is contained in:
2026-10-07 20:03:38 -07:00
parent d6ec1f93b8
commit c28308c389
47 changed files with 3185 additions and 6304 deletions

View File

@@ -1,77 +1,43 @@
# Vyla Documentation
--- START OF FILE llms.txt ---
# Vyla Entertainment
Vyla is a community-built media project focused on freedom, privacy, and giving people control over their own experience.
> Vyla is a community-built, self-hosted media platform and developer ecosystem focused on user freedom, privacy, and decentralized control. It provides native client applications (Home, Go, TV), a Node.js scraper SDK, and an optional HTTP/SSE Stream API proxy.
## Project Overview
## Overview & Architecture
Vyla is not a streaming service and does not host or provide media. Instead, Vyla builds software that brings the media experience together while leaving control in the hands of the person using it. The project consists of:
- [Introduction](https://vyla.cc/): Community ethos, mission, platforms, and getting started overview.
- [Our Architecture](https://vyla.cc/start-here/architecture): System decoupling between local runtimes, provider resolution, and playback delivery.
- **Vyla Home**: Desktop application for Windows, macOS, and Linux
- **Vyla Go**: Android mobile application
- **Vyla TV**: Android TV application
- **Vyla SDK**: Node.js/TypeScript SDK for developers
- **Stream API**: Self-hosted HTTP/SSE API for browser and mobile clients
## Products
## Key Features
- [Vyla Home](https://vyla.cc/products/home): Desktop control center and application runtime for Windows, macOS, and Linux.
- [Vyla Go](https://vyla.cc/products/go): Android mobile client managing local service lifecycles and embedded playback.
- [Vyla TV](https://vyla.cc/products/tv): Android TV Leanback streaming client built with Jetpack Compose and ExoPlayer.
- [Build a Player](https://vyla.cc/products/player): Architectural guidelines for building resilient client media players.
- Self-hosted and privacy-focused
- Open source community project
- Provider-based streaming resolution
- Multi-platform support (desktop, Android, Android TV)
- Developer-friendly SDK and API
- Support for HLS and MP4 streaming
- Built-in health monitoring and fallback systems
## Core Concepts
## Documentation Structure
- [Providers](https://vyla.cc/concepts/providers): Source configurations, jitter, timeout policies, HLS proxy mechanics, and verification pipelines.
- `/` - Introduction to Vyla
- `/architecture` - System architecture and component relationships
- `/home` - Vyla Home desktop application
- `/go` - Vyla Go Android application
- `/tv` - Vyla TV Android TV application
- `/player` - Building custom media players
- `/sdk` - SDK reference documentation
- `/sdk-quickstart` - Quick start guide for SDK
- `/stream-api/overview` - Stream API overview
- `/stream-api/paths` - API paths and SSE events
- `/stream-api/media-data` - Subtitles and downloads API
- `/stream-api/operations` - Health, testing, and operations
- `/self-hosting` - Self-hosting deployment guide
- `/concepts/providers` - Provider configuration and verification
- `/guides/integrations` - Client integration guide
- `/guides/error-handling` - Error handling and fallbacks
- `/misc/credit` - Credits and acknowledgments
- `/misc/dmca` - DMCA and copyright policy
## Developer SDK
## Technical Stack
- [SDK Reference](https://vyla.cc/sdk): Node.js package (@vyla-entertainment/sdk) for direct stream resolution, subtitles, downloads, and health probing.
- [SDK Quickstart](https://vyla.cc/sdk/vyla-sdk/quickstart): Rapid installation, provider selection, and server-side integration guide.
- Node.js 18+ for SDK and Stream API
- TypeScript for SDK
- Server-Sent Events (SSE) for streaming
- HLS.js for web playback
- TMDB API for metadata
- Jetpack Compose for Android TV
## Stream API
## Integration Options
- [Stream API Overview](https://vyla.cc/stream-api/overview): Self-hosted HTTP and SSE progressive playback service.
- [Paths & Playback Events](https://vyla.cc/stream-api/reference/paths): SSE event contract for /movie and /tv routes emitting meta, source, and done events.
- [Subtitles & Downloads](https://vyla.cc/stream-api/reference/media-data): REST endpoints for subtitle track extraction and direct media downloads.
- [Operations & Health](https://vyla.cc/stream-api/reference/operations): /health metrics, /test probes, and safe production troubleshooting.
- [Self-Hosting Guide](https://vyla.cc/stream-api/deployment/self-hosting): Node.js deployment, cluster scaling, environment variables, and reverse proxy setup.
1. **Direct SDK**: For Node.js applications - embed provider resolution directly
2. **Stream API**: For browser/mobile clients - HTTP/SSE interface
3. **Vyla Home**: Managed desktop experience with bundled services
## Guides & Integrations
## Important Notes
- [Client Integration](https://vyla.cc/guides/integrations): Frontend implementation patterns using HLS.js, React, Vue, ExoPlayer, and AVPlayer.
- [Error Handling](https://vyla.cc/guides/error-handling): Handling SSE timeouts, fallback queues, subtitle absence, and retry strategies.
- Vyla is self-hosted only - no public hosted instance
- Requires TMDB API key for metadata-dependent sources
- Provider availability varies by network environment
- Supports fallback strategies for resilient playback
- CORS-enabled by default
- No database required for Stream API
## Policies & Attribution
## Community
- GitLab: https://gitlab.com/vyla-entertainment/
- Discord: https://discord.gg/5eqRhKeywG
## Legal
Vyla does not host or distribute media. Rights holders can request source removal via the DMCA policy. The project is intended for personal, educational, and development use. Users are responsible for complying with applicable laws.
- [Credit](https://vyla.cc/misc/project/credit): Acknowledgments for upstream open-source inspiration including P-Stream, CinePro, and Movieslay.
- [DMCA Policy](https://vyla.cc/misc/project/dmca): DMCA takedown procedures, upstream content aggregation disclosures, and contact points.