Перейти к содержанию

Начало работы

Эта страница проведёт вас от чистого сервера Unraid до первой резервной копии.

Требования

Требование Примечания
Unraid 6.12+ Более ранние версии не проверялись. Главная цель — Unraid, но BombVault работает и на обычном хосте Docker, и на TrueNAS Scale (см. Обычный хост Docker и TrueNAS SCALE).
Место репозитория restic Локальный путь (рекомендуется: массив или кэш), SMB, NFS или любой бэкенд rclone.
Сокет Docker Шаблон подключает его сам (/var/run/docker.sock).
Флешка Unraid (/boot) Шаблон подключает её целиком сам (/boot в /host/boot). Нужна для копии флешки и позволяет восстановленному контейнеру снова появиться как обычное изменяемое приложение Unraid.
Виртуальные машины KVM (по желанию) Копии виртуальных машин обращаются к libvirt по SSH, без монтирования libvirt. Настройте это в Настройки, Интеграции, SSH хоста (см. Конфигурация).
Наборы данных ZFS (по желанию) То же SSH-соединение, что и для копий виртуальных машин, zfs на хосте и Host Data, подключённый как /mnt с режимом доступа Read/Write - Slave, как в шаблоне по умолчанию. См. Наборы данных ZFS.
Приложение для Android (необязательно) Android 10 или новее, сопряжённый с серверами версии 9.7.0 или новее. См. Приложение для Android.

Установка на Unraid

Проще всего через Community Applications.

  1. Откройте вкладку Apps в Unraid.
  2. Найдите BombVault.
  3. Нажмите Install, задайте обязательные переменные (ниже) и примените.

Ручная установка шаблона

Если вы предпочитаете добавить шаблон вручную:

  1. Откройте Docker, Add Container, Template repositories и добавьте:
    https://github.com/junkerderprovinz/unraid-apps
    
  2. Найдите BombVault среди шаблонов.
  3. Задайте обязательные переменные и нажмите Apply.

Обычный хост Docker

Не на Unraid? BombVault работает и как обычный контейнер на любом хосте Docker. У TrueNAS SCALE свои шаги в разделе TrueNAS SCALE.

  1. Возьмите из репозитория готовый к правке файл deploy/docker-compose.generic.yml.
  2. Задайте APP_KEY (см. ниже) и направьте том Host Data на реальный корень ваших данных. Комментарии в файле объясняют и то, и другое.
  3. Выполните docker compose up -d, затем откройте https://<host-ip>:3443/.

Чем это отличается от Unraid:

  • Раздела Flash нет. Загрузочной USB-флешки нет, ни копировать, ни восстанавливать нечего, поэтому раздел Flash здесь ничего не делает. Вместо него, когда Host Data достаёт до /etc хоста, Добавить на странице «Резервные копии» предлагает Конфигурация системы как папку-подсказку: начальный набор папок /etc, который вы просматриваете и правите перед сохранением.
  • Нет собственных уведомлений Unraid. Собственные каналы уведомлений BombVault внутри приложения (webhook, оповещения о сбоях внешних копий и так далее) работают как обычно. Пропускается только отправка в собственную систему уведомлений Unraid, потому что такой системы, куда отправлять, нет.
  • Копии виртуальных машин включаются по желанию и требуют отдельного хоста libvirtd, доступного по SSH. См. закомментированный блок в файле compose. В обычный хост Docker менеджер виртуальных машин не встроен.
  • Нет плитки на панели. TollRoll является плагином Unraid, поэтому и этот шаг пропускается.
  • Поиск данных контейнера. Без соглашения Unraid об appdata папка данных контейнера находится по сегментам из DATA_ROOT_SEGMENTS, именованным томам Docker, рабочему каталогу проекта Compose и метке bombvault.data (см. Определение источника копии). Именованные тома и шаблон /etc достают только пути внутри точки монтирования Host Data, поэтому направьте Host Data на общего предка, который охватывает и корень данных Docker.
  • PLATFORM. Задайте generic или truenas. Если не задан, BombVault определяет Unraid по собственному маркеру на точке монтирования флешки и считает всё остальное обычным хостом, а шаги только для Unraid пропускаются, а не пробуются безуспешно.

TrueNAS SCALE

BombVault пока нет в каталоге приложений TrueNAS, поэтому установите его как пользовательское приложение: Apps, Discover Apps, затем Install via YAML в меню рядом с Custom App. YAML ниже задаёт то же, что и запись каталога в папке truenas-apps репозитория. Замените tank на ваш пул и заполните APP_KEY, как описано в следующем разделе.

services:
  bombvault:
    image: junkerderprovinz/bombvault:latest
    hostname: bombvault
    restart: unless-stopped
    cap_drop: [ALL]
    cap_add: [CHOWN, DAC_OVERRIDE, FOWNER, SETGID, SETPCAP, SETUID, SYS_CHROOT]
    environment:
      APP_KEY: ""
      PLATFORM: truenas
      HOST_SOURCE_ROOT: /mnt/tank
      HOST_MOUNT_ROOT: /mnt/tank
      # For VM backups:
      # LIBVIRT_URI: qemu+ssh://root@<truenas-ip>/system?socket=/run/truenas_libvirt/libvirt-sock
    volumes:
      - /mnt/tank/apps/bombvault:/config
      - /var/run/docker.sock:/var/run/docker.sock
      - type: bind
        source: /mnt/tank
        target: /mnt/tank
        bind:
          propagation: rslave
    ports:
      - "30528:3443"

Затем откройте https://<truenas-ip>:30528/. Всё, что перечислено в Чем это отличается от Unraid, действует и здесь, а на TrueNAS добавляется следующее:

  • Возможности (capabilities). BombVault нужны семь перечисленных выше. Без SETPCAP копии виртуальных машин не работают, а без SYS_CHROOT каждый контейнер останавливается на всё время копирования, а не читается из снимка.
  • Host Data — это путь хоста на наборе данных, здесь /mnt/tank, подключённый по тому же пути внутри приложения. Поэтому HOST_SOURCE_ROOT и HOST_MOUNT_ROOT называют его оба. rslave передаёт монтирования, которые хост делает позже, а они нужны копиям наборов данных ZFS.
  • Данные в ixVolume не копируются. Приложение, чьё хранилище — ixVolume, держит данные в /mnt/.ix-apps, вне Host Data. BombVault сохраняет только определение приложения, а запуск называет пропущенные папки. Для каждого приложения, чьи данные вы хотите копировать, выберите хранилище Host Path на наборе данных внутри Host Data.
  • Копии виртуальных машин и наборов данных ZFS обращаются к TrueNAS по SSH от имени root. Включите службу SSH в System, Services и добавьте открытый ключ из Настройки, Интеграции, SSH хоста пользователю root в Credentials, Users. Для копий виртуальных машин нужен ещё LIBVIRT_URI, как выше, потому что libvirtd в TrueNAS слушает собственный сокет. Если не заданы ни LIBVIRT_URI, ни LIBVIRT_HOST, BombVault использует шлюз приложения по умолчанию как хост, так как host.docker.internal в приложении TrueNAS не разрешается. Подробности, включая виртуальные машины на zvol, есть в руководстве по копированию виртуальных машин.
  • Для реплики ZFS нужен другой ключ. Реплика на втором сервере ZFS входит с ключом, который показывает окно реплики, а не с ключом SSH хоста. Добавьте именно его на принимающем сервере.
  • Удалённое приложение возвращается в два шага. Сначала переустановите его в TrueNAS под тем же именем, что снова создаст его сеть, а затем восстановите его данные в BombVault. До этого проверка восстановления сообщает об отсутствующей сети, а восстановление отказывается, ничего не изменив.
  • Рядом с оригиналом создаёт обычный контейнер Docker. Он работает, но экран Apps в TrueNAS его не перечисляет.
  • Дампы баз данных работают на монтированиях наборов данных. Импорт в папку данных, которая сама является набором данных, перемещает старое содержимое в папку рядом с ней, поэтому набору данных выше нужно место для него.

ZimaOS, CasaOS и другие хосты

  • ZimaOS и CasaOS: добавьте магазин сообщества и установите из него BombVault. Он работает там как PLATFORM=generic с Host Data на /DATA. ZimaOS хранит данные приложений в /DATA/AppData/<app>, и BombVault находит их сам, потому что DATA_ROOT_SEGMENTS совпадает с appdata в любом регистре.
  • MOS: установите BombVault из MOS Hub. Он работает там как PLATFORM=generic с Host Data на /mnt/cache.
  • Synology: в Container Manager создайте проект из файла compose (DSM 7.2 или новее).
  • Proxmox: запустите его в виртуальной машине или контейнере LXC, где есть Docker.

Без комментариев общий файл compose короткий. Замените ./data на папку хоста, в которой лежат данные ваших контейнеров, задайте HOST_SOURCE_ROOT тем же путём и заполните APP_KEY:

services:
  bombvault:
    image: junkerderprovinz/bombvault:latest
    restart: unless-stopped
    hostname: bombvault
    container_name: bombvault
    volumes:
      - ./config:/config
      - /var/run/docker.sock:/var/run/docker.sock
      - ./data:/host/user
    environment:
      APP_KEY: ""
      PLATFORM: generic
      HOST_SOURCE_ROOT: /host/user
    ports:
      - "3443:3443"

Чтобы копировать и именованные тома Docker, подключите папку, в которой лежат и ваши данные, и корень данных Docker (docker info -f '{{.DockerRootDir}}', обычно /var/lib/docker), так же как шаблон Unraid подключает весь /mnt.

Единственная обязательная настройка

Единственная переменная, которую нужно задать, — APP_KEY, секрет из 32 байт в шестнадцатеричной записи (64 шестнадцатеричных символа), из которого выводится пароль репозитория restic.

Сгенерируйте его на любом компьютере:

openssl rand -hex 32

Вставьте результат в поле APP_KEY шаблона (Unraid) или в переменную окружения APP_KEY в docker-compose.yml (обычный хост Docker).

Не теряйте свой APP_KEY

Потеря APP_KEY делает ваши зашифрованные копии невосстановимыми. Храните его в надёжном месте отдельно от сервера. Когда BombVault заработает, задайте пароль для входа и скачайте набор для восстановления в Настройки, Восстановление (см. Внешние копии и восстановление). В нём лежат ключ, все места назначения и команды restic.

Шаблон также сам подключает сокет Docker, флешку (/boot) и корень Host Data (/mnt). И источники, и назначения копий лежат внутри Host Data. Полный справочник по переменным и настройку внешних копий см. в разделе Конфигурация.

Первый запуск

Страница приветствия новой установки с тем, что BombVault нашёл на сервере. Страница приветствия новой установки с тем, что BombVault нашёл на сервере.

  1. Откройте веб-интерфейс по адресу https://<your-unraid-ip>:3443 (сразу с самоподписанным сертификатом). Новая установка открывается на Добро пожаловать в BombVault со списком того, что BombVault нашёл на сервере.
  2. Нажмите Начать. Обзор покажет карточку Первые шаги с тремя шагами:
    1. Выберите разделы: включите то, что копирует BombVault (контейнеры, виртуальные машины, Flash, папки, наборы данных ZFS, автобэкап). Выбрать открывает список записей раздела, где Приостановить расписание исключает одну из них. Разделы, которые вы здесь включаете, запускаются каждую ночь, что меняется в Настройки, Расписание.
    2. Добавить место назначения: второе место для копий. У каждого раздела уже есть папка на этом сервере, /mnt/user/bombvault/{container,vms,flash,config,files,zfs}, которая создаётся при первой копии. Надёжнее всего второе место назначения вне вашего помещения, например Storage Box или Backblaze B2.
    3. Первая резервная копия: после этого она идёт сама каждую ночь. Карточка остаётся, пока не закончится первая копия.
  3. Откройте Резервные копии, чтобы увидеть все записи в одном списке. Создать копию всего сейчас запускает проход по всем включённым разделам, а Создать резервную копию на странице записи копирует только её.

Карточка «Первые шаги» с тремя шагами, второй открыт. Карточка «Первые шаги» с тремя шагами, второй открыт.

Уже пользовались BombVault? Восстановить из резервной копии на странице приветствия открывает страницу «Восстановление», где Аварийный мастер возвращает настройки, контейнеры, виртуальные машины и папки утраченного сервера. См. Внешние копии и восстановление.

Необязательно: выберите порядок копирования

Если некоторые контейнеры всегда должны копироваться раньше других (например, база данных раньше приложения, которое ею пользуется), откройте карточку Порядок в Настройки, Расписание и перетащите их в нужную последовательность. Плановые запуски и полный бэкап затем следуют ей. Всё, что вы не упорядочили, копируется в порядке просрочки, самое просроченное первым.

Пример: первая резервная копия контейнера от начала до конца

Этот пример проходит по чистому серверу Unraid с несколькими контейнерами, среди них plex, до тех пор, пока первая копия не будет готова и вы не будете знать, где её искать. Он занимает около десяти минут плюс время первой копии.

  1. Установка. На вкладке Unraid Apps найдите BombVault и нажмите Install.
  2. Задайте ключ. На компьютере выполните openssl rand -hex 32 и вставьте 64 символа в поле APP_KEY шаблона. Сразу, прежде чем делать что-либо ещё, сохраните копию в менеджере паролей. Нажмите Apply.
  3. Откройте его. Перейдите на https://<your-unraid-ip>:3443 и примите самоподписанный сертификат. Добро пожаловать в BombVault перечисляет, что он нашёл, например 12 контейнеров, 2 виртуальные машины и флешку.
  4. Начать. Обзор открывается с карточкой Первые шаги.
  5. Выберите разделы. Контейнеры включены с самого начала. Включите то, что вам нужно ещё, например Flash. Выбрать открывает список найденных контейнеров, где Приостановить расписание исключает один из них, например тестовый контейнер, который вам не важен. Включённые разделы запускаются каждую ночь в полном бэкапе.
  6. Добавить место назначения. У каждого раздела уже есть своя папка на этом сервере в /mnt/user/bombvault, так что первой копии есть куда идти. Этот шаг добавляет второе место, и самое надёжное из них находится вне вашего помещения. Сделать это можно сейчас по примеру с S3 или вернуться к этому, когда закончится первая копия. Карточка остаётся до тех пор.
  7. Первая резервная копия. Откройте Резервные копии и нажмите Создать копию всего сейчас или дождитесь ночи. Кольцо в строке состояния превращается в кольцо хода выполнения и считает записи, например Идёт резервное копирование: 3 из 12. Каждый контейнер останавливается, пока читаются его данные, и сразу после этого запускается снова. Контейнер, чьи данные лежат на ZFS, простаивает всего несколько секунд снимка. Первая копия читает всё, поэтому она самая долгая. Последующие сохраняют только изменившееся.
  8. Проверьте. Когда кольцо скажет Всё скопировано, откройте История в обзоре: у каждого контейнера в Запуски зелёная строка. Откройте Резервные копии, щёлкните plex и посмотрите на его вкладку Резервные копии: первый снимок на месте, а место, которое его хранит, — Локально. Через несколько минут на вкладке Проверка появится проверка восстановления, которая восстановила выборку из копии и прочитала её обратно.
  9. Защитите ключ. Откройте Настройки, Безопасность и задайте пароль для входа. Затем откройте Настройки, Восстановление и нажмите Скачать набор для восстановления в На экстренный случай. Храните файл вне сервера рядом с копией APP_KEY из шага 2. Напоминание Сохраните набор для восстановления в обзоре исчезнет, когда вы нажмёте Я надёжно его сохранил.

С этого момента контейнеры копируются каждую ночь. Хорошие следующие шаги в таком порядке: внешнее место назначения, чтобы погибший сервер не унёс с собой копии, затем уведомления, чтобы сбой дошёл до вас, и взгляд на Расписания, если 03:00 вам не подходит.

Строка состояния, пока идёт первая копия, с кольцом хода выполнения и его станциями. Строка состояния, пока идёт первая копия, с кольцом хода выполнения и его станциями.

Проверка интеграции с хостом

Карточка Интеграция с хостом в обзоре проверяет каждое монтирование и каждую утилиту командной строки (сокет Docker, libvirt, restic, qemu-img, rclone) и сообщает, чего не хватает, чтобы вы могли убедиться, что контейнер подключён правильно, прежде чем на него полагаться. Она ждёт в разделе Настроить, пока вы её не добавите.

Копии VPS как узла

VPS или другому небольшому серверу не нужен собственный BombVault с веб-интерфейсом. Добавьте его как узел этого экземпляра, и копированием займётся этот экземпляр:

  1. Задайте пароль для входа в Настройки, Безопасность, если ещё не сделали этого.
  2. Откройте Экземпляры, выберите Добавить узел и введите название, например vps-helsinki.
  3. Выберите, куда идут его копии, например на принимающий сервер этого экземпляра, и когда он их создаёт.
  4. Скопируйте на сервер compose-файл, который показывает окно, направьте его том Host Data и HOST_SOURCE_ROOT на данные для копирования и выполните docker compose up -d.

Когда узел ответит, его карточка покажет Подключён, а его контейнеры появятся в Резервные копии. Страница Узлы проводит через это на примере.

Настройки в виде плиток с карточками выбранной плитки рядом. Каждое изменение записывается сразу. Настройки в виде плиток с карточками выбранной плитки рядом. Каждое изменение записывается сразу.

В боковой панели пять пунктов: Обзор, Аномалии (пока включено обнаружение аномалий), Резервные копии, Восстановление и под Выйти пункт Настройки. Главное действие страницы плавает внизу справа, а в Ещё лежат редкие. На телефоне в панели стоят «Обзор», «Резервные копии», «Восстановление» и «Настройки», а остальное в Ещё.

Страницы и настройки занимают всю ширину окна. Окно держит свои кнопки в нижней части, а кнопка, ведущая вперёд, стоит справа. На телефоне нижняя часть, в которой больше трёх кнопок, оставляет выход и главное действие, а остальные убирает в Ещё.

На телефоне: панель внизу с открытым «Ещё». На телефоне: панель внизу с открытым «Ещё».

  • Обзор показывает, всё ли скопировано и что требует вас. См. Обзор.
  • Резервные копии перечисляют все контейнеры, виртуальные машины, наборы папок, флешку, каждый набор данных ZFS и автобэкап как записи. Плитки над списком выбирают вид, а Фильтры, Сортировка и Поиск сужают его. У каждой записи своя страница с тремя вкладками: Резервные копии, Настройки и Проверка. Кнопка «назад» слева от значка записи ведёт к списку. См. Копии и записи.
  • Восстановление — одна страница для всего: выберите раздел, найдите запись и выберите копию. Аварийный мастер и другие источники тоже начинаются здесь. См. Восстановление.
  • Настройки — четырнадцать плиток: Общие, Внешний вид, Расписание, Места назначения, Восстановление, Уведомления, Проверка, Безопасность, Экземпляры, Сопряжение, Интеграции, Приложения, Система и Информация. См. Настройки. Нажмите / или Ctrl+K, чтобы искать по всем, в том числе по названиям, которые страницы носили в прежних версиях. Перетащите плитки в свой порядок в разделе Внешний вид. Там, где колонка плиток рядом со страницей сжимала бы её, например в окне шириной около 1200 пикселей, плитки превращаются в ленту над страницей, которая прокручивается вбок. Телефон показывает ту же ленту.
  • Места назначения и Экземпляры — плитки настроек со своими страницами. Показывать также в боковой панели на их плитке закрепляет их в боковой панели.

Нет ни кнопки «Сохранить», ни раскрывающихся блоков: редкое лежит в отдельной карточке или окне, а пояснения — в подсказках (i). После обновления само открывается окно с карточкой для каждого релиза с вашей последней версии, а зелёные точки отмечают изменившееся. Щелчок скрывает точку. Новое в карточке «Версия» в Настройки, Информация считает то, чего вы ещё не видели, и снова открывает это окно с заметками каждого релиза и его изменениями с Перейти туда.

Сборка из исходного кода

BombVault — один статический бинарный файл Go, который обслуживает JSON API и встроенный интерфейс React. Сначала соберите интерфейс, затем запустите бинарный файл:

npm --prefix web ci
npm --prefix web run build     # writes web/dist, which the binary embeds
export APP_KEY=$(openssl rand -hex 32)
go test ./...                  # unit and integration tests, with a real restic round trip
golangci-lint run ./...
go run ./cmd/bombvault         # serves https://localhost:3443 with a self-signed certificate

Сборка интерфейса нужна и для go run. Репозиторий отслеживает только пустой маркер в web/dist, поэтому без npm --prefix web run build бинарный файл ничего не встраивает и отвечает 500 SPA index not found, и это ожидаемо. Docker, libvirt и Unraid нельзя проверить в CI, поэтому перед pull request проверьте монтирования, restic и SSH-связь для виртуальных машин на настоящем хосте с помощью карточки Интеграция с хостом в обзоре (или GET /api/spike).

Следующие шаги