Merge pull request #8 from ExpressApp/feature/easy-deploy

feat: add easy deploy instruction

Author: YunusovSamat

Dockerfile

@@ -11,28 +11,18 @@ WORKDIR /app
 
 COPY poetry.lock pyproject.toml ./
 
-ARG CI_JOB_TOKEN=""
-ARG GIT_HOST=""
-ARG GIT_PASSWORD=${CI_JOB_TOKEN}
-ARG GIT_LOGIN="gitlab-ci-token"
-
-# Poetry can't read password to download private repos
-RUN echo -e "machine ${GIT_HOST}\nlogin ${GIT_LOGIN}\npassword ${GIT_PASSWORD}" > ~/.netrc && \
-    apt-get update && \
+RUN apt-get update && \
     apt-get install -y git sudo && \
     pip install poetry==1.1.0 --no-cache-dir && \
     poetry config virtualenvs.create false && \
     poetry install --no-dev && \
     echo "${NON_ROOT_USER} ALL = NOPASSWD: /usr/sbin/update-ca-certificates" > /etc/sudoers.d/express_bot && \
     rm -rf /root/.cache/pypoetry && \
-    rm -rf ~/.netrc && \
     apt-get clean autoclean && \
     apt-get autoremove --yes && \
     rm -rf /var/lib/{apt,dpkg,cache,log}/
 
 COPY . .
-ARG CI_COMMIT_SHA=""
-ENV GIT_COMMIT_SHA=${CI_COMMIT_SHA}
 
 USER ${NON_ROOT_USER}
 

README.md

@@ -8,175 +8,43 @@
 
 Бот, позволяющий составлять список дел на день, следить за их выполнением.
 
+## Инструкция по развёртыванию ToDo bot
 
-## Переменные окружения
+> :note: Если вы планируете развёртывать несколько ботов на сервере, используйте
+> продвинутый вариант инструкции:
+> [detailed-deploy.md](https://github.com/ExpressApp/todo-bot/blob/feature/easy-deploy/detailed-deploy.md).
 
-* `BOT_CREDENTIALS`: Учётные данные бота. Состоят из блоков
-  `cts_host@secret_key@bot_id`, разделённых запятыми (один бот может быть
-  зарегистрирован на нескольких CTS. `cts_host` -- адрес админки, `secret_key` и
-  `bot_id` можно получить после регистрации бота, кликнув на его имя. Инструкция по
-  регистрации бота находится в [Руководстве
-  администратора](https://express.ms/admin_guide.pdf) `->` Эксплуатация корпоративного
-  сервера `->` Управление контактами `->` Чат-боты.
-* `DB_CONNECTION`: DSN для БД PostgreSQL, например:
-  `postgres://postgres_user:postgres_password@postgres:port/db_name`
-* `REDIS_DSN`: DSN для хранилища Redis, например: `redis://redis:6379/0`
-* `DEBUG` [`false`]: Включает вывод сообщений уровня `DEBUG` (по-умолчанию выводятся
-    сообщения с уровня `INFO`).
-* `SQL_DEBUG` [`false`]: Включает вывод запросов к БД PostgreSQL.
 
 
-## Деплой
+1. Воспользуйтесь инструкцией [Руководство 
+   администратора](https://express.ms/admin_guide.pdf) `-> Эксплуатация корпоративного 
+   сервера -> Управление контактами -> Чат-боты`, чтобы создать бота в админке 
+   eXpress. 
+   Получите `secret_key` и `bot_id` кликнув на имя созданного бота. 
+   Получите `cts_host` в строке браузера, когда вы в админке. 
+   
 
-**Примечание**: Чтобы легко добавлять новых ботов на сервер, хранилища находятся в
-отдельной docker-сети и используются несколькими ботами сразу (каждый обращается к своей
-БД, но к единственному экземпляру PosgreSQL/Redis). При необходимости хранилища и бота
-легко объединить в один docker-compose файл.
-
-
-### Настройка хранилищ, используемых ботом
-
-1. Создайте директорию для PosgreSQL+Redis.
-
-```shell
-mkdir -p /opt/express/bots/storages
-```
-
-2. В директории `/opt/express/bots/storages` создайте файл `docker-compose.yml` со
-   следующим содержимым:
-
-```yaml
-version: "3.8"
-
-services:
-  postgres:
-    image: postgres:13.2-alpine
-    env_file: .env
-    ports:
-      - "5432:5432"
-    restart: always
-    networks:
-      - express_bots_storages
-    volumes:
-      - /opt/express/bots/storages/postgresdata:/var/lib/postgresql/12/main
-    logging:
-      driver: "json-file"
-      options:
-        max-size: "10m"
-        max-file: "10"
-
-  redis:
-    image: redis:6.2-alpine
-    env_file: .env
-    ports:
-      - "6379:6379"
-    restart: always
-    networks:
-      - express_bots_storages
-    volumes:
-      - /opt/express/bots/storages/redisdata:/var/lib/postgresql/data
-    logging:
-      driver: "json-file"
-      options:
-        max-size: "10m"
-        max-file: "10"
-
-networks:
-  express_bots_storages:
-    name: express_bots_storages
-```
-
-3. Заполните файл `.env` необходимыми данными (для генерации паролей используйте команду
-   `openssl rand -hex 16`):
+2. Скачайте репозиторий на сервер:
 
 ```bash
-POSTGRES_USER="postgres"  # Общий пользователь PostgreSQL, у бота будет свой собственный
-POSTGRES_PASSWORD="<GENERATE>"
+git clone https://github.com/ExpressApp/todo-bot.git /opt/express/bots/todo-bot
+cd /opt/express/bots/todo-bot
 ```
 
-4. Запустите контейнеры командой `docker-compose up -d`.
-5. Убедитесь, что в логах хранилищ нет ошибок.
-
-```bash
-docker-compose logs
-```
+3. Отредактируйте `docker-compose.yml` подставив вместо `cts_host`, `secret_key` и `bot_id` реальные значения.
 
 
-### Настройка бота
-
-1. Создайте БД и пользователя для бота (для генерации паролей используйте команду
-   `openssl rand -hex 16`):
-
-```shell
-docker exec -it storages_postgres_1 psql --user postgres
-```
-
-```sql
-CREATE USER todo_bot_user PASSWORD "<GENERATE>";
-CREATE DATABASE todo_bot_db;
-GRANT ALL PRIVILEGES ON DATABASE todo_bot_db TO todo_bot_user;
-```
-
-2. Создайте бота в админке eXpress. Хост CTS (в строке браузера, когда вы в админке) и
-   "Secret key" пригодятся для заполнения переменной окружения `BOT_CREDENTIALS`.
-
-3. Создайте директорию для бота.
-
-```shell
-mkdir -p /opt/express/bots/todo-bot
-```
-
-4. В директории `/opt/express/bots/todo-bot` создайте файл
-   `docker-compose.yml` со следующим содержимым:
-
-```yaml
-version: "3.8"
-
-services:
-  todo-bot:
-    image: registry.example.com/bots/todo-bot:master
-    container_name: todo-bot
-    env_file: .env
-    ports:
-      - "8000:8000"  # Отредактируйте порт хоста (первый), если он уже занят
-    restart: always
-    depends_on:
-      - postgres
-      - redis
-    logging:
-      driver: "json-file"
-      options:
-        max-size: "10m"
-        max-file: "10"
-
-networks:
-  default:
-    external:
-      name: express_bots_storages
-```
-
-5. Заполните `.env` необходимыми данными:
-
-```bash
-BOT_CREDENTIALS="example.cts.domain@d87f0dce2280d04b41f08e3adb1ae81c@5ce31515-32ae-435a-b6f4-748d2ced921d"
-# etc.
-```
-
-Описание переменных и примеры можно посмотреть в [соответствующем
-разделе](#переменные-окружения).
-
-6. Запустите бота командой:
+4. Запустите контейнеры командой:
 
 ```bash
 docker-compose up -d
 ```
 
-7. Найдите бота через поиск корпоративных контактов (иконка человечка слева-сверху в
-   мессенджере), напишите ему что-нибудь для проверки (обычно у бота есть команда
-   `/help`).
-
-8. Убедитесь, что в логах бота нет ошибок.
+5. Убедитесь, что в логах нет ошибок.
 
 ```bash
 docker-compose logs
 ```
+
+6. Найдите бота через поиск корпоративных контактов (иконка человечка слева-сверху в
+   мессенджере), напишите ему что-нибудь для проверки.