Ga naar inhoud

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 Generieke Docker-host).
Locatie restic-repo Een lokaal pad (aanbevolen: je array of cache), SMB, NFS, of elke 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 flash-back-up mogelijk en laat een herstelde container weer verschijnen als een normale, bewerkbare Unraid-app.
KVM-VM's (opt-in) VM-back-up praat met libvirt via SSH, geen libvirt-mount. Stel het in bij Instellingen (zie Configuratie).
ZFS-datasets (opt-in) Dezelfde SSH-verbinding als voor VM-back-ups, zfs op de host, en Host Data gemapt 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.

  1. Open het tabblad Apps in Unraid.
  2. Zoek naar BombVault.
  3. Klik op Install, stel de vereiste variabelen (hieronder) in en pas toe.

Template handmatig installeren

Als je de template liever met de hand toevoegt:

  1. Ga naar Docker, Add Container, Template repositories en voeg toe: 
    https://github.com/junkerderprovinz/unraid-apps
  2. Zoek naar BombVault in Templates.
  3. Stel de vereiste variabelen in en klik op Apply.

Generieke Docker-host

Geen Unraid? BombVault draait ook als gewone container op elke Docker-host (dat is ook waar de containerondersteuning op TrueNAS Scale op rust, vooruitlopend op een eigen vermelding in de app-catalogus daar).

  1. Haal het kant-en-klaar te bewerken bestand deploy/docker-compose.generic.yml uit de repository.
  2. Stel APP_KEY in (zie hieronder) en richt het Host Data-volume op je echte datawortel: de opmerkingen in het bestand lopen beide door.
  3. docker compose up -d, open daarna https://<host-ip>:3443/.

Wat er anders is dan bij Unraid:

  • Geen flash-/USB-domein. Er is geen opstart-USB om vast te leggen of terug te zetten, dus het Flash-domein in de instellingen heeft hier niets te doen. In plaats daarvan biedt het Mappen-domein de suggestie met één klik Voorinstelling toevoegen: hostsysteemconfiguratie (een eerste set /etc-bestanden die je nakijkt en aanpast voor je opslaat), als praktisch generiek equivalent.
  • Geen Unraid-eigen meldingen. BombVaults eigen meldingskanalen (webhook, waarschuwingen bij mislukte off-site en dergelijke) werken gewoon; alleen de Unraid-specifieke melding aan diens eigen meldingssysteem blijft achterwege, omdat zo'n systeem hier niet bestaat.
  • Back-up van virtuele machines is optioneel en vraagt een aparte libvirtd-host die via SSH bereikbaar is. Zie het uitgecommentarieerde blok in het compose-bestand. Een generieke Docker-host heeft zelf geen VM-beheer.
  • Geen dashboardwidget. De BombVault Widget is een Unraid-plugin, dus die stap vervalt ook.
  • De data van een container vinden. Zonder de appdata-conventie van Unraid wordt de datamap van een container gevonden via de segmenten in DATA_ROOT_SEGMENTS, benoemde Docker-volumes, de werkmap van een Compose-project en het label bombvault.data (zie Herkenning van de back-upbronnen). Benoemde volumes en de /etc-voorinstelling bereiken alleen paden binnen de Host Data-mount, dus richt Host Data op een gemeenschappelijke bovenliggende map die ook de dataroot van Docker omvat.
  • PLATFORM. Zet het op generic of truenas. Zonder waarde herkent BombVault Unraid aan diens eigen markering op de flash-mount en behandelt het al het andere als generiek, en worden de stappen die alleen voor Unraid zijn overgeslagen in plaats van geprobeerd en mislukt.

TrueNAS Scale volgt dezelfde compose-route; een catalogusvermelding is in de repository voorbereid, maar nog niet ingediend. VM-back-up heeft daar LIBVIRT_URI nodig, omdat de libvirtd van TrueNAS op een eigen socket luistert (/run/truenas_libvirt/libvirt-sock) die de drie LIBVIRT_*-variabelen niet kunnen uitdrukken (zie Configuratie). Hoe ver dit bewezen is: de zvol-back-up is uitgevoerd op een echte TrueNAS Scale-machine, op een zvol die aan een draaiende VM hing, en zfs snapshot, zfs send, restic en zfs receive brachten hem byte voor byte heen en terug. Een volledig herstel dat door BombVault zelf wordt aangestuurd, is nog niet op TrueNAS-hardware uitgevoerd, en die zvol was thin-provisioned, dus de doorvoer bij vele gigabytes is niet getest. Test daar een herstel voordat je erop vertrouwt.

De ene vereiste instelling

De enige variabele die je moet instellen is APP_KEY, een 32-byte hex-geheim (64 hex-tekens) dat wordt gebruikt om het wachtwoord van de restic-repository af te leiden.

Genereer er een op een willekeurige machine:

openssl rand -hex 32

Plak het resultaat in het APP_KEY-veld van de template (Unraid), of in de omgevingsvariabele APP_KEY in docker-compose.yml (generieke Docker-host).

Raak je APP_KEY niet kwijt

Als je APP_KEY kwijtraakt, zijn je versleutelde back-ups onherstelbaar. Bewaar het ergens veilig en gescheiden van de server. Zodra BombVault draait, gebruik je de herstelkit voor de encryptiesleutel met één klik (zie Off-site en herstel) om de volledige herstelbundel op te slaan.

De template mount ook de Docker-socket, de flash (/boot) en de root Host Data (/mnt) voor je. Back-upbronnen en bestemmingen leven allebei onder Host Data. Voor de volledige variabelenreferentie en de off-site setup, zie Configuratie.

Eerste keer draaien

Het dashboard na een eerste back-up: wat beschermd is, wat er volgt en een live logboek.

Het dashboard na een eerste back-up: wat beschermd is, wat er volgt en een live logboek.

  1. Open de web-UI op https://<jouw-unraid-ip>:3443 (out-of-the-box een zelfondertekend certificaat).
  2. Schakel bij Instellingen de back-updomeinen in die je wilt (Containers, VM's, Flash, Zelf-back-up, Mappen, ZFS-datasets) en kies een accentkleur.
  3. Kies op het tabblad Containers een container en klik op Nu back-up maken om je eerste herstelpunt te maken. Repository-paden gaan standaard naar /mnt/user/bombvault/{container,vms,flash,config,files,zfs} en worden bij de eerste back-up aangemaakt.
  4. Stel de planning in via Instellingen, Schema's. Er is een Alles in planning opnemen-optie met één klik voor containers en VM's.

Optioneel: kies een back-upvolgorde

Als sommige containers altijd vóór andere geback-upt moeten worden (bijvoorbeeld een database vóór de app die hem gebruikt), open dan het paneel Back-upvolgorde op de Containers-pagina en sleep ze in de gewenste volgorde. Geplande en meervoudige selecties volgen die volgorde daarna; alles wat je ongeordend laat, wordt geback-upt met het meest-achterstallige eerst, zoals voorheen.

Host-integratiecontrole

Open /spike in de web-UI nadat de container is gestart. Het test elke mount en CLI (Docker-socket, libvirt, restic, qemu-img, rclone) en meldt eventuele ontbrekende onderdelen, zodat je kunt bevestigen dat de container correct is aangesloten voordat je erop vertrouwt.

Simpel vs Geavanceerd

Instellingen hebben geen Opslaan-knop: elke wijziging wordt meteen weggeschreven.

Instellingen hebben geen Opslaan-knop: elke wijziging wordt meteen weggeschreven.

Standaard toont de interface alleen de essentie (back-uppen, herstellen, plannen). Gebruik de schakelaar Eenvoudige weergave / Geavanceerde weergave in de zijbalk om de expertbediening te onthullen: retentie, off-site kopie, pre/post-hooks, herstel op bestandsniveau, meldingen, Prometheus-metrics en de integriteits-/onderhoudstools. Het is een voorkeur per browser en standaard uit, zodat nieuwkomers een schone UI krijgen en poweruser alles.

Bouwen vanaf de broncode

BombVault is één statische Go-binary die een JSON-API en een ingebouwde React-interface serveert. Bouw eerst de interface en start daarna de binary:

npm --prefix web ci
npm --prefix web run build     # schrijft web/dist, dat de binary insluit
export APP_KEY=$(openssl rand -hex 32)
go test ./...                  # unit- en integratietests, met een echte restic-rondgang heen en terug
golangci-lint run ./...
go run ./cmd/bombvault         # serveert https://localhost:3443 met een zelfondertekend certificaat

De interface-build is ook nodig voor go run. De repository bevat onder web/dist alleen een lege markering, dus zonder npm --prefix web run build sluit de binary niets in en antwoordt hij met 500 SPA index not found, en dat is zo bedoeld. Docker, libvirt en Unraid kunnen niet in CI worden getest, dus controleer mounts, restic en de SSH-verbinding voor VM's op een echte host met de Host-integratiecontrole (/spike) voordat je een pull request opent.

Volgende stappen

  • Blader door de volledige Functies.
  • Zet elke server van je groep op je telefoon met de Android-app.
  • Voeg een of meer Off-site en herstel-replica's toe (elk domein kan tegelijk naar meerdere bestemmingen sturen) en bewaar je herstelkit.
  • Een setup klonen of naar een nieuwe machine verhuizen? Neem je hele configuratie mee met de kaart Instellingen exporteren / importeren. Zie Configuratie.
  • Loop je vast? Zie Probleemoplossing.