Add README and CONFIG in RU and EN
This commit is contained in:
65
README.md
Normal file
65
README.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# tg-admin-bot
|
||||
|
||||
Telegram-бот администратора для Linux-серверов. Даёт быстрый доступ к статусам, бэкапам и операциям через чат.
|
||||
|
||||
## Возможности
|
||||
|
||||
- Docker: статус, рестарт, логи (tail, since, фильтр).
|
||||
- Arcane: список проектов, refresh, up/down, restart.
|
||||
- Бэкапы (restic): снапшоты, статистика репозитория, запуск бэкапа, очередь, restic check, weekly report.
|
||||
- Система: диски, безопасность, проверка URL, метрики, обновления, upgrade, reboot, железо, SSL (NPMplus).
|
||||
- Алерты: диск/нагрузка и SMART с cooldown.
|
||||
- Аудит: все нажатия и сообщения (ротация раз в неделю).
|
||||
|
||||
## Требования
|
||||
|
||||
- Linux-хост.
|
||||
- Python 3.11+ (проверено на 3.13).
|
||||
- Системные утилиты по необходимости:
|
||||
- docker
|
||||
- restic
|
||||
- smartctl (smartmontools)
|
||||
- sudo для reboot/upgrade/backup скриптов
|
||||
- systemd (для таймеров/статуса, желательно)
|
||||
|
||||
## Установка
|
||||
|
||||
```bash
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r req.txt
|
||||
```
|
||||
|
||||
## Настройка
|
||||
|
||||
1. Скопировать пример:
|
||||
|
||||
```bash
|
||||
cp config.example.yaml config.yaml
|
||||
```
|
||||
|
||||
2. Заполнить минимум:
|
||||
|
||||
- `telegram.token`
|
||||
- `telegram.admin_id`
|
||||
|
||||
3. Опционально:
|
||||
|
||||
- путь к restic env (`paths.restic_env`)
|
||||
- docker autodiscovery или явный список `docker.containers`
|
||||
- Arcane и NPMplus API
|
||||
- аудит логов
|
||||
|
||||
Подробности в `CONFIG.md`.
|
||||
|
||||
## Запуск
|
||||
|
||||
```bash
|
||||
python bot.py
|
||||
```
|
||||
|
||||
## Примечания
|
||||
|
||||
- Для NPMplus с self-signed TLS установи `npmplus.verify_tls: false`.
|
||||
- Бот использует `sudo` для части операций — настрой права.
|
||||
- Аудит по умолчанию пишется в `/var/server-bot/audit.log`.
|
||||
Reference in New Issue
Block a user