mirror of
https://github.com/catspace-dev/unicheckbot.git
synced 2024-11-13 01:36:34 +03:00
Update README.md
This commit is contained in:
parent
c5aa357c23
commit
c654fb7b08
29
README.md
29
README.md
|
@ -5,8 +5,35 @@
|
||||||
<img src="https://img.shields.io/badge/aiogram-blue"> <img src="https://img.shields.io/badge/gevent-green"> <img src="https://img.shields.io/badge/flask-yellow"> <img src="https://img.shields.io/badge/mcstatus-purple"> <img src="https://img.shields.io/badge/icmplib-pink"> <img src="https://img.shields.io/badge/requests-black">
|
<img src="https://img.shields.io/badge/aiogram-blue"> <img src="https://img.shields.io/badge/gevent-green"> <img src="https://img.shields.io/badge/flask-yellow"> <img src="https://img.shields.io/badge/mcstatus-purple"> <img src="https://img.shields.io/badge/icmplib-pink"> <img src="https://img.shields.io/badge/requests-black">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
Данный бот служит для получения различной информации о хосте с нескольких нод.
|
||||||
|
|
||||||
|
Часто возникают случаи, когда необходимо посмотреть, как поведет себя тот или инной ресурс с различных IP адресов. Например - посмотреть задержку или заблокирован ли порт для определенного региона.
|
||||||
|
|
||||||
|
### Работает это таким образом:
|
||||||
|
|
||||||
|
* На удаленные сервера устанавливается API-сервер
|
||||||
|
* На ещё один сервер(или рядом) устанавливается бот
|
||||||
|
* В настройках бота (в файле `nodes.py`) указываются адреса серверов API
|
||||||
|
* В зависимости от команды бот получает информацию с указанных нод
|
||||||
|
* Архитектура не отменяет того, что в боте есть команды, которые выполняются на хосте где установлен бот.
|
||||||
|
|
||||||
|
Все команды, которые есть сейчас, можно посмотреть [в самом боте](https://t.me/unicheckbot), для этого напишите в нём /start
|
||||||
|
|
||||||
|
### Установка
|
||||||
|
* Установите git, docker и docker-compose
|
||||||
|
* Склонируйте репозиторий: `git clone https://github.com/catspace-dev/unicheckbot`
|
||||||
|
|
||||||
|
#### Установка API сервера
|
||||||
|
* Настройте параметры в `api.env`
|
||||||
|
* Запустите `docker-compose -f docker-compose-api.yml --env-file api.env up -d`
|
||||||
|
* В боте по пути `apps/tgbot/tgbot/nodes.py` добавьте ноду как указано в примере и перезапустите бота.
|
||||||
|
#### Установка бота
|
||||||
|
* Настройте параметры в `tgbot.env`
|
||||||
|
* Запустите `docker-compose -f docker-compose-tgbot.yml --env-file tgbot.env up -d`
|
||||||
|
|
||||||
|
# Проект теперь разрабатывается по другой модели
|
||||||
На данный момент актуальная версия проекта находится [здесь](https://github.com/Unicheckbot). Форк был сделан по ряду причин (одна из них - неудачная архитектура проекта), описывать которых я абсолютно не вижу смысла.
|
На данный момент актуальная версия проекта находится [здесь](https://github.com/Unicheckbot). Форк был сделан по ряду причин (одна из них - неудачная архитектура проекта), описывать которых я абсолютно не вижу смысла.
|
||||||
|
|
||||||
Если у вас есть какие-то предложения по боту или какие-то проблемы с ним - можете оставлять ваши [issues](https://github.com/Unicheckbot/unicheckbot) тут.
|
Если у вас есть какие-то предложения по боту или какие-то проблемы с ним - можете оставлять ваши [issues](https://github.com/Unicheckbot/unicheckbot) тут.
|
||||||
|
|
||||||
Нода для бота находится [тут](https://github.com/Unicheckbot/rei). Исходники бота теперь закрыты.
|
Нода для бота находится [тут](https://github.com/Unicheckbot/rei). Исходники **НОВОЙ ВЕРСИИ** бота теперь закрыты. Исходники старой версии и сам бот находятся здесь, вы можете их использовать.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user