From df2f7535e23334f46e45cfeb0f9c31a8be921788 Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sat, 1 Mar 2025 02:17:41 +0300 Subject: [PATCH] Update README.md --- README.md | 183 +++++++++++++++++++----------------------------------- 1 file changed, 63 insertions(+), 120 deletions(-) diff --git a/README.md b/README.md index 4a55d95f..ee39836d 100644 --- a/README.md +++ b/README.md @@ -2,152 +2,93 @@ **SoloBot** — ваш идеальный помощник для управления API 3x-UI VPN на протоколе VLESS. -Три версии — море возможностей: +SoloBot -- [v1.4](https://github.com/Vladless/Solo_bot/releases/tag/v1.4) — бот для продажи ключей VLESS: +## Описание +Бот, предоставляющий инструменты под различные реализации. Хорошая кастомизация и подстройка под свой бренд. -![](.github/images/preview_v1.jpg) +## Интеграция платёжных систем +В боте реализована интеграция касс как для физических лиц, так и для самозанятых и ИП: +- **Юкасса** (Самозанятость и ИП) +- **Юмани** (Физические Лица) (TrackLine) +- **Robokassa** (Физические Лица) +- **Cryptobot** (Криптовалюта) (izzzzzi) +- **Звезды Telegram** -- [v2.3.1](https://github.com/Vladless/Solo_bot/releases/tag/v2.3.1) — стабильная версия подписок вместо ключей с - кнопками автодобавления в приложение: +## Основные возможности -![](.github/images/preview_v2.jpg) +**SoloBot** реализует множество функций, включая: -- [v3.1](https://github.com/Vladless/Solo_bot/releases/tag/v3.1) — версия бота со значительным расширением возможностей. +### Управление подписками +- Выдача подписок на различные периоды (**1 месяц, 3 месяца, полгода, год**). +- Использование **тестового периода** подписки. +- Продление ключей на указанные периоды. -[Последние актуальные релизы.](https://github.com/Vladless/Solo_bot/releases) -Если вам не хватает функций — направьте их в [issue](https://github.com/Vladless/Solo_bot/issues), мы реализуем. +### Полный контроль клиента над своими ключами +- Просмотр информации о ключе (**сервер, оставшееся время, сам ключ**). +- Продление ключей. +- Удаление ключей. +- Просмотр полной информации вплотть до минут истечения +- Смена локации (**перемещение ключа между серверами**). +- Поддержка **нескольких ключей и устройств** для одного клиента. -## 📋 Оглавление +### Реферальная программа +- Уникальная ссылка для приглашений. +- Инлайн режим или обычные сообщения -1. [Описание](#-описание) -2. [Стек технологий](#-стек-технологий) -3. [Установка](#-установка) -4. [Конфигурация](#-конфигурация) -5. [Запуск](#-запуск) -6. [Контакты](#-solobot-в-telegram-и-полная-версия) +### Пополнение баланса +- **Юкасса** (Самозанятость и ИП) +- **Юмани** (Физические Лица) (TrackLine) +- **Robokassa** (ИП) +- **Cryptobot** (Криптовалюта) (izzzzzi) +- **Звезды Telegram** ---- +### Безопасность и стабильность +- **Периодические бэкапы** базы данных клиентов и их восстановление. +- **Смена домена** в случае переезда. -## 📖 Описание +SoloBot -SoloBot реализует множество функций, включая: +### Уведомления +- **Произвольные сообщения** через панель администратора. +- Уведомления о **неиспользованных пробниках**. +- Уведомления об **истекающих ключах** (_за сутки, за 6 часов и в момент истечения_). +- **Воронка продаж**. Если клиент не взял пробник предлагаются более выгодные условия. +- **Рассылка лично или всем.** С сохранением форматирования и отправкой картинок -- **Выдача подписок на различные периоды** (1 месяц, 3 месяца, полгода, год). -- **Использование тестового периода подписки.** -- **Продление ключей** на указанные периоды. -- **Полный контроль** клиента над своими ключами: - - **Просмотр** информации о ключе (сервер, оставшееся время, сам ключ). - - **Продление** ключей. - - **Удаление** ключей. -- **Смена локации** (перемещение ключа между серверами). -- **Поддержка нескольких ключей и устройств** для одного клиента. -- **Реферальная программа** с уникальной ссылкой для приглашений. -- Доступ к **инструкциям** для подключения к сервису. -- Пополнение баланса: - * **Юкасса** (Самозанятость и ИП) - * **Юмани** (Физические Лица) ([TrackLine](https://github.com/TrackLine)) - * **FreeKassa** (Физические Лица) - * **Robokassa** (Физические Лица) - * **Cryptobot** (Криптовалюта) ([izzzzzi](https://github.com/izzzzzi)) - * **Звезды Telegram** -- Периодические **бэкапы базы данных клиентов**. -- Уведомления: - - Произвольные сообщения через панель администратора. - - Уведомления о неиспользованных пробниках. - - Уведомления об истекающих ключах (за сутки, за 6 часов и в момент истечения). -- **Чат поддержки** и канал для связи. +### Поддержка +- Чат поддержки и канал для связи. - **Автоматическое продление ключа** при наличии достаточного баланса. -- **Удобная панель администратора прямо в боте** -- Серверы: - - **Мультисерверность** — добавление сервера прямо в админке - - **Проверка на доступность** — бот следит за серверами и их откликом - - **Балансировка** — бот выдает подписку на наименее загруженный сервер +- **Удобная панель администратора** прямо в боте. ---- +### Серверы +- **Мультисерверность** — добавление сервера прямо в админке. +- **Проверка на доступность** — бот следит за серверами и их откликом. +- **Балансировка** — бот выдает подписку на наименее загруженный сервер. +- **Сихнронизация** — перемещайте клиентов на другие сервера бесшовно. +- **Смена домена** — сменили домен? одна кнопка и ваши клиенты переедут на другой домен. -## 💻 Стек технологий +### Кастомизация +- **Пробник** — Сами решаете будет или нет. Количество дней пробникаю +- **Реферальная программа** — процент с каждого пополнения или фиксированно сумму? +- **Все меню** — меняйте все меняю как вам захочется, в боте это есть давно. +- **Кешбэк** — начисляйте кэщбек за пополнения если хотите. +- **Настройки** — Капча, подписка на канал, купоны и прочее. -Основные технологии, используемые в проекте: - -- **Python** версии 3.10 (3.12, для последних версий). -- **PostgreSQL** — для хранения данных. -- **aiogram** — для взаимодействия с Telegram API. -- **aiohttp** — для API запросов к панелям. - -Проект полностью асинхронный, что обеспечивает высокую скорость работы. - ---- - -## ⚙️ Установка - -### 1️⃣ Шаг 1: Клонирование репозитория - -Клонируйте репозиторий и перейдите в его директорию: - -```bash -git clone https://github.com/Vladless/Solo_bot.git -cd solo_bot -``` - -### 2️⃣ Шаг 2: Создание и подключение виртуального окружения - -Создайте виртуальное окружение **Python** и перейдите в сессию: - -``` -python3 -m venv venv -source venv/bin/activate -``` - -### 3️⃣ Шаг 3: Установка зависимостей - -Установите зависимости: - -``` -pip install -r requirements.txt -``` - -### 🛠️ Конфигурация - -Для правильной работы вам нужно: - -* Установить и запустить **PostgreSQL**, создать пользователя для работы с базой данных и выдать ему права -* Настроить ваш сервер для работы с ботом, выпустить SSL сертификат для домена -* Настроить вебхуки и указать пути до них через любой веб-сервер, например **nginx** - -* Создать файл config.py в корневой папке проекта с вашими данными: - -``` -API_TOKEN = "токен вашего бота телеграм" - -ADMIN_USERNAME = "логин от вашей панели x-ray" -ADMIN_PASSWORD = "пароль от вашей панели x-ray" -ADD_CLIENT_URL = f"{API_URL}/panel/api/inbounds/addClient" -GET_INBOUNDS_URL = f"{API_URL}/panel/api/inbounds/list/" -AUTH_URL = f"{API_URL}/login/" -``` - -**Мы высылаем детальный гайд и недостающие файлы в поддержке бота!** - -### 🚀 Запуск - -Введите команду из виртуального окружения `venv/bin/activate` - -``` -python3 main.py -``` +## Настраивайте как вам удобно! ### 🔗 SoloBot в Telegram и Полная версия #### Наш [**➡ сайт**](https://pocomacho.ru/solonetbot/): Всегда актуальные гайды по установке, файлы для запуска и ссылка на общий чат: -![image](https://github.com/user-attachments/assets/737fbc21-e4b1-4c69-9323-71284d34e454) +![image](https://github.com/user-attachments/assets/28f317f0-6b26-4d86-a501-df9800646131) + Попробовать SoloBot прямо сейчас в Telegram [**➡ Попробовать**](https://t.me/SoloNetVPN_bot). #### Отзывы пользователей: -SoloBot уже помог сотням пользователей!: +SoloBot уже помог сотням пользователей в нашем сообществе: ![image](https://github.com/user-attachments/assets/fe13a00f-94d3-419c-afd0-d1c1efec5179) @@ -158,4 +99,6 @@ SoloBot уже помог сотням пользователей!: ## Права на использование +# Перепродажа кода и тем более присвоение кода к своему лицу запрещено, ознакомьтесь с лицензией + [Этот проект использует лицензию CC BY-NC 4.0](LICENSE)