diff --git a/documentation/settings.md b/.github/readme.md similarity index 61% rename from documentation/settings.md rename to .github/readme.md index a8fb132..524ec41 100644 --- a/documentation/settings.md +++ b/.github/readme.md @@ -1,3 +1,9 @@ +# Бот в 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). + +Официально запускается от имени [@emp_zaboal_bot](https://t.me/emp_zaboal_bot) для [«Студии Зажигина»](https://site.zaboal.ru). + ## Переменные бота Настройки бота расположены в директории [`src/bot/settings`](../src/bot/settings) для Telegram Bot API и в файле переменных среды [`environment.sh`](../environment.sh) для команды `source`. Файл переменных окружения имеет жизненно необходимые значения, их обязательно требуется указать. @@ -21,4 +27,14 @@ * [`commands.json`](../source/bot-telegram_register/settings/commands.json) — список команд и их описаний бота; * [`default_administrator_rights.json`](../src/bot/settings/default_administrator_rights.json) — предлагаемый набор прав администратора бота при добавлении в группу. -Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения. \ No newline at end of file +Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения. + +## Запуск бота + +Перед запуском требуется заполнить [переменные среды](#environmentsh--переменные-среды). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен. + +Если все переменные указаны верно, можно запускать файл [`start.sh`](../start.sh) от имени администратора: + +```bash +sudo bash start.sh +``` \ No newline at end of file diff --git a/documentation/readme.md b/documentation/readme.md deleted file mode 100644 index 6dbb6ec..0000000 --- a/documentation/readme.md +++ /dev/null @@ -1,5 +0,0 @@ -# Бот в 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). Процедура запуска изложена подробнее в [`docs/start.md`](start.md), вся документация в этой же директории. - -Официально запускается от имени [@emp_zaboal_bot](https://t.me/emp_zaboal_bot) для [«Студии Зажигина»](https://site.zaboal.ru). diff --git a/documentation/start.md b/documentation/start.md deleted file mode 100644 index 49c7b33..0000000 --- a/documentation/start.md +++ /dev/null @@ -1,9 +0,0 @@ -## Запуск бота - -Перед запуском требуется заполнить [переменные среды](settings.md#envsh--переменные-окружения). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен. - -Если все переменные указаны верно, можно запускать файл [`start.sh`](../start.sh) от имени администратора: - -```bash -sudo bash start.sh -``` \ No newline at end of file