Ga naar hoofdinhoud

De lionbackup-client

De back-up verloopt via een lichte, in Go geschreven client die als open source client wordt aangeboden.

Wat de client doet​

De client verzorgt het volledige lokale deel van een back-up:

  1. Comprimeren van de geselecteerde data,
  2. Versleutelen — met client-side end-to-end-encryptie ingeschakeld verlaat alleen cijfertekst uw systeem,
  3. Overbrengen naar een beschikbare Citadel van de gekozen Storage Zone.

Faalt tijdens de overdracht een endpoint, dan schakelt de client automatisch over naar een andere beschikbare Citadel.

Platforms​

De client ondersteunt Linux, Windows en macOS (bèta). Voorgebouwde binaries staan klaar om te downloaden; de broncode is openbaar in te zien.

Configuratie​

Voor het gebruik legt u in de lokale configuratie vast:

  • het projectgebonden toegangstoken,
  • bij client-side encryptie het sleutelmateriaal,
  • de te back-uppen paden of gegevensbronnen.
Open source

Doordat de client open source is, valt na te gaan hoe compressie, versleuteling en overdracht verlopen — transparantie die past bij de soevereine koers van lionbackup.

Een volledig verloop van login tot eerste back-up staat onder Aan de slag.

Meerdere back-uptaken op één machine​

Een project kan meerdere configuraties hebben, bijvoorbeeld een dagelijkse run voor documenten en een wekelijkse voor de database. Elke configuratie geeft haar taak een naam met name::

lionbackup:
name: daily-docs

De naam verschijnt in de uitvoer en in de naam van het logbestand (lionbackup-<name>-YYYYMMDD.log). Meerdere configuraties kunnen zo één log_directory delen zonder dat hun regels in één bestand door elkaar raken. Ontbreekt name:, dan leidt de client hem af uit de bestandsnaam van de configuratie (daily-docs.yaml → daily-docs). Houd bestandsnaam en name: bij voorkeur gelijk.

Leesfouten, speciale Windows-mappen en transparantie​

Vanaf client v0.1.2:

  • Windows-legacy-junctions (verborgen compatibiliteitskoppelingen zoals "Mijn afbeeldingen" in de profielmap) worden altijd overgeslagen – ze zijn per ontwerp onleesbaar en bevatten geen data.
  • Leesfouten onder een bron (toegang geweigerd, bestand tijdens de run verwijderd) leiden standaard tot een waarschuwing + overslaan; aan het einde meldt de client het totaal aan overgeslagen items. Een ontbrekende of onleesbare bron zelf breekt nog steeds af.
  • Het gedrag is instelbaar via on_read_error in lionbackup.yaml: warn (standaard) of abort om bij de eerste fout hard te stoppen.
on_read_error: warn # of: abort

De client vertelt zijn stappen ("Stap 1/3: bronnen controleren …", scanvoortgang elke seconde), zodat ook bij zeer grote mappen direct zichtbaar is wat er gebeurt.

Windows: geopende bestanden via schaduwkopie​

Onder Windows leest de client bestanden die een programma exclusief geopend houdt uit een schaduwkopie (VSS) van het station. Dat staat standaard aan (use_vss: true) en vereist beheerdersrechten. Zonder die rechten slaat de client vergrendelde bestanden over, back-upt hij de rest en noemt hij ze in het logboek. Kies voor back-ups via Taakplanner daarom "Met hoogste bevoegdheden uitvoeren".

De schaduwkopie leest weliswaar de bestanden van een draaiende database, maar zonder de database erbij te betrekken. Betrouwbaar is een back-up die de database zelf schrijft, bijvoorbeeld via een pre_backup-commando (zie hieronder) naar een map die de client back-upt.

Hyper-V-VM's​

Vanaf client 0.2.0 back-upt de client op een Windows Server met de Hyper-V-rol complete VM's. In de configuratie staan alleen hun namen, zoals Get-VM ze toont; welke bestanden erbij horen, vraagt de client bij elke run aan Hyper-V.

lionbackup:
hyperv:
vms:
- FILESRV01
- DC01 # of "*" voor alle VM's van de host
files: # optioneel, mag ontbreken
- D:\Shares
  • Toepassingsconsistent, zonder afsluiten. De schaduwkopie ontstaat via DiskShadow met de Hyper-V-writer. Met de integratieservice voor back-up (volumeschaduwkopie) in de gast is dat een online back-up, waarbij ook toepassingen zoals SQL Server consistent worden; zonder die service zet Hyper-V de VM kort in de opgeslagen toestand.
  • Eén back-up per VM, opgebouwd als een export van Hyper-V. Na het herstellen leest Import-VM hem in als kopie met een nieuwe ID.
  • Volledige back-up. Elke run back-upt de hele VM. De standaardlimiet van 100 GB per back-up (zie Limieten) verhogen wij op verzoek.
  • Vereisten. Windows Server 2025 of 2022, client als beheerder, VM-bestanden op lokale volumes van een zelfstandige host. VM's op Cluster Shared Volumes of SMB-shares, pass-through-schijven en VHD Sets weigert de client met een melding. Zonder DiskShadow (Windows 10/11), of als de Hyper-V-writer faalt, back-upt hij alleen crashconsistent en waarschuwt hij; on_writer_error: abort breekt in plaats daarvan af.
  • Oudere controlepunten na de import. Een controlepunt dat al vóór de back-up bestond, start in de geïmporteerde VM pas met Secure Boot als eerst de Secure Boot-sjabloon opnieuw wordt ingesteld (Set-VMFirmware -VM $vm -EnableSecureBoot On -SecureBootTemplate MicrosoftWindows). Na een import uit de eigen export van Hyper-V is dat net zo.

Een stapsgewijze handleiding met hersteltest staat op de blog: Hyper-V VM's back-uppen zonder ze af te sluiten en Een Hyper-V VM herstellen uit de cloud.

Commando's voor en na de back-up​

Vanaf client 0.2.0 voert de client eigen commando's uit die onder hooks: staan, bijvoorbeeld een databasedump vóór de back-up:

lionbackup:
hooks:
pre_backup:
- 'C:\Scripts\database-back-up.cmd'
post_backup:
- 'C:\Scripts\na-de-back-up.cmd'
timeout_sec: 3600 # per commando, standaard 3600
FaseWanneerAls het commando mislukt
pre_backupvóór al het andere, nog vóór het controleren van de bronnenDe run back-upt niets.
post_snapshotzodra de schaduwkopie er is, anders na het lezenDe back-up loopt door, maar eindigt met een fout.
post_backupaltijd aan het einde, ook na foutenDe run eindigt met een fout.

Zet commando's tussen enkele aanhalingstekens: anders breekt een dubbele punt gevolgd door een spatie of een # in het commando de YAML. Onder Windows worden ze uitgevoerd via cmd.exe /C, onder Linux en macOS via /bin/sh -c.

Commando's draaien met de rechten van de client

Wie de configuratie mag wijzigen, kan daarmee commando's uitvoeren, op een server vaak als beheerder. Sla de configuratie zo op dat alleen beheerders haar kunnen wijzigen. Onder Linux en macOS weigert de client hooks: in een configuratie waarin de groep of anderen mogen schrijven.