BitMaster/main
1
0
Fork 0
mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-04-07 05:18:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update.

Browse Source 
Migration documentation added.
Build instructions moved to the builds folder.
This commit is contained in:
Divarion-D
2025-10-08 21:41:36 +03:00
parent 311cb9564c
commit c1a0597202
10 changed files with 428 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
docs/en/build_binaries.md → docs/en/builds/build_binaries.md
View File

0
docs/en/build_ffmpeg.md → docs/en/builds/build_ffmpeg.md
View File

57
docs/en/main-page.md
View File

@@ -1,32 +1,53 @@
# 📚 Project Documentation
<h1 align="center">📚 XC_VM Documentation</h1>
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.
<p align="center">
Welcome to the official XC_VM documentation!<br>
Here you’ll find everything you need to work with the project — from API guides to build and update instructions.
</p>
---
## 🔌 API
## 🔌 API Reference
| 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. |
|:---------|:-------------|
| [System API](api/system_api.md) | Core system endpoints and utilities. |
| [Get Playlist](api/playlist.md) | Generate and download user playlists. |
| [XtreamCodes API](api/xtreamcodes_api.md) | Integration with XtreamCodes-compatible systems. |
---
## 🛠 Building
## 🛠 Build & Compilation
| Section | Description |
|--------|-------- -|
| [Binaries](build_binaries.md) | Instructions for building core binaries. |
| [FFmpeg](build_ffmpeg.md) | Building and configuring FFmpeg for the project. |
|:---------|:-------------|
| [Binaries](build/build_binaries.md) | Instructions for building core binary components. |
| [FFmpeg](build/build_ffmpeg.md) | Guide to building and configuring FFmpeg for XC_VM. |
---
## 🔄 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. |
## 🔄 Update & Release
---
| Section | Description |
|:---------|:-------------|
| [Panel Update](update.md) | Step-by-step guide for upgrading XC_VM to the latest version. |
| [Pre-Release Checklist](updates_checklist.md) | A checklist to follow before publishing a new release. |
---
## 📦 Additional Resources
| Section | Description |
|:---------|:-------------|
| [Migration Guide](migration_guide.md) | Step-by-step guide for migrating from XUI, Xtream Codes, and similar panels. |
<!-- | [FAQ](faq.md) | Frequently asked questions and troubleshooting. | -->
---
<p align="center">
<a href="https://github.com/Vateron-Media/XC_VM">
🔗 Back to Repository
</a>
</p>
---

107
docs/en/migration_guide.md Normal file
View File

@@ -0,0 +1,107 @@
<h1 align="center">🧭 XC_VM Migration Guide</h1>
<p align="center">
Migrate from compatible IPTV systems with ease using the built-in XC_VM migration tool.
</p>
<!-- <p align="center">
<a href="../../wiki"><b>⬅️ Back to Wiki</b></a>
</p> -->
---
## ⚙️ Before You Begin
> 💡 **Recommendation:**
> It’s best to perform the migration on a **clean XC_VM installation**.
If you decide to use an **existing installation**, note that:
- XC_VM will **wipe any tables** in your main database that match data found in your migration database.
- Always **create backups** before performing any migration.
---
## 🚀 Migration Steps
### 1. Upload Your Backup
Upload your existing backup database to your XC_VM server via **SFTP**.
For this example, we’ll assume it’s located at:
```
/tmp/backup.sql
````
### 2. Restore the Backup to the Migration Database
Use the tools script to clear the existing migration database and restore your backup:
```bash
/home/xc_vm/tools migration "/tmp/backup.sql"
````
### 3. Start the Migration
Assuming no errors occurred during restoration, you can begin the migration in one of two ways:
#### 🧩 Option 1 — Command Line (recommended)
Run the migration manually:
```bash
/home/xc_vm/bin/php/bin/php /home/xc_vm/includes/cli/migrate.php
```
#### 🌐 Option 2 — Web Installer
If you prefer not to use command line tools, you can also return to the **web installer** interface via the link provided by the script when installing the panel.
There, select the **“Migration”** option and follow the instructions on the screen to complete the process interactively.
You will see real-time progress updates while XC_VM migrates your data.
Once complete, you will be able to log in to your system.
---
## 🔑 Post-Migration Access Recovery
If you cannot log in (e.g., missing username/password or invalid access code), you can use the **rescue tools**:
### Generate a Rescue Access Code
```bash
/home/xc_vm/tools access
```
### Generate a Rescue Admin User
```bash
/home/xc_vm/tools user
```
> ⚠️ Once logged in, make sure to **change your access code and admin credentials** immediately.
---
## 🧩 After Migration
* Load balancers will initially appear **offline**.
* All streams are **stopped automatically** for safety.
### Next Steps
1. Reinstall your load balancers and **manually start your streams** once migration is verified.
2. Review and update your **default XC_VM settings**.
3. Check **Main Server** details — domain names, SSL configuration, etc.
4. Ensure everything matches your environment and preferences.
---
## 🖥️ Preparing the load balancer
You will need to reinstall the OS on the load balancers.
---
<!-- <p align="center">
<a href="../../wiki"><b>⬅️ Back to Wiki</b></a>
</p>
--- -->

108
docs/en/update.md
View File

@@ -1,43 +1,73 @@
# Control Panel Update Documentation
<h1 align="center">🧩 Control Panel Update Guide</h1>
This documentation describes the process of updating XC_VM. Follow the instructions below to successfully update the server via the control panel.
## Prerequisites
- Access to the control panel with appropriate administrator rights.
- Stable internet connection.
- Backup of server data (recommended before updating).
## Step-by-step instructions
1. **Go to the “Servers” section**
- Log in to the control panel.
- Select the **Servers** section in the main menu.
- ![Servers](../img/update1.png)
2. **Select “Manage Servers”**
- In the “Servers” section, find and click on **Manage Servers** to view the list of available servers.
- ![Servers](../img/update2.png)
3. **Open the “Actions” menu**
- Find the server you want to update in the list.
- Click on the **Actions** button (usually represented as a drop-down menu or icon next to the server).
- ![Servers](../img/update3.png)
4. **Go to “Server Tools”**
- In the “Actions” menu, select **Server Tools** to open the available tools for managing the server.
- ![Servers](../img/update4.png)
5. **Run “Update Server”**
- In the “Server Tools” section, select the **Update Server** option.
- Confirm the action if prompted (you may need to enter a password or confirm the update).
- Wait for the update process to complete. Do not interrupt the process to avoid errors.
- ![Servers](../img/update5.png)
## Notes
- **Update time**: The time required for the update depends on the size of the server and the speed of your Internet connection.
- **Update verification**: After the update is complete, check the server status to ensure that it is working correctly.
- **Errors**: If the update ended with an error, check the server logs or contact technical support.
<p align="center">
This document explains how to update <b>XC_VM</b> via the web control panel.<br>
Follow these steps carefully to perform a clean and safe update.
</p>
---
**Note**: Please attach images for each step so that they can be included in the documentation. If the images have not yet been provided, indicate where they should be inserted, as shown above.
## ⚙️ Prerequisites
Before you begin, make sure you have:
- 🔑 **Administrator access** to the control panel.
- 🌐 **Stable internet connection** during the update.
- 💾 **Backup** of all server data *(strongly recommended)*.
---
## 🪜 Step-by-Step Instructions
### 1️⃣ Go to the **“Servers”** section
- Log in to the control panel.
- Select **Servers** from the main menu.
![Servers](../img/update1.png)
---
### 2️⃣ Select **“Manage Servers”**
- Inside the **Servers** section, click on **Manage Servers** to view your server list.
![Manage Servers](../img/update2.png)
---
### 3️⃣ Open the **“Actions”** menu
- Locate the server you want to update.
- Click the **Actions** button — usually shown as a drop-down menu or icon next to the server.
![Actions Menu](../img/update3.png)
---
### 4️⃣ Go to **“Server Tools”**
- In the **Actions** menu, choose **Server Tools** to access available management tools.
![Server Tools](../img/update4.png)
---
### 5️⃣ Run **“Update Server”**
- Inside **Server Tools**, click **Update Server**.
- Confirm the action if prompted (you might need to re-enter your password).
- Wait for the update to finish — **do not interrupt** the process.
![Update Server](../img/update5.png)
---
## 🧠 Notes & Recommendations
> 🕒 **Update Duration**
> Depends on your server size and network speed.
> ✅ **Post-Update Check**
> After completion, verify that all services are running properly.
> ⚠️ **In Case of Errors**
> Review server logs for details or contact technical support if the issue persists.
---
<!-- <p align="center">
<a href="../"><b>⬅️ Back to Wiki</b></a>
</p>
--- -->

0
docs/ru/build_binaries.md → docs/ru/builds/build_binaries.md
View File

0
docs/ru/build_ffmpeg.md → docs/ru/builds/build_ffmpeg.md
View File

53
docs/ru/main-page.md
View File

@@ -1,34 +1,53 @@
# 📚 Документация проекта
<h1 align="center">📚 XC_VM Documentation</h1>
Добро пожаловать в документацию!
Здесь собраны все материалы по работе с проектом — от API до инструкций по сборке и обновлению.
<p align="center">
Добро пожаловать в официальную документацию проекта!<br>
Здесь собраны все материалы по работе с системой — от API до сборки и обновлений.
</p>
---
## 🔌 API
## 🔌 API Reference
| Раздел | Описание |
|--------|---------|
| [Системный API](api/system_api.md) | Системный API. |
| [Получить плейлист](api/playlist.md) | Генерация и загрузка плейлистов. |
| [XtreamCodes API](api/xtreamcodes_api.md) | Интеграция и работа с XtreamCodes. |
|:--------|:----------|
| [Системный API](api/system_api.md) | Основные системные эндпоинты. |
| [Получить плейлист](api/playlist.md) | Генерация и загрузка пользовательских плейлистов. |
| [XtreamCodes API](api/xtreamcodes_api.md) | Интеграция и взаимодействие с XtreamCodes совместимыми сервисами. |
---
## 🛠 Сборка
## 🛠 Сборка и Компиляция
| Раздел | Описание |
|--------|---------|
| [Бинарники](build_binaries.md) | Инструкции по сборке основных бинарных файлов. |
| [FFmpeg](build_ffmpeg.md) | Сборка и настройка FFmpeg для проекта. |
|:--------|:----------|
| [Бинарники](build/build_binaries.md) | Инструкции по сборке основных бинарных компонентов проекта. |
| [FFmpeg](build/build_ffmpeg.md) | Руководство по сборке и настройке FFmpeg для работы с XC_VM. |
---
## 🔄 Обновление
## 🔄 Обновление и Релизы
| Раздел | Описание |
|--------|---------|
| [Обновление панели](update.md) | Пошаговое руководство по обновлению панели. |
| [Чеклист перед публикацией релиза](updates_checklist.md) | Список задач для подготовки релиза. |
|:--------|:----------|
| [Обновление панели](update.md) | Подробное руководство по обновлению XC_VM до последней версии. |
| [Чеклист перед публикацией релиза](updates_checklist.md) | Контрольный список задач для подготовки нового релиза. |
---
---
## 📦 Дополнительно
| Раздел | Описание |
|:--------|:----------|
| [Миграция с других систем](migration_guide.md) | Пошаговое руководство по миграции с XUI, Xtream Codes и других панелей. |
<!-- | [FAQ](faq.md) | Часто задаваемые вопросы и решения распространённых проблем. | -->
---
<p align="center">
<a href="https://github.com/Vateron-Media/XC_VM">
🔗 Перейти к репозиторию
</a>
</p>
---

108
docs/ru/migration_guide.md Normal file
View File

@@ -0,0 +1,108 @@
<h1 align="center">🧭 Руководство по миграции XC_VM</h1>
<p align="center">
Легко переходите с совместимых систем IPTV с помощью встроенного инструмента миграции XC_VM.
</p>
<!-- <p align="center">
<a href="../../wiki"><b>⬅️ Вернуться в Wiki</b></a>
</p> -->
---
## ⚙️ Перед началом
> 💡 **Рекомендация:**
> Лучше всего выполнять миграцию на **чистой установке XC_VM**.
Если вы решите использовать **существующую установку**, обратите внимание на следующее:
- XC_VM **удалит все таблицы** в вашей основной базе данных, которые соответствуют данным, найденным в вашей базе данных миграции.
- Всегда **создавайте резервные копии** перед выполнением миграции.
---
## 🚀 Шаги миграции
### 1. Загрузите резервную копию
Загрузите существующую резервную копию базы данных на сервер XC_VM через **SFTP**.
В этом примере мы предположим, что она находится по адресу:
```
/tmp/backup.sql
````
### 2. Восстановите резервную копию в базе данных миграции
Используйте скрипт инструментов, чтобы очистить существующую базу данных миграции и восстановить резервную копию:
```bash
/home/xc_vm/tools migration «/tmp/backup.sql»
````
### 3. Запустите миграцию
Если во время восстановления не произошло никаких ошибок, вы можете начать миграцию одним из двух способов:
#### 🧩 Вариант 1 — командная строка (рекомендуется)
Запустите миграцию вручную:
```bash
/home/xc_vm/bin/php/bin/php /home/xc_vm/includes/cli/migrate.php
```
#### 🌐 Вариант 2 — Веб-установщик
Если вы не хотите использовать инструменты командной строки, вы также можете вернуться к интерфейсу **веб-установщика** по ссылке, предоставленной скриптом при установке панели.
Там выберите опцию **«Миграция»** и следуйте инструкциям на экране, чтобы завершить процесс в интерактивном режиме.
Вы будете видеть обновления прогресса в режиме реального времени, пока XC_VM мигрирует ваши данные.
По завершении вы сможете войти в свою систему.
---
## 🔑 Восстановление доступа после миграции
Если вы не можете войти в систему (например, из-за отсутствия имени пользователя/пароля или недействительного кода доступа), вы можете использовать **инструменты спасения**:
### Создание кода доступа для спасения
```bash
/home/xc_vm/tools access
```
### Создание администратора для восстановления доступа
```bash
/home/xc_vm/tools user
```
> ⚠️ После входа в систему не забудьте немедленно **изменить код доступа и учетные данные администратора**.
---
## 🧩 После миграции
* Балансировщики нагрузки сначала будут отображаться как **отключенные**.
* Все потоки **автоматически остановятся** в целях безопасности.
### Следующие шаги
1. Переустановите балансировщики нагрузки и **вручную запустите потоки** после подтверждения миграции.
2. Просмотрите и обновите **настройки XC_VM по умолчанию**.
3. Проверьте данные **главного сервера** — доменные имена, конфигурацию SSL и т. д.
4. Убедитесь, что все соответствует вашей среде и настройкам.
---
## 🖥️ Подготовка балансировщика нагрузки
Вам необходимо будет переустановить ОС на балансировщиках нагрузки.
---
<!-- <p align="center">
<a href="../../wiki"><b>⬅️ Вернуться в Wiki</b></a>
</p>
--- -->

108
docs/ru/update.md
View File

@@ -1,43 +1,73 @@
# Документация по обновлению панели управления
<h1 align="center">🧩 Руководство по обновлению через панель управления</h1>
Эта документация описывает процесс обновления XC_VM. Следуйте инструкциям ниже, чтобы успешно обновить сервер через панель управления.
## Предварительные требования
- Доступ к панели управления с соответствующими правами администратора.
- Стабильное интернет-соединение.
- Резервная копия данных сервера (рекомендуется перед обновлением).
## Пошаговая инструкция
1. **Перейдите в раздел "Servers"**
- Войдите в панель управления.
- В главном меню выберите раздел **Servers**.
- ![Servers](../img/update1.png)
2. **Выберите "Manage Servers"**
- В разделе "Servers" найдите и нажмите на **Manage Servers**, чтобы просмотреть список доступных серверов.
- ![Servers](../img/update2.png)
3. **Откройте меню "Actions"**
- Найдите сервер, который требуется обновить, в списке.
- Нажмите на кнопку **Actions** (обычно представлена в виде выпадающего меню или значка рядом с сервером).
- ![Servers](../img/update3.png)
4. **Перейдите в "Server Tools"**
- В меню "Actions" выберите **Server Tools**, чтобы открыть доступные инструменты для управления сервером.
- ![Servers](../img/update4.png)
5. **Запустите "Update Server"**
- В разделе "Server Tools" выберите опцию **Update Server**.
- Подтвердите действие, если появится запрос (может потребоваться ввести пароль или подтвердить обновление).
- Дождитесь завершения процесса обновления. Не прерывайте процесс, чтобы избежать ошибок.
- ![Servers](../img/update5.png)
## Примечания
- **Время обновления**: Время, необходимое для обновления, зависит от размера сервера и скорости интернет-соединения.
- **Проверка обновления**: После завершения обновления проверьте статус сервера, чтобы убедиться, что он работает корректно.
- **Ошибки**: Если обновление завершилось с ошибкой, проверьте логи сервера или обратитесь в техническую поддержку.
<p align="center">
В этом документе описан процесс обновления <b>XC_VM</b> через веб-панель управления.<br>
Следуйте шагам ниже, чтобы выполнить обновление безопасно и корректно.
</p>
---
**Примечание**: Пожалуйста, прикрепите изображения для каждого шага, чтобы они были включены в документацию. Если изображения еще не предоставлены, укажите, где они должны быть вставлены, как показано выше.
## ⚙️ Перед началом
Перед тем как начать обновление, убедитесь, что у вас есть:
- 🔑 **Доступ администратора** к панели управления.
- 🌐 **Стабильное интернет-соединение**.
- 💾 **Резервная копия данных сервера** *(настоятельно рекомендуется)*.
---
## 🪜 Пошаговая инструкция
### 1️⃣ Перейдите в раздел **“Servers”**
- Авторизуйтесь в панели управления.
- Выберите раздел **Servers** в главном меню.
![Servers](../img/update1.png)
---
### 2️⃣ Выберите **“Manage Servers”**
- В разделе **Servers** нажмите **Manage Servers**, чтобы открыть список доступных серверов.
![Manage Servers](../img/update2.png)
---
### 3️⃣ Откройте меню **“Actions”**
- Найдите сервер, который требуется обновить.
- Нажмите кнопку **Actions** — обычно это выпадающее меню или значок рядом с сервером.
![Actions Menu](../img/update3.png)
---
### 4️⃣ Перейдите в раздел **“Server Tools”**
- В меню **Actions** выберите пункт **Server Tools**, чтобы открыть инструменты управления сервером.
![Server Tools](../img/update4.png)
---
### 5️⃣ Запустите **“Update Server”**
- В разделе **Server Tools** нажмите **Update Server**.
- Подтвердите действие, если потребуется (возможно, будет запрошен пароль).
- Дождитесь завершения обновления — **не прерывайте процесс**, чтобы избежать ошибок.
![Update Server](../img/update5.png)
---
## 🧠 Примечания и рекомендации
> 🕒 **Время обновления**
> Зависит от размера сервера и скорости интернет-соединения.
> ✅ **Проверка после обновления**
> После завершения обновления проверьте состояние сервера и убедитесь, что все службы работают корректно.
> ⚠️ **Ошибки при обновлении**
> В случае ошибки проверьте логи сервера или обратитесь в техническую поддержку.
---
<!-- <p align="center">
<a href="../"><b>⬅️ Назад к Wiki</b></a>
</p>
--- -->