Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

BackupDotNet

BackupDotNet

Мониторинг бэкапов, доступности и железа. Один агент, веб-интерфейс, ноль внешних зависимостей.

.NET Framework 4.8 · Windows · работает в закрытом контуре · без NuGet

build docs


Что это

BackupDotNet — самоходный агент для Windows, который следит за тем, что резервные копии действительно появляются, сервисы действительно отвечают, а железо не перегревается и не сыпется. Всё управление — в браузере: компании, источники проверок, политики свежести, пользователи и роли, развёртывание агентов, журналы.

Программа рассчитана на работу без доступа в интернет: единственные внешние сборки — те, что уже стоят в Windows (WMI, DirectoryServices, Windows PowerShell 5.1). Сторонних NuGet-пакетов нет вообще — включая JSON, HTTP-сервер и логотипы.

Возможности

Проверка бэкапов

Источник Что проверяется
file-age свежесть файлов по маске/пути, минимальный размер
zip целостность ZIP (CRC), дата, размер
veeam-rest задания Veeam B&R через REST API: статус, длительность, размер
veeam-files репозиторий .vbk/.vib без API
iperius-ftp архивы на FTP/FTPS
tasks задачи планировщика: есть ли, когда отработали, код возврата

Доступность

http (код ответа, ключевое слово, время отклика) · tcp · ping · dns · push (heartbeat от самого сервиса)

Железо и инфраструктура

smart (износ SSD, температура, часы, ошибки) · raid (тома, диски, батарея) · hardware (IPMI/WMI: температуры, вентиляторы, БП) · inventory (ОС, тома, службы, софт, обновления) · vss (писатели и теневые копии — главная причина падений бэкапов) · eventlog · netconfig · hyperv · esxi (SOAP) · mikrotik (API/SSH/SNMP)

Платформа

  • Веб-интерфейс — дашборд, таблица по дням, доступность, журнал, компании, пользователи
  • Роли — admin, operator, viewer, client (последний видит только свои компании)
  • Zabbix — sender (push) и pull-режим (--zabbix), автосоздание хостов через API, LLD
  • Развёртывание — установка агентов на другие машины по WinRM, сканирование сети, AD
  • Удалённые агенты — центральный агент раздаёт конфигурацию, филиалы шлют результаты
  • Журналы — файл + консоль, просмотр из веб-интерфейса, ротация и автоочистка
  • Самодиагностика — страница «Здоровье»: место на диске, права на каталоги, задержка планировщика, очередь Zabbix, память процесса, ошибки конфигурации
  • Бэкапы Hyper-V — экспорт ВМ через WMI, очередь заданий с прогрессом и отменой, страница «Бэкапы» (первый шаг от мониторинга к управлению)
  • Инвентарь ВМ — список машин с ресурсами, дисками, сетями, снимками и IP, свободное место на дисках хоста, предупреждение о переподписке vCPU/памяти
  • Гигиена — диски-сироты, старые снимки, давно выключенные и крупные ВМ; только показывает, ничего не удаляет
  • Аудит — страница журнала действий с фильтрами по действию и пользователю
  • Выгрузка в CSV — задания, копии, аудит, инвентарь, компании, состояния; открывается в Excel без настройки кодировки
  • Ссылки на задания — #/backups/<id> открывает карточку с деталями
  • Перенос конфигурации — экспорт/импорт одним ZIP с проверкой изменений и автоматической резервной копией перед применением
  • Живая валидация — форма компании проверяется на вводе: ошибки привязаны к полям, заведомо битую форму сохранить нельзя
  • Уведомления — SMTP и Telegram о смене состояния задания, с подавлением повторов, тихими часами и очередью на досылку
  • Хранение истории — настраиваемое окно, автоочистка, ручная уборка из интерфейса
  • Проверка обновлений — по локальному каталогу или сетевой папке, без интернета

В планах — от мониторинга к управлению

Сейчас агент наблюдает и уже умеет делать бэкап Hyper-V. Дальше — больше (подробности в ROADMAP.md, этапы 3 и 4):

  • Управление бэкапами — запуск бэкапа Hyper-V через WMI (без внешних библиотек), планировщик, политика хранения (GFS), VSS-снимки, архивация, и главное — проверка восстановлением: пробный импорт ВМ в песочницу.
  • Управление инфраструктурой — инвентарь ВМ и хостов, создание ВМ из шаблонов, питание и снимки, массовые операции, развёртывание «под ключ» (создать → ОС → домен → агент), гигиена (сироты, переподписка, снимки старше N дней).

Разрушительные операции проходят через уже существующую очередь подтверждений (submit → approve), с аудитом и dry-run.

Быстрый старт

Прод-инстанс в bin\ (обычный путь)

build.cmd        # сборка Release + синхронизация в bin\ + конфиги + брендинг DPT
run.cmd          # запуск: http://localhost:8080/

bin\ — это рабочий экземпляр: бинарники, рабочие конфиги, история и журналы. Каталог целиком в .gitignore, поэтому в репозиторий не попадают ни сборка, ни конфиги, ни данные. build.cmd безопасно запускать повторно: данные и уже созданные конфиги сохраняются, обновляется только код.

bin\
├─ BackupDotNet.exe        # агент
├─ public\                 # веб-интерфейс
├─ config\                 # рабочие конфиги (branding.json = DPT.Backup)
├─ data\                   # состояние, история, журналы
├─ auth\AGENT.md           # пароль администратора (после первого запуска)
└─ docs\                   # документация рядом с бинарником

Полезные варианты:

build.cmd -NoBuild          # только синхронизировать файлы
build.cmd -ResetBranding    # вернуть брендинг DPT.Backup
run.cmd --once              # один прогон всех проверок
run.cmd --check acme        # одна компания
run.cmd --help

Отладочный запуск из дерева сборки

dotnet build BackupDotNet.sln -c Release
cd src\BackupDotNet.App\bin\Release
.\BackupDotNet.exe --console

Откройте http://localhost:8080/. Логин admin, пароль — в auth/AGENT.md (создаётся при первом запуске, рядом с exe).

Установка как службы

# из папки с BackupDotNet.exe
sc.exe create BackupDotNetService binPath= "C:\BackupDotNet\BackupDotNet.exe --service" start= auto
sc.exe description BackupDotNetService "Мониторинг бэкапов, доступности и железа"
netsh http add urlacl url=http://+:8080/ user="NT AUTHORITY\SYSTEM"
sc.exe start BackupDotNetService

Режимы запуска

Ключ Назначение
--console агент + веб-интерфейс (обычный запуск, отладка)
--service то же, но как служба Windows
--service-remote служба удалённого агента
--once один прогон всех проверок и выход (для Планировщика задач)
--check <id> прогон одной компании
--zabbix discovery JSON для LLD
--zabbix job <имя> <поле> значение поля задания (pull-режим)
--remote удалённый агент: конфиг с центрального, результаты обратно
--version, --help версия и справка

Конфигурация

Всё лежит рядом с BackupDotNet.exe в config/:

config/
├─ settings.json          # порт, интервалы, Zabbix, журналирование
├─ branding.json          # название, цвета, логотип, подвал
├─ env.json               # пути конкретной инсталляции (dataDir, serviceName)
├─ secrets.json           # секреты (DPAPI LocalMachine), не коммитится
├─ remote.json            # только для удалённого агента
└─ companies/
   ├─ example.json        # одна компания = один файл
   └─ ...

Шаблоны лежат в config/*.example.json — скопируйте и уберите .example.

Минимальная компания:

{
  "id": "acme",
  "name": "ООО «Акме»",
  "policy": { "freshnessHours": 26, "minSizeMb": 10 },
  "sources": [
    { "id": "1c", "type": "file-age", "jobName": "1С · бэкап",
      "paths": ["D:\\Backup\\1C\\*.dt"], "maxAgeHours": 26 }
  ]
}

Журналирование

  • Пишется через System.Diagnostics.Trace без App.Config — листенеры подключаются в коде.
  • Файл: <каталог данных>\logs\<Продукт>_<дата>_<время>.log, UTF-8 без BOM.
  • Ротация по размеру (logging.maxFileSizeMb), автоочистка (logging.keepDays).
  • Init идемпотентен: повторный вызов не создаёт дубликатов листенеров.
  • Просмотр — в веб-интерфейсе: Журналы (только admin), с автообновлением.

Структура решения

src/
├─ BackupDotNet.App       # exe: режимы запуска, службы, CLI
├─ BackupDotNet.Core      # коллекторы, планировщик, хранилище, JSON, журнал
├─ BackupDotNet.Web       # HttpListener, REST API, авторизация, роли
├─ BackupDotNet.Deploy    # развёртывание по WinRM
└─ BackupDotNet.Manage    # очередь операций управления
public/                   # веб-интерфейс (HTML/CSS/JS, без сборки)
config/                   # шаблоны конфигурации и брендинг DPT
assets/                   # логотип и иконка (генерируются tools\generate-assets.ps1)
tools/                    # сборка, упаковка, генерация графики
bin/                      # прод-инстанс (в .gitignore)
reference/                # сторонние исходники, сохранённые для истории

Брендинг DPT

Прод-инстанс собирается с брендингом DPT.Backup: файл config/branding.dpt.json копируется в bin\config\branding.json при сборке.

Что Значение
Название в шапке DPT (синий #0088FF) + .Backup (белый)
Заголовок вкладки DPT.Backup · Мониторинг
Подвал © DPT
Службы DPTBackupService, DPTBackupRemote
Имя журнала DPT.Backup_<дата>_<время>.log

Исходный продукт (BackupDotNet) остаётся в коде и шаблонах — брендинг меняется одним файлом, пересборка не нужна.

Документация

  • AGENTS.md — правила работы: постоянные просьбы, ограничения, стиль
  • PROMPT.md — исходное ТЗ
  • ROADMAP.md — план развития от простого к сложному
  • docs/ARCHITECTURE.md — как всё устроено внутри
  • docs/CONFIG.md — полный справочник по конфигурации
  • docs/SOURCES.md — все типы источников и их параметры
  • docs/DEPLOY.md — установка, служба, обновление, удалённые агенты
  • docs/ZABBIX.md — интеграция с Zabbix
  • docs/DEVELOPMENT.md — сборка, отладка, стиль кода

Сборка и релизы

GitHub Actions собирает проект на каждый пуш и PR:

Что Когда Результат
Сборка + проверка «ноль пакетов» каждый пуш, PR статус в PR
Артефакты (каталог + ZIP) master, теги 30 дней в Actions
GitHub Release с ZIP тег v* релиз с заметками

Чтобы выпустить версию:

git tag v1.1.0
git push origin v1.1.0

Версия из тега подставляется в артефакт и релиз. Локально то же самое: powershell -File tools\package.ps1 -Version 1.1.0.

Лицензия

См. LICENSE.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages