330 lines
9.7 KiB
Markdown
330 lines
9.7 KiB
Markdown
# MC Panel - Панель управления Minecraft серверами
|
||
|
||
**Версия:** 1.1.0
|
||
**Дата:** 15 января 2026
|
||
|
||
---
|
||
|
||
## 📚 Документация
|
||
|
||
### 🎉 ПРОЕКТ_ЗАВЕРШЁН
|
||
**Полный обзор проекта**
|
||
|
||
Comprehensive overview всего проекта:
|
||
- ✅ Все выполненные задачи (11 шт.)
|
||
- 📊 Статистика проекта
|
||
- 🎯 Основные возможности
|
||
- 🚀 Быстрый старт (3 варианта)
|
||
- 🏆 Достижения
|
||
|
||
**Начните отсюда для общего понимания!** 🌟
|
||
|
||
### 📋 ФИНАЛЬНЫЙ_СПИСОК
|
||
**Полный список всех файлов**
|
||
|
||
Детальный список всех файлов проекта:
|
||
- 📁 Структура проекта (60+ файлов)
|
||
- 📊 Статистика кода (~20,000 строк)
|
||
- 📚 Навигация по документации
|
||
- 🎯 Выполненные задачи (14 шт.)
|
||
- 🏆 Достижения
|
||
|
||
**Полная карта проекта!** 🗺️
|
||
|
||
### ✅ CHECKLIST
|
||
**Финальный Checklist**
|
||
|
||
Проверка завершения всех работ:
|
||
- ✅ Все задачи (14/14 - 100%)
|
||
- ✅ Все файлы (65+)
|
||
- ✅ Вся функциональность
|
||
- ✅ Вся документация
|
||
- 🚀 Production Ready
|
||
|
||
**Подтверждение готовности!** ✔️
|
||
|
||
### 👑 OWNER_PERMISSIONS
|
||
**Роль Владельца и Система Прав**
|
||
|
||
Новая система управления пользователями:
|
||
- 👑 Роль владельца (Owner)
|
||
- 🔐 Система прав и разрешений
|
||
- 👥 Управление пользователями
|
||
- 🚫 Блокировка/разблокировка
|
||
- 📊 5 ролей (Owner, Admin, Support, User, Banned)
|
||
|
||
**Полный контроль над панелью!** 🎯
|
||
|
||
### 🔧 MIGRATION_FIX
|
||
**Исправление миграции**
|
||
|
||
Решение проблемы KeyError при миграции:
|
||
- 🐛 Описание проблемы
|
||
- ✅ Решение (поддержка обоих форматов)
|
||
- 📊 Примеры до/после
|
||
- 🧪 Тестирование
|
||
- ❓ FAQ
|
||
|
||
**Миграция работает!** ✔️
|
||
|
||
### ✅ OWNER_UI_READY
|
||
**UI Владельца готов!**
|
||
|
||
Полная инструкция по использованию:
|
||
- 🎉 Что было сделано
|
||
- 🚀 Как запустить
|
||
- 🎯 Как использовать
|
||
- 💡 Примеры
|
||
- 🐛 Troubleshooting
|
||
|
||
**Управление пользователями работает!** 👑
|
||
|
||
### 👁️ OWNER_VIEW_ALL
|
||
**Владелец видит все серверы**
|
||
|
||
Изменение логики доступа:
|
||
- 🎯 Что изменилось
|
||
- 📊 Логика доступа к серверам
|
||
- 🎫 Логика доступа к тикетам
|
||
- 🔐 Права view_all_resources
|
||
- 🚀 Как проверить
|
||
|
||
**Полный контроль над всеми ресурсами!** 🖥️
|
||
|
||
### 👑 MULTIPLE_OWNERS
|
||
**Несколько владельцев**
|
||
|
||
Возможность назначить несколько владельцев:
|
||
- 🎯 Что изменилось
|
||
- 📊 Новая логика
|
||
- 💡 Примеры использования
|
||
- 🔒 Правила безопасности
|
||
- 🎯 Рекомендации
|
||
|
||
**Больше владельцев - больше контроля!** 👑👑
|
||
|
||
### 🚀 DRONE_SIMPLIFIED
|
||
**Упрощённый CI/CD**
|
||
|
||
Упрощение Drone конфигурации:
|
||
- 🎯 Что изменилось (4→2 пайплайна)
|
||
- 📋 Оставшиеся пайплайны
|
||
- 🗑️ Удалённые компоненты
|
||
- 🔧 Настройка
|
||
- ✅ Преимущества
|
||
|
||
**Меньше сложности - больше контроля!** 🔧
|
||
|
||
### 📝 CHANGELOG
|
||
**История изменений**
|
||
|
||
Все изменения проекта:
|
||
- 📋 Версия 1.1.0 - Система прав
|
||
- 📋 Версия 1.0.0 - Первый релиз
|
||
- 🔄 Детальное описание изменений
|
||
- 🐛 Исправленные ошибки
|
||
|
||
**Отслеживание изменений!** 📊
|
||
|
||
### 🎉 VERSION_1.1.0
|
||
**Релиз v1.1.0**
|
||
|
||
Что нового в версии 1.1.0:
|
||
- 👑 Роль владельца
|
||
- 🔐 Система прав (7 типов)
|
||
- 🆕 8 новых API эндпоинтов
|
||
- 🛠️ Инструменты миграции
|
||
- 📚 Новая документация
|
||
|
||
**Обзор релиза!** 🚀
|
||
|
||
---
|
||
|
||
### 📖 ДОКУМЕНТАЦИЯ
|
||
**Полная документация проекта**
|
||
|
||
Содержит всю информацию о проекте:
|
||
- 🚀 Быстрый старт
|
||
- ⚙️ Установка и настройка
|
||
- 🎮 Функциональность
|
||
- 🔔 Система уведомлений
|
||
- 🎨 Дизайн и темы
|
||
- 📁 Файловый менеджер
|
||
- 🎫 Система тикетов
|
||
- 👤 Личный кабинет
|
||
- 🔐 OpenID Connect
|
||
- 👥 Роли пользователей
|
||
- 🔒 Безопасность
|
||
- 🔧 Troubleshooting
|
||
|
||
**Начните отсюда!** 👈
|
||
|
||
---
|
||
|
||
### 🌐 API
|
||
**Документация API**
|
||
|
||
Полное описание REST API:
|
||
- 📋 Все эндпоинты (37 шт.)
|
||
- 🔐 Аутентификация
|
||
- 👥 Управление пользователями
|
||
- 🖥️ Управление серверами
|
||
- 📁 Управление файлами
|
||
- 🎫 Тикеты
|
||
- 💡 Примеры интеграции (Python, JavaScript, cURL)
|
||
- 📦 Postman коллекция
|
||
|
||
**Для разработчиков!** 👨💻
|
||
|
||
---
|
||
|
||
### 📦 MC_Panel_API.postman_collection
|
||
**Postman коллекция**
|
||
|
||
Готовая коллекция для тестирования API:
|
||
- 40+ готовых запросов
|
||
- Автоматическое сохранение токена
|
||
- Переменные окружения
|
||
- Примеры тел запросов
|
||
|
||
**Импортируйте в Postman!** 📮
|
||
|
||
**Всё .md файлы есть на вики**
|
||
|
||
### Вариант 1: Docker (рекомендуется) 🐳
|
||
|
||
```bash
|
||
# 1. Настройте переменные окружения
|
||
cp .env.example .env
|
||
# Отредактируйте .env файл
|
||
|
||
# 2. Запустите
|
||
docker-compose up -d
|
||
|
||
# 3. Откройте http://localhost:8000
|
||
```
|
||
|
||
**Подробнее:** [DOCKER.md](DOCKER.md)
|
||
|
||
### Вариант 2: Локальная установка
|
||
|
||
**Backend:**
|
||
```bash
|
||
cd backend
|
||
pip install -r requirements.txt
|
||
python main.py
|
||
```
|
||
|
||
**Frontend:**
|
||
```bash
|
||
cd frontend
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
### 2. Первый вход
|
||
|
||
1. Откройте `http://localhost:3000`
|
||
2. Зарегистрируйтесь (первый пользователь = admin)
|
||
3. Создайте сервер
|
||
4. Загрузите `server.jar`
|
||
5. Запустите сервер!
|
||
|
||
**Учетные данные по умолчанию:**
|
||
- Логин: `Root`
|
||
- Пароль: `Admin`
|
||
|
||
---
|
||
|
||
## ✨ Основные возможности
|
||
|
||
- 🖥️ **Управление серверами** - запуск, остановка, мониторинг
|
||
- 📁 **Файловый менеджер** - полное управление файлами
|
||
- 💬 **Консоль** - команды и логи в реальном времени
|
||
- 📊 **Статистика** - CPU, RAM, диск
|
||
- 🎫 **Тикеты** - система поддержки
|
||
- 👥 **Пользователи** - роли и права доступа
|
||
- 🔐 **OpenID Connect** - интеграция с ZITADEL
|
||
- 🎨 **6 тем** - включая современную темную
|
||
- 🔔 **Уведомления** - о всех событиях
|
||
- 👤 **Личный кабинет** - профиль и статистика
|
||
|
||
---
|
||
|
||
## 🛠️ Технологии
|
||
|
||
**Backend:**
|
||
- FastAPI (Python)
|
||
- JWT аутентификация
|
||
- WebSocket
|
||
- Authlib (OpenID Connect)
|
||
|
||
**Frontend:**
|
||
- React 18
|
||
- Tailwind CSS
|
||
- Axios
|
||
- Lucide React
|
||
|
||
---
|
||
|
||
## 📁 Структура проекта
|
||
|
||
```
|
||
mc-panel/
|
||
├── backend/
|
||
│ ├── main.py # FastAPI приложение
|
||
│ ├── oidc_config.py # OpenID Connect
|
||
│ ├── requirements.txt # Зависимости
|
||
│ └── servers/ # Папка серверов
|
||
├── frontend/
|
||
│ ├── src/
|
||
│ │ ├── App.jsx # Главный компонент
|
||
│ │ ├── components/ # React компоненты
|
||
│ │ └── themes.js # Темы
|
||
│ └── package.json # npm зависимости
|
||
├── MC_Panel_API.postman_collection.json # Postman
|
||
└── README.md # Этот файл
|
||
```
|
||
|
||
---
|
||
|
||
## 🔒 Безопасность
|
||
|
||
- JWT токены (7 дней)
|
||
- Bcrypt хеширование паролей
|
||
- Проверка прав доступа
|
||
- Защита файловой системы
|
||
- OpenID Connect поддержка
|
||
|
||
**Для production:**
|
||
1. Измените `SECRET_KEY` в `backend/main.py`
|
||
2. Используйте HTTPS
|
||
3. Настройте CORS
|
||
4. Используйте базу данных вместо JSON
|
||
|
||
---
|
||
|
||
## 📞 Поддержка
|
||
|
||
- **Документация**
|
||
- **API**
|
||
- **Тикеты:**
|
||
|
||
---
|
||
|
||
## 🙏 Благодарности
|
||
|
||
Спасибо за использование MC Panel!
|
||
|
||
Если у вас есть вопросы или предложения:
|
||
1. Прочитайте документацию
|
||
2. Проверьте API документацию
|
||
3. Создайте тикет в системе
|
||
|
||
---
|
||
|
||
**Версия:** 1.1.0
|
||
**Дата:** 15 января 2026
|
||
|
||
**Приятного использования!** 🎮
|