Update README.md

2024-12-23 16:01:16 +03:00
parent 83dd78c3dd
commit f51df67dc4
1 changed files with 66 additions and 58 deletions
@@ -1,27 +1,31 @@
 # 🚀 SoloBot

-**SoloBot** — ваш идеальный помощник для управления API 3x-UI VPN на протоколе VLESS.  
+**SoloBot** — ваш идеальный помощник для управления API 3x-UI VPN на протоколе VLESS.

 Три версии — море возможностей:
-  - v1.4 — бот для продажи ключей vless:

-![Основные окна](preview.jpg)
-  - v2.3.1 — стабильная версия подписок вместо ключей с кнопками автодобавления в приложение:
+- [v1.4](https://github.com/Vladless/Solo_bot/releases/tag/v1.4) — бот для продажи ключей VLESS:

-![Основные окна](preview_v_2.jpg)
-  - v3.1 — настолько большая, что смотрите в [релизе](https://github.com/Vladless/Solo_bot/releases/tag/v3.1):
+![](preview.jpg)

+- [v2.3.1](https://github.com/Vladless/Solo_bot/releases/tag/v2.3.1) — стабильная версия подписок вместо ключей с
+  кнопками автодобавления в приложение:

+![](preview_v_2.jpg)

-Если вам не хватает функций — направьте их в issue, мы реализуем
+- [v3.1](https://github.com/Vladless/Solo_bot/releases/tag/v3.1) — версия бота со значительным расширением возможностей.
+
+[Последние актуальные релизы.](https://github.com/Vladless/Solo_bot/releases)
+Если вам не хватает функций — направьте их в [issue](https://github.com/Vladless/Solo_bot/issues), мы реализуем.

 ## 📋 Оглавление
-1. [Описание](#описание)
-2. [Стек технологий](#стек-технологий)
-3. [Установка](#установка)
-4. [Конфигурация](#конфигурация)
-5. [Запуск](#запуск)
-6. [Контакты](#контакты)
+
+1. [Описание](#-описание)
+2. [Стек технологий](#-стек-технологий)
+3. [Установка](#-установка)
+4. [Конфигурация](#-конфигурация)
+5. [Запуск](#-запуск)
+6. [Контакты](#-solobot-в-telegram-и-полная-версия)

 ---

@@ -29,50 +33,47 @@

 SoloBot реализует множество функций, включая:

- **Выдача подписок на пробный и длительные периоды** (1 месяц, 3 месяца, полгода, год).
+- **Выдача подписок на различные периоды** (1 месяц, 3 месяца, полгода, год).
+- **Использование тестового периода подписки.**
 - **Продление ключей** на указанные периоды.
- Полный контроль клиента над своими ключами:
-  - Удаление ключей.
-  - Продление ключей.
-  - Просмотр информации о ключе (сервер, оставшееся время, сам ключ).
+- **Полный контроль** клиента над своими ключами:
+    - **Просмотр** информации о ключе (сервер, оставшееся время, сам ключ).
+    - **Продление** ключей.
+    - **Удаление** ключей.
 - **Смена локации** (перемещение ключа между серверами).
- Поддержка нескольких ключей для одного клиента (несколько устройств).
- **Реферальная программа** с пригласительной ссылкой.
- Доступ к **инструкциям**.
- **Пополнение баланса**:
-    * через Юкасса (самозанятость и ИП)
-    * через freekassa (Физические Лица)
-    * Криптовалюта (Thanks [izzzzzi](https://github.com/izzzzzi))
-    * Звезды Telegram
-    * Юмани (физические лица) (Thanks [TrackLine](https://github.com/TrackLine))
+- **Поддержка нескольких ключей и устройств** для одного клиента.
+- **Реферальная программа** с уникальной ссылкой для приглашений.
+- Доступ к **инструкциям** для подключения к сервису.
+- Пополнение баланса:
+    * **Юкасса** (Самозанятость и ИП)
+    * **Юмани** (Физические Лица) ([TrackLine](https://github.com/TrackLine))
+    * **FreeKassa** (Физические Лица)
+    * **Robokassa** (Физические Лица)
+    * **Cryptobot** (Криптовалюта) ([izzzzzi](https://github.com/izzzzzi))
+    * **Звезды Telegram**
 - Периодические **бэкапы базы данных клиентов**.
 - Уведомления:
-  - Произвольные сообщения через админку.
-  - Уведомления о неиспользованных пробниках.
-  - Уведомления о истекающих ключах (за сутки, за 6 часов и в момент истечения).
+    - Произвольные сообщения через панель администратора.
+    - Уведомления о неиспользованных пробниках.
+    - Уведомления об истекающих ключах (за сутки, за 6 часов и в момент истечения).
 - **Чат поддержки** и канал для связи.
 - **Автоматическое продление ключа** при наличии достаточного баланса.
- **Удобная админка прямо в боте**
+- **Удобная панель администратора прямо в боте**
 - Серверы:
-  - **мультисерверность**- добавление сервера прямо в админке
-  - **Проверка на доступность** - бот следит за серверами и их откликом
-  - **Балансировка** - бот выдает подписку на наименее загруженный сервер
-
+    - **Мультисерверность** — добавление сервера прямо в админке
+    - **Проверка на доступность** — бот следит за серверами и их откликом
+    - **Балансировка** — бот выдает подписку на наименее загруженный сервер

 ---

 ## 💻 Стек технологий

-Проект использует следующие технологии:
+Основные технологии, используемые в проекте:

- **Python** версии 3.10 или выше.
- **Git** для клонирования репозитория.
- **Virtualenv** для создания виртуального окружения (рекомендуется).
- **PostgreSQL** для хранения данных.
- **Nginx** для работы с вебхуками.
- **aiogram** (версия 3.13) для взаимодействия с Telegram API.
- **youkassa** для обработки платежей.
- **aiohttp** для API запросов к панелям.
+- **Python** версии 3.10 (3.12, для последних версий).
+- **PostgreSQL** — для хранения данных.
+- **aiogram** — для взаимодействия с Telegram API.
+- **aiohttp** — для API запросов к панелям.

 Проект полностью асинхронный, что обеспечивает высокую скорость работы.

@@ -89,7 +90,9 @@ git clone https://github.com/Vladless/Solo_bot.git
 cd solo_bot
 ```

-### 2️⃣ Шаг 2: Создание и активация виртуального окружения
+### 2️⃣ Шаг 2: Создание и подключение виртуального окружения
+
+Создайте виртуальное окружение **Python** и перейдите в сессию:

 ```
 python3 -m venv venv
@@ -98,6 +101,8 @@ source venv/bin/activate

 ### 3️⃣ Шаг 3: Установка зависимостей

+Установите зависимости:
+
 ```
 pip install -r requirements.txt
 ```
@@ -106,33 +111,32 @@ pip install -r requirements.txt

 Для правильной работы вам нужно:

-* установить и запустить postgresql, создать пользователя для работы с базой данных и выдать ему права
-* Настроить ваш сервер на работу с ботом, выпустить SSL сертификат для домена
-* Настроить вебхуки и пути до них в NGINX
+* Установить и запустить **PostgreSQL**, создать пользователя для работы с базой данных и выдать ему права
+* Настроить ваш сервер для работы с ботом, выпустить SSL сертификат для домена
+* Настроить вебхуки и указать пути до них через любой веб-сервер, например **nginx**

 * Создать файл config.py в корневой папке проекта с вашими данными:

 ```
+API_TOKEN = "токен вашего бота телеграм"

-API_TOKEN = токен вашего бота телеграм
-
-ADMIN_USERNAME = логин от вашей панели x-ray
-ADMIN_PASSWORD = пароль от вашей панели x-ray
+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`

 ```
-python main.py
+python3 main.py
 ```
+
 ### 🔗 SoloBot в Telegram и Полная версия

 #### Наш [**➡ сайт**](https://pocomacho.ru/solonetbot/):
@@ -140,7 +144,11 @@ python main.py
 Всегда актуальные гайды по установке, файлы для запуска и ссылка на общий чат:
 ![image](https://github.com/user-attachments/assets/737fbc21-e4b1-4c69-9323-71284d34e454)

-
 Попробовать SoloBot прямо сейчас в Telegram [**➡ Попробовать**](https://t.me/SoloNetVPN_bot).

-Связаться с нами через [**➡ поддержку**](https://t.me/solonet_sup). Там вы сможете купить полную версию и получить логин и пароль от сайта, а также задать необходимые вопросы!
+Связаться с нами через [**➡ поддержку**](https://t.me/solonet_sup). Там вы сможете купить полную версию и получить логин
+и пароль от сайта, а также задать необходимые вопросы!
+
+## Права на использование
+
+[Этот проект использует лицензию CC BY-NC 4.0](LICENSE)