Erste Schritte¶
Diese Seite führt dich von einer frischen Unraid-Box bis zu deiner ersten Sicherung.
Voraussetzungen¶
| Voraussetzung | Hinweise |
|---|---|
| Unraid 6.12+ | Ältere Versionen sind nicht getestet. Unraid ist das Hauptziel, BombVault läuft aber auch auf einem schlichten Docker-Host und auf TrueNAS Scale (siehe Generischer Docker-Host und TrueNAS SCALE). |
| Ort des restic-Repos | Ein lokaler Pfad (empfohlen: dein Array oder Cache), SMB, NFS oder ein beliebiges rclone-Backend. |
| Docker-Socket | Wird vom Template automatisch gemountet (/var/run/docker.sock). |
Unraid-Flash (/boot) |
Wird vom Template automatisch komplett gemountet (/boot nach /host/boot). Ermöglicht die Flash-Sicherung und lässt einen wiederhergestellten Container als normale, bearbeitbare Unraid-App wiedererscheinen. |
| KVM-VMs (optional) | Die VM-Sicherung spricht über SSH mit libvirt, kein libvirt-Mount. Einzurichten unter Einstellungen, Anbindungen, Host-SSH (siehe Konfiguration). |
| ZFS-Datasets (optional) | Dieselbe SSH-Verbindung wie bei der VM-Sicherung, zfs auf dem Host und Host Data als /mnt eingebunden mit dem Zugriffsmodus Read/Write - Slave, der Vorgabe des Templates. Siehe ZFS-Datasets. |
| Android-App (optional) | Android 10 oder neuer, gekoppelt mit Servern ab Version 9.7.0. Siehe Android-App. |
Auf Unraid installieren¶
Der einfachste Weg sind die Community Applications.
- Öffne den Tab Apps in Unraid.
- Suche nach BombVault.
- Klicke auf Install, setze die erforderlichen Variablen (unten) und übernimm.
Template von Hand installieren
Wenn du das Template lieber von Hand hinzufügst:
- Gehe zu Docker, Add Container, Template repositories und füge hinzu:
- Suche in den Templates nach BombVault.
- Setze die erforderlichen Variablen und klicke auf Apply.
Generischer Docker-Host¶
Nicht auf Unraid? BombVault läuft auch als schlichter Container auf jedem Docker-Host. TrueNAS SCALE hat unter TrueNAS SCALE eigene Schritte.
- Hol dir die fertig zu bearbeitende
deploy/docker-compose.generic.ymlaus dem Repo. - Setze
APP_KEY(siehe unten) und richte das Host-Data-Volume auf deine echte Datenwurzel. Die Kommentare der Datei führen durch beides. docker compose up -d, dann öffnehttps://<host-ip>:3443/.
Was anders ist als auf Unraid:
- Kein Bereich Flash. Es gibt keinen Boot-USB-Stick zum Erfassen oder Wiederherstellen, der Bereich Flash hat hier also nichts zu tun. Reicht Host Data stattdessen bis zum
/etcdes Hosts, bietet Hinzufügen auf der Seite Sicherungen die Systemkonfiguration als Ordnervorschlag an: ein vorbereitetes/etc-Ordner-Set, das du vor dem Speichern prüfst und bearbeitest. - Keine Unraid-eigenen Benachrichtigungen. Die eigenen Benachrichtigungskanäle von BombVault in der App (Webhook, Warnungen bei Off-site-Fehlern usw.) funktionieren wie gewohnt. Nur der Unraid-spezifische Push an dessen eigenes Benachrichtigungssystem entfällt, da es kein solches System gibt.
- Die VM-Sicherung ist optional und braucht einen separaten libvirtd-Host, der über SSH erreichbar ist. Siehe den auskommentierten Block in der Compose-Datei. In einen generischen Docker-Host selbst ist kein VM-Manager eingebaut.
- Keine Dashboard-Kachel. TollRoll ist ein Unraid-Plugin, dieser Schritt entfällt also ebenfalls.
- Die Daten eines Containers finden. Ohne die
appdata-Konvention von Unraid wird der Datenordner eines Containers anhand der Segmente inDATA_ROOT_SEGMENTS, benannter Docker-Volumes, des Arbeitsverzeichnisses eines Compose-Projekts und des Labelsbombvault.datagefunden (siehe Erkennung der Sicherungsquellen). Benannte Volumes und die/etc-Vorlage erreichen nur Pfade innerhalb des Host-Data-Mounts, richte Host Data also auf einen gemeinsamen Vorfahren, der auch die Datenwurzel von Docker abdeckt. PLATFORM. Setze es aufgenericodertruenas. Ungesetzt erkennt BombVault Unraid an seiner eigenen Markierung am Flash-Mount und behandelt alles andere als generisch, und die Unraid-only-Schritte werden übersprungen, statt versucht zu werden und zu scheitern.
TrueNAS SCALE¶
BombVault ist noch nicht im TrueNAS-App-Katalog, installiere es also als benutzerdefinierte App: Apps, Discover Apps, dann Install via YAML im Menü neben Custom App. Das YAML unten setzt dasselbe wie der Katalogeintrag im Ordner truenas-apps des Repositorys. Ersetze tank durch deinen Pool und trage APP_KEY ein, wie der nächste Abschnitt es beschreibt.
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"
Öffne dann https://<truenas-ip>:30528/. Was unter Was anders ist als auf Unraid steht, gilt auch hier, und auf TrueNAS außerdem:
- Capabilities. BombVault braucht die sieben oben. Die VM-Sicherung scheitert ohne
SETPCAP, und ohneSYS_CHROOTwird jeder Container für seine ganze Sicherung angehalten, statt aus einem Snapshot gelesen zu werden. - Host Data ist ein Host-Pfad auf einem Dataset, hier
/mnt/tank, im selben Pfad in der App gemountet. Deshalb nennenHOST_SOURCE_ROOTundHOST_MOUNT_ROOTihn beide.rslavereicht die Mounts weiter, die der Host später macht, was ZFS-Dataset-Sicherungen brauchen. - Daten in einem ixVolume werden nicht gesichert. Eine App, deren Speicher ein ixVolume ist, hält ihre Daten unter
/mnt/.ix-apps, außerhalb von Host Data. BombVault sichert nur die Definition der App, und der Lauf nennt die Ordner, die er ausgelassen hat. Wähle für jede App, deren Daten gesichert werden sollen, den Speicher Host Path auf einem Dataset unterhalb von Host Data. - VM- und ZFS-Dataset-Sicherungen erreichen TrueNAS über SSH als root. Schalte den SSH-Dienst unter System, Services ein und füge den öffentlichen Schlüssel aus Einstellungen, Anbindungen, Host-SSH dem Benutzer root unter Credentials, Users hinzu. VM-Sicherungen brauchen außerdem
LIBVIRT_URIwie oben, weil der libvirtd von TrueNAS auf einem eigenen Socket lauscht. Sind wederLIBVIRT_URInochLIBVIRT_HOSTgesetzt, nutzt BombVault das Standard-Gateway der App als Host, da sichhost.docker.internalin einer TrueNAS-App nicht auflöst. Die Anleitung zur VM-Sicherung behandelt die Einzelheiten, auch VMs auf zvols. - Eine ZFS-Replik nutzt einen anderen Schlüssel. Eine Replik auf einem zweiten ZFS-Server meldet sich mit dem Schlüssel an, den der Replik-Dialog zeigt, nicht mit dem Host-SSH-Schlüssel. Füge diesen auf dem empfangenden Server hinzu.
- Eine gelöschte App kommt in zwei Schritten zurück. Installiere sie in TrueNAS zuerst unter demselben Namen neu, was ihr Netzwerk wieder anlegt, und stelle dann ihre Daten in BombVault wieder her. Bis dahin meldet die Wiederherstellungsprüfung das fehlende Netzwerk, und die Wiederherstellung lehnt ab, bevor sie etwas ändert.
- Neben das Original legt einen schlichten Docker-Container an. Er läuft, aber der Bildschirm Apps von TrueNAS listet ihn nicht auf.
- Datenbank-Dumps funktionieren auf Dataset-Mounts. Ein Import in einen Datenordner, der ein eigenes Dataset ist, verschiebt den alten Inhalt in einen Ordner daneben, das darüberliegende Dataset braucht also Platz dafür.
ZimaOS, CasaOS und andere Hosts¶
- ZimaOS und CasaOS: Füge den Community-Store hinzu und installiere BombVault daraus. Es läuft dort als
PLATFORM=genericmit Host Data auf/DATA. ZimaOS hält App-Daten in/DATA/AppData/<app>, was BombVault von selbst findet, daDATA_ROOT_SEGMENTSappdatain jeder Schreibweise trifft. - MOS: Installiere BombVault aus dem MOS Hub. Es läuft dort als
PLATFORM=genericmit Host Data auf/mnt/cache. - Synology: Lege im Container Manager ein Projekt aus der Compose-Datei an (DSM 7.2 oder neuer).
- Proxmox: Betreibe es in einer VM oder einem LXC-Container, der Docker hat.
Ohne Kommentare ist die generische Compose-Datei kurz. Ersetze ./data durch den Host-Ordner, der die Daten deiner Container enthält, setze HOST_SOURCE_ROOT auf denselben Pfad und trage APP_KEY ein:
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"
Um auch benannte Docker-Volumes zu sichern, mounte einen Ordner, der sowohl deine Daten als auch die Datenwurzel von Docker enthält (docker info -f '{{.DockerRootDir}}', meist /var/lib/docker), so wie das Unraid-Template ganz /mnt mountet.
Die eine erforderliche Einstellung¶
Die einzige Variable, die du setzen musst, ist APP_KEY, ein Hex-Geheimnis mit 32 Byte (64 Hex-Zeichen), aus dem das Passwort des restic-Repositorys abgeleitet wird.
Erzeuge eines auf einem beliebigen Rechner:
Füge das Ergebnis in das Feld APP_KEY des Templates (Unraid) oder die Umgebungsvariable APP_KEY in docker-compose.yml (generischer Docker-Host) ein.
Verliere deinen APP_KEY nicht
Geht APP_KEY verloren, sind deine verschlüsselten Sicherungen unwiederbringlich. Bewahre ihn an einem sicheren Ort getrennt vom Server auf. Sobald BombVault läuft, setze ein Login-Passwort und lade das Recovery-Kit unter Einstellungen, Wiederherstellung herunter (siehe Off-site und Wiederherstellung). Es enthält den Schlüssel, jeden Speicherort und die restic-Befehle.
Das Template mountet außerdem den Docker-Socket, den Flash (/boot) und die Host Data-Wurzel (/mnt) für dich. Sicherungs-Quellen und -Ziele liegen beide unter Host Data. Die vollständige Variablenreferenz und die Off-site-Einrichtung stehen unter Konfiguration.
Erster Start¶

- Öffne die Web-UI unter
https://<deine-unraid-ip>:3443(selbstsigniertes Zertifikat ab Werk). Eine neue Installation öffnet sich auf Willkommen bei BombVault, was auflistet, was BombVault auf dem Server gefunden hat. - Wähle Los geht’s. Die Übersicht zeigt dann die Karte Erste Schritte mit drei Schritten:
- Bereiche wählen: Schalte ein, was BombVault sichert (Container, VMs, Flash, Ordner, ZFS-Datasets, Selbstsicherung). Auswählen öffnet die Liste der Einträge eines Bereichs, wo Zeitplan pausieren einen auslässt. Die Bereiche, die du hier einschaltest, laufen jede Nacht, was du unter Einstellungen, Zeitplan änderst.
- Speicherort hinzufügen: ein zweiter Ort für die Sicherungen. Jeder Bereich hat schon einen Ordner auf diesem Server,
/mnt/user/bombvault/{container,vms,flash,config,files,zfs}, bei der ersten Sicherung angelegt. Am sichersten ist ein zweiter Speicherort außer Haus, etwa eine Storage Box oder Backblaze B2. - Erste Sicherung: Danach läuft sie jede Nacht von selbst. Die Karte bleibt, bis die erste Sicherung durchgelaufen ist.
- Öffne Sicherungen, um jeden Eintrag in einer Liste zu sehen. Jetzt alles sichern startet einen Lauf über alle eingeschalteten Bereiche, und Jetzt sichern auf der Seite eines Eintrags sichert nur diesen.

BombVault schon früher benutzt? Aus einer Sicherung wiederherstellen auf der Willkommensseite öffnet die Seite Wiederherstellung, wo der Notfall-Assistent die Einstellungen, Container, VMs und Ordner eines verlorenen Servers zurückholt. Siehe Off-site und Wiederherstellung.
Optional: eine Sicherungsreihenfolge festlegen
Sollen manche Container immer vor anderen gesichert werden (zum Beispiel eine Datenbank vor der App, die sie nutzt), öffne die Karte Reihenfolge unter Einstellungen, Zeitplan und zieh sie in die gewünschte Folge. Geplante Läufe und die Gesamtsicherung richten sich dann danach. Was du ohne Reihenfolge lässt, wird nach dem am längsten Überfälligen zuerst gesichert.
Beispiel: deine erste Container-Sicherung von A bis Z¶
Das führt durch eine frische Unraid-Box mit ein paar Containern, darunter plex, bis die erste Sicherung fertig ist und du weißt, wo du sie findest. Es dauert etwa zehn Minuten plus die Zeit der ersten Sicherung.
- Installieren. Suche im Unraid-Tab Apps nach BombVault und drücke Install.
- Den Schlüssel setzen. Führe auf einem Rechner
openssl rand -hex 32aus und füge die 64 Zeichen in das FeldAPP_KEYdes Templates ein. Leg gleich jetzt eine Kopie in deinem Passwortmanager ab, vor allem anderen. Drücke Apply. - Öffnen. Gehe zu
https://<deine-unraid-ip>:3443und akzeptiere das selbstsignierte Zertifikat. Willkommen bei BombVault listet auf, was es gefunden hat, etwa 12 Container, 2 VMs und den Flash. - Los geht’s. Die Übersicht öffnet sich mit der Karte Erste Schritte.
- Bereiche wählen. Container ist von Anfang an an. Schalte ein, was du sonst willst, etwa Flash. Auswählen öffnet die Liste der gefundenen Container, wo Zeitplan pausieren einen auslässt, zum Beispiel einen Testcontainer, der dir egal ist. Eingeschaltete Bereiche laufen jede Nacht in der Gesamtsicherung.
- Speicherort hinzufügen. Jeder Bereich hat schon einen eigenen Ordner auf diesem Server, unterhalb von
/mnt/user/bombvault, die erste Sicherung hat also ein Ziel. Dieser Schritt fügt einen zweiten Ort hinzu, und der sicherste liegt außer Haus. Das kannst du jetzt mit dem S3-Beispiel tun oder zurückkommen, wenn die erste Sicherung durch ist. Die Karte bleibt bis dahin. - Erste Sicherung. Öffne Sicherungen und drücke Jetzt alles sichern, oder warte auf die Nacht. Der Ring im Statuskopf wird zum Fortschrittsring und zählt die Einträge, etwa Sichert gerade: 3 von 12. Jeder Container wird angehalten, während seine Daten gelesen werden, und gleich danach wieder gestartet. Ein Container, dessen Daten auf ZFS liegen, steht nur die wenigen Sekunden eines Snapshots still. Die erste Sicherung liest alles und dauert daher am längsten. Spätere speichern nur, was sich geändert hat.
- Prüfen. Sagt der Ring Alles gesichert, öffne Verlauf in der Übersicht: Jeder Container hat unter Läufe eine grüne Zeile. Öffne Sicherungen, klicke
plexan und sieh dir seinen Tab Sicherungen an: Der erste Snapshot ist da, mit Lokal als dem Ort, der ihn hält. Ein paar Minuten später zeigt sein Tab Prüfung die Wiederherstellungsprüfung, die eine Stichprobe der Sicherung wiederhergestellt und zurückgelesen hat. - Den Schlüssel schützen. Öffne Einstellungen, Sicherheit und setze ein Login-Passwort. Öffne dann Einstellungen, Wiederherstellung und drücke in Für den Notfall Recovery-Kit herunterladen. Bewahre die Datei außerhalb des Servers auf, neben der Kopie von
APP_KEYaus Schritt 2. Die Erinnerung Sichere dein Recovery-Kit in der Übersicht verschwindet, sobald du Sicher aufbewahrt drückst.
Ab jetzt werden die Container jede Nacht gesichert. Gute nächste Schritte, in dieser Reihenfolge: ein Off-site-Speicherort, damit ein toter Server die Sicherungen nicht mitnimmt, dann Benachrichtigungen, damit dich ein Fehler erreicht, dann ein Blick in die Zeitpläne, falls dir 03:00 nicht passt.

Host-Integrations-Check
Die Karte Host-Integration in der Übersicht prüft jeden Mount und jedes CLI (Docker-Socket, libvirt, restic, qemu-img, rclone) und meldet fehlende Teile, damit du bestätigen kannst, dass der Container richtig verdrahtet ist, bevor du dich darauf verlässt. Sie wartet unter Anpassen, bis du sie hinzufügst.
Einen VPS als Knoten sichern¶
Ein VPS oder ein anderer kleiner Server braucht kein eigenes BombVault mit Weboberfläche. Füge ihn als Knoten dieser Instanz hinzu, dann kümmert sich diese Instanz um seine Sicherungen:
- Setze unter Einstellungen, Sicherheit ein Login-Passwort, falls du noch keines hast.
- Öffne Instanzen, wähle Knoten hinzufügen und gib einen Namen ein, etwa
vps-helsinki. - Wähle, wohin seine Sicherungen gehen, etwa auf den Empfangsserver dieser Instanz, und wann er sichert.
- Kopiere die Compose-Datei aus dem Fenster auf den Server, richte ihr Volume Host Data und
HOST_SOURCE_ROOTauf die Daten, die gesichert werden sollen, und führedocker compose up -daus.
Sobald der Knoten antwortet, sagt seine Karte Verbunden, und seine Container erscheinen unter Sicherungen. Knoten geht das Ganze an einem Beispiel durch.
Sich zurechtfinden¶

Die Seitenleiste hat fünf Einträge: Übersicht, Anomalien (solange die Anomalie-Erkennung an ist), Sicherungen, Wiederherstellung und, unter Abmelden, Einstellungen. Die Hauptaktion einer Seite schwebt unten rechts, und Mehr enthält die seltenen. Auf einem Handy enthält die Leiste Übersicht, Sicherungen, Wiederherstellung und Einstellungen, und Mehr hat den Rest.
Seiten und Einstellungen nutzen die ganze Breite des Fensters. Ein Fenster hält seine Knöpfe in seinem Fuß, der nach vorn führende rechts. Auf einem Handy behält ein Fuß mit mehr als drei Knöpfen den Ausweg und die Hauptaktion und legt die anderen unter Mehr.

- Die Übersicht zeigt, ob alles gesichert ist und was dich braucht. Siehe Übersicht.
- Sicherungen listet jeden Container, jede VM, jedes Ordner-Set, den Flash, jedes ZFS-Dataset und die Selbstsicherung als Einträge auf. Kacheln über der Liste wählen eine Art, und Filter, Sortieren und Suchen grenzen sie ein. Jeder Eintrag hat eine eigene Seite mit drei Tabs: Sicherungen, Einstellungen und Prüfung. Ein Zurück-Knopf links vom Symbol des Eintrags führt zur Liste. Siehe Sicherungen und Einträge.
- Wiederherstellung ist eine Seite für alles: Wähle einen Bereich, suche einen Eintrag und wähle eine Sicherung. Auch der Notfall-Assistent und die anderen Quellen starten hier. Siehe Wiederherstellung.
- Die Einstellungen sind vierzehn Kacheln: Allgemein, Aussehen, Zeitplan, Speicherorte, Wiederherstellung, Benachrichtigungen, Prüfung, Sicherheit, Instanzen, Kopplung, Anbindungen, Apps, System und Info. Siehe Einstellungen. Drücke
/oder Strg+K, um alle zu durchsuchen, auch nach den Namen, die Seiten in früheren Versionen hatten. Zieh die Kacheln unter Aussehen in deine eigene Reihenfolge. Wo eine Kachelspalte neben der Seite sie zusammendrücken würde, etwa in einem Fenster von etwa 1200 Pixeln Breite, werden die Kacheln zu einem Streifen über der Seite, der seitlich scrollt. Ein Handy zeigt denselben Streifen. - Speicherorte und Instanzen sind Einstellungskacheln mit eigenen Seiten. Auch in der Seitenleiste zeigen auf ihrer Kachel heftet sie an die Seitenleiste.
Nichts hat einen Speichern-Knopf, und nichts klappt auf: Seltenes hat eine eigene Karte oder ein Fenster, und Erklärungen stehen in den (i)-Blasen. Nach einem Update öffnet sich von selbst ein Fenster mit einer Karte für jede Version seit deiner letzten, und grüne Punkte markieren, was sich geändert hat. Ein Klick blendet einen Punkt aus. Neu in der Karte Version unter Einstellungen, Info zählt, was du noch nicht gesehen hast, und öffnet dieses Fenster wieder, mit den Hinweisen jeder Version und ihren Änderungen mit Hingehen.
Aus dem Quellcode bauen¶
BombVault ist eine einzelne statische Go-Binärdatei, die eine JSON-API und eine eingebettete React-Oberfläche liefert. Baue zuerst die Oberfläche und starte dann die Binärdatei:
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
Der Bau der Oberfläche ist auch für go run nötig. Das Repository verfolgt unter web/dist nur eine leere Markierung, ohne npm --prefix web run build bettet die Binärdatei also nichts ein und antwortet 500 SPA index not found, was zu erwarten ist. Docker, libvirt und Unraid lassen sich in der CI nicht testen, prüfe daher Mounts, restic und die VM-SSH-Verbindung auf einem echten Host mit der Karte Host-Integration der Übersicht (oder GET /api/spike), bevor du einen Pull Request öffnest.
Nächste Schritte¶
- Füge einen oder mehrere Speicherorte außer Haus hinzu (jeder Bereich kann auf mehrere zugleich kopieren) und sichere dein Recovery-Kit, wie unter Off-site und Wiederherstellung beschrieben. Das S3-Beispiel führt durch einen.
- Sorge mit Benachrichtigungen dafür, dass dich ein Fehler erreicht.
- Prüfe unter Zeitpläne, wann was läuft.
- Bring mit der Android-App jeden Server deiner Gruppe aufs Handy.
- Sichere von hier aus einen VPS mit einem Knoten.
- Die Praxisbeispiele führen durch die üblichen Aufgaben, und Funktionen listet alles auf, was BombVault kann.
- Eine Einrichtung klonen oder auf eine neue Box umziehen? Nimm deine ganze Konfiguration mit der Karte Einstellungen exportieren / importieren mit. Siehe Konfiguration.
- Hakt etwas? Siehe Fehlersuche.