From 4bcdcea751ad99b55c6dba11c2f47cbc146c31bd Mon Sep 17 00:00:00 2001
From: kiriharu <38693046+kiriharu@users.noreply.github.com>
Date: Tue, 5 Jan 2021 03:07:30 +0300
Subject: [PATCH] Create README.md
---
README.md | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8032df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+
+ HostInfoBot
+
+
+
+
+
+Данный бот служит для получения различной информации о хосте с нескольких нод.
+Часто возникают случаи, когда необходимо посмотреть, как поведет себя тот или инной ресурс с различных IP адресов. Например - посмотреть задержку или заблокирован ли порт для определенного региона.
+
+ ### Работает это таким образом:
+
+* На удаленные сервера устанавливается API-сервер
+* На ещё один сервер(или рядом) устанавливается бот
+* В настройках бота (в файле `nodes.py`) указываются адреса серверов API
+* В зависимости от команды бот получает информацию с указанных нод
+* Архитектура не отменяет того, что в боте есть команды, которые выполняются на хосте где установлен бот.
+
+Все команды, которые есть сейчас, можно посмотреть [в самом боте](https://t.me/triviabot "в самом боте"), для этого напишите в нём /start
+
+### Установка
+* Установите git, docker и docker-compose
+* Склонируйте репозиторий: `git clone https://github.com/catspace-dev/hostinfobot`
+#### Установка API сервера
+* Запустите `docker-compose -f docker-compose-api.yml up -d`
+* В боте по пути `apps/tgbot/tgbot/nodes.py` добавьте ноду как указано в примере и перезапустите его.
+#### Установка бота
+* Запустите `docker-compose -f docker-compose-bot.yml up -d`