commit 3fbc7dfbaceedfcd926f9509e261b7daeb0efae6
Author: taphix <taphix1@gmail.com>
Date:   Mon Jul 15 10:14:31 2024 +0300

    First commit

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5f1493
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Docker-compose для телеграмм бота с PostgreSQL, Redis, FastAPI, Nginx и Certbot
+
+Инструкция для запуска проекта.  
+В директориях __fastapi_app__ и __tgbot_app__ представлены примеры базовых проектов с минимальными функциями, требующимися для демонстрации работы.
+
+## Подготовка
+
+Для начала требуется создать три файла с переменными окружения - один для телеграмм бота, один для api и один для docker-compose:  
+* В корневой директории __test-mission__:  
+`touch .env`  
+`vim .env` - после чего вставить:  
+    ```
+    POSTGRES_USER=<пользователь для postgres>
+    POSTGRES_PASSWORD=<пароль для пользователя>
+    POSTGRES_DB=<имя базы>
+    R_PASSWORD=<пароль для redis>
+    ```
+Далее требуется сохранить изменения - `:wq`  
+* В директории __fastapi_app__:  
+`touch .env`  
+`vim .env` - после чего вставить:  
+    ```
+    POSTGRES_USER=<пользователь для postgres>
+    POSTGRES_PASSWORD=<пароль для пользователя>
+    POSTGRES_DB=<имя базы>
+    ```
+Далее требуется сохранить изменения - `:wq`  
+* В директории __tgbot_app__:  
+`touch .env`  
+`vim .env` - также вставляем переменные:  
+    ```
+    R_PASSWORD=<пароль для redis>
+    T_TOKEN=<токен, который был выдан BotFather>
+    ```
+Далее требуется сохранить изменения - `:wq`
+
+## Установка Docker
+Требуется сделать скрипт установки исполняемым:  
+`chmod +x install-docker.sh`  
+После введите команду:  
+`sudo sh install-docker.sh`  
+Проверим, корректно ли установился докер:  
+`docker --version`  
+
+## Корректировка названия доменов в файлах docker-compose.yml и nginx.conf и настройка DNS
+
+Требуется зайти в раздел *редактирования DNS* на сайте администратора вашего домена и указать в __A__-записи IP-адрес вашего сервера. Смена DNS обычно не занимает много времени, в ближайшие __15-20__ минут ваш домен будет отдавать новый IP, для проверки введите в консоли команду:  
+`dig a <ваш домен>`  
+
+Если все успешно, перейдите `vim nginx/nginx.conf` и укажите ваш домен вместо ```anakinnikita.ru```, то же самое сделайте в *docker-compose.yml*:  
+```command: certonly --webroot -w /var/www/html --email anakinnikitaa@gmail.com -d anakinnikita.ru --cert-name=certfolder --key-type rsa --agree-tos```  
+Замените *anakinnikitaa@gmail.com* на ваш почтовый ящик и *anakinnikita.ru* на ваш домен, также рекомендуется указывать имя домена вместо `certfolder`.  
+## Запуск контейнеров
+Теперь можно запускать контейнеры:  
+`docker compose up --build -d`  
+Приложение запущено.
\ No newline at end of file