203 lines
5.7 KiB
Markdown
203 lines
5.7 KiB
Markdown
# MC Panel - Панель управления Minecraft серверами
|
||
|
||
**Версия:** 1.0.0
|
||
**Дата:** 15 января 2026
|
||
|
||
---
|
||
|
||
## 📚 Документация
|
||
|
||
### 📖 [ДОКУМЕНТАЦИЯ.md](ДОКУМЕНТАЦИЯ.md)
|
||
**Полная документация проекта**
|
||
|
||
Содержит всю информацию о проекте:
|
||
- 🚀 Быстрый старт
|
||
- ⚙️ Установка и настройка
|
||
- 🎮 Функциональность
|
||
- 🔔 Система уведомлений
|
||
- 🎨 Дизайн и темы
|
||
- 📁 Файловый менеджер
|
||
- 🎫 Система тикетов
|
||
- 👤 Личный кабинет
|
||
- 🔐 OpenID Connect
|
||
- 👥 Роли пользователей
|
||
- 🔒 Безопасность
|
||
- 🔧 Troubleshooting
|
||
|
||
**Начните отсюда!** 👈
|
||
|
||
---
|
||
|
||
### 🌐 [API.md](API.md)
|
||
**Документация API**
|
||
|
||
Полное описание REST API:
|
||
- 📋 Все эндпоинты (37 шт.)
|
||
- 🔐 Аутентификация
|
||
- 👥 Управление пользователями
|
||
- 🖥️ Управление серверами
|
||
- 📁 Управление файлами
|
||
- 🎫 Тикеты
|
||
- 💡 Примеры интеграции (Python, JavaScript, cURL)
|
||
- 📦 Postman коллекция
|
||
|
||
**Для разработчиков!** 👨💻
|
||
|
||
---
|
||
|
||
### 📦 [MC_Panel_API.postman_collection.json](MC_Panel_API.postman_collection.json)
|
||
**Postman коллекция**
|
||
|
||
Готовая коллекция для тестирования API:
|
||
- 40+ готовых запросов
|
||
- Автоматическое сохранение токена
|
||
- Переменные окружения
|
||
- Примеры тел запросов
|
||
|
||
**Импортируйте в Postman!** 📮
|
||
|
||
### Вариант 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 зависимости
|
||
├── ДОКУМЕНТАЦИЯ.md # Документация проекта
|
||
├── API.md # API документация
|
||
├── 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
|
||
|
||
---
|
||
|
||
## 📞 Поддержка
|
||
|
||
- **Документация:** [ДОКУМЕНТАЦИЯ.md](ДОКУМЕНТАЦИЯ.md)
|
||
- **API:** [API.md](API.md)
|
||
- **Тикеты:** Используйте систему тикетов в панели
|
||
|
||
---
|
||
|
||
## 📝 Лицензия
|
||
|
||
AGPL-3.0 License
|
||
|
||
---
|
||
|
||
## 🙏 Благодарности
|
||
|
||
Спасибо за использование MC Panel!
|
||
|
||
Если у вас есть вопросы или предложения:
|
||
1. Прочитайте документацию
|
||
2. Проверьте API документацию
|
||
3. Создайте тикет в системе
|
||
|
||
---
|
||
|
||
**Версия:** 1.0.0
|
||
**Дата:** 15 января 2026
|
||
|
||
**Приятного использования!** 🎮
|