Configuratie¶
Deze pagina behandelt de omgevingsvariabelen van de container, de mounts die de template levert, het beveiligingsmodel, VM-back-up via SSH en de off-site-instelling. Waar back-ups naartoe gaan, stel je in de app in als bestemmingen, niet met omgevingsvariabelen.
Omgevingsvariabelen¶
| Variabele | Vereist | Beschrijving |
|---|---|---|
APP_KEY |
Ja | Geheim van 32 bytes in hex (64 hex-tekens) waarmee het restic-repositorywachtwoord wordt afgeleid. Genereer het met openssl rand -hex 32. Bewaar het goed: raak je het kwijt, dan zijn versleutelde back-ups onherstelbaar. |
LIBVIRT_HOST |
Voor VM's en ZFS-datasets | Unraid-host die via SSH wordt bereikt voor back-ups van VM's en ZFS-datasets (templateveld Host SSH: Address, standaard host.docker.internal). De template vult de plaatshouder 192.168.x.x vooraf in, die als niet ingesteld telt. Gebruik het LAN-IP van je Unraid, verplicht op een eigen br0.x-netwerk. Lost host.docker.internal niet op, zoals in een TrueNAS-app, en noemt ook LIBVIRT_URI geen host, dan gebruikt BombVault de standaardgateway van de container en noemt het opstartlogboek die. |
LIBVIRT_SSH_PORT |
Nee | SSH-poort van de host voor back-ups van VM's en ZFS-datasets (templateveld Host SSH: Port, standaard 22). |
LIBVIRT_SSH_USER |
Nee | SSH-gebruiker op de host voor back-ups van VM's en ZFS-datasets (templateveld Host SSH: User, standaard root). |
LIBVIRT_URI |
Nee | Volledige libvirt-verbindings-URI, letterlijk gebruikt in plaats van er een op te bouwen uit de drie LIBVIRT_*-variabelen hierboven (die dan voor de verbindingsstring worden genegeerd). Standaard niet ingesteld. Nodig op TrueNAS Scale, waarvan libvirtd op een niet-standaard socket luistert die de opgebouwde vorm niet kan uitdrukken: qemu+ssh://<user>@<truenas-host>/system?socket=/run/truenas_libvirt/libvirt-sock. Zie de VM-back-upgids. Is het een qemu+ssh://-URI, dan wordt elk van LIBVIRT_HOST, LIBVIRT_SSH_USER en LIBVIRT_SSH_PORT dat niet is ingesteld eruit overgenomen, ook voor de eigen SSH-opdrachten van BombVault (NVRAM-overdracht, ZFS-datasets). |
PORT |
Nee | HTTP-poort (standaard 3000. Alleen gebruikt met HTTP_ONLY=true). |
HTTPS_PORT |
Nee | HTTPS-poort (standaard 3443. De template publiceert hem 1:1, dus de WebUI antwoordt op https://<ip>:3443). |
HTTP_ONLY |
Nee | Zet op true om de zelfondertekende HTTPS-listener uit te schakelen en alleen gewoon HTTP te serveren (voor gebruik achter een reverse proxy die TLS afhandelt). |
BIND_HOST |
Nee | Adres waarop de WebUI luistert (standaard 0.0.0.0, elke interface). Laat het in de container ongewijzigd, want de gepubliceerde poorten hebben elke interface nodig. 127.0.0.1 past bij een run buiten Docker. De healthcheck vraagt hetzelfde adres. |
TRUSTED_PROXY |
Nee | Kommagescheiden adressen of CIDR-bereiken van de reverse proxy voor BombVault (bijvoorbeeld 192.168.20.11 of 10.0.0.0/8). Alleen van die hops wordt X-Forwarded-For geloofd, en de inlogbeperking telt mislukkingen dan per echte client in plaats van iedereen achter de proxy in één emmer te stoppen. Niet ingesteld (de standaard) vertrouwt niemand: een header die onvoorwaardelijk wordt geloofd, laat elke aanroeper zijn eigen emmer kiezen. |
HOST_SOURCE_ROOT |
Nee | Het hostpad dat als Host Data is gemount (standaard /mnt). BombVault vertaalt de bind-mountbronnen die Docker meldt naar paden onder deze mount. Wijzig het alleen als je een andere hostroot hebt gemount. |
HOST_MOUNT_ROOT |
Nee | Waar Host Data in de container is gemount (standaard /host/user). Op TrueNAS is Host Data op zijn eigen hostpad gemount, dus dit en HOST_SOURCE_ROOT noemen allebei dat pad, bijvoorbeeld /mnt/tank (zie TrueNAS SCALE). |
DATA_ROOT_SEGMENTS |
Nee | Kommagescheiden namen van padsegmenten die een bind-mountbron als back-updata markeren (standaard appdata, volgens de Unraid-conventie /mnt/user/appdata/<container>). De bind-mount van een container wordt automatisch voor back-up gekozen als ELK genoemd segment als volledig padsegment in zijn hostbron voorkomt. Met DATA_ROOT_SEGMENTS=appdata,config wordt bijvoorbeeld ook een .../config-bind opgepikt. De vergelijking negeert hoofdletters, dus de standaard dekt ook /DATA/AppData/<container> van ZimaOS. Zie Detectie van back-upbronnen voor de andere manieren, altijd actief, waarop de datamap van een container wordt gevonden. |
PLATFORM |
Nee | Dwingt af op welk platform BombVault denkt te draaien, in plaats van automatisch te detecteren: unraid, generic of truenas (standaard niet ingesteld: detecteert Unraid automatisch door te zoeken naar de dockerMan-markering onder de flash-mount, anders generic. Een onbekende waarde valt ook terug op generic, met een logregel). Stel het expliciet in op een gewone Docker-host of TrueNAS Scale in plaats van op de automatische test die alleen voor Unraid werkt. Het generieke compose-bestand doet dat. Het verandert de appdata-terugvalconventie, de standaarden voor herstelbestemmingen tussen instanties en of de stappen voor meldingen en de begeleidende plug-in, die alleen voor Unraid zijn, überhaupt worden geprobeerd (zie internal/platform). |
BOMBVAULT_SELF_CONTAINER |
Nee | De naam van de BombVault-container zelf, zodat hij nooit een back-up van zichzelf maakt (en zichzelf dus stopt). |
BACKUP_MAX_HOURS |
Nee | Maximaal aantal uren (klokuren) dat één back-uprun de lock van zijn onderdeel mag vasthouden voordat hij geforceerd wordt geannuleerd (een beveiliging zodat een vastgelopen run het onderdeel niet eeuwig kan blokkeren). Leeg (de standaard) gebruikt 48. Verhoog het voor zeer grote of trage cloud-back-ups (een run die op de limiet wordt geannuleerd, mislukt met context deadline exceeded). Zet 0 om de limiet helemaal uit te schakelen. Een opschoonronde krijgt dezelfde limiet, en een controle of opschoonronde loopt zolang restic voortgang blijft melden. |
BACKUP_STALL_HOURS |
Nee | Uren die een back-up helemaal geen voortgang mag maken voordat hij wordt geannuleerd. Leeg (de standaard) gebruikt 2. Zet 0 om nooit op stilstand te annuleren. Dit is de fijnere van de twee beveiligingen en meestal degene die toeslaat: ze kijkt of er nog iets gebeurt in plaats van hoe lang de run duurt, zodat een trage maar gezonde back-up van meerdere terabytes met rust wordt gelaten terwijl een back-up die vastzit op een niet-reagerende share in uren wordt gestopt in plaats van in dagen. Na 30 minuten stilte wordt een waarschuwing gelogd, voordat er iets wordt geannuleerd. Scannen telt als voortgang: restic schrijft geen bytes terwijl het een grote boom doorloopt, en die fase wordt bewaakt via zijn bestands- en bytetotalen in plaats van via de geschreven bytes. De twee variabelen zijn onafhankelijk, en BACKUP_MAX_HOURS begrenst nog steeds de fasen na de back-up zelf (bewaarbeleid, statistieken, off-site-kopie), waar geen tellers zijn om te bewaken. |
DB_DUMP_MAX_HOURS |
Nee | Uren die één automatische databasedump mag lopen voordat hij wordt gestopt. Leeg (de standaard) gebruikt 6. Toegestane waarden zijn 1 tot 48, en de limiet blijft een uur onder BACKUP_MAX_HOURS (op de helft ervan als dat minder dan twee uur is), zodat een lange dump door zijn eigen limiet wordt afgebroken en zo wordt gemeld in plaats van de back-up mee te slepen. Een dump die geen voortgang maakt, wordt eerder gestopt, na BACKUP_STALL_HOURS. Een gestopte dump mislukt op zichzelf en de containerback-up gaat door. Op Unraid voeg je hem toe aan de BombVault-container met Add another Path, Port, Variable. |
TZ |
Nee | Tijdzone voor de planner (bijvoorbeeld Europe/Berlin). Laat je hem leeg, dan draait elke planning in UTC: een planning van 02:30 gaat dan af om 02:30 UTC in plaats van op je eigen klok. Op Unraid stel je dit nooit zelf in: het systeem geeft zijn eigen tijdzone door aan elke container. Het opstartlogboek zegt welke zone eruit is gekomen. Bij een zone met zomertijd valt in het voorjaar één run weg en loopt er in de herfst één twee keer, terwijl UTC geen van beide doet maar twee keer per jaar een uur van je klok afwijkt. |
DATA_DIR |
Nee | Waar BombVault zijn database, sleutels en caches bewaart (standaard /config). Laat het met rust in de container. Het doet ertoe als je de binary buiten Docker draait. |
FLASH_DIR, FLASH_TEMPLATES_DIR |
Nee | Waar de flash en zijn Docker-templates in de container zijn gemount (standaard /host/boot en /host/boot/config/plugins/dockerMan/templates-user). Ze volgen de /boot-mount van de template, dus laat ze leeg. |
MODE |
Nee | full (de standaard) draait de hele app. node draait een node: geen webinterface en geen eigen planningen, alleen wat zijn thuisinstantie hem vertelt. Elke andere waarde stopt het starten met een melding. De thuisinstantie vult hem voor je in het compose-bestand van de node in. |
NODE_HOME |
Op een node | Bij welke thuisinstantie de node hoort, met de sleutel en de relay van de thuisinstantie, als één waarde die met bvhome1. begint. De thuisinstantie schrijft hem in het compose-bestand van de node. Zonder deze waarde start de node, maar bereikt geen thuisinstantie hem. Een node die een thuisinstantie al heeft aangenomen, weigert te starten als NODE_HOME een andere noemt, tot de eerste hem vrijgeeft. |
NODE_NAME |
Nee | De naam van de node, zoals de thuisinstantie die invulde op basis van de naam die je hem gaf. |
Mounts¶
Mount de Docker-socket, de flash (/boot) en de Host Data-root (/mnt) zoals getoond in de CA-template. Back-upbronnen en -bestemmingen staan allebei onder Host Data, en die wordt als slave gemount, zodat een externe share die pas na het starten van de container wordt gemount (bijvoorbeeld onder /mnt/remotes) zichtbaar wordt zonder herstart.
Op TrueNAS is Host Data een datasetpad zoals /mnt/tank, nooit een ixVolume. Data die een app in een ixVolume bewaart, ligt daarbuiten en wordt niet geback-upt. Zie TrueNAS SCALE.
Back-ups van ZFS-datasets hebben ook deze modus nodig: de host mount de snapshot van een dataset pas nadat de container is gestart. Zie ZFS-datasets.
Lokale repository's staan standaard in /mnt/user/bombvault/{container,vms,flash,config,files,zfs}, aangemaakt bij de eerste back-up. Dat zijn de eigen mappen van de onderdelen en samen vormen ze de bestemming Lokaal. Op de pagina van die bestemming onder Bestemmingen wijzigt de kaart Verbinding de map van elk onderdeel.
De eigen map van een onderdeel kan ook in een bestemming staan die je al hebt, zoals een NAS of een S3-bucket: Als eigen map gebruiken op de pagina van die bestemming verplaatst haar daarheen en zegt eerst wat er met de al gemaakte back-ups gebeurt. Zie De eigen map van een onderdeel.
De lokale repositorymappen blijven op modi 0755 en 0644, zodat een niet-root-syncgebruiker via SMB niet wordt buitengesloten, en de repository's zijn versleuteld, dus dit legt niets bloot. Hersteldefinities staan in elk repository, dus een gekopieerde map is op zichzelf compleet. Het repository van de zelf-back-up blijft alleen voor root leesbaar.
Controle van de hostintegratie
De kaart Host-integratie op het overzicht (voeg hem toe onder Aanpassen) test elke mount en elk CLI-programma (Docker-socket, libvirt, restic, qemu-img, rclone) en meldt wat er ontbreekt.
Detectie van back-upbronnen¶
Voor elke container kiest BombVault automatisch welke bind-mounts en benoemde volumes in de back-up komen. Een pad wordt opgepikt als een van de volgende punten geldt (je kunt het resultaat altijd aanpassen in de kaart Back-upmappen op het tabblad Instellingen van de container):
- Overeenkomst met een dataroot-segment: de hostbron van de bind bevat een van de
DATA_ROOT_SEGMENTS-segmenten als volledig padonderdeel (standaard alleenappdata). - Docker-benoemde volumes zitten er altijd bij, omdat ze geen wegwerpequivalent hebben en er niets te filteren valt, maar alleen als het echte opslagpad van het volume op de host zelf bereikbaar is via de Host Data-mount, precies zoals elk ander hostpad dat BombVault back-upt. De standaard lokale volumedriver van Docker slaat een volume op onder de eigen dataroot van de daemon (
/var/lib/docker/volumes/<name>/_data, tenzij je dat hebt aangepast. Controleer metdocker info -f '{{.DockerRootDir}}'), en die valt niet onder de smalle Host Data-mount met één map die de generiekedocker-compose.ymlstandaard gebruikt. Een onbereikbaar volume wordt stilletjes overgeslagen, het is geen fout. Om benoemde volumes op een gewone host echt te back-uppen, wijs je Host Data (enHOST_SOURCE_ROOT) naar een gemeenschappelijke voorouder die ook de Docker-dataroot omvat. De opmerking over Host Data in het compose-bestand legt de afweging uit (Unraid omzeilt dit door al/mntte mounten, zijn eigen universele topniveauconventie, om dezelfde reden). - Docker Compose-projectmap: draagt de container het standaardlabel
com.docker.compose.project.working_dir(automatisch gezet doordocker compose up), dan wordt die map ook toegevoegd, ongeacht of een bind op een dataroot-segment paste. - Overschrijven met het label
bombvault.data: zet het labelbombvault.data=trueop een container om al zijn bind-mounts op te nemen, voor een indeling die geen van beide conventies hierboven vangt (bijvoorbeeld één/srv/plex/config-bind zonder Compose-project). Elke niet-lege waarde behalvefalsetelt als waar. Een ontbrekend label ofbombvault.data=falseverandert niets. - Label
bombvault.dbdump: zetbombvault.dbdump=falseop een container om zijn automatische databasedump uit te schakelen (0,noenoffdoen hetzelfde), of noem de engine (postgres,mysql,mariadb) om een container te dumpen die BombVault zelf niet herkent. Het label gaat voor op de schakelaar in de kaart Database op het tabblad Instellingen van de container, wat op Unraid de weg is.
Beveiligingsmodel¶
Controle op het niveau van root over de host
Via de Docker-socket kan BombVault containers stoppen, verwijderen en opnieuw aanmaken en appdata lezen en schrijven, en voor VM-back-up logt het via SSH (qemu+ssh://, standaard als root) in op de host om virsh uit te voeren. Wie bij de webinterface kan, heeft in feite root op de host.
Inloggen¶
- Optionele wachtwoordbeveiliging (kaart Wachtwoord onder Instellingen, Beveiliging): stel een wachtwoord in om inloggen te eisen, wis het om het uit te schakelen. Standaard uit, voor gebruik op een vertrouwd LAN. Het wachtwoord wordt opgeslagen met Argon2id over een pepper die met
APP_KEYis gesleuteld, dus een gekopieerde/configis zonder de sleutel waardeloos en met de sleutel traag aan te vallen. Een nieuw wachtwoord heeft minstens 12 tekens nodig. Een bestaand korter wachtwoord blijft werken tot het wordt gewijzigd. Sessies zijn ondertekend (HMAC afgeleid vanAPP_KEY) en een wachtwoordwijziging maakt ze ongeldig. Inloggen is beperkt tot vijf mislukkingen per minuut per client. Het wijzigen of wissen van het wachtwoord vraagt om het Huidig wachtwoord en, bij ingeschakelde tweefactorauthenticatie, om de code. - Sommige dingen vereisen een wachtwoord. Het downloaden van de herstelkit, het bugrapport en de ZIP van een flashback-up, het exporteren van een flashback-up of zelf-back-up, het toevertrouwen van de sleutel aan een sleutelbewaarder, toestaan dat een bewaarkopie wordt uitgegeven, een nieuwe vrijgavecode maken, instellingen exporteren met inloggegevens, tweefactorauthenticatie, passkeys, een node toevoegen, het compose-bestand van een node opnieuw tonen en de items van een node openen worden geweigerd tot er een inlogwachtwoord is ingesteld, en ze vragen een aanmelding op de instantie zelf. Back-ups verwijderen werkt ook zonder wachtwoord. Is er een ingesteld, dan vraagt het ook die aanmelding.
- Een bestemming toont geen wachtwoord. Een bestemming kan inloggegevens bevatten, zoals in
rest:https://user:password@host/repo, en elke pagina en elk API-antwoord toont die alsrest:https://[redacted]@host/repo, met of zonder inlogwachtwoord. Wijzig je het pad erachter, dan blijft het opgeslagen wachtwoord staan. Wil je de bestemming naar een andere server laten wijzen, typ dan de hele bestemming met het wachtwoord, want een verborgen wachtwoord blijft bij zijn server. - Tweefactorauthenticatie (Instellingen, Beveiliging): een tijdcode uit een authenticator-app bovenop het wachtwoord, plus acht herstelcodes voor eenmalig gebruik die je één keer krijgt als je de functie inschakelt. Het gedeelde geheim wordt versleuteld met
APP_KEYopgeslagen, en om de tweede factor weer uit te zetten is een actuele code nodig. - Passkeys (WebAuthn) staan op een eigen kaart zodra er een wachtwoord is ingesteld, naast het wachtwoord en nooit in plaats ervan, dus als je alle passkeys verwijdert, sluit je niemand buiten. Ze hebben een echte domeinnaam en een certificaat nodig dat de browser vertrouwt. Het standaardadres
https://<ip>:3443is precies wat WebAuthn weigert, en de kaart zegt dat in plaats van een knop te tonen die mislukt. Is tweefactorauthenticatie ingeschakeld, dan moet een passkey je pincode, vingerafdruk of gezicht controleren, anders vraagt de aanmelding ook om de code. - Een configuratieherstel (Instellingen terughalen in de Noodassistent) beëindigt elke sessie, verwijdert elke passkey en trekt elk API-token en elke MCP-sleutel in, omdat de herstelde instellingen sleutels kunnen terugbrengen die na het opslaan zijn verwijderd. Meld je aan met het wachtwoord en stel je passkeys opnieuw in onder Instellingen, Beveiliging.
- Een vergeten wachtwoord zet je terug op de inlogpagina. Bij Wachtwoord vergeten? schrijft BombVault een code van 12 tekens, in drie groepen van vier, naar het containerlogboek (op Unraid: tabblad Docker, BombVault-icoon, Logs). Die code en een nieuw wachtwoord melden je aan. De reset zet ook tweefactorauthenticatie uit, verwijdert elke passkey, trekt elk API-token, elke MCP-sleutel en elke OAuth-aanmelding in, beëindigt elke andere sessie, meldt elke gekoppelde telefoon af en zet het koppelen van telefoons uit. De pagina erna toont wat er is verdwenen. Een code is 10 minuten geldig, en foute pogingen gebruiken hem niet op. Widget- en metrics-tokens blijven, omdat ze alleen lezen.
- Wie het containerlogboek kan lezen, kan het wachtwoord resetten. Dat is root op de host, maar ook een logviewer zoals Dozzle, elke container die de Docker-socket heeft gekregen (alleen-lezen is genoeg) en een logshipper die containeruitvoer doorstuurt. Geef die alleen aan mensen die je het wachtwoord zou toevertrouwen. Wie alleen de webinterface bereikt, ziet de code nooit.
Telefoons en groepsleden¶
- Gekoppelde telefoons bereiken een toegestane lijst. Een telefoon die de twaalf woorden van de groep kent, meldt zich zonder wachtwoord aan, zolang Telefoons kunnen koppelen met de twaalf woorden van de groep aanstaat in de kaart Android-app onder Instellingen, Beveiliging. Zijn sessie bereikt alleen wat de app toont: het overzicht, de runs, de back-ups om te bekijken, te starten en te herstellen, de anomalieën om te lezen en de pagina Instanties om te bekijken. Bestemmingen en commando's bereiken hem zonder hun adressen en geheimen, en een herstel dat het origineel vervangt, maakt eerst een back-up van de huidige staat. Een herstel naar een map neemt alleen een nieuwe of lege map binnen de herstelmap, en een telefoon kan in geen andere map kijken. Al het andere antwoordt dat het een aanmelding op de instantie zelf nodig heeft: sleutels, de herstelkit, bewaarkopieën van de sleutel, instellingen, back-ups verwijderen. Een wachtwoordreset zet het koppelen van telefoons uit tot je het weer aanzet. Een telefoon die van de pagina Instanties is verwijderd, of waarvan Deze instantie bevragen in de details is uitgezet, verliest meteen zijn sessie, en een verwijderde telefoon die zijn app opnieuw opent, komt uitgeschakeld terug.
- Onderweg opent een telefoon pagina's via de relay. Elk verzoek van de pagina wordt verzegeld met de sleutel van de groep, die de relay niet kan lezen of wijzigen, en ondertekend met een eigen sleutel van de telefoon, die de server bij de eerste aanroep van de telefoon vastzet en binnenlaat zodra iemand de telefoon op de koppelpagina goedkeurt. De server voert een verzoek één keer uit en alleen zolang het recent is. Hij antwoordt alleen een telefoon die op de pagina Instanties staat terwijl het koppelen van telefoons aanstaat, en alleen met een sessie die hij die telefoon gaf, dus overal afmelden en een wachtwoordreset beëindigen ook deze pagina's. De server ondertekent elk antwoord, en de app controleert de handtekening tegen de sleutel die hij voor die server heeft vastgezet en waarschuwt als de sleutel verandert. Zo'n pagina bereikt dezelfde toegestane lijst als een gekoppelde telefoon, met of zonder inlogwachtwoord, plus de aanmeldstatus die de pagina als eerste leest. Aan- en afmelden, de wachtwoordreset en downloads blijven op het eigen adres van de server, en één antwoord is beperkt tot 16 MB.
- Leden ondertekenen wat ze vragen. Rolverzoeken en hun antwoorden, opslagaanbiedingen, het uitgeven van een restic-wachtwoord aan een ontvanger of ophaler, logins van ontvangers en bewaarkopieën van sleutels worden ondertekend met een sleutel van elk lid, die een instantie vastzet de eerste keer dat hij dat lid ziet. Een aanroep die met een andere sleutel is ondertekend, wordt geweigerd. Sleutel vergeten in de details van een instantie laat de vastgezette sleutel los, voor het geval dat de sleutel die hier bekend is niet de eigen sleutel van het lid is. Bij zijn volgende ondertekende aanroep wordt het lid opnieuw om zijn sleutel gevraagd. Leden op BombVault 9.x ondertekenen niet en kunnen worden nagebootst door iedereen met de woorden, zoals in 9.9. Een rolverzoek of een opslagaanbieding van een lid op 10.4 of ouder wordt geweigerd tot dat lid is bijgewerkt.
- De twaalf woorden zijn een wachtwoord. Wie ze heeft, treedt tot de groep toe, ziet de beschermingsstatus van de leden en kan rollen aanvragen, die iemand op de andere instantie nog moet toestaan. Zonder inlogwachtwoord kan iedereen die de webinterface kan openen ze lezen, en de koppelkaart zegt dat tot er een wachtwoord is ingesteld.
Sleutels¶
- APP_KEY doet twee dingen. Hij verzegelt wat deze installatie opslaat (wachtwoorden, inloggegevens, tokens) en hij is de sleutel van de back-ups: het restic-wachtwoord wordt ervan afgeleid, en container- en VM-definities worden ermee verzegeld.
- Een overgenomen sleutel wordt apart bewaard. Neemt de Noodassistent de back-ups van een andere server over, dan blijft deze installatie met haar eigen APP_KEY verzegelen en bewaart ze de sleutel van de andere server als haar back-upsleutel, verzegeld zoals elk ander geheim. De herstelkit toont dan allebei. Wordt APP_KEY daarna gewijzigd, dan kan de back-upsleutel niet meer worden geopend: BombVault stopt met back-uppen en meldt dat onder Aandacht nodig, in plaats van met de verkeerde sleutel te schrijven. Upload de herstelkit opnieuw onder Herstel, Noodgeval, of zet APP_KEY terug. Zie Noodassistent.
- Versleuteling staat standaard aan (Back-ups versleutelen in de kaart Versleuteling onder Instellingen, Beveiliging). Back-ups worden door restic versleuteld met het wachtwoord dat van de back-upsleutel is afgeleid.
- Bewaarkopieën van de sleutel. Een sleutelbewaarder in je groep houdt een verzegelde kopie van de herstelkit van deze server die hij zelf niet kan openen. Alleen de vrijgavecode van 20 tekens opent hem, en de bewaarder geeft hem pas uit nadat iemand daar op Toestaan drukt. Zie Sleutelbewaarder.
Nodes¶
Een node is een BombVault zonder webinterface die zijn opdrachten van een thuisinstantie krijgt.
- De thuisinstantie heeft de node in handen. Een node koppelt de Docker-socket van zijn server, en dat is daar root, en de thuisinstantie bestuurt de node. Wordt de thuisinstantie overgenomen, dan beheerst de aanvaller ook al haar nodes. Geef de thuisinstantie een inlogwachtwoord en houd haar webinterface van het internet af.
- Een node heeft weinig in handen. Wordt een node overgenomen, dan krijgt de aanvaller geen koppelgroep, geen vesting, geen andere node en geen ander repository. De node heeft alleen een verbinding met zijn thuisinstantie, een eigen login op de ontvangserver en een eigen map op een bestemming. Op de ontvangserver kan hij geen geschiedenis wissen, omdat de server append-only is. Hij kan wel de schijf van de server vullen, omdat rest-server geen quotum instelt, dus geef de ontvangserver genoeg ruimte of een eigen share. Op een bestemming kunnen zijn inloggegevens meestal verwijderen wat daar staat. Back-ups die op de node bewaard worden, zijn in handen van de aanvaller, en daarom haalt de thuisinstantie er een kopie van op.
- De verbinding is privé en ondertekend. De thuisinstantie en de node praten via de relay over een eigen verbinding, verzegeld met een geheim dat van de
APP_KEYvan de node is afgeleid. Elke kant kent de sleutel van de ander al voor de eerste aanroep, dus er is geen goedkeuringsstap. De thuisinstantie ondertekent elke aanroep met haar eigen sleutel en een teller, en de node weigert een aanroep die niet door de thuisinstantie is ondertekend of die hij al eerder heeft aangenomen. De node roept bij de thuisinstantie niets aan behalve zijn hallo. - De thuisinstantie bereikt een vaste lijst. Verzoeken die de thuisinstantie aan een node doorgeeft, lopen alleen op een vaste lijst van routes van de node, te zien bij
GET /api/nodes/routes, en de node beantwoordt ze alleen met JSON. Niets op de lijst verwijdert iets of bereikt de instellingen, de opslag, de sleutels, de groep of de tokens. Op de thuisinstantie vragen ze een aanmelding met het wachtwoord: gekoppelde telefoons, API-tokens en MCP-sleutels bereiken geen node. Back-ups en herstelacties die zo zijn gestart, staan als gestart door de thuisinstantie. - Bewaarkopieën bevatten nodesleutels. De thuisinstantie bewaart de
APP_KEYvan elke node, en de herstelkit drukt hem af in zijn hoofdstuk Nodes, dus een bewaarkopie bevat hem ook. Een sleutelbewaarder die de bewaarkopie en de vrijgavecode krijgt, kan de repository's van je nodes openen, maar kan geen node aansturen, want daarvoor is de handtekening van de thuisinstantie nodig. - Vrijgeven is definitief. Een vrijgegeven node neemt met dezelfde
APP_KEYgeen thuisinstantie meer aan. Een node die weg is als je hem vrijgeeft, hoort het van de thuisinstantie zodra hij terug is.
Netwerk¶
- Wijzigingen vereisen JSON. Een verzoek dat iets wijzigt, moet
Content-Type: application/jsonmeesturen en mag door de browser niet als cross-site zijn gemarkeerd, zodat een pagina op een andere site je browser geen instellingen op een LAN-adres kan laten wijzigen. Een script dat de API aanstuurt, stuurt die header mee. Al het andere wordt geweigerd met415. - Omdat de aanmelding optioneel is, zijn, zolang er geen wachtwoord is ingesteld, de hele UI en API (inclusief de bestemmingen, de routes voor de sabotagetest en de herstelroutes) bereikbaar voor iedereen die de poort kan bereiken. Stel een inlogwachtwoord in zodra off-site, append-only back-ups of versleuteling in gebruik zijn.
- Draai BombVault alleen op een vertrouwd netwerk dat niet blootstaat. Zet het voor toegang op afstand achter een reverse proxy die authenticatie en TLS toevoegt. Antwoorden dragen basis-beveiligingsheaders (CSP,
nosniff,X-Frame-Options,Referrer-Policy). - Achter een reverse proxy draagt elk verzoek het adres van de proxy, dus zonder
TRUSTED_PROXYtelt de inlogbeperking elke client in één emmer en sluiten de mislukkingen van een aanvaller ook jou buiten. Noem de proxy inTRUSTED_PROXYom de telling per client terug te krijgen. - Een reverse proxy voor BombVault moet de header
AuthorizationofX-API-Keydoorgeven aan/mcpen mag zijn antwoorden niet bufferen, anders kunnen assistenten niet verbinden. Zie MCP-server. - Het MCP-eindpunt
/mcpantwoordt404tot er een sleutel bestaat of aanmelden via OAuth is ingeschakeld, en het vraagt elke client om zijn sleutel of token, ook met het inlogwachtwoord uit. Geen adres is vrijgesteld, ooklocalhostniet. Het heeft geen herstel- of verwijdertools, en het herstellen van een configuratieback-up trekt elke sleutel in. Zie MCP-server. - Met
HTTP_ONLY=trueverliest het sessiecookie zijnSecure-vlag (dat moet, om over gewoon HTTP te werken), dus schakel het wachtwoord alleen in achter een proxy die TLS afhandelt als vertrouwelijkheid ertoe doet. - De SSH-verbinding voor VM-back-up vertrouwt de hostsleutel bij de eerste verbinding (TOFU) en zet hem daarna vast. Controleer de sleutel van de host langs een andere weg als het pad van container naar host niet te vertrouwen is.
- Links leiden niet uit de mount. Een back-up of een herstel op zijn plaats stopt met een melding als een link boven zijn pad uit de host-mount leidt, omdat een container die in zijn eigen share schrijft, er een kan neerzetten. Een bestemming waarvan de host of de rclone-remote met een streepje begint, wordt op dezelfde manier geweigerd, bij het opslaan en bij de volgende run, omdat
sshofrclonedie als optie zou lezen.
MCP-server¶
De MCP-server heeft geen omgevingsvariabele nodig. Je schakelt hem in door een sleutel aan te maken onder Instellingen, Integraties, MCP-server, en hij antwoordt op /mcp op dezelfde poort als de webinterface (bijvoorbeeld https://192.168.1.10:3443/mcp). Zonder actieve sleutel antwoordt dat pad 404. Clients, certificaten en limieten staan beschreven bij MCP-server.
VM-back-up via SSH¶
BombVault maakt back-ups van KVM/libvirt-VM's zonder een libvirt-pad te mounten. Het draait virsh op de host via SSH (qemu+ssh://), zodat het nooit je VM Manager op de host kan beïnvloeden.
De libvirt-socket van de host in een container mounten is kwetsbaar op Unraid: de VM Manager beheert die paden, en het omschakelen van "Enable VMs" kan libvirt laten falen bij het starten. De SSH-sleutel geeft root op de host, hetzelfde vertrouwensniveau als de Docker-socket die BombVault al gebruikt.
Snelle installatie:
- Instellingen, Integraties, Host-SSH: kopieer de getoonde publieke sleutel.
- Voeg hem toe aan
/root/.ssh/authorized_keysvan Unraid (ook op de flash bewaard, zodat hij herstarts overleeft). - Klik op Verbinding testen.
De template voegt --add-host=host.docker.internal:host-gateway toe zodat de container de host kan bereiken. Zet LIBVIRT_HOST op het LAN-IP van je Unraid als die naam niet oplost (bijvoorbeeld wanneer de container op een eigen br0.x-netwerk draait). Heb je de SSH-poort van Unraid gewijzigd, zet dan LIBVIRT_SSH_PORT erop af. Live-snapshots hebben ook de qemu guest agent in de VM nodig en de schijf op /mnt/cache (niet /mnt/user).
Volledige VM-installatie en netwerkgids
De complete stapsgewijze gids (SSH inschakelen, blijvende sleutelautorisatie, routering voor eigen netwerken en VLAN's, methode per VM en probleemoplossing aan de hostkant) is de VM-back-upgids.
Off-site instellen¶
Off-site-kopieën gaan naar bestemmingen. Open Bestemmingen via zijn instellingentegel (of zet hem vast in de zijbalk) en kies Bestemming toevoegen. Zie Off-site en herstel voor de volledige werkwijze (bescherming tegen verwijderen, sabotagetest en DR-oefeningen). In het kort:
- Backends: SMB/CIFS en WebDAV via rclone zonder host-mount, NFS (mount de export op de host en gebruik hem als lokale map), native restic-backends zonder rclone (
s3:...,rest:http://host:8000/repo,sftp:user@host:/repo), of elke rclone-remote (rclone:<remote>:<bucket>/path). Backblaze B2 heeft hier geen native backend: bereik het via zijn S3-eindpunt (s3:https://s3.<region>.backblazeb2.com/<bucket>/<path>) met de sleutel-ID en de applicatiesleutel als S3-inloggegevens. - Inloggegevens worden versleuteld opgeslagen, als één lijst met opgeslagen inloggegevens in de kaart Inloggegevens onder Instellingen, Bestemmingen. Een ster markeert de standaard, die wordt gebruikt waar geen inlog is gekozen. De eigen pagina van een bestemming kiest in zijn kaart Inloggegevens welke hij gebruikt. Zie Inloggegevens.
- SSH-doelen hebben aan de andere kant niets geïnstalleerd nodig.
sftp:heeft alleen een SSH-server nodig. Voeg de publieke sleutel uit Instellingen, Integraties, Host-SSH (ook te vinden op/config/ssh/id_ed25519.pub) toe aan~/.ssh/authorized_keysvan de doelgebruiker, of laat Sleutel toevoegen in Bestemming toevoegen hem daar plaatsen met het wachtwoord van het account. - rest-server met een zelfondertekend certificaat: zet zijn certificaat, of dat van de autoriteit die het ondertekende, als PEM-bestand in de map
certsvan de datamap van BombVault (/config/certsin de container,appdata/bombvault/certsop Unraid). Back-ups, kopieën en de test van de bescherming tegen verwijderen vertrouwen het zonder herstart. - Off-site kopie: BombVault kopieert nieuwe snapshots met
restic copyop best-effort-basis, bovenop een (meestal lokale) primaire. De kaart Kopiëren van een bestemming bepaalt of er wordt gekopieerd Na elke back-up of volgens een eigen planning, en Instellingen, Planning, Off-site-kopieën per onderdeel geeft één onderdeel een eigen kopieerplanning. Nu repliceren staat in de rij van het onderdeel in de kaart Offsite-kopieën onder Instellingen, Bestemmingen. - Meerdere bestemmingen per onderdeel: de kaart Bestemmingen per onderdeel op de pagina Bestemmingen zet elke lijn van een onderdeel naar een bestemming met één klik aan of uit, Lokaal inbegrepen. Een onderdeel met alleen off-site-bestemmingen maakt rechtstreeks daarheen een back-up, en een onderdeel met elke lijn uit krijgt geen back-up. De Regels per onderdeel van een bestemming geven één onderdeel daar een eigen repository, bewaarbeleid of compressie.
- Plaatsing per item: elke container, VM en mappenset verlicht Lokaal en de bestemmingen die zijn back-ups krijgen, in de kaart Planning en bestemming op zijn tabblad Instellingen. Items zonder eigen keuze volgen hun onderdeel. Zie Plaatsing per item.
- Bewaarbeleid: elke bestemming bewaart back-ups volgens zijn kaart Hoe lang bewaren, en een onderdeel kan daar onder Regels per onderdeel eigen waarden houden. Dat geldt ook voor de kopie in het off-site-veld van een onderdeel. Alles op nul snoeit de snapshots van een bestemming nooit.
- Bandbreedtelimieten: begrens de upload- en downloadsnelheid van restic in de kaart Off-site bandbreedte onder Instellingen, Bestemmingen, of per bestemming in zijn kaart Kopiëren. Je voert KiB/s in, en het veld toont dezelfde snelheid in MB/s en Mbit/s.
- Streaming eerst: kies in de kaart Streaming op de pagina Bestemmingen de mediaservers (Plex, Jellyfin en Emby zijn vooraf gekozen op naam van de image), de verzendsnelheid vanaf waar iets als streaming telt, de uploadlimiet terwijl er gestreamd wordt en hoe lang na een stream de normale limiet terugkomt.
- Koude opslag en archiefopslagklasse (S3): kies voor een S3-bestemming op zijn pagina een klasse die leesbaar is voor herstel (Standard, Standard-IA, One Zone-IA, Intelligent-Tiering, Glacier Instant Retrieval). rclone-remotes stellen hun klasse in de rclone-configuratie in.
- Eigen map in een bestemming in plaats van lokaal: de eigen map van een onderdeel kan in een van de bestemmingen hierboven staan, zonder lokale kopie en zonder kopieerstap. Zie De eigen map van een onderdeel.
Anomalieën¶
Anomaliedetectie heeft geen omgevingsvariabele nodig. Ze wordt ingesteld in de kaart Anomalieën onder Instellingen, Verificatie, beschreven bij Anomalieën.
Draagbare instellingen (exporteren en importeren)¶
De kaart Instellingen exporteren / importeren onder Instellingen, Systeem schrijft je hele BombVault-configuratie (instellingen van onderdelen, bestemmingen, planningen, bewaarbeleid, meldingen) weg naar een draagbaar JSON-bestand dat je op een andere instantie kunt importeren, zodat verhuizen naar een nieuwe machine of een opstelling klonen niet betekent dat je alles met de hand opnieuw invoert. Import toont een voorbeeld en vraagt om bevestiging, en raakt je back-updata of geschiedenis nooit aan. Verwijzingen in het bestand naar bestemmingen of repository's die niet meer bestaan, worden weggelaten, en het voorbeeld noemt ze. Terwijl een ZFS-replica loopt, wordt een import geweigerd voordat er iets wordt geschreven.
De export kan inloggegevens bevatten
Je kiest zelf of de off-site-, meldings- en MQTT-brokerinloggegevens in het bestand komen. Met inloggegevens is de export net zo gevoelig als je herstelkit, dus bewaar hem op een veilige plek. Zonder inloggegevens bevat het bestand alleen instellingen zonder geheimen.
De APP_KEY reist niet mee met het bestand
De repository's zijn vergrendeld met een wachtwoord dat van de APP_KEY is afgeleid, en het bestand bevat die niet. Geef bij een geplande verhuizing de nieuwe box de oude APP_KEY in zijn template, of neem de sleutel over met de herstelkit onder Noodgeval. Onder een andere sleutel antwoorden de repository's met een verkeerd wachtwoord. Er gaat niets verloren, en met de juiste sleutel gaan ze weer open.