diff --git a/readme.md b/readme.md index 4399181..19aaf46 100644 --- a/readme.md +++ b/readme.md @@ -1,16 +1,16 @@ # Бот в Telegram для регистрации в организации -Бот описан в [`src/bot/bot.ts`](../source/bot-telegram_register/bot.ts) на TypeScript с помощью фреймворка Grammy над Telegram Bot API. Предназначен для запуска в контейнере Docker через NodeJS, файл сборки образа можно видеть под названием [`src/dockerfile`](../source/dockerfile). Главный метод запуска проекта — через файл Bash скрипта [`start.sh`](../source/start.sh). +Бот описан в [`bot-telegram_profile/bot-telegram_profile.ts`](../bot-telegram_profile/bot-telegram_profile.ts) на TypeScript с помощью фреймворка Grammy над Telegram Bot API. Предназначен для запуска в контейнере Docker через NodeJS, файл сборки образа можно видеть под названием [`dockerfile`](../dockerfile). Главный метод запуска проекта — через файл Bash скрипта [`start.sh`](../start.sh). Официально запускается под доменом [@zaboal_profile_bot](https://t.me/zaboal_profile_bot). ## Переменные бота -Настройки бота расположены в директории [`src/bot/settings`](../src/bot/settings) для Telegram Bot API и в файле переменных среды [`environment.sh`](../environment.sh) для команды `source`. Файл переменных окружения имеет жизненно необходимые значения, их обязательно требуется указать. +Настройки бота расположены в директории [`bot-telegram_profile/settings`](../bot-telegram_profile/settings) для Telegram Bot API и в файле переменных среды [`environment.sh`](../environment.sh) для команды `source`. Файл переменных окружения имеет жизненно необходимые значения, их обязательно требуется указать. -### [`environment.sh`](../source/environment.sh) — переменные среды +### [`environment.sh`](../environment.sh) — переменные среды Для запуска бота требуется три константы в формате Bash: @@ -18,22 +18,22 @@ * `BOT_DB_PATH` — путь к базе данных SQLite бота на хосте, с данными об идентификаторах пользователя Телеграм людей зарегистрированных в организации; * `ORG_BD_PATH` — путь к базе данных SQLite орагнизации, с данными об подразделениях, рабочих и т.д. -Данные будут переданы в контейнер Docker в процессе Bash скрипта запуска проекта [`start.sh`](../source/start.sh). По путям к базам данных на хосте в контейнер будут примонтированы соответствующие файлы SQLite под программными названиями. +Данные будут переданы в контейнер Docker в процессе Bash скрипта запуска проекта [`start.sh`](../start.sh). По путям к базам данных на хосте в контейнер будут примонтированы соответствующие файлы SQLite под программными названиями. -### [`settings/*.json`](../source/bot-telegram_register/settings) — переменные для Telegram Bot API +### [`settings/*.json`](../bot-telegram_profile/settings) — переменные для Telegram Bot API -При запуске бот передаст Telegram Bot API файлы конфигурации в формате json из директории [`settings`](../source/bot-telegram_register/settings/): +При запуске бот передаст Telegram Bot API файлы конфигурации в формате json из директории [`settings`](../bot-telegram_profile/settings/): -* [`commands.json`](../source/bot-telegram_register/settings/commands.json) — список команд и их описаний бота; -* [`default_administrator_rights.json`](../src/bot/settings/default_administrator_rights.json) — предлагаемый набор прав администратора бота при добавлении в группу. +* [`commands.json`](../bot-telegram_profile/settings/commands.json) — список команд и их описаний бота; +* [`default_administrator_rights.json`](../bot-telegram_profile/settings/default_administrator_rights.json) — предлагаемый набор прав администратора бота при добавлении в группу. Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения. ## Запуск бота -Перед запуском требуется заполнить [переменные среды](#environmentsh--переменные-среды). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен. +Перед запуском требуется заполнить [переменные среды](#environmentsh--переменные-среды). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../dockerfile) будет примонтированы файлы баз данных и передан токен. Если все переменные указаны верно, можно запускать файл [`start.sh`](../start.sh) от имени администратора: diff --git a/source/bot-telegram_register/bot.ts b/source/bot-telegram_profile/bot-telegram_profile.ts similarity index 100% rename from source/bot-telegram_register/bot.ts rename to source/bot-telegram_profile/bot-telegram_profile.ts diff --git a/source/bot-telegram_register/package.json b/source/bot-telegram_profile/package.json similarity index 76% rename from source/bot-telegram_register/package.json rename to source/bot-telegram_profile/package.json index 9025ed4..ed269fa 100644 --- a/source/bot-telegram_register/package.json +++ b/source/bot-telegram_profile/package.json @@ -7,6 +7,6 @@ "ts-node": "latest" }, "scripts": { - "start": "ts-node bot.ts" + "start": "ts-node bot-telegram_profile.ts" } } \ No newline at end of file diff --git a/source/bot-telegram_register/settings/commands.json b/source/bot-telegram_profile/settings/commands.json similarity index 100% rename from source/bot-telegram_register/settings/commands.json rename to source/bot-telegram_profile/settings/commands.json diff --git a/source/bot-telegram_register/settings/default_administrator_rights.json b/source/bot-telegram_profile/settings/default_administrator_rights.json similarity index 100% rename from source/bot-telegram_register/settings/default_administrator_rights.json rename to source/bot-telegram_profile/settings/default_administrator_rights.json diff --git a/source/bot-telegram_register/tsconfig.json b/source/bot-telegram_profile/tsconfig.json similarity index 100% rename from source/bot-telegram_register/tsconfig.json rename to source/bot-telegram_profile/tsconfig.json diff --git a/source/dockerfile b/source/dockerfile index 25b1899..14944f7 100644 --- a/source/dockerfile +++ b/source/dockerfile @@ -6,11 +6,11 @@ WORKDIR /usr/src/app # Установка зависимостей -COPY bot-telegram_register/package.json . +COPY bot-telegram_profile/package.json . RUN npm install # Добавление оставшихся файлов проекта -COPY bot-telegram_register . +COPY bot-telegram_profile . # Объявление переменных окружения diff --git a/source/start.sh b/source/start.sh index 4d0cc25..910899c 100644 --- a/source/start.sh +++ b/source/start.sh @@ -13,10 +13,10 @@ echo -e \ # Сборка и запуск контейнера Docker docker build . \ - --tag bot-telegram_zaboal-register; + --tag bot-telegram_profile; docker run -it \ --env BOT_TOKEN=$BOT_TOKEN \ --volume $BOT_DB_PATH:/usr/src/app/bot.sqlite \ --volume $ORG_DB_PATH:/usr/src/app/organization.sqlite \ - bot-telegram_zaboal-register; \ No newline at end of file + bot-telegram_profile; \ No newline at end of file