mikrotik-bot/README.md
stakost 7528a825d7
Some checks failed
Build and Deploy MikroTik Bot / build-and-deploy (push) Has been cancelled
🎉 Test CI/CD pipeline - Update README
2025-06-01 12:03:20 +03:00

63 lines
2.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# MikroTik Telegram Bot
🤖 **Телеграм бот для мониторинга MikroTik роутеров**
## 🚀 Возможности
- 📊 Мониторинг WiFi клиентов
- 📈 Статистика подключений
- 🔔 Уведомления о событиях
- 💾 История подключений
- 🔧 Управление через FastAPI
## 📦 Автоматическая сборка
[![CI/CD](https://img.shields.io/badge/CI%2FCD-Active-green)](http://10.10.30.120:3000/stakost/mikrotik-bot)
Проект использует **Gitea Actions** для автоматической сборки и деплоя:
- ✅ Docker сборка
- ✅ Загрузка в Registry
- ✅ Автоматический деплой
## 🛠️ Технологии
- **Python 3.10+**
- **aiogram3** - Telegram Bot API
- **librouteros** - MikroTik API
- **FastAPI** - HTTP API
- **SQLite** - База данных
- **Docker** - Контейнеризация
## Описание
Бот для Telegram, который позволяет:
- Получать уведомления о новых Wi-Fi-подключениях, пропадании интернета, статистике
- Управлять устройствами (VLAN, блокировка, просмотр клиентов)
- Работать только через RouterOS API (минимум fetch-скриптов)
## Архитектура
- Python 3.10+
- aiogram (Telegram-бот)
- librouteros (интеграция с MikroTik API)
- Docker или virtualenv для изоляции
## Быстрый старт (Docker)
1. Клонируй репозиторий или скопируй папку
2. Заполни .env (пример см. .env.example)
3. Собери и запусти контейнер:
```
docker build -t mikrotik-telegram-bot .
docker run --env-file .env --restart unless-stopped mikrotik-telegram-bot
```
4. Для автоматического обновления через Portainer используй Watchtower или настрой auto-pull (если репозиторий в GitHub/GitLab).
## Быстрый старт (без Docker)
1. pip install -r requirements.txt
2. Заполни .env
3. python bot.py
## Безопасность
- Токен Telegram и доступ к MikroTik храни только в .env
- Ограничь доступ к боту по user_id
## Документация
- Все примеры и расширения смотри в файлах mikrotik_home/7step_telegram_bot.md и bot.py