Перейти до змісту

Початок роботи

Ця сторінка проведе вас від чистого сервера 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).

Наступні кроки