Vai al contenuto

Primi passi

Questa pagina ti accompagna da una macchina Unraid appena installata al tuo primo backup.

Requisiti

Requisito Note
Unraid 6.12+ Le versioni precedenti non sono testate. Unraid è l'obiettivo principale, ma BombVault gira anche su un semplice host Docker e su TrueNAS Scale (vedi Host Docker generico).
Posizione del repo restic Un percorso locale (consigliato: il tuo array o la cache), SMB, NFS o qualsiasi backend rclone.
Socket Docker Montato automaticamente dal template (/var/run/docker.sock).
Flash Unraid (/boot) Montato per intero automaticamente dal template (/boot in /host/boot). Alimenta il backup del flash e permette a un container ripristinato di riapparire come una normale app Unraid, modificabile.
VM KVM (opzionale) Il backup delle VM comunica con libvirt via SSH, nessun mount libvirt. Configuralo in Impostazioni (vedi Configurazione).
Dataset ZFS (opzionale) Lo stesso collegamento SSH del backup delle VM, zfs sull'host e Host Data mappato come /mnt con modalità di accesso Read/Write - Slave, il valore predefinito del template. Vedi Dataset ZFS.
App Android (facoltativa) Android 10 o successivo, associata a server con versione 9.7.0 o successiva. Vedi App Android.

Installazione su Unraid

Il percorso più semplice è Community Applications.

  1. Apri la scheda Apps in Unraid.
  2. Cerca BombVault.
  3. Clicca Install, imposta le variabili richieste (sotto) e applica.

Installazione manuale del template

Se preferisci aggiungere il template a mano:

  1. Vai su Docker, Add Container, Template repositories e aggiungi: 
    https://github.com/junkerderprovinz/unraid-apps
  2. Cerca BombVault in Templates.
  3. Imposta le variabili richieste e clicca Apply.

Host Docker generico

Non sei su Unraid? BombVault gira anche come semplice contenitore su qualsiasi host Docker (è anche ciò su cui si regge il supporto ai contenitori su TrueNAS Scale, prima di una voce dedicata nel suo catalogo di applicazioni).

  1. Prendi dal repository il file deploy/docker-compose.generic.yml, pronto da modificare.
  2. Imposta APP_KEY (vedi sotto) e punta il volume Host Data alla tua vera radice dati: i commenti nel file spiegano entrambe le cose.
  3. docker compose up -d, poi apri https://<ip-host>:3443/.

Cosa cambia rispetto a Unraid:

  • Nessun dominio flash/USB. Non c'è una chiavetta di avvio da catturare o ripristinare, quindi il dominio Flash nelle impostazioni qui non ha nulla da fare. Al suo posto il dominio Cartelle propone il suggerimento in un clic Aggiungi preimpostazione: configurazione di sistema dell'host (un insieme iniziale di file /etc che rivedi e modifichi prima di salvare), come equivalente generico pratico.
  • Nessuna notifica nativa di Unraid. I canali di notifica propri di BombVault (webhook, avvisi di fallimento off-site e così via) funzionano normalmente; viene saltato soltanto l'inoltro specifico al sistema di notifiche di Unraid, dato che qui non esiste.
  • Il backup delle macchine virtuali è opzionale e richiede un host libvirtd separato raggiungibile via SSH. Vedi il blocco commentato nel file compose. Un host Docker generico non porta con sé alcun gestore di macchine virtuali.
  • Nessun widget per la dashboard. BombVault Widget è un plugin Unraid, quindi anche questo passaggio viene saltato.
  • Trovare i dati di un container. Senza la convenzione appdata di Unraid, la cartella dati di un container viene trovata a partire dai segmenti in DATA_ROOT_SEGMENTS, dai volumi con nome di Docker, dalla directory di lavoro di un progetto Compose e dalla label bombvault.data (vedi Rilevamento delle sorgenti di backup). I volumi con nome e la preimpostazione /etc raggiungono solo percorsi all'interno del mount Host Data, quindi punta Host Data a una cartella antenata comune che copra anche la data root di Docker.
  • PLATFORM. Impostala su generic o truenas. Se non è impostata, BombVault riconosce Unraid dal proprio marcatore sul mount del flash e tratta tutto il resto come generico, e i passaggi specifici di Unraid vengono saltati invece di essere tentati e fallire.

TrueNAS Scale segue la stessa strada con compose; una voce di catalogo è pronta nel repository ma non ancora inviata. Lì il backup delle VM richiede LIBVIRT_URI, perché il libvirtd di TrueNAS ascolta su un socket tutto suo (/run/truenas_libvirt/libvirt-sock) che le tre variabili LIBVIRT_* non possono esprimere (vedi Configurazione). Fin dove è stato verificato: il backup di zvol è stato eseguito su una vera macchina TrueNAS Scale, su uno zvol collegato a una VM in esecuzione, e zfs snapshot, zfs send, restic e zfs receive lo hanno riportato indietro identico byte per byte. Un ripristino completo guidato da BombVault stesso non è ancora stato eseguito su hardware TrueNAS, e quello zvol era sparse, quindi il throughput su molti gigabyte non è testato. Prova un ripristino lì prima di farci affidamento.

L'unica impostazione richiesta

L'unica variabile che devi impostare è APP_KEY, un segreto esadecimale di 32 byte (64 caratteri esadecimali) usato per derivare la password del repository restic.

Generane uno su qualsiasi macchina:

openssl rand -hex 32

Incolla il risultato nel campo APP_KEY del template (Unraid), oppure nella variabile d'ambiente APP_KEY in docker-compose.yml (host Docker generico).

Non perdere la tua APP_KEY

Perdere APP_KEY rende i tuoi backup cifrati irrecuperabili. Conservala in un luogo sicuro e separato dal server. Una volta che BombVault è in esecuzione, usa il suo kit di ripristino della chiave di crittografia con un clic (vedi Off-site e ripristino) per salvare l'intero pacchetto di ripristino.

Il template monta anche il socket Docker, il flash (/boot) e la radice Host Data (/mnt) per te. Le origini e le destinazioni dei backup risiedono entrambe sotto Host Data. Per il riferimento completo delle variabili e la configurazione off-site, vedi Configurazione.

Prima esecuzione

La dashboard dopo un primo backup: cosa è protetto, cosa parte dopo e un registro dal vivo.

La dashboard dopo un primo backup: cosa è protetto, cosa parte dopo e un registro dal vivo.

  1. Apri l'interfaccia web all'indirizzo https://<your-unraid-ip>:3443 (certificato autofirmato pronto all'uso).
  2. In Impostazioni, abilita i domini di backup che vuoi (Container, VM, Flash, Auto-backup, Cartelle, Dataset ZFS) e scegli un colore di accento.
  3. Nella scheda Container, scegli un container e clicca Esegui backup ora per creare il tuo primo punto di ripristino. I percorsi dei repository hanno come predefinito /mnt/user/bombvault/{container,vms,flash,config,files,zfs} e vengono creati al primo backup.
  4. Imposta la pianificazione da Impostazioni, Pianificazioni. C'è un Includi tutto nel calendario con un clic per container e VM.

Facoltativo: scegli un ordine di backup

Se alcuni container dovrebbero sempre essere sottoposti a backup prima di altri (per esempio un database prima dell'app che lo usa), apri il pannello Ordine dei backup nella pagina Container e trascinali nella sequenza che vuoi. Le esecuzioni pianificate e a selezione multipla la seguono quindi; tutto ciò che lasci non ordinato viene sottoposto a backup dal più in ritardo per primo, come prima.

Verifica integrazione host

Apri /spike nell'interfaccia web dopo l'avvio del container. Sonda ogni mount e CLI (socket Docker, libvirt, restic, qemu-img, rclone) e segnala eventuali pezzi mancanti, così puoi confermare che il container sia collegato correttamente prima di affidartici.

Semplice vs Avanzata

Le impostazioni non hanno un pulsante Salva: ogni modifica viene scritta mentre la fai.

Le impostazioni non hanno un pulsante Salva: ogni modifica viene scritta mentre la fai.

Per impostazione predefinita l'interfaccia mostra solo l'essenziale (backup, ripristino, pianificazione). Usa l'interruttore Vista semplice / Vista avanzata nella barra laterale per rivelare i controlli esperti: conservazione, copia off-site, hook pre/post, ripristino a livello di file, notifiche, metriche Prometheus e gli strumenti di integrità/manutenzione. È una preferenza per browser e disattivata di default, così i nuovi arrivati ottengono un'interfaccia pulita e gli utenti esperti ottengono tutto.

Compilare dai sorgenti

BombVault è un unico binario Go statico che serve un'API JSON e un'interfaccia React incorporata. Compila prima l'interfaccia, poi avvia il binario:

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

La build dell'interfaccia serve anche per go run. Il repository traccia solo un marcatore vuoto sotto web/dist, quindi senza npm --prefix web run build il binario non incorpora nulla e risponde 500 SPA index not found, ed è normale. Docker, libvirt e Unraid non si possono testare in CI, quindi verifica i mount, restic e il collegamento SSH delle VM su un host reale con la verifica integrazione host (/spike) prima di aprire una pull request.

Prossimi passi

  • Sfoglia l'insieme completo delle Funzionalità.
  • Porta tutti i server del tuo gruppo sul telefono con l'App Android.
  • Aggiungi una o più repliche Off-site e ripristino (ogni dominio può spedire a più destinazioni contemporaneamente) e salva il tuo kit di ripristino.
  • Stai clonando una configurazione o passando a una nuova macchina? Porta con te l'intera configurazione con la scheda Esporta / importa impostazioni. Vedi Configurazione.
  • Hai incontrato un intoppo? Vedi Risoluzione dei problemi.