Refactor environment configuration and update documentation for MVP status
- Removed deprecated Telegram user ID configuration from `.env.example` and added a new setting for admin Telegram user IDs. - Updated `CLAUDE.md` to reflect the current MVP status, detailing completed features and testing coverage. - Enhanced `README.md` with quick start instructions for Docker setup and clarified project status. - Revised API design documentation to include updated error handling and request/response structures. - Improved frontend documentation to outline the project structure and technologies used.
This commit is contained in:
+4
-2
@@ -75,7 +75,8 @@ PnvPanel **не заменяет** Xray/3x-ui — он оркестрирует
|
||||
|
||||
### U2. Пользователь следит за трафиком
|
||||
- Фоновая синхронизация тянет трафик из 3x-ui; изменения приходят в UI через SignalR (без перезагрузки).
|
||||
- При достижении лимита/срока конфиг помечается и (опционально) отключается в 3x-ui.
|
||||
- **В MVP это только отображение**: лимиты по трафику/сроку конфига не реализованы — единственная
|
||||
квота — число активных конфигов на роль. Конфиг живёт, пока его явно не отзовут.
|
||||
|
||||
### A1. Админ подключает ноду и публикует инбаунды
|
||||
1. Вводит адрес панели 3x-ui, логин/пароль (шифруются при хранении).
|
||||
@@ -121,7 +122,8 @@ PnvPanel **не заменяет** Xray/3x-ui — он оркестрирует
|
||||
|
||||
## Нефункциональные требования
|
||||
|
||||
- **Безопасность**: секреты нод шифруются at-rest; JWT с коротким TTL + refresh; rate-limiting на создание конфигов и auth.
|
||||
- **Безопасность**: секреты нод шифруются at-rest; JWT с коротким TTL + refresh; rate-limiting на
|
||||
auth/Telegram-эндпоинты и публичную подписку (создание конфигов им пока не покрыто).
|
||||
- **Наблюдаемость**: структурные логи (Serilog), health-checks нод, метрики.
|
||||
- **Отказоустойчивость к нодам**: недоступность одной ноды не роняет панель; операции идемпотентны где возможно.
|
||||
- **Производительность**: списки с пагинацией; синхронизация трафика батчами.
|
||||
|
||||
Reference in New Issue
Block a user