Merge pull request #931 from Fr1ngg/jehc2b-bedolaga/-readme

docs: expand README functional overview
This commit is contained in:
Egor
2025-10-08 19:46:23 +03:00
committed by GitHub

172
README.md
View File

@@ -35,7 +35,7 @@
### ⚡ **Полная автоматизация VPN бизнеса**
- 🎯 **Готовое решение** - разверни за 5 минут, начни продавать сегодня
- 💰 **Многоканальные платежи** - Telegram Stars + Tribute + CryptoBot + ЮKassa + MulenPay + PayPalych + P2P
- 💰 **Многоканальные платежи** - Telegram Stars + Tribute + CryptoBot + YooKassa + MulenPay + PayPalych (СБП)
- 🔄 **Автоматизация 99%** - от регистрации до продления подписок
- 📊 **Детальная аналитика** - полная картина вашего бизнеса
- 💬 **Уведомления в топики** об: Активация триала 💎 Покупка подписки 🔄 Конверсия из триала в платную ⏰ Продление подписки 💰 Пополнение баланса 🚧 Включении тех работ ♻️ Появлении новой версии бота
@@ -952,105 +952,111 @@ WEBHOOK_PATH=/webhook
### 👤 **Для пользователей**
🧭 **Онбординг и доступ**
- 🌐 Выбор языка интерфейса, динамическая локализация и настройка кнопки меню.
- 📜 Принятие правил, оферты и политики конфиденциальности прямо в боте.
- 📡 Проверка подписки на обязательный канал, deeplink-инвайты и UTM-кампании.
- 👤 Сбор контактных данных с антиспам-защитой и быстрым восстановлением доступа.
🛒 **Умная покупка подписок**
- 📅 Гибкие периоды (14-360 дней)
- 📊 Выбор трафика или фиксированный лимит
- 🌍 Автоматический выбор серверов (для одного сквада) или ручной выбор из множества
- 📱 Настройка количества устройств и серверов прямо при оформлении
- 🧾 Понятный калькулятор стоимости с учетом всех опций
- 📅 Гибкие периоды (14360 дней) и скидки за длительные подписки.
- 📊 Выбор трафика: фиксированный лимит, квоты или безлимит.
- 🌍 Автоматический выбор сквада или мультивыбор из десятков серверов.
- 📱 Настройка количества устройств, стран и доп. услуг прямо в чек-ауте.
- 🧾 Динамический калькулятор стоимости, черновики и возвращение к незавершённым заказам.
🧪 **Тестовая подписка**
- Настраиваемый триал-период
- Уведомления об истечении и сценарий мягкой конверсии в платную подписку
- Приветственное сообщение с предложением активации триала (с возможностью отключения)
- Поддержка рекламных кампаний с автоматической выдачей бонусных подписок
- Гибко настраиваемый триал и welcome-цепочка.
- Уведомления об истечении и автоконверсия в платный тариф.
- Автовыдача бонусов за участие в кампаниях и инвайт-линках.
- Контроль за обязательной подпиской на канал даже в режиме триала.
💰 **Удобные платежи**
- ⭐ Telegram Stars
- 💳 Tribute
- 💳 YooKassa (включая СБП и онлайн-чек)
- 💳 MulenPay
- 💳 PayPalych (Pal24)
- 💰 CryptoBot (мультивалюта и срок жизни инвойсов)
- 🎁 Реферальные и промо-бонусы
- Детальная история транзакций и чеков
💰 **Платежи и баланс**
- ⭐ Telegram Stars, 💳 Tribute, 💳 YooKassa (СБП + онлайн-чек), 💳 MulenPay, 🏦 PayPalych (СБП), 💰 CryptoBot.
- 📥 Автогенерация счетов, контроль статусов через вебхуки и уведомления.
- 💼 История операций с фильтрами, квитанциями и выгрузкой чеков.
- 🔄 Автоплатёж с настройкой дня списания и уведомлениями об ошибках.
- 🎁 Реферальные, промо- и кэшбэк-бонусы автоматически начисляются на баланс.
📱 **Управление подписками**
- 📈 Статистика использования в реальном времени (трафик, устройства, серверы)
- 🔄 Автопродление с баланса с настройкой дней и мгновенными уведомлениями
- 🔄 Управление трафиком и лимитами без участия оператора
- 🌍 Переключение серверов Remnawave на лету
- 📱 Управление устройствами + сброс HWID
- 🧩 Смена языка и персональных настроек
- 📈 Реальный трафик, устройства и география серверов прямо в диалоге.
- 🌍 Переключение серверов, стран и лимитов без помощи оператора.
- 📱 Сброс HWID, повторная выдача конфигов и инструкции подключения.
- 🧩 Смена языка, промогруппы и персональных параметров.
- 🧾 Просмотр активных услуг, статуса оплаты и сроков действия.
🎁 **Бонусная система**
- 🎫 Промокоды на деньги/дни/длинный триал
- 👥 Защищенная реферальная программа с комиссиями и антифродом
- 📊 Детальная статистика рефералов и кампаний
- 📨 Персональные рассылки и уведомления о новых бонусах
🛟 **Поддержка и самообслуживание**
- 🎫 Тикеты с приоритетами, вложениями и уведомлениями об ответе.
- 📚 FAQ, правила, оферта и политика доступны из меню.
- 💬 Быстрые ссылки на живую поддержку или кастомные каналы связи.
🧩 **Бонусы и рефералы**
- 🎫 Промокоды на деньги, дни, устройства, страны и расширенные триалы.
- 👥 Реферальная программа с комиссиями, бонусами и антифрод-фильтрами.
- 🧾 Подробная аналитика доходов, конверсии и активности приглашённых.
- 🔗 Генерация реферальных ссылок и QR-кодов в один тап.
🪪 **Mini App и инструкции**
- 📱 Telegram WebApp с обзором подписки, конфигами и кнопкой «Подключить».
- 📥 Библиотека загрузочных ссылок для клиентов Happ и кастомных гайдов.
- 🛰️ Web API для получения статуса подписки в мини-приложениях и внешних витринах.
</td>
<td width="50%" valign="top">
### ⚙️ **Для администраторов**
📊 **Мощная аналитика**
- 👥 Детальная статистика пользователей и подписок
- 💰 Анализ платежей по источникам (Stars, YooKassa, Tribute, MulenPay, PayPalych, CryptoBot)
- 🖥️ Мониторинг серверов Remnawave и статуса сквадов
- 📈 Финансовые отчеты, конверсии и эффективность рекламных кампаний
📊 **Аналитика и отчётность**
- 📈 Дашборды по пользователям, подпискам, трафику и удержанию.
- 💰 Детализация платежей по источникам (Stars, YooKassa, Tribute, MulenPay, PayPalych, CryptoBot).
- 🧮 Продажи по тарифам, устройствам, странам и промогруппам.
- 📣 Эффективность кампаний, промокодов, UTM-источников и реферальных потоков.
👥 **Управление пользователями**
- 🔍 Поиск и редактирование профилей
- 💰 Управление балансами и ручные начисления
- 📱 Изменение лимита устройств (1-X)
- 📊 Настройка лимитов трафика (0-10000 ГБ) и подключенных сквадов
- 🌍 Мультивыбор серверов и мгновенная синхронизация с панелью
- 🔄 Сброс HWID устройств и обновление конфигураций
- 👥 Детальная реферальная статистика в профиле пользователя
- 🔄 Изменение типа подписки триал/платная и ручное продление
- 🚫 Блокировка/разблокировка/удаление аккаунтов
- 🔍 Поиск, фильтры и детальные карточки с историей операций.
- 💰 Ручное изменение баланса, компенсации и корректировки.
- 📱 Изменение лимитов устройств, трафика, стран и подключенных сквадов.
- 🔄 Сброс HWID, перегенерация подписки и синхронизация с Remnawave.
- 🎯 Назначение промогрупп, тарифов и ручных продлений/обновлений.
- 🚫 Блокировки с таймером, полное удаление и аудит действий персонала.
🎯 **Маркетинг и продажи**
- 🎫 Гибкая промо-система (деньги/дни/длинный триал)
- 📣 Рекламные кампании с автоматическими бонусами за регистрацию
- 📊 Детальная статистика использования промокодов и кампаний
- 📨 Рассылки по сегментам с фильтрами по активности, подпискам и языкам
🎯 **Продажи, маркетинг и удержание**
- 🎫 Промокоды (разовые/многоразовые), бонусные предложения и бесплатные пакеты.
- 💳 Промогруппы со скидками на серверы, трафик, устройства и допуслуги.
- 📣 Кампании с deeplink-ссылками, UTM и автопродвижением триалов.
- 📨 Рассылки по сегментам, кастомные кнопки и медиа, отмена «в полёте».
- 🔘 Настройка кнопок главного меню, приветственных экранов и мини-приложений.
🖥️ **Умный мониторинг**
- 💚 Контроль доступности Remnawave панели в реальном времени
- 🔄 Автоматическая синхронизация данных и реконнект при ошибках
- 🌐 Управление сквадами с актуальным статусом и массовыми действиями
- 🚧 Автоматический режим тех. работ с уведомлениями пользователей
- 📋 Логи и диагностика, включая журнал сбоев и действий бота
- 📦 Проверка обновлений проекта и уведомления о новых релизах
🛟 **Поддержка и модерация**
- 🎫 Центр тикетов с приоритетами, статусами и перепиской.
- 🧑‍⚖️ Разграничение ролей (админы, модераторы), журнал аудита действий.
- ⏱️ SLA таймеры, автоматические напоминания и уведомления в канал.
- 🚫 Массовые блокировки нарушителей и автоматическое снятие блокировок.
- 🧾 История диалогов, прикреплённые файлы и быстрые ответы.
📨 **Коммуникации и поддержка**
- 📢 Рассылки по сегментам и мгновенные оповещения
- 🔔 Автоуведомления о продлении, задолженностях и автоплатежах
- 💬 Система поддержки с HTML разметкой и история обращений
- 📝 Настройка правил сервиса, FAQ и приветственных экранов
- 🧪 Настраиваемое приветственное сообщение с предложением активации триала
🔔 **Уведомления и коммуникации**
- 📢 Топики для событий (покупки, триалы, техработы, ошибки интеграций).
- 🔔 Настройка пользовательских и админских уведомлений, расписаний и каналов.
- 📨 Шаблоны правил, оферты, FAQ, приветствий и страницы поддержки.
- 💬 Автоматические сообщения о задолженностях, автоплатежах и продлениях.
📨 **Уведомления в закрытый канал**
- 🎯 Активация триала, продления и конверсии в платную подписку
- 💎 Покупка подписки и пополнение баланса
- 🔄 Изменения параметров подписки пользователем
- 🚧 Потеря соединения с Remnawave и включение техработ
- 🗄️ Авто- и ручные бекапы/восстановления с отправкой файлов
- ♻️ Выхлоп новых версий бота и результаты автоплатежей
🧰 **Обслуживание и DevOps**
- 🛠️ `install_bot.sh`: управление контейнерами, логами, обновлениями, прокси и резервными копиями.
- 🚧 Ручной и авто-режим техработ с кастомными сообщениями.
- 🗒️ Просмотр системных логов, health-check, мониторинг Remnawave и серверов.
- ♻️ Проверка обновлений репозитория, уведомления о новых версиях и плавный деплой.
🗄️ **Бекапы и восстановление**
- Ручной запуск бекапа с выбором содержимого (включая логи)
- Автоматические бекапы по расписанию и управление retention-политикой
- Восстановление из бекапа без остановки сервиса
- Отправка копии бекапа в выделенный чат/топик и ведение метаданных
- 🗓️ Планировщик авто-бекапов, гибкая политика хранения и компрессия.
- 📦 Ручные бекапы с выбором содержимого (БД, конфиги, логи).
- 📤 Отправка архивов в выделенный чат/топик, журнал попыток и статусов.
- 🔁 Восстановление из бекапа без остановки бота, проверка целостности.
💳 **Автоплатежи и биллинг**
- Настройки автоплатежа на уровне пользователя (вкл/выкл, дни до списания)
- Принудительная проверка готовности автосписаний
- Уведомления об успешных и неудачных автоплатежах с подсказками действий
- Настройка минимального баланса и логирование всех списаний
💳 **Биллинг и автоплатежи**
- ⚙️ Глобальные настройки автосписаний, минимального баланса и напоминаний.
- 🧪 Тестовые платежи для каждого провайдера прямо из админки.
- 🪝 Управление вебхуками Tribute, YooKassa, CryptoBot, MulenPay и PayPalych.
- 🧾 Экспорт транзакций, сверка с платёжками и интеграция с бухгалтерией.
</td>
</tr>
@@ -1065,6 +1071,16 @@ WEBHOOK_PATH=/webhook
- 📦 **Интеграция с Remnawave API** — автоматическое создание пользователей, управление сквадами и синхронизация подписок.
- 🧾 **История операций** — хранение транзакций, уведомлений, рассылок, кампаний и бекапов для аудита.
### 🌐 Веб-API, мини-приложение и интеграции
- ⚙️ **FastAPI Web API** (`app/webapi`) с эндпоинтами для управления токенами, конфигурациями, рассылками, кампаниями, промогруппами, статистикой, подписками, транзакциями, тикетами и бекапами.
- 🔑 **Управление API-ключами** — выпуск, отзыв, реактивация и аудит токенов прямо из админки.
- 🛡️ **Гибкая авторизация** — API-key, Bearer, Basic Auth и cookie eGames для совместимости с внешними панелями.
- 🛰️ **Mini App** — статический фронтенд в `miniapp/` и proxied эндпоинты `/miniapp/*` для отображения статуса подписки внутри Telegram.
- 🧭 **App Config** — централизованная раздача ссылок на клиенты и инструкции (`app-config.json`, `miniapp/app-config.json`).
- 🪝 **Платёжные вебхуки** — встроенные Flask-серверы для Tribute, YooKassa, CryptoBot, MulenPay и PayPalych (Pal24) с health-check и логированием.
- 📡 **Мониторинг серверов** — REST-эндпоинты для просмотра нод Remnawave, статистики нагрузки и управления сквадами из внешних систем.
### 🧭 Навигация по проекту
- `app/bot.py` — точка входа бота и регистрация middlewares/handlers.