Toutsu/GmRelayBot
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 15 Wiki Activity

Update wiki page 'Быстрый старт'

Toutsu
2026-04-24 13:30:16 +03:00
parent 19788f4808
commit 9d15107abf
1 changed files with 12 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
%D0%91%D1%8B%D1%81%D1%82%D1%80%D1%8B%D0%B9-%D1%81%D1%82%D0%B0%D1%80%D1%82.md
+12 -14
@@ -1,11 +1,11 @@
# Быстрый старт # Быстрый старт
Эта страница описывает минимальный запуск текущей версии GM-Relay. Эта страница описывает минимальный запуск текущей версии GM-Relay **v1.2.0**.
## Требования ## Требования
- Docker и Docker Compose для packaged-запуска. - Docker и Docker Compose для packaged-запуска.
- `.NET 10 SDK` для локальной разработки через решение `GM-Relay.slnx`. - `.NET 10 SDK` для локальной разработки через `GM-Relay.slnx`.
- Telegram-бот, созданный через `@BotFather`. - Telegram-бот, созданный через `@BotFather`.
- PostgreSQL поднимается автоматически в Docker Compose или Aspire. - PostgreSQL поднимается автоматически в Docker Compose или Aspire.
@@ -41,37 +41,35 @@ docker compose up -d
Compose поднимает: Compose поднимает:
- `db`: PostgreSQL 17 Alpine, БД `gmrelay_db`, пользователь `gmrelay`. - `db`: PostgreSQL 17 Alpine, БД `gmrelay_db`, пользователь `gmrelay`.
- `bot`: образ `git.codeanddice.ru/toutsu/gmrelay-bot:1.1.5`. - `bot`: образ `git.codeanddice.ru/toutsu/gmrelay-bot:1.2.0`.
- `web`: образ `git.codeanddice.ru/toutsu/gmrelay-web:1.1.5`. - `web`: образ `git.codeanddice.ru/toutsu/gmrelay-web:1.2.0`.
Web UI доступен на `http://localhost:8080`, если `GMRELAY_WEB_PORT` не переопределён. Web UI будет доступен на `http://localhost:8080`, если `GMRELAY_WEB_PORT` не переопределён.
## Локальный запуск через .NET Aspire ## Локальный запуск через .NET Aspire
Из корня репозитория:
```bash ```bash
dotnet restore GM-Relay.slnx dotnet restore GM-Relay.slnx
dotnet build GM-Relay.slnx -c Release dotnet build GM-Relay.slnx -c Release
dotnet run --project src/GmRelay.AppHost dotnet run --project src/GmRelay.AppHost
``` ```
`GmRelay.AppHost` описывает PostgreSQL с PgAdmin и запускает проекты `GmRelay.Bot` и `GmRelay.Web`. Для standalone-запуска bot/web сервисов нужны конфигурационные значения: Для standalone-запуска bot/web нужны:
- `ConnectionStrings__gmrelaydb` — строка подключения к PostgreSQL. - `ConnectionStrings__gmrelaydb` — строка подключения к PostgreSQL.
- `Telegram__BotToken` — токен Telegram-бота. - `Telegram__BotToken` — токен Telegram-бота.
- `Telegram__BotUsername` — имя бота без `@`, нужно web-панели для Telegram Login Widget. - `Telegram__BotUsername` — имя бота без `@`, нужно для Telegram Login Widget.
## Настройка Telegram ## Настройка Telegram
1. Добавьте бота в группу или супергруппу. 1. Добавьте бота в группу или супергруппу.
2. Для forum-групп выдайте право управления темами, иначе бот не сможет создавать topic под пачку игр. 2. Для forum-групп выдайте право управления темами, иначе бот не сможет создать topic под пачку игр.
3. Рекомендуемые права: отправка сообщений, закрепление сообщений, управление темами. 3. Рекомендуемые права: отправка сообщений, закрепление сообщений, управление темами.
4. Для web-login настройте домен у `@BotFather` через `/setdomain`, если web-панель используется не только локально. 4. Для web-login настройте домен у `@BotFather` через `/setdomain`, если Web-панель используется не локально.
## Проверка после запуска ## Проверка после запуска
- Команда `/start` должна ответить `GM-Relay Bot ready. Use /help for commands.` - `/start` должен ответить `GM-Relay Bot ready. Use /help for commands.`
- Команда `/help` должна показать формат `/newsession`. - `/help` должен показать формат `/newsession`, включая необязательную строку `Мест:`.
- Web-панель должна перенаправлять неавторизованного пользователя на `/login`. - Web-панель должна перенаправлять неавторизованного пользователя на `/login`.
- После входа через Telegram ГМ видит только группы, где он записан как `gm_telegram_id`. - После входа через Telegram GM видит только группы, где он записан как `gm_telegram_id`.