Update README

Updated README.md with emojis and improved formatting.

.gitlab-ci.yml

@@ -1,3 +1,4 @@
+# Универсальная группа раннеров
 default:
   tags:
     - universal
@@ -48,10 +49,10 @@ deploy_to_server:
     - chmod 600 ~/.ssh/id_ed25519
     - ansible-galaxy collection install community.docker
   script:
+    - echo "TOKEN=$BOT_TOKEN" > .env
+    - echo "ADMIN_IDS=$ADMIN_ID_TG" >> .env
     - cd auto-deployment/
-    - ansible-playbook -i inventory.ini A_deploy.yml
-        --extra-vars "image_tag=$CI_COMMIT_SHORT_SHA"
-
+    - ansible-playbook -i inventory.ini A_deploy.yml --extra-vars "image_tag=$CI_COMMIT_SHORT_SHA"
   environment:
     name: production
     url: http://$BOT_SERVER_IP

README.md

@@ -1,2 +1,56 @@
-### Цитатный бот
-#### .....Скоро.....
+# Цитатный телеграмм бот с авторазвёртыванием. :robot:
+
+## 🛠 Под капотом (Стек технологий)
+Этот проект создавался в том числе для практики современных DevOps-инструментов. Здесь реализован полноценный автоматизированный пайплайн развертывания:
+
+* **Terraform + Yandex Cloud:** Используется концепция Infrastructure as Code (IaC) для автоматического создания виртуальных машин, настройки сети и дисков в облаке.
+* **Docker:** Приложение упаковано в контейнер, что решает проблему с зависимостями и позволяет легко запускать бота на любом сервере.
+* **Ansible:** Автоматизирует настройку чистого сервера. Плейбук сам устанавливает Docker (если его нет), настраивает окружение и запускает контейнер.
+* **GitLab CI/CD:** Готовый пайплайн (`.gitlab-ci.yml`), который прогоняет тесты, собирает Docker-образ с помощью Kaniko, пушит его в Docker Hub и автоматически запускает Ansible-плейбук для деплоя на боевой сервер.
+
+---
+
+### Что умеет данный бот?
+* Отправлять рандомную цитату по запросу ``` /quote ```
+* По команде ``` /stats ``` показывать, сколько цитат в базе есть на данный момент.
+
+### Возможности для администратора: :gear:
+* Добавлять новые цитаты командой ``` /add <текст цитаты> ```
+
+## Как это развернуть? :rocket:
+### Вам понадобится:
+* Зарубежный Linux сервер на Ubuntu или Debian.
+* Токен вашего телеграмм бота. Можно получить здесь: [BotFather](https://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 ` и добавьте в него данные командой ` nano .env `:
+```
+TOKEN=your_token_here # Замените на реальный токен
+ADMIN_IDS=123456789,987654321 # Напишите свой id или id того аккаунта, с которого будет осуществляться добавление цитат. ID может быть несколько, порядок записи в примере.
+```
+* Перейдите в папку ` auto-deployment ` командой ` cd auto-deployment `
+* Отредактируйте файл инвентори командой ` nano inventory.ini `. Удалите оттуда всю информацию и добавьте следующее ( :warning: не забудьте поменять данные на свои):
+
+```
+[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`
+
+### Готово, через несколько минут бот заработает. :white_check_mark:
+
+***
+
+***
+
+***
+
+## Диагностика, если бот не отвечает/падает:
+...скоро...

auto-deployment/A_deploy.yml

@@ -2,23 +2,43 @@
 - name: Автоматический деплой Telegram-бота
   hosts: all
   
+
   vars:
     image_name: "leor156/quote-bot:{{ image_tag | default('latest') }}"
     container_name: "quote-bot"
     container_state: "started"
 
   tasks:
-    - name: Убеждаемся, что установлена библиотека Docker для Python
+    - name: Устанавливаем Docker и библиотеку для Python
       apt:
-        name: python3-docker
+        name: 
+          - docker.io
+          - python3-docker
         state: present
         update_cache: yes
 
+    - name: Убеждаемся, что Docker запущен
+      service:
+        name: docker
+        state: started
+        enabled: yes
+
     - name: Скачиваем  образ бота с Docker Hub
       community.docker.docker_image:
         name: "{{ image_name }}"
         source: pull
 
+    - name: Создать папку, если она отсутствует
+      ansible.builtin.file:
+        path: /opt/quote-bot
+        state: directory
+        mode: '0700'
+
+    - name: Копируем .env файл на сервер
+      copy:
+        src: ../.env
+        dest: /opt/quote-bot/.env
+
     - name: Запускаем контейнер
       community.docker.docker_container:
         name: "{{ container_name }}"
@@ -26,9 +46,7 @@
         state: "{{ container_state }}"
         restart_policy: unless-stopped
         pull: always
-        env:
-          TOKEN: "{{ lookup('env', 'BOT_TOKEN') }}"
-          ADMIN_IDS: "{{ lookup('env', 'ADMIN_ID_TG') }}"
+        env_file: /opt/quote-bot/.env
 
     - name: Чистка
       community.docker.docker_prune: