From 04cbcbd8178bb10f687f44f4705ac31bd58f2355 Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sun, 29 Sep 2024 02:11:50 +0300 Subject: [PATCH 1/6] Create README.md --- README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..7444ba04 --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ +# 🚀 Название проекта + +**[SoloBot]**! +[Бот для API x-ray] + +## 📋 Оглавление +1. [Описание](#описание) +2. [Требования](#требования) +3. [Установка](#установка) +4. [Конфигурация](#конфигурация) +5. [Запуск](#запуск) +6. [Автор](#автор) + +--- + +## 📖 Описание + +[Бот предназначен для автоматизирования выдачи ключей, хранении их в базе данных и управления подключениями] + + +--- + +## 💻 Требования + +Для работы проекта необходимы следующие компоненты: + +- **Python** версии 3.8 или выше +- **Git** для клонирования репозитория +- **Virtualenv** для создания виртуального окружения (рекомендуется) +- **Postresqpl** для работы базы данных + +--- + +## ⚙️ Установка + +### 1️⃣ Шаг 1: Клонирование репозитория + +Клонируйте репозиторий и перейдите в его директорию: + +```bash +git clone https://github.com/Vladless/Solo_bot.git +cd solo_bot +``` + +### 2️⃣ Шаг 2: Создание и активация виртуального окружения + +``` +python3 -m venv venv +source venv/bin/activate +``` + +### 3️⃣ Шаг 3: Установка зависимостей + +``` +pip install -r requirements.txt +``` + +### 🛠️ Конфигурация + +Для правильной работы вам нужно установить postresql, создать пользователя для работы с базой данных и выдать ему права + +Также создайте файл config.py в корневой папке проекта с вашими данными: + +``` +API_TOKEN = токен вашего бота телеграм +API_URL = домен вашего 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/" +DOMEN = "{ваш домен без www}:443" +DATABASE_URL = путь к вашей базе данных, имеет вид "postgresql://{user}:{password}@{Ip-adress}:5432/{имя базы данных}" +ADMIN_ID = ID телеграм профиля администратора +CHANNEL_URL = ссылка телеграм на ваш канал +``` + +### 🚀 Запуск + +введите команду из виртуального окружения + +``` +python main.py +``` + + + + + + From 594b97a7525617432e104468b26209eac131e293 Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sun, 29 Sep 2024 02:13:32 +0300 Subject: [PATCH 2/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7444ba04..ac7f5681 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ - **Python** версии 3.8 или выше - **Git** для клонирования репозитория - **Virtualenv** для создания виртуального окружения (рекомендуется) -- **Postresqpl** для работы базы данных +- **postgresql** для работы базы данных --- @@ -57,7 +57,7 @@ pip install -r requirements.txt ### 🛠️ Конфигурация -Для правильной работы вам нужно установить postresql, создать пользователя для работы с базой данных и выдать ему права +Для правильной работы вам нужно установить postgresql, создать пользователя для работы с базой данных и выдать ему права Также создайте файл config.py в корневой папке проекта с вашими данными: From 9d759b949d79c9d537141567e65b1be592803788 Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sun, 29 Sep 2024 02:23:52 +0300 Subject: [PATCH 3/6] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ac7f5681..cd74314c 100644 --- a/README.md +++ b/README.md @@ -57,22 +57,22 @@ pip install -r requirements.txt ### 🛠️ Конфигурация -Для правильной работы вам нужно установить postgresql, создать пользователя для работы с базой данных и выдать ему права +Для правильной работы вам нужно установить и запустить postgresql, создать пользователя для работы с базой данных и выдать ему права Также создайте файл config.py в корневой папке проекта с вашими данными: ``` API_TOKEN = токен вашего бота телеграм -API_URL = домен вашего x-ray сервера с указанием порта дополнительным именем +API_URL = домен вашего x-ray сервера с указанием порта и дополнительным путем панели вида "https://{domen}:{port}/{путь}" без слэша в конце 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/" -DOMEN = "{ваш домен без www}:443" -DATABASE_URL = путь к вашей базе данных, имеет вид "postgresql://{user}:{password}@{Ip-adress}:5432/{имя базы данных}" +DOMEN = "{ваш домен без https://}:443" +DATABASE_URL = путь к вашей базе данных, имеет вид "postgresql://{user}:{password}@{Ip-adress}:{port}/{имя базы данных}" ADMIN_ID = ID телеграм профиля администратора -CHANNEL_URL = ссылка телеграм на ваш канал +CHANNEL_URL = ссылка на ваш телеграм канал ``` ### 🚀 Запуск From 5d5f2b0556feedd75a980bd162e78384a4443c1d Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sun, 29 Sep 2024 02:31:06 +0300 Subject: [PATCH 4/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cd74314c..94660784 100644 --- a/README.md +++ b/README.md @@ -82,8 +82,8 @@ CHANNEL_URL = ссылка на ваш телеграм канал ``` python main.py ``` - - +🔗 SoloBot в Telegram +Попробуйте SoloBot прямо сейчас в Telegram [по этой ссылке](https://t.me/SoloNetVPN_bot). From dc76929283716ea29725bb2cbe996dda22971be5 Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sun, 29 Sep 2024 02:31:26 +0300 Subject: [PATCH 5/6] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 94660784..021220a9 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ CHANNEL_URL = ссылка на ваш телеграм канал python main.py ``` 🔗 SoloBot в Telegram + Попробуйте SoloBot прямо сейчас в Telegram [по этой ссылке](https://t.me/SoloNetVPN_bot). From 5549d0a55c0d567490ef53d806dfb63201f33ade Mon Sep 17 00:00:00 2001 From: Vladislav Lisitsyn <114032530+Vladless@users.noreply.github.com> Date: Sun, 29 Sep 2024 18:04:48 +0300 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 021220a9..4ad4bca1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 🚀 Название проекта +# 🚀 SoloBot **[SoloBot]**! [Бот для API x-ray]