github junkerderprovinz/bombvault v9.6.0

latest releases: v10.6.4, v10.6.3, v10.6.2...
one month ago

qcow2 VMs can be backed up by reading only the blocks that changed, and BombVault gets a documented HTTP API with tokens of its own, a Home Assistant device over MQTT and a name on the local network. Settings, schedules and repositories carry over as they are, and every new switch except the network announcement starts off.

✨ Added

Changed blocks for VMs

  • Changed blocks only. A running VM with qcow2 disks can be backed up through libvirt checkpoints, so each backup reads only the blocks written since the previous one. The VM keeps running, as with Live. Off by default, switched on per VM on its card.
  • Every restore point is complete on its own. Unchanged parts are taken over from the previous restore point without being read, so any of them restores the whole disk. A restore rebuilds the disk and converts it back to qcow2, which flattens a backing chain.
  • The checks before a restore know these restore points. The plan lists each disk the restore rebuilds and counts it at the most it can take, so a shortfall by that count leaves the space line grey instead of blocking. The restore check after the first backup, and Check restore, make sure every segment of every disk is there at the size it should have.
  • It falls back instead of failing. A missing or broken checkpoint or a disk that changed size means one full read. A VM that is off, a raw or zvol disk, no host SSH link or a libvirt without the backup API means the usual backup. The card says which the last run used and why. Unraid creates raw vdisks by default, and those keep the usual backup.
  • Nothing stays behind in libvirt. Between runs the VM has no checkpoint on record, so Unraid's Remove VM and a restore work as before. A backup job left running by an interrupted run is ended when BombVault starts again. Checkpoints of other tools are left alone, and a VM that has some cannot be restored until you delete them; the restore stops before it touches the VM. A refused restore keeps the chain, so the next backup still reads only what changed. The data waiting for restic takes up to 4 GiB under /config.
  • The guest is frozen only while the job starts. With the guest agent answering, BombVault freezes the guest's filesystems just for the start of the backup job. A thaw that fails is tried again for about fifteen seconds, and if the guest still does not thaw, BombVault sends a notification.

HTTP API

  • A documented API under /api/v1 for scripts and dashboards: health, status, activity, items, runs, anomalies and storage, and starting or cancelling a backup. BombVault serves its description at /api/v1/openapi.json (OpenAPI 3.1), which needs no token. Restores, deletions and settings stay in the web interface.
  • Tokens of its own. Create them under Settings, Integrations, API tokens, read-only or allowed to start backups. A token is shown once and stored as a fingerprint, and every request needs one, even without a login password. An MCP key does not open the API, and a token does not open MCP. Each token's tile shows its last use and has a log, Replace token and revoke. A request sent by a web page on another origin is refused.
  • The same limits as MCP. 12 starts per hour per token, and the 15 minutes between starts of the same item, the 4 starts per item a day and the retention guard count starts through MCP, the API and Home Assistant together. A run started this way reads "via API" with the token's name in the activity log.

Home Assistant and the local network

  • Home Assistant over MQTT discovery. Enter your broker under Settings, Integrations, Home Assistant and BombVault shows up as a device with sensors for its status, the running job, open anomalies, the next scheduled backup, and each domain's last backup, last result and repository free space. Home Assistant needs no custom component. When you change the broker's address, port or user name, enter the password again: BombVault does not hand the stored one to another broker or user.
  • Backup buttons are off by default. With Buttons start backups on, each domain gets a button that backs up the whole domain, under the API's limits. BombVault takes one press per domain at a time and at most six a minute, and ignores a press the broker kept as a retained message. Anyone who can publish to the broker can press them, so give the broker a password. A run started this way reads "via Home Assistant".
  • bombvault.local. BombVault announces its web interface over mDNS, so a browser reaches it as https://bombvault.local:3443. On by default, switched under Settings, Integrations, Find on the network. If the name is taken, it becomes bombvault-2.local. It answers only queries from the local network, and on the host network it leaves out Docker's and libvirt's bridges.

🎨 Design

  • README buttons for the relay and the widget, in a row of their own below the download buttons. The widget's button carries the widget's new logo.

⚡ Improved

  • The settings search finds the new cards. API tokens, Home Assistant and Find on the network sit on the Integrations page next to the MCP server, and searching for one of their captions, or for a word in one of their (i) texts, opens that page at the card.
  • MCP limits count the API and Home Assistant too. The 15 minutes between starts, the 4 starts per item a day and the retention guard also count starts through the API and from Home Assistant, and list_runs names such a run as started by the API or by Home Assistant. A refusal in a key's log says the item was started outside the web interface.
  • The settings export carries Home Assistant and the network switch. The broker password travels only in an export with credentials and is sealed again with the APP_KEY of the instance you import it into. The Home Assistant node id stays behind, so two instances made from one file do not send on the same topics; after a move, BombVault appears in Home Assistant as a new device. A file from an older version leaves both settings of the instance you import it into as they are.

🌐 Translations

  • Every new card, hint and message: 90 new strings in all 42 languages, and the MCP key log's cooldown refusal and the export's credentials switch, which now mention starts outside the web interface and the MQTT broker password.
  • The new API and integrations page in all 26 documentation languages, together with the new parts of the features, configuration and MCP server pages. The changed-blocks section of the VM backup guide is in English, like the rest of that guide.

Upgrading

  • Nothing has to be changed. The database is upgraded on the first start, settings export files from older versions still import, and no setting or environment variable was removed or renamed. restic stays at 0.17.3 and the repositories are left as they are.
  • New switches start off: changed blocks for VMs, Home Assistant and its buttons. Every API route except its description needs a token you create, so the API stays closed until you make one.
  • The network announcement starts on. In Docker's default bridge network, which the Unraid template uses, it stays inside Docker and nobody on the LAN sees it; open BombVault by the host's address as before. On br0, macvlan or ipvlan the container has its own address on the LAN, and the announcement reaches it, so https://bombvault.local:3443 works from any browser there. Switch it off under Settings, Integrations, Find on the network.
  • The first changed-block backup of a VM reads the whole disk. Only the runs after it read just what changed.

Don't miss a new bombvault release

NewReleases is sending notifications on new releases.