Pierwsze kroki¶
Ta strona przeprowadzi Cię od świeżej maszyny Unraid do Twojej pierwszej kopii zapasowej.
Wymagania¶
| Wymaganie | Uwagi |
|---|---|
| Unraid 6.12+ | Wcześniejsze wersje nie są testowane. Unraid jest główną platformą, ale BombVault działa też na zwykłym hoście Dockera i na TrueNAS Scale (zobacz Zwykły host Dockera i TrueNAS SCALE). |
| Lokalizacja repozytorium restic | Ścieżka lokalna (zalecane: Twoja macierz lub cache), SMB, NFS lub dowolny backend rclone. |
| Gniazdo Docker | Montowane automatycznie przez szablon (/var/run/docker.sock). |
Flash Unraid (/boot) |
Montowany w całości automatycznie przez szablon (/boot do /host/boot). Zasila kopię flash i pozwala przywróconemu kontenerowi pojawić się ponownie jako normalna, edytowalna aplikacja Unraid. |
| Maszyny wirtualne KVM (opcjonalnie) | Kopia VM komunikuje się z libvirt przez SSH, bez montowania libvirt. Skonfiguruj to w Ustawienia, Integracje, SSH hosta (zobacz Konfiguracja). |
| Zbiory danych ZFS (opcjonalnie) | To samo połączenie SSH co przy kopiach VM, zfs na hoście oraz Host Data zmapowane jako /mnt z trybem dostępu Read/Write - Slave, domyślnym w szablonie. Zobacz Zbiory danych ZFS. |
| Aplikacja na Androida (opcjonalnie) | Android 10 lub nowszy, sparowana z serwerami w wersji 9.7.0 lub nowszej. Zobacz Aplikacja na Androida. |
Instalacja na Unraid¶
Najprostsza droga to Community Applications.
- Otwórz zakładkę Apps w Unraid.
- Wyszukaj BombVault.
- Kliknij Install, ustaw wymagane zmienne (poniżej) i zastosuj.
Ręczna instalacja szablonu
Jeśli wolisz dodać szablon ręcznie:
- Przejdź do Docker, Add Container, Template repositories i dodaj:
- Wyszukaj BombVault w Templates.
- Ustaw wymagane zmienne i kliknij Apply.
Zwykły host Dockera¶
Nie Unraid? BombVault działa też jako zwykły kontener na dowolnym hoście Dockera. TrueNAS SCALE ma własne kroki w TrueNAS SCALE.
- Pobierz z repozytorium gotowy do edycji plik
deploy/docker-compose.generic.yml. - Ustaw
APP_KEY(patrz niżej) i skieruj wolumen Host Data na swój prawdziwy katalog danych. Komentarze w pliku prowadzą przez jedno i drugie. docker compose up -d, a następnie otwórzhttps://<ip-hosta>:3443/.
Czym różni się to od Unraida:
- Brak sekcji Flash. Nie ma pendrive'a rozruchowego do zabezpieczenia ani odtworzenia, więc sekcja Flash nie ma tu nic do roboty. Zamiast tego, gdy Host Data sięga do
/etchosta, Dodaj na stronie Kopie zapasowe proponuje Konfiguracja systemu jako podpowiedź folderu: początkowy zestaw folderów z/etc, który przeglądasz i poprawiasz przed zapisaniem. - Brak natywnych powiadomień Unraida. Własne kanały powiadomień BombVaulta (webhook, alerty o nieudanej replikacji poza siedzibę i tak dalej) działają normalnie. Pomijane jest tylko wysłanie do systemu powiadomień Unraida, bo takiego systemu tutaj nie ma.
- Kopia maszyn wirtualnych jest opcjonalna i wymaga osobnego hosta libvirtd dostępnego przez SSH. Zobacz zakomentowany blok w pliku compose. Zwykły host Dockera sam w sobie nie ma menedżera maszyn wirtualnych.
- Brak kafelka na pulpicie. TollRoll to wtyczka Unraida, więc ten krok również jest pomijany.
- Odnajdywanie danych kontenera. Bez konwencji
appdataz Unraida folder danych kontenera jest odnajdywany na podstawie segmentów wDATA_ROOT_SEGMENTS, nazwanych woluminów Dockera, katalogu roboczego projektu Compose i etykietybombvault.data(zobacz Wykrywanie źródeł kopii zapasowej). Nazwane woluminy i zestaw predefiniowany/etcsięgają tylko do ścieżek wewnątrz montowania Host Data, więc skieruj Host Data na wspólny katalog nadrzędny, który obejmuje też katalog danych Dockera. PLATFORM. Ustaw ją nagenericalbotruenas. Gdy nie jest ustawiona, BombVault rozpoznaje Unraid po jego własnym znaczniku na montowaniu flash, a wszystko inne traktuje jako zwykły host, i kroki tylko dla Unraida są pomijane, zamiast być próbowane i kończyć się błędem.
TrueNAS SCALE¶
BombVault nie jest jeszcze w katalogu aplikacji TrueNAS, więc zainstaluj go jako własną aplikację: Apps, Discover Apps, a potem Install via YAML w menu obok Custom App. Poniższy YAML ustawia to samo co wpis katalogu w folderze truenas-apps repozytorium. Zastąp tank swoją pulą i uzupełnij APP_KEY, jak opisuje następna sekcja.
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
# Dla kopii VM:
# 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"
Następnie otwórz https://<truenas-ip>:30528/. To, co wymieniono w Czym różni się to od Unraida, dotyczy także tego przypadku, a na TrueNAS:
- Uprawnienia (capabilities). BombVault potrzebuje siedmiu powyższych. Bez
SETPCAPkopie VM kończą się błędem, a bezSYS_CHROOTkażdy kontener jest zatrzymywany na całą swoją kopię, zamiast być czytany z migawki. - Host Data to ścieżka hosta na zbiorze danych, tutaj
/mnt/tank, zamontowana pod tą samą ścieżką wewnątrz aplikacji. DlategoHOST_SOURCE_ROOTiHOST_MOUNT_ROOTpodają ją obie.rslaveprzekazuje montowania, które host wykonuje później, a tego potrzebują kopie zbiorów danych ZFS. - Dane w ixVolume nie są kopiowane. Aplikacja, której pamięcią jest ixVolume, trzyma dane pod
/mnt/.ix-apps, poza Host Data. BombVault zapisuje tylko definicję aplikacji, a przebieg podaje foldery, które pominął. Dla każdej aplikacji, której dane chcesz kopiować, wybierz pamięć Host Path na zbiorze danych pod Host Data. - Kopie VM i zbiorów danych ZFS łączą się z TrueNAS przez SSH jako root. Włącz usługę SSH w System, Services i dodaj klucz publiczny z Ustawienia, Integracje, SSH hosta do użytkownika root w Credentials, Users. Kopie VM potrzebują też
LIBVIRT_URIjak wyżej, bo libvirtd na TrueNAS nasłuchuje na własnym gnieździe. Gdy nie ustawiono aniLIBVIRT_URI, aniLIBVIRT_HOST, BombVault używa domyślnej bramy aplikacji jako hosta, bohost.docker.internalnie rozwiązuje się w aplikacji TrueNAS. Poradnik kopii VM opisuje szczegóły, także dla VM na zvolach. - Replika ZFS używa innego klucza. Replika na drugim serwerze ZFS loguje się kluczem, który pokazuje okno repliki, a nie kluczem SSH hosta. Dodaj ten klucz na serwerze odbierającym.
- Usunięta aplikacja wraca w dwóch krokach. Najpierw zainstaluj ją ponownie w TrueNAS pod tą samą nazwą, co tworzy na nowo jej sieć, a potem przywróć jej dane w BombVault. Do tego czasu kontrola przed przywracaniem zgłasza brakującą sieć, a przywracanie odmawia, zanim cokolwiek zmieni.
- Obok oryginału tworzy zwykły kontener Dockera. Działa, ale ekran Apps w TrueNAS go nie wymienia.
- Zrzuty baz danych działają na montowaniach zbiorów danych. Import do folderu danych, który jest osobnym zbiorem danych, przenosi starą zawartość do folderu obok, więc nadrzędny zbiór danych potrzebuje na nią miejsca.
ZimaOS, CasaOS i inne hosty¶
- ZimaOS i CasaOS: dodaj sklep społeczności i zainstaluj z niego BombVault. Działa tam jako
PLATFORM=genericz Host Data na/DATA. ZimaOS trzyma dane aplikacji w/DATA/AppData/<app>, co BombVault znajduje sam, boDATA_ROOT_SEGMENTSpasuje doappdataw dowolnej wielkości liter. - MOS: zainstaluj BombVault z MOS Hub. Działa tam jako
PLATFORM=genericz Host Data na/mnt/cache. - Synology: w Container Manager utwórz projekt z pliku compose (DSM 7.2 lub nowszy).
- Proxmox: uruchom go w maszynie wirtualnej albo kontenerze LXC z Dockerem.
Bez komentarzy ogólny plik compose jest krótki. Zastąp ./data folderem hosta, który zawiera dane Twoich kontenerów, ustaw HOST_SOURCE_ROOT na tę samą ścieżkę i uzupełnij 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"
Aby kopiować także nazwane woluminy Dockera, zamontuj folder, który zawiera zarówno Twoje dane, jak i katalog główny danych Dockera (docker info -f '{{.DockerRootDir}}', zwykle /var/lib/docker), tak jak szablon Unraid montuje całe /mnt.
Jedno wymagane ustawienie¶
Jedyną zmienną, którą musisz ustawić, jest APP_KEY, 32-bajtowy sekret w formacie hex (64 znaki hex) używany do wyprowadzenia hasła repozytorium restic.
Wygeneruj go na dowolnej maszynie:
Wklej wynik do pola APP_KEY w szablonie (Unraid) albo do zmiennej środowiskowej APP_KEY w docker-compose.yml (zwykły host Docker).
Nie zgub swojego APP_KEY
Utrata APP_KEY sprawia, że zaszyfrowane kopie zapasowe stają się nieodzyskiwalne. Przechowuj go w bezpiecznym miejscu, oddzielnie od serwera. Gdy BombVault już działa, ustaw hasło logowania i pobierz zestaw odzyskiwania w Ustawienia, Przywracanie (zobacz Kopie poza siedzibą i odzyskiwanie). Zawiera klucz, każde miejsce docelowe i polecenia restic.
Szablon montuje też za Ciebie gniazdo Docker, flash (/boot) oraz katalog główny Host Data (/mnt). Zarówno źródła, jak i miejsca docelowe kopii zapasowych znajdują się pod Host Data. Pełny opis zmiennych oraz konfigurację poza siedzibą znajdziesz w Konfiguracja.
Pierwsze uruchomienie¶

- Otwórz interfejs webowy pod adresem
https://<your-unraid-ip>:3443(certyfikat samopodpisany od razu po instalacji). Nowa instalacja otwiera się na ekranie Witamy w BombVault, który wymienia to, co BombVault znalazł na serwerze. - Wybierz Zaczynamy. Przegląd pokaże wtedy kartę Pierwsze kroki z trzema krokami:
- Wybierz sekcje: włącz to, co BombVault ma kopiować (Containers, Maszyny wirtualne, Flash, Foldery, Zbiory danych ZFS, Autokopia). Wybierz otwiera listę elementów sekcji, na której Wstrzymaj harmonogram pomija jedną z nich. Sekcje włączone tutaj działają co noc, co zmienisz w Ustawienia, Harmonogram.
- Dodaj miejsce docelowe: drugie miejsce na kopie. Każda sekcja ma już folder na tym serwerze,
/mnt/user/bombvault/{container,vms,flash,config,files,zfs}, tworzony przy pierwszej kopii. Najbezpieczniej mieć drugie miejsce docelowe poza domem, na przykład Storage Box albo Backblaze B2. - Pierwsza kopia zapasowa: potem działa sama co noc. Karta zostaje, dopóki pierwsza kopia się nie zakończy.
- Otwórz Kopie zapasowe, aby zobaczyć każdy element na jednej liście. Utwórz kopię wszystkiego teraz uruchamia przebieg po wszystkich włączonych sekcjach, a Utwórz kopię teraz na stronie elementu kopiuje tylko tę jedną.

Używasz już BombVault? Przywróć z kopii zapasowej na stronie powitalnej otwiera stronę Przywracanie, gdzie Kreator awaryjny przywraca ustawienia, kontenery, maszyny wirtualne i foldery utraconego serwera. Zobacz Kopie poza siedzibą i odzyskiwanie.
Opcjonalnie: wybierz kolejność kopii zapasowych
Jeśli niektóre kontenery powinny być zawsze kopiowane przed innymi (na przykład baza danych przed aplikacją, która z niej korzysta), otwórz kartę Kolejność w Ustawienia, Harmonogram i przeciągnij je w wybraną sekwencję. Uruchomienia zaplanowane i pełna kopia będą jej przestrzegać. Wszystko, co pozostawisz bez kolejności, jest kopiowane od najbardziej spóźnionego.
Przykład: Twoja pierwsza kopia kontenera od początku do końca¶
Ten przykład prowadzi przez świeży serwer Unraid z kilkoma kontenerami, wśród nich plex, aż pierwsza kopia będzie gotowa i będziesz wiedzieć, gdzie ją znaleźć. Zajmuje około dziesięciu minut plus czas pierwszej kopii.
- Zainstaluj. W zakładce Apps w Unraid wyszukaj BombVault i naciśnij Install.
- Ustaw klucz. Na komputerze uruchom
openssl rand -hex 32i wklej 64 znaki w poleAPP_KEYszablonu. Zachowaj kopię w menedżerze haseł od razu, przed czymkolwiek innym. Naciśnij Apply. - Otwórz. Wejdź na
https://<your-unraid-ip>:3443i zaakceptuj certyfikat samopodpisany. Witamy w BombVault wymienia to, co znalazł, na przykład 12 kontenerów, 2 maszyny wirtualne i dysk flash. - Zaczynamy. Przegląd otwiera się z kartą Pierwsze kroki.
- Wybierz sekcje. Containers są włączone od początku. Włącz, co jeszcze chcesz, na przykład Flash. Wybierz otwiera listę znalezionych kontenerów, na której Wstrzymaj harmonogram pomija jeden z nich, na przykład testowy kontener, na którym Ci nie zależy. Włączone sekcje działają co noc w pełnej kopii.
- Dodaj miejsce docelowe. Każda sekcja ma już własny folder na tym serwerze, pod
/mnt/user/bombvault, więc pierwsza kopia ma dokąd trafić. Ten krok dodaje drugie miejsce, a najbezpieczniejsze jest to poza domem. Możesz to zrobić teraz według przykładu z S3 albo wrócić do tego po pierwszej kopii. Karta zostaje do tego czasu. - Pierwsza kopia. Otwórz Kopie zapasowe i naciśnij Utwórz kopię wszystkiego teraz albo poczekaj do nocy. Pierścień w nagłówku stanu zmienia się w pierścień postępu i liczy elementy, na przykład Trwa tworzenie kopii: 3 z 12. Każdy kontener jest zatrzymywany na czas czytania jego danych i zaraz potem startuje z powrotem. Kontener, którego dane leżą na ZFS, jest wyłączony tylko na kilka sekund migawki. Pierwsza kopia czyta wszystko, więc trwa najdłużej. Kolejne zapisują tylko to, co się zmieniło.
- Sprawdź. Gdy pierścień mówi Wszystko skopiowane, otwórz Historia w przeglądzie: każdy kontener ma zieloną linię w Przebiegi. Otwórz Kopie zapasowe, kliknij
plexi spójrz na jego kartę Kopie zapasowe: jest tam pierwsza migawka, a miejscem, które ją przechowuje, jest Lokalne. Kilka minut później jego karta Weryfikacja pokazuje sprawdzenie przywracania, które przywróciło próbkę kopii i odczytało ją z powrotem. - Ochroń klucz. Otwórz Ustawienia, Bezpieczeństwo i ustaw hasło logowania. Potem otwórz Ustawienia, Przywracanie i naciśnij Pobierz zestaw odzyskiwania w Na wypadek awarii. Zapisz plik poza serwerem, obok kopii
APP_KEYz kroku 2. Przypomnienie Zapisz swój zestaw odzyskiwania w przeglądzie znika, gdy naciśniesz Bezpiecznie zapisałem.
Od teraz kontenery są kopiowane co noc. Dobre następne kroki, w tej kolejności: miejsce docelowe poza siedzibą, żeby martwy serwer nie zabrał ze sobą kopii, potem powiadomienia, żeby błąd do Ciebie dotarł, a potem rzut oka na Harmonogramy, jeśli 03:00 Ci nie odpowiada.

Sprawdzenie integracji z hostem
Karta Integracja z hostem w przeglądzie sonduje każdy montaż i każde CLI (gniazdo Docker, libvirt, restic, qemu-img, rclone) i zgłasza wszelkie brakujące elementy, więc możesz potwierdzić, że kontener jest poprawnie połączony, zanim na nim polegasz. Czeka w Dostosuj, aż ją dodasz.
Kopia VPS-a jako węzła¶
VPS albo inny mały serwer nie potrzebuje własnego BombVault z interfejsem WWW. Dodaj go jako węzeł tej instancji, a ona będzie robić jego kopie:
- Ustaw hasło logowania w Ustawienia, Bezpieczeństwo, jeśli jeszcze go nie masz.
- Otwórz Instancje, wybierz Dodaj węzeł i wpisz nazwę, na przykład
vps-helsinki. - Wybierz, dokąd trafiają jego kopie, na przykład na serwer odbiorczy tej instancji, i kiedy je robi.
- Skopiuj plik compose pokazany w oknie na serwer, skieruj jego wolumen Host Data i
HOST_SOURCE_ROOTna dane do kopiowania i uruchomdocker compose up -d.
Gdy węzeł odpowie, jego karta pokazuje Połączono, a jego kontenery pojawiają się w Kopie zapasowe. Strona Węzły prowadzi przez to na przykładzie.
Poruszanie się po aplikacji¶

Pasek boczny ma pięć pozycji: Przegląd, Anomalie (gdy wykrywanie anomalii jest włączone), Kopie zapasowe, Przywracanie i, pod Wyloguj się, Ustawienia. Główna akcja strony unosi się w prawym dolnym rogu, a Więcej zawiera te rzadkie. Na telefonie pasek ma Przegląd, Kopie zapasowe, Przywracanie i Ustawienia, a Więcej resztę.
Strony i ustawienia zajmują całą szerokość okna. Okno trzyma swoje przyciski w stopce, a ten, który prowadzi dalej, jest po prawej. Na telefonie stopka z więcej niż trzema przyciskami zostawia drogę wyjścia i główną akcję, a resztę chowa pod Więcej.

- Przegląd pokazuje, czy wszystko jest skopiowane i co wymaga uwagi. Zobacz Przegląd.
- Kopie zapasowe wymieniają każdy kontener, maszynę wirtualną, zestaw folderów, nośnik flash, każdy zbiór danych ZFS i autokopię jako elementy. Kafelki nad listą wybierają rodzaj, a Filtry, Sortuj i Szukaj zawężają listę. Każdy element ma własną stronę z trzema kartami: Kopie zapasowe, Ustawienia i Weryfikacja. Przycisk wstecz po lewej stronie ikony elementu prowadzi do listy. Zobacz Kopie zapasowe i elementy.
- Przywracanie to jedna strona dla wszystkiego: wybierz sekcję, wyszukaj element i wybierz kopię zapasową. Kreator awaryjny i inne źródła zaczynają się tutaj też. Zobacz Przywracanie.
- Ustawienia to czternaście kafelków: Ogólne, Wygląd, Harmonogram, Miejsca docelowe, Przywracanie, Powiadomienia, Weryfikacja, Bezpieczeństwo, Instancje, Parowanie, Integracje, Aplikacje, System i Info. Zobacz Ustawienia. Naciśnij
/lub Ctrl+K, aby przeszukać je wszystkie, także po nazwach, które strony miały we wcześniejszych wersjach. Przeciągnij kafelki w swoją kolejność w Wygląd. Tam, gdzie kolumna kafelków obok strony ścisnęłaby ją, jak w oknie o szerokości około 1200 pikseli, kafelki stają się paskiem nad stroną, który przewija się na boki. Telefon pokazuje ten sam pasek. - Miejsca docelowe i Instancje to kafelki ustawień z własnymi stronami. Pokaż także na pasku bocznym na ich kafelku przypina je do paska bocznego.
Nic nie ma przycisku Zapisz i nic się nie rozwija: rzadkie rzeczy mają własną kartę albo okno, a wyjaśnienia są w dymkach (i). Po aktualizacji samo otwiera się okno z kartą dla każdego wydania od twojej ostatniej wersji, a zielone kropki oznaczają, co się zmieniło. Kliknięcie ukrywa kropkę. Nowości na karcie Wersja w Ustawienia, Info liczy to, czego jeszcze nie widziałeś, i otwiera to okno ponownie, z notatkami do każdego wydania i jego zmianami z Przejdź tam.
Budowanie ze źródeł¶
BombVault to pojedyncza statyczna binarka Go, która serwuje JSON API i osadzony interfejs React. Najpierw zbuduj interfejs, potem uruchom binarkę:
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
Zbudowanie interfejsu jest potrzebne także dla go run. Repozytorium śledzi pod web/dist tylko pusty znacznik, więc bez npm --prefix web run build binarka niczego nie osadza i odpowiada 500 SPA index not found, czego należy się spodziewać. Dockera, libvirt i Unraida nie da się przetestować w CI, więc przed otwarciem pull requesta sprawdź montowania, restic i połączenie SSH do VM na prawdziwym hoście za pomocą karty Integracja z hostem w przeglądzie (lub GET /api/spike).
Kolejne kroki¶
- Dodaj jedno lub więcej miejsc docelowych poza domem (każda sekcja może kopiować do kilku naraz) i zapisz swój zestaw odzyskiwania, jak opisano w Kopie poza siedzibą i odzyskiwanie. Przykład z S3 przeprowadza przez jedno z nich.
- Zadbaj, żeby błąd do Ciebie dotarł, dzięki Powiadomieniom.
- Sprawdź, kiedy co działa, w Harmonogramach.
- Przenieś wszystkie serwery swojej grupy na telefon dzięki aplikacji na Androida.
- Rób stąd kopie VPS-a jako węzła.
- Przykłady krok po kroku prowadzą przez typowe zadania, a Funkcje wymieniają wszystko, co robi BombVault.
- Klonujesz konfigurację lub przenosisz się na nową maszynę? Przenieś całą swoją konfigurację za pomocą karty Eksport / import ustawień. Zobacz Konfiguracja.
- Napotkałeś problem? Zobacz Rozwiązywanie problemów.