Aan de slag¶
Deze pagina leidt je van een verse Unraid-machine naar je eerste back-up.
Vereisten¶
| Vereiste | Opmerkingen |
|---|---|
| Unraid 6.12+ | Eerdere versies zijn niet getest. Unraid is het hoofddoel, maar BombVault draait ook op een gewone Docker-host en op TrueNAS Scale (zie Gewone Docker-host en TrueNAS SCALE). |
| Locatie van het restic-repository | Een lokaal pad (aanbevolen: je array of cache), SMB, NFS of een willekeurige rclone-backend. |
| Docker-socket | Automatisch gemount door de template (/var/run/docker.sock). |
Unraid-flash (/boot) |
In zijn geheel automatisch gemount door de template (/boot naar /host/boot). Maakt de flash-back-up mogelijk en laat een herstelde container weer verschijnen als een gewone, bewerkbare Unraid-app. |
| KVM-VM's (optioneel) | VM-back-up praat met libvirt via SSH, zonder libvirt-mount. Stel het in onder Instellingen, Integraties, Host-SSH (zie Configuratie). |
| ZFS-datasets (optioneel) | Dezelfde SSH-verbinding als bij VM-back-ups, zfs op de host, en Host Data gekoppeld als /mnt met toegangsmodus Read/Write - Slave, de standaard van de template. Zie ZFS-datasets. |
| Android-app (optioneel) | Android 10 of nieuwer, gekoppeld met servers op versie 9.7.0 of nieuwer. Zie Android-app. |
Installeren op Unraid¶
De makkelijkste weg is Community Applications.
- Open het tabblad Apps in Unraid.
- Zoek naar BombVault.
- Klik op Install, stel de vereiste variabelen in (hieronder) en pas toe.
Template handmatig installeren
Voeg je de template liever zelf toe:
- Ga naar Docker, Add Container, Template repositories en voeg toe:
- Zoek bij Templates naar BombVault.
- Stel de vereiste variabelen in en klik op Apply.
Gewone Docker-host¶
Geen Unraid? BombVault draait ook als gewone container op elke Docker-host. TrueNAS SCALE heeft eigen stappen onder TrueNAS SCALE.
- Haal het kant-en-klare, bewerkbare bestand
deploy/docker-compose.generic.ymluit de repo. - Stel
APP_KEYin (zie hieronder) en wijs het Host Data-volume naar je echte dataroot. De opmerkingen in het bestand lopen beide langs. docker compose up -d, en open danhttps://<host-ip>:3443/.
Wat anders is dan op Unraid:
- Geen onderdeel Flash. Er is geen boot-USB om te bewaren of te herstellen, dus het onderdeel Flash heeft hier niets te doen. Reikt Host Data tot
/etcvan de host, dan biedt Toevoegen op de pagina Back-ups in plaats daarvan Systeemconfiguratie aan als mapsuggestie: een voorgestelde mappenset voor/etcdie je nakijkt en bewerkt voordat je opslaat. - Geen eigen meldingen van Unraid. De meldingskanalen in de app van BombVault zelf (webhook, waarschuwingen bij mislukte off-site-kopieën enzovoort) werken gewoon. Alleen de Unraid-specifieke push naar het eigen meldingssysteem wordt overgeslagen, omdat er zo'n systeem niet is.
- VM-back-up is optioneel en heeft een aparte libvirtd-host nodig die via SSH bereikbaar is. Zie het uitgecommentarieerde blok in het compose-bestand. Een gewone Docker-host heeft zelf geen VM-beheer.
- Geen dashboardtegel. TollRoll is een Unraid-plug-in, dus ook die stap wordt overgeslagen.
- De data van een container vinden. Zonder de
appdata-conventie van Unraid wordt de datamap van een container gevonden via de segmenten inDATA_ROOT_SEGMENTS, Docker-benoemde volumes, de werkmap van een Compose-project en het labelbombvault.data(zie Detectie van back-upbronnen). Benoemde volumes en de preset voor/etcbereiken alleen paden binnen de Host Data-mount, dus wijs Host Data naar een gemeenschappelijke voorouder die ook de dataroot van Docker omvat. PLATFORM. Zet het opgenericoftruenas. Laat je het leeg, dan detecteert BombVault Unraid aan zijn eigen markering op de flash-mount en behandelt alles anders als generiek, en worden de stappen die alleen voor Unraid zijn overgeslagen in plaats van geprobeerd en mislukt.
TrueNAS SCALE¶
BombVault staat nog niet in de TrueNAS-appcatalogus, dus installeer het als eigen app: Apps, Discover Apps, daarna Install via YAML in het menu naast Custom App. De YAML hieronder stelt hetzelfde in als het catalogusitem in de map truenas-apps van de repository. Vervang tank door je pool en vul APP_KEY in zoals de volgende sectie beschrijft.
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"
Open daarna https://<truenas-ip>:30528/. Wat onder Wat anders is dan op Unraid staat, geldt ook hier, en op TrueNAS geldt bovendien:
- Capabilities. BombVault heeft de zeven hierboven nodig. Zonder
SETPCAPmislukken VM-back-ups, en zonderSYS_CHROOTwordt elke container voor zijn hele back-up gestopt in plaats van uit een snapshot gelezen. - Host Data is een hostpad op een dataset, hier
/mnt/tank, op hetzelfde pad in de app gemount. Daarom noemenHOST_SOURCE_ROOTenHOST_MOUNT_ROOThet allebei.rslavegeeft de mounts door die de host later maakt, wat back-ups van ZFS-datasets nodig hebben. - Data in een ixVolume wordt niet geback-upt. Een app waarvan de opslag een ixVolume is, bewaart zijn data onder
/mnt/.ix-apps, buiten Host Data. BombVault bewaart alleen de definitie van de app, en de run noemt de mappen die hij heeft overgeslagen. Kies voor elke app waarvan je de data wilt back-uppen opslag van het type Host Path op een dataset onder Host Data. - Back-ups van VM's en ZFS-datasets bereiken TrueNAS via SSH als root. Zet de SSH-service aan onder System, Services, en voeg de publieke sleutel uit Instellingen, Integraties, Host-SSH toe aan de gebruiker root onder Credentials, Users. VM-back-ups hebben ook
LIBVIRT_URInodig zoals hierboven, omdat libvirtd van TrueNAS op een eigen socket luistert. Zijn nochLIBVIRT_URInochLIBVIRT_HOSTingesteld, dan gebruikt BombVault de standaardgateway van de app als host, omdathost.docker.internalin een TrueNAS-app niet oplost. De VM-back-upgids behandelt de details, VM's op zvols inbegrepen. - Een ZFS-replica gebruikt een andere sleutel. Een replica op een tweede ZFS-server logt in met de sleutel die het replicavenster toont, niet met de Host-SSH-sleutel. Voeg die toe op de ontvangende server.
- Een verwijderde app komt in twee stappen terug. Installeer hem eerst in TrueNAS opnieuw onder dezelfde naam, wat zijn netwerk opnieuw aanmaakt, en herstel dan zijn data in BombVault. Tot dan meldt de herstelcontrole het ontbrekende netwerk en weigert het herstel voordat het iets verandert.
- Naast het origineel maakt een gewone Docker-container aan. Die draait, maar het scherm Apps van TrueNAS toont hem niet.
- Databasedumps werken op datasetmounts. Een import in een datamap die een eigen dataset is, verplaatst de oude inhoud naar een map ernaast, dus de dataset erboven heeft ruimte nodig voor die inhoud.
ZimaOS, CasaOS en andere hosts¶
- ZimaOS en CasaOS: voeg de communitystore toe en installeer BombVault daaruit. Het draait er als
PLATFORM=genericmet Host Data op/DATA. ZimaOS bewaart appdata in/DATA/AppData/<app>, wat BombVault zelf vindt, omdatDATA_ROOT_SEGMENTSappdatain elke schrijfwijze herkent. - MOS: installeer BombVault uit de MOS Hub. Het draait er als
PLATFORM=genericmet Host Data op/mnt/cache. - Synology: maak in Container Manager een project aan uit het compose-bestand (DSM 7.2 of nieuwer).
- Proxmox: draai het in een VM of een LXC-container met Docker.
Zonder opmerkingen is het generieke compose-bestand kort. Vervang ./data door de hostmap met de data van je containers, zet HOST_SOURCE_ROOT op datzelfde pad en vul APP_KEY in:
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"
Om ook Docker-benoemde volumes te back-uppen, mount je een map die zowel je data als de dataroot van Docker bevat (docker info -f '{{.DockerRootDir}}', meestal /var/lib/docker), zoals de Unraid-template heel /mnt mount.
De enige vereiste instelling¶
De enige variabele die je moet instellen is APP_KEY, een geheim van 32 bytes in hex (64 hex-tekens) waarmee het wachtwoord van het restic-repository wordt afgeleid.
Genereer er een op een willekeurige machine:
Plak het resultaat in het veld APP_KEY van de template (Unraid), of in de omgevingsvariabele APP_KEY in docker-compose.yml (gewone Docker-host).
Raak je APP_KEY niet kwijt
Raak je APP_KEY kwijt, dan zijn je versleutelde back-ups onherstelbaar. Bewaar hem ergens veilig en gescheiden van de server. Stel zodra BombVault draait een inlogwachtwoord in en download de herstelkit onder Instellingen, Herstel (zie Off-site en herstel). Die bevat de sleutel, elke bestemming en de restic-opdrachten.
De template mount ook de Docker-socket, de flash (/boot) en de Host Data-root (/mnt) voor je. Back-upbronnen en -bestemmingen staan allebei onder Host Data. Voor de volledige variabelenreferentie en de off-site-instelling, zie Configuratie.
Eerste keer starten¶

- Open de webinterface op
https://<je-unraid-ip>:3443(standaard een zelfondertekend certificaat). Een nieuwe installatie opent op Welkom bij BombVault, dat toont wat BombVault op de server heeft gevonden. - Kies Aan de slag. Het overzicht toont dan de kaart Eerste stappen met drie stappen:
- Kies onderdelen: schakel in wat BombVault back-upt (Containers, VM's, Flash, Mappen, ZFS-datasets, Zelf-back-up). Kiezen opent de lijst met items van een onderdeel, waar Schema pauzeren er een weglaat. De onderdelen die je hier inschakelt, draaien elke nacht, wat je wijzigt onder Instellingen, Planning.
- Bestemming toevoegen: een tweede plek voor de back-ups. Elk onderdeel heeft al een map op deze server,
/mnt/user/bombvault/{container,vms,flash,config,files,zfs}, aangemaakt bij de eerste back-up. Het veiligst is een tweede bestemming buiten de locatie, zoals een Storage Box of Backblaze B2. - Eerste back-up: daarna loopt het elke nacht vanzelf. De kaart blijft staan tot de eerste back-up klaar is.
- Open Back-ups om elk item in één lijst te zien. Nu alles back-uppen start een run over alle ingeschakelde onderdelen, en Nu back-up maken op de pagina van een item maakt alleen van dat item een back-up.

BombVault al eerder gebruikt? Herstellen vanaf een back-up op de welkomstpagina opent de pagina Herstel, waar de Noodassistent de instellingen, containers, VM's en mappen van een verloren server terugbrengt. Zie Off-site en herstel.
Optioneel: kies een back-upvolgorde
Moeten sommige containers altijd vóór andere worden geback-upt (bijvoorbeeld een database vóór de app die hem gebruikt), open dan de kaart Volgorde onder Instellingen, Planning en sleep ze in de gewenste reeks. Geplande runs en de volledige back-up volgen die dan. Alles wat je ongeordend laat, wordt geback-upt met de langst achterstallige eerst.
Voorbeeld: je eerste containerback-up, van begin tot eind¶
Dit loopt langs een verse Unraid-machine met een paar containers, onder meer plex, tot de eerste back-up klaar is en je weet waar je hem vindt. Het duurt ongeveer tien minuten plus de tijd van de eerste back-up.
- Installeren. Zoek in het Unraid-tabblad Apps naar BombVault en druk op Install.
- De sleutel instellen. Voer op een computer
openssl rand -hex 32uit en plak de 64 tekens in het veldAPP_KEYvan de template. Bewaar nu meteen een kopie in je wachtwoordmanager, vóór al het andere. Druk op Apply. - Openen. Ga naar
https://<je-unraid-ip>:3443en accepteer het zelfondertekende certificaat. Welkom bij BombVault toont wat het vond, zoals 12 containers, 2 VM's en de flash. - Aan de slag. Het overzicht opent met de kaart Eerste stappen.
- Kies onderdelen. Containers staat vanaf het begin aan. Schakel in wat je verder wilt, zoals Flash. Kiezen opent de lijst met containers die het vond, waar Schema pauzeren er een weglaat, bijvoorbeeld een testcontainer waar je niets om geeft. Ingeschakelde onderdelen draaien elke nacht in de volledige back-up.
- Bestemming toevoegen. Elk onderdeel heeft al een eigen map op deze server, onder
/mnt/user/bombvault, dus de eerste back-up heeft een plek om naartoe te gaan. Deze stap voegt een tweede plek toe, en de veiligste ligt buiten de locatie. Je kunt dat nu doen met het S3-voorbeeld, of erop terugkomen als de eerste back-up klaar is. De kaart blijft tot dan staan. - Eerste back-up. Open Back-ups en druk op Nu alles back-uppen, of wacht op de nacht. De ring in de statuskop wordt een voortgangsring en telt de items, zoals Back-up wordt gemaakt: 3 van 12. Elke container wordt gestopt terwijl zijn data wordt gelezen en meteen daarna weer gestart. Een container waarvan de data op ZFS ligt, ligt maar de paar seconden van een snapshot stil. De eerste back-up leest alles, dus die duurt het langst. Latere slaan alleen op wat veranderde.
- Controleren. Als de ring Alles is geback-upt zegt, open dan Geschiedenis op het overzicht: elke container heeft een groene lijn bij Runs. Open Back-ups, klik op
plexen kijk op zijn tabblad Back-ups: de eerste snapshot staat er, met Lokaal als de plek die hem bevat. Een paar minuten later toont zijn tabblad Verificatie de herstelcontrole, die een steekproef van de back-up herstelde en teruglas. - De sleutel beschermen. Open Instellingen, Beveiliging en stel een inlogwachtwoord in. Open daarna Instellingen, Herstel en druk in Voor noodgevallen op Herstelkit downloaden. Bewaar het bestand buiten de server, naast de kopie van
APP_KEYuit stap 2. De herinnering Bewaar je herstelkit op het overzicht verdwijnt zodra je op Ik heb hem veilig bewaard drukt.
Vanaf nu worden de containers elke nacht geback-upt. Goede volgende stappen, in deze volgorde: een off-site-bestemming, zodat een kapotte server de back-ups niet meeneemt, dan meldingen, zodat een mislukking je bereikt, en dan een blik op Planningen als 03:00 je niet uitkomt.

Controle van de hostintegratie
De kaart Host-integratie op het overzicht test elke mount en elk CLI-programma (Docker-socket, libvirt, restic, qemu-img, rclone) en meldt wat er ontbreekt, zodat je kunt controleren of de container goed is aangesloten voordat je erop vertrouwt. Hij wacht onder Aanpassen tot je hem toevoegt.
Een VPS als node back-uppen¶
Een VPS of een andere kleine server heeft geen eigen BombVault met webinterface nodig. Voeg hem toe als node van deze, en deze instantie zorgt voor zijn back-ups:
- Stel onder Instellingen, Beveiliging een inlogwachtwoord in, als je dat nog niet hebt gedaan.
- Open Instanties, kies Node toevoegen en typ een naam zoals
vps-helsinki. - Kies waar zijn back-ups heen gaan, bijvoorbeeld de ontvangserver van deze instantie, en wanneer hij een back-up maakt.
- Kopieer het compose-bestand uit het venster naar de server, richt zijn volume Host Data en
HOST_SOURCE_ROOTop de data waarvan je een back-up wilt en voerdocker compose up -duit.
Zodra de node antwoordt, zegt zijn kaart Verbonden en verschijnen zijn containers onder Back-ups. Nodes loopt het met een voorbeeld door.
Je weg vinden¶

De zijbalk heeft vijf onderdelen: Overzicht, Anomalieën (zolang anomaliedetectie aanstaat), Back-ups, Herstel en, onder Afmelden, Instellingen. De hoofdactie van een pagina zweeft rechtsonder, en Meer bevat de zeldzame. Op een telefoon bevat de balk Overzicht, Back-ups, Herstel en Instellingen, en Meer de rest.
Pagina's en instellingen gebruiken de hele breedte van het venster. Een venster houdt zijn knoppen onderaan, met de knop die vooruit gaat rechts. Op een telefoon houdt een voet met meer dan drie knoppen de uitweg en de hoofdactie en zet de andere onder Meer.

- Overzicht toont of alles is geback-upt en wat je aandacht nodig heeft. Zie Overzicht.
- Back-ups toont elke container, VM, mappenset, de flash, elke ZFS-dataset en de zelf-back-up als items. Tegels boven de lijst kiezen een soort, en Filters, Sorteren en Zoeken versmallen haar. Elk item heeft een eigen pagina met drie tabbladen: Back-ups, Instellingen en Verificatie. Een terugknop links van het icoon van het item leidt naar de lijst. Zie Back-ups en items.
- Herstel is één pagina voor alles: kies een onderdeel, zoek een item en kies een back-up. De Noodassistent en de andere bronnen beginnen hier ook. Zie Herstel.
- Instellingen zijn veertien tegels: Algemeen, Uiterlijk, Planning, Bestemmingen, Herstel, Meldingen, Verificatie, Beveiliging, Instanties, Koppeling, Integraties, Apps, Systeem en Info. Zie Instellingen. Druk op
/of Ctrl+K om ze allemaal te doorzoeken, ook op de namen die pagina's in eerdere versies hadden. Sleep de tegels in je eigen volgorde onder Uiterlijk. Waar een kolom met tegels naast de pagina haar zou samenknijpen, zoals in een venster van ongeveer 1200 pixels breed, worden de tegels een strook boven de pagina die zijwaarts scrolt. Een telefoon toont dezelfde strook. - Bestemmingen en Instanties zijn instellingentegels met eigen pagina's. Ook in de zijbalk tonen op hun tegel zet ze vast in de zijbalk.
Niets heeft een knop Opslaan en niets klapt open: zeldzame dingen hebben een eigen kaart of een venster, en uitleg staat in de (i)-bubbels. Na een update opent vanzelf een venster met een kaart voor elke release sinds je laatste versie, en groene stippen markeren wat is veranderd. Een klik verbergt een stip. Nieuw in de kaart Versie onder Instellingen, Info telt wat je nog niet hebt gezien en opent dat venster opnieuw, met de notities van elke release en zijn wijzigingen met Ga erheen.
Bouwen uit de broncode¶
BombVault is één statische Go-binary die een JSON-API en een ingebouwde React-interface serveert. Bouw eerst de interface en draai dan de binary:
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
De interfacebuild is ook voor go run nodig. De repository volgt onder web/dist alleen een lege markering, dus zonder npm --prefix web run build bevat de binary niets en antwoordt hij 500 SPA index not found, wat te verwachten is. Docker, libvirt en Unraid kunnen niet in CI worden getest, dus controleer mounts, restic en de VM-SSH-verbinding op een echte host met de kaart Host-integratie van het overzicht (of GET /api/spike) voordat je een pull request opent.
Volgende stappen¶
- Voeg een of meer bestemmingen buiten de locatie toe (elk onderdeel kan naar meerdere tegelijk kopiëren) en bewaar je herstelkit, zoals beschreven onder Off-site en herstel. Het S3-voorbeeld loopt er een door.
- Zorg dat een mislukking je bereikt met Meldingen.
- Kijk wanneer dingen draaien onder Planningen.
- Zet elke server van je groep op je telefoon met de Android-app.
- Maak van hieruit back-ups van een VPS met een node.
- De uitgewerkte voorbeelden lopen de gebruikelijke klussen langs, en Functies toont alles wat BombVault doet.
- Een opstelling klonen of naar een nieuwe machine verhuizen? Neem je hele configuratie mee met de kaart Instellingen exporteren / importeren. Zie Configuratie.
- Loop je ergens op vast? Zie Problemen oplossen.