Files
XC_VM/docs/en/README.md
T
Divarion-D 76844fef11 docs: restructure, fix PSR-4 drift, and unify en/ru
Overhaul the Docsify documentation (English + Russian) so it matches the current
codebase and follows one consistent pattern.

Content accuracy (post-migration):
- Rewrite development/autoloader.md to PSR-4 / Composer (the old XC_Autoloader
  scanner, igbinary tmp/cache/autoload_map and registerDirectories are gone).
- PascalCase every source path (src/core -> src/Core, domain/Stream, cli/Commands,
  public/Controllers, Infrastructure/Redis, ...) across all docs.
- Replace the removed autoload.php references with vendor/autoload.php
  (build_system, bootstrap-contexts, error-handling, modules).
- ssl-generation: note that the installer now auto-generates a unique self-signed
  certificate before Nginx starts.

Common pattern (Clean & uniform):
- Strip emoji from headings; remove the in-page Navigation blocks (the Docsify
  sidebar already provides navigation).
- One H1 + intro per doc; uniform "Related files" / "Связанные файлы" section,
  added to the code-centric docs that lacked it.

Structure:
- Remove the empty stray docs/api/; move updates_checklist.md into builds/;
  link the previously-orphaned ucs-integration.md.
- Regroup the sidebars (split the oversized guides group into Developer Guides /
  Security & Access / Integrations; fold builds into Build & Release).

Augment:
- dev-workflow: Local Setup (make dev-tools) + Quality Checks (phpstan, cs, gates).
- build_system: Composer Dependencies section (committed prod-only vendor,
  committed lock, dev tools via composer install, no build-time vendor step).

en/ru parity:
- Apply the same structure, fixes and pattern to docs/ru/ (translated), including
  a new Russian ucs-integration.md. The en and ru file sets are now identical.
2026-06-26 15:56:15 +03:00

85 lines
2.0 KiB
Markdown

# XC_VM IPTV Panel
![Vateron Media Logo](https://avatars.githubusercontent.com/u/149707645?s=400&v=4)
A modern, open-source IPTV panel inspired by Xtream Codes. Lightweight, fast, and community-driven.
---
## What Is It?
**XC_VM** is a modern IPTV panel built on PHP, Nginx, FFmpeg, and MariaDB.
XC_VM helps you deploy a full IPTV infrastructure:
- Management of Live TV, Movies, and Series
- Reseller and user management
- Load Balancing
- EPG and VOD system
- Monitoring tools and API
💡 *Completely free. No licenses. No server locks.*
---
## Features
- 🚀 Modern IPTV panel architecture
- 🔀 Built-in load balancer support
- 🎥 Management of VOD and live streams
- 🧩 API compatible with Xtream Codes
- 🔐 Enhanced security fixes
- 📦 Fast FFmpeg-based transcoding
- 🌍 Multi-language documentation
- 🧭 Simple and intuitive interface
- 🛠 Modular extension system
---
## Technologies
- **Nginx** — reverse proxy & web server
- **PHP 8.1** — core backend
- **MariaDB** — database
- **KeyDB** — cache/session engine
- **FFmpeg 8.0** — transcoding
- **yt-dlp** — media acquiring
XC_VM officially supports Ubuntu 22.04 and is tested on 24.04.
---
## Community
XC_VM is a fully community-driven project.
- 💬 [Issues](https://github.com/Vateron-Media/XC_VM/issues)
- ⭐ GitHub Stars: support the project by giving it a star
- 🔧 Pull Requests: welcome
If you want to contribute, read the:
[Contributing Guide](https://github.com/Vateron-Media/XC_VM/blob/master/CONTRIBUTING.md)
---
## Installation
Installation on Ubuntu 22.04+:
```bash
sudo apt update && sudo apt full-upgrade -y
sudo apt install -y python3-pip unzip
latest_version=$(curl -s https://api.github.com/repos/Vateron-Media/XC_VM/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)
wget "https://github.com/Vateron-Media/XC_VM/releases/download/${latest_version}/XC_VM.zip"
unzip XC_VM.zip
sudo python3 install
```
---
## Disclaimer
> You are fully responsible for your own use of this software.