generated from FOSS/Bot-Template
58 lines
2.2 KiB
Markdown
58 lines
2.2 KiB
Markdown
# Channel Notifier
|
|
|
|
Telegram-бот на aiogram 3, который автоматически отправляет личное сообщение пользователям, подавшим заявку в закрытый канал.
|
|
|
|
## Запуск через .bat (Windows)
|
|
|
|
Запусти `start.bat` двойным кликом. Скрипт автоматически:
|
|
|
|
1. Создаст виртуальное окружение `.venv`
|
|
2. Установит зависимости из `requirements.txt`
|
|
3. Создаст `.env` из примера (если ещё нет)
|
|
4. Запустит бота
|
|
|
|
## Запуск через командную строку (вручную)
|
|
|
|
1. Установи Python `3.11+`.
|
|
2. Поставь зависимости:
|
|
|
|
```bash
|
|
python3.11 -m pip install -r requirements.txt
|
|
```
|
|
|
|
3. Создай `.env` по примеру:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
4. Заполни минимум:
|
|
|
|
```env
|
|
BOT_TOKEN=
|
|
BOT_ADMIN_IDS=
|
|
```
|
|
|
|
Конфигурация читается только из `.env` или переменных окружения.
|
|
|
|
5. Запусти бота:
|
|
|
|
```bash
|
|
python3 main.py
|
|
```
|
|
|
|
## Настройки
|
|
|
|
| Параметр | Что делает |
|
|
| --- | --- |
|
|
| `BOT_TOKEN` | Токен Telegram-бота от BotFather |
|
|
| `BOT_ADMIN_IDS` | Telegram ID админов, один или несколько через запятую |
|
|
| `BOT_DATABASE_EXPORT` | Разрешает отправку файла БД админам через `/db` и ежедневный автобэкап |
|
|
| `BOT_STATUS_NOTIFICATION` | Включает уведомление админов о запуске |
|
|
| `BOT_TIMEZONE` | Временная зона бота |
|
|
| `BOT_USER_CACHE_TTL` | Время кеширования пользователя в middleware |
|
|
| `BOT_THROTTLE_RATE` | Базовая задержка антиспама |
|
|
| `PATH_DATABASE` | Путь к SQLite-базе |
|
|
| `PATH_LOGS` | Путь к файлу логов |
|
|
|
|
По умолчанию `BOT_DATABASE_EXPORT=False`. Это специально: база может содержать персональные данные, поэтому экспорт надо включать руками и осознанно. |