Update README.md and update logic CI/CD and ansible playbook

2026-09-15 15:29:49 +05:00
parent b178c4004b
commit 187c2bcc1b
3 changed files with 63 additions and 10 deletions
@@ -1,2 +1,36 @@
-### Цитатный бот
-#### .....Скоро.....
+# Цитатный телеграмм бот с авторазвёртыванием.
+
+### Что умеет данный бот?
+* Отправлять рандомную цитату по запросу ``` /quote ```.
+* По команде ``` /stats ``` показывать, сколько цитат в базе есть на данный момент.
+
+### Возможности для администратора:
+* Добавлять новые цитаты командой ``` /add <текст цитаты> ```.
+
+## Как это развернуть?
+### вам понадобится:
+* Зарубежный Linux сервер на Ubuntu или Debian.
+* Токен вашего телеграмм бота. Можно получить здесь: [BotFather](t.me/BotFather).
+* У вас должен быть установлен ansible и git на wsl. Если не установлен, то установите командами ` sudo apt install ansible ` и ` sudo apt install git `.
+
+### Ваши действия для развертывания:
+* Клонируйте репозиторий командой: ` git clone https://github.com/LeoR156/quote-bot `.
+* Перейдите в папку с ботом командой ` cd quote-bot `
+* Создайте файл ` .env ` и добавте в него данные:
+```
+TOKEN=your_token_here # Замените на реальный токен
+ADMIN_IDS=123456789,987654321 # Напишите свой id или id того аккаунта, с которого будет осущесвляться добавление цитат. ID может быть несколько, порядок записи в примере.
+```
+* Перейдите в папку ` auto-deployment ` командой ` cd auto-deployment `.
+* Отредактируйте файл инвентори командой ` nano inventory.ini `. Удалите оттуда всю информацию и добавьте следующее:
+
+```
+[server_bot]
+server ansible_host=<ваш_ip> ansible_user=<ваш_пользователь> ansible_ssh_private_key_file=<путь_до_вашего_ssh_ключа_на_хосте>
+
+[all:vars]
+ansible_ssh_common_args='-o StrictHostKeyChecking=no'
+```
+* Запустите плейбук командой `ansible-playbook A_deploy.yml -i inventory.ini`
+
+##### Готово, через несколько минут бот заработает.