zaboal/bot-telegram_profile
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Правильнее документация

Browse source
This commit is contained in:
bogdan zažigin 2022-12-19 17:24:06 +03:00
parent 41b9830046
commit e36957c8ef
3 changed files with 17 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
documentation/settings.md → .github/readme.md vendored
View file

@ -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) — предлагаемый набор прав администратора бота при добавлении в группу.
Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения.
Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения.
## Запуск бота
Перед запуском требуется заполнить [переменные среды](#environmentsh--переменные-среды). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен.
Если все переменные указаны верно, можно запускать файл [`start.sh`](../start.sh) от имени администратора:
```bash
sudo bash start.sh
```

5
documentation/readme.md
View file

@ -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).

9
documentation/start.md
View file

@ -1,9 +0,0 @@
## Запуск бота
Перед запуском требуется заполнить [переменные среды](settings.md#envsh--переменные-окружения). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен.
Если все переменные указаны верно, можно запускать файл [`start.sh`](../start.sh) от имени администратора:
```bash
sudo bash start.sh
```