mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-04-11 15:39:04 +00:00
Upd docs mainpage and change readme
This commit is contained in:
13
README.md
13
README.md
@@ -43,7 +43,7 @@ It enables:
|
||||
|------------|---------|---------------------------------|
|
||||
| PHP | 8.2 | Backend runtime |
|
||||
| Nginx | 1.24 | Web server & reverse proxy |
|
||||
| FFmpeg | 4.4 | Media transcoding & processing |
|
||||
| FFmpeg | 8.0 | Media transcoding & processing |
|
||||
| MariaDB | 10.6+ | SQL database engine |
|
||||
| KeyDB | 6.3.4 | Cache & session storage (Redis) |
|
||||
| yt-dlp | 2025.07.21 | Audio/Video downloader |
|
||||
@@ -92,6 +92,17 @@ journalctl -u xc_vm -f # Live logs
|
||||
|
||||
---
|
||||
|
||||
## 📂 Project Structure
|
||||
|
||||
```text.
|
||||
|
||||
├─ docs/ # 📚 Project documentation
|
||||
├─ lb_configs/ # ⚙️ Configurations for building Load Balancer (LB)
|
||||
└─ src/ # 💻 Main project code
|
||||
````
|
||||
|
||||
---
|
||||
|
||||
## 🧮 Server Requirements & Sizing
|
||||
|
||||
### 🔧 Minimum Specs
|
||||
|
||||
@@ -1,16 +1,32 @@
|
||||
# Documentation
|
||||
# 📚 Project Documentation
|
||||
|
||||
## API
|
||||
Welcome to the documentation!
|
||||
Here you will find all the materials you need to work with the project, from the API to instructions for building and updating.
|
||||
|
||||
- [System API](api/system_api.md)
|
||||
- [Get playlist](api/playlist.md)
|
||||
- [Xtreamcodes](api/xtreamcodes_api.md)
|
||||
---
|
||||
|
||||
## Build
|
||||
## 🔌 API
|
||||
|
||||
- [Binaries](build_binaries.md)
|
||||
- [FFmpeg](build_ffmpeg.md)
|
||||
| Section | Description |
|
||||
|--------|---------|
|
||||
| [System API](api/system_api.md) | System API. |
|
||||
| [Get playlist](api/playlist.md) | Generating and loading playlists. |
|
||||
| [XtreamCodes API](api/xtreamcodes_api.md) | Integration and working with XtreamCodes. |
|
||||
|
||||
## Update
|
||||
- [Panel update](update.md)
|
||||
- [Checklist before releasing a release](updates_checklist.md)
|
||||
---
|
||||
|
||||
## 🛠 Building
|
||||
| Section | Description |
|
||||
|--------|-------- -|
|
||||
| [Binaries](build_binaries.md) | Instructions for building core binaries. |
|
||||
| [FFmpeg](build_ffmpeg.md) | Building and configuring FFmpeg for the project. |
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Updating
|
||||
| Section | Description |
|
||||
|------- -|---------|
|
||||
| [Updating the dashboard](update.md) | Step-by-step guide to updating the dashboard. |
|
||||
| [Pre-release checklist](updates_checklist.md) | List of tasks for preparing a release. |
|
||||
|
||||
---
|
||||
@@ -1,17 +1,34 @@
|
||||
# Документация
|
||||
# 📚 Документация проекта
|
||||
|
||||
## API
|
||||
Добро пожаловать в документацию!
|
||||
Здесь собраны все материалы по работе с проектом — от API до инструкций по сборке и обновлению.
|
||||
|
||||
- [Системный API](api/system_api.md)
|
||||
- [Получить плейлист](api/playlist.md)
|
||||
- [Xtreamcodes](api/xtreamcodes_api.md)
|
||||
---
|
||||
|
||||
## Сборка
|
||||
## 🔌 API
|
||||
|
||||
- [Бинарники](build_binaries.md)
|
||||
- [FFmpeg](build_ffmpeg.md)
|
||||
| Раздел | Описание |
|
||||
|--------|---------|
|
||||
| [Системный API](api/system_api.md) | Системный API. |
|
||||
| [Получить плейлист](api/playlist.md) | Генерация и загрузка плейлистов. |
|
||||
| [XtreamCodes API](api/xtreamcodes_api.md) | Интеграция и работа с XtreamCodes. |
|
||||
|
||||
## Обновление
|
||||
---
|
||||
|
||||
- [Обновление панели](update.md)
|
||||
- [Чеклист перед публикацией релиза](updates_checklist.md)
|
||||
## 🛠 Сборка
|
||||
|
||||
| Раздел | Описание |
|
||||
|--------|---------|
|
||||
| [Бинарники](build_binaries.md) | Инструкции по сборке основных бинарных файлов. |
|
||||
| [FFmpeg](build_ffmpeg.md) | Сборка и настройка FFmpeg для проекта. |
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Обновление
|
||||
|
||||
| Раздел | Описание |
|
||||
|--------|---------|
|
||||
| [Обновление панели](update.md) | Пошаговое руководство по обновлению панели. |
|
||||
| [Чеклист перед публикацией релиза](updates_checklist.md) | Список задач для подготовки релиза. |
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user