Merge pull request #123 from hteppl/license

Лицензия и обновленный README

LICENSE

@@ -0,0 +1,330 @@
+Creative Commons Attribution-NonCommercial 4.0 International Public
+License © Vladless, 2024.
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-NonCommercial 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+  d. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  e. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  f. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  g. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  h. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  i. NonCommercial means not primarily intended for or directed towards
+     commercial advantage or monetary compensation. For purposes of
+     this Public License, the exchange of the Licensed Material for
+     other material subject to Copyright and Similar Rights by digital
+     file-sharing or similar means is NonCommercial provided there is
+     no payment of monetary compensation in connection with the
+     exchange.
+
+  j. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  k. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  l. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part, for NonCommercial purposes only; and
+
+            b. produce, reproduce, and Share Adapted Material for
+               NonCommercial purposes only.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties, including when
+          the Licensed Material is used other than for NonCommercial
+          purposes.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+       4. If You Share Adapted Material You produce, the Adapter's
+          License You apply must not prevent recipients of the Adapted
+          Material from complying with this Public License.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database for NonCommercial purposes
+     only;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material; and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.

README.md

@@ -1,27 +1,31 @@
 # 🚀 SoloBot
 
-**SoloBot** — ваш идеальный помощник для управления API 3x-UI VPN на протоколе VLESS.  
+**SoloBot** — ваш идеальный помощник для управления API 3x-UI VPN на протоколе VLESS.
 
 Три версии — море возможностей:
-  - v1.4 — бот для продажи ключей vless:
 
-![Основные окна](preview.jpg)
+- [v1.4](https://github.com/Vladless/Solo_bot/releases/tag/v1.4) — бот для продажи ключей VLESS:
-  - v2.3.1 — стабильная версия подписок вместо ключей с кнопками автодобавления в приложение:
 
-![Основные окна](preview_v_2.jpg)
+![](preview.jpg)
-  - v3.1 — настолько большая, что смотрите в [релизе](https://github.com/Vladless/Solo_bot/releases/tag/v3.1):
 
+- [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. [Стек технологий](#стек-технологий)
+1. [Описание](#-описание)
-3. [Установка](#установка)
+2. [Стек технологий](#-стек-технологий)
-4. [Конфигурация](#конфигурация)
+3. [Установка](#-установка)
-5. [Запуск](#запуск)
+4. [Конфигурация](#-конфигурация)
-6. [Контакты](#контакты)
+5. [Запуск](#-запуск)
+6. [Контакты](#-solobot-в-telegram-и-полная-версия)
 
 ---
 
@@ -29,50 +33,47 @@
 
 SoloBot реализует множество функций, включая:
 
-- **Выдача подписок на пробный и длительные периоды** (1 месяц, 3 месяца, полгода, год).
+- **Выдача подписок на различные периоды** (1 месяц, 3 месяца, полгода, год).
+- **Использование тестового периода подписки.**
 - **Продление ключей** на указанные периоды.
-- Полный контроль клиента над своими ключами:
+- **Полный контроль** клиента над своими ключами:
-  - Удаление ключей.
+    - **Просмотр** информации о ключе (сервер, оставшееся время, сам ключ).
-  - Продление ключей.
+    - **Продление** ключей.
-  - Просмотр информации о ключе (сервер, оставшееся время, сам ключ).
+    - **Удаление** ключей.
 - **Смена локации** (перемещение ключа между серверами).
-- Поддержка нескольких ключей для одного клиента (несколько устройств).
+- **Поддержка нескольких ключей и устройств** для одного клиента.
-- **Реферальная программа** с пригласительной ссылкой.
+- **Реферальная программа** с уникальной ссылкой для приглашений.
-- Доступ к **инструкциям**.
+- Доступ к **инструкциям** для подключения к сервису.
-- **Пополнение баланса**:
+- Пополнение баланса:
-    * через Юкасса (самозанятость и ИП)
+    * **Юкасса** (Самозанятость и ИП)
-    * через freekassa (Физические Лица)
+    * **Юмани** (Физические Лица) ([TrackLine](https://github.com/TrackLine))
-    * Криптовалюта (Thanks [izzzzzi](https://github.com/izzzzzi))
+    * **FreeKassa** (Физические Лица)
-    * Звезды Telegram
+    * **Robokassa** (Физические Лица)
-    * Юмани (физические лица) (Thanks [TrackLine](https://github.com/TrackLine))
+    * **Cryptobot** (Криптовалюта) ([izzzzzi](https://github.com/izzzzzi))
+    * **Звезды Telegram**
 - Периодические **бэкапы базы данных клиентов**.
 - Уведомления:
-  - Произвольные сообщения через админку.
+    - Произвольные сообщения через панель администратора.
-  - Уведомления о неиспользованных пробниках.
+    - Уведомления о неиспользованных пробниках.
-  - Уведомления о истекающих ключах (за сутки, за 6 часов и в момент истечения).
+    - Уведомления об истекающих ключах (за сутки, за 6 часов и в момент истечения).
 - **Чат поддержки** и канал для связи.
 - **Автоматическое продление ключа** при наличии достаточного баланса.
-- **Удобная админка прямо в боте**
+- **Удобная панель администратора прямо в боте**
 - Серверы:
-  - **мультисерверность**- добавление сервера прямо в админке
+    - **Мультисерверность** — добавление сервера прямо в админке
-  - **Проверка на доступность** - бот следит за серверами и их откликом
+    - **Проверка на доступность** — бот следит за серверами и их откликом
-  - **Балансировка** - бот выдает подписку на наименее загруженный сервер
+    - **Балансировка** — бот выдает подписку на наименее загруженный сервер
-
 
 ---
 
 ## 💻 Стек технологий
 
-Проект использует следующие технологии:
+Основные технологии, используемые в проекте:
 
-- **Python** версии 3.10 или выше.
+- **Python** версии 3.10 (3.12, для последних версий).
-- **Git** для клонирования репозитория.
+- **PostgreSQL** — для хранения данных.
-- **Virtualenv** для создания виртуального окружения (рекомендуется).
+- **aiogram** — для взаимодействия с Telegram API.
-- **PostgreSQL** для хранения данных.
+- **aiohttp** — для API запросов к панелям.
-- **Nginx** для работы с вебхуками.
-- **aiogram** (версия 3.13) для взаимодействия с Telegram API.
-- **youkassa** для обработки платежей.
-- **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, создать пользователя для работы с базой данных и выдать ему права
+* Установить и запустить **PostgreSQL**, создать пользователя для работы с базой данных и выдать ему права
-* Настроить ваш сервер на работу с ботом, выпустить SSL сертификат для домена
+* Настроить ваш сервер для работы с ботом, выпустить SSL сертификат для домена
-* Настроить вебхуки и пути до них в NGINX
+* Настроить вебхуки и указать пути до них через любой веб-сервер, например **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)

install.sh

@@ -1,23 +0,0 @@
-#!/bin/bash
-
-# Check if the virtual environment directory exists
-if [ ! -d "venv" ]; then
-    echo "Creating virtual environment..."
-    python3 -m venv venv
-fi
-
-# Activate the virtual environment
-source venv/bin/activate
-
-# Install dependencies if they haven't been installed yet
-if [ ! -f "venv/lib/python*/site-packages/installed" ]; then
-    echo "Installing wheel for faster installing..."
-    pip3 install wheel
-
-    echo "Installing dependencies..."
-    if [ -f "requirements.txt" ]; then
-        pip3 install -r requirements.txt
-    fi
-fi
-
-echo "Installation completed successfully!"

start.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-# Activate the virtual environment
-source venv/bin/activate
-
-# Start the bot
-echo "Starting the bot..."
-python3 main.py
-
-# Deactivate the virtual environment when done
-deactivate