hbkit

Restore a Hyper Backup without a Synology NAS

This guide is for you if your NAS is gone and the backup is all you have. The backup is a folder whose name ends in .hbk, on a USB disk, a NAS share or a cloud bucket. The guide is also for you if you want to prove that your backup restores before you need it.

If the disk is slow, clicks or shows SMART errors, stop. Image it or send it to a recovery lab, then run hbkit on the copy.

hbkit never writes to the archive. If it is your only copy, copy the whole .hbk folder to another disk first and run hbkit on the copy.

hbkit is an open reader for your own backups. It is free and open source (MIT), and reads .hbk archives directly, with no Synology software. It has restored a 3 TB archive byte-exact. Its doctor command checks the layout and rebuilds a sample of files before you restore anything:

hbk doctor
$ hbk demo/synth.hbk doctor
          chunk codec : lz4
            encrypted : no
               shares : Documents, Photos
      backup versions : 3
      reading version : 3 (2026-10-28 08:33:20, Complete) - newest complete

  PASS  virtual_file layout known  (56 B)
  PASS  chunk_index layout known  (29 B)
  PASS  bucket layout known  (32 B)
  PASS  rebuilt 6 sampled files, all chunks verified  (6 ok, 0 failed)

  VERDICT: recoverable. Sampled files rebuilt byte-exact and checksum-verified.
Real hbkit output, shortened. The archive is a small one that hbkit's own tests build, not one from a NAS.

When the answer is no, the verdict says so: "cannot be recovered by this tool" or "do not trust output". After you install it, hbkit works offline for a local disk and sends nothing anywhere. It never writes to the archive.

What hbkit can't do yet

  • Synology C2 Storage: Not tested yet. Use Hyper Backup Explorer or C2 Storage Explorer in the C2 web portal.
  • Entire System backups and DSM settings: hbkit restores files and folders. To put a whole system or its settings back, you need a Synology NAS.
  • Damaged or encrypted files in Config/, for example after ransomware: hbkit needs the file index in Config/ and stops without it.
  • Key-file access: not supported. Use the password. Hyper Backup Explorer is the right tool if you only have the key file.
  • Older RSA-encrypted archives: not supported. Use Hyper Backup Explorer.
  • Restore on Windows: On Windows, CI restores test archives byte-exact on every change. A backup from a real NAS has not been restored on Windows yet.

Five steps

1. Copy the whole .hbk folder first

The backup is a folder such as nas_1.hbk, with Config/ and Pool/ inside. The file SynologyHyperBackup.bkpi is only a marker, and it can be empty. Your data is in Pool/. The file names and folders are in Config/. If you copy the backup, copy the whole .hbk folder, not only the .bkpi file.

hbkit never writes to the archive. If it is your only copy, copy the whole .hbk folder to another disk first and run hbkit on the copy. For a bucket, a copy on a local disk is much faster.

2. Install hbkit

brew install YordiLorenzo/tap/hbkit

Homebrew works on macOS and Linux, and it installs liblz4 for you. Without Homebrew, use pipx (or pip) and install liblz4 yourself:

pipx install hbkit
sudo apt install liblz4-1      # or: brew install lz4, sudo pacman -S lz4

hbkit needs Python 3.10 or newer.

3. Check the archive with doctor

hbk /Volumes/Backup doctor

Give it the .hbk folder, or any disk or folder that holds one. doctor reads the layout and rebuilds a sample of real files. It checks each of their chunks against the MD5 and CRC32 stored in the archive. For an encrypted archive, add -p and the password or set HBK_PASSWORD. doctor does not prompt for a password.

If the verdict is not "recoverable", do not restore yet. Open an issue and paste the output. The fixes in 0.4.5 and 0.4.6 came from reports like that (#1, #4).

4. Pick the backup version

hbk /Volumes/Backup versions

This lists every backup version with its start time and status, and marks the default. It needs no password. hbkit reads the newest complete version unless you choose another. --version 12 reads version 12. --version @2026-10-15 reads the newest complete version that started by the end of that day:

hbk /Volumes/Backup list invoice --version @2026-10-15

5. Restore

To tick folders in a full-screen browser:

hbk-tui /Volumes/Backup

Press space to tick a folder, d to choose the destination and r to start the restore. Before you start, it warns you if the selection will not fit. Or use one command:

hbk /Volumes/Backup get "/Photos/*" ~/restore

Paths start with a slash and the share name. Files go to ~/restore/Photos/... with their original dates. If the restore stops, run the same command again. It skips the files that are complete.

Where the backup is stored

WherePoint hbkit atWhat to know
USB or external diskThe disk, for example /Volumes/BackupFaster than a share or a bucket. From a USB hard disk that reads 92 MB/s at most, a restore ran at 58 MB/s.
NAS shareThe mounted shareWorks like a local folder. The first index of 1.1 million files took about 48 s, against about 10 s from a local disk.
S3, R2 or B2 bucketAn rclone mount: hbk mount r2:mybucket ~/mnt/backupMuch slower than a disk. Use -j 16. Copy the archive down first if you can.
Encrypted, in any of these placesThe same path, with -p, HBK_PASSWORD or the promptPassword only.
Synology C2 StorageNot tested yet with hbkitUse Hyper Backup Explorer or C2 Storage Explorer.

Ways to get the files back

hbkit is not always the right tool.

WayRuns onPriceLimitsRight when
Hyper Backup Explorer (Synology)Windows, macOS, Ubuntu. The Mac and Linux builds of 3.0.1 are x86-64 only.FreeNo command line. Last release 2023-04-13. Apple says Rosetta, which runs Intel apps on Apple silicon, stays available for all apps only through macOS 27. Apple’s notice.Windows or an Intel Mac, a C2 backup, or an archive that hbkit does not support. It also reads any backup version.
Explorer on a mounted bucketWindows or Mac, with Mountain Duck or rcloneMountain Duck: paid. rclone: free.The limits of Explorer, and every read crosses the network. We did not test rclone with Explorer.You want a desktop app and the bucket is too big to download. Jake Wright did this with B2 and Mountain Duck.
A new Synology NASSynology hardwareA NAS and drivesTime to buy and set up. Then in Hyper Backup: Restore > Data > Restore from existing repositories.You need an Entire System backup or DSM settings back. Synology says the new model must be the same or newer, with at least as many drives.
A second Synology that runs Hyper Backup VaultThat NASFree if you have itVault does not restore. Use the Hyper Backup app on that NAS: Restore > Data.Your backup went to that NAS and it still works.
Virtual DSMVirtual Machine Manager on a Synology NASNeeds a Synology NASThe vdsm/virtual-dsm Docker container also says "only run this container on Synology hardware".Seldom. On a Synology NAS, Hyper Backup itself is simpler.
C2 Storage Explorer, in the C2 web portalA web browserPart of your C2 planSynology: "A single folder can be downloaded up to 20 times per day." Encrypted shared folders do not show.Your backup is in C2 and you need a few files.
Callido RestoremacOS, Windows 10 and 11, a Synology NAS, DockerFree (MIT)Created 2026-10-30. Apps not signed or notarized. No client-side encryption yet. Not reviewed by us.An unencrypted archive that ransomware partly encrypted: since 1.3.1 it skips the encrypted parts and restores what is left. Or you want a desktop app with a timeline.
hbkitmacOS (Apple silicon and Intel), Linux. On Windows, CI restores test archives byte-exact on every change. A backup from a real NAS has not been restored on Windows yet.Free (MIT)A terminal app: a command line and a full-screen browser. See what hbkit can't do yet.Apple silicon, a headless server, a bucket, an encrypted archive, scripts, or when you want every chunk checked.
A data recovery labTheir labA quote for each caseMoney and time.The disk is failing. Ask for a copy of the disk, then use a tool above on the copy.

The README names two more open source readers under Prior art.

Linux, without a desktop

Synology's Explorer for Linux is a desktop app for x86-64 only. On a server, use hbkit over SSH:

pipx install hbkit
sudo apt install liblz4-1
hbk /mnt/backup doctor
hbk /mnt/backup get "/Documents/*" /srv/restore

hbk-tui runs in the terminal, so it also works over SSH. For a restore test from cron, doctor exits with 0 when the archive is recoverable and 1 when it is not. verify checks files without restoring them. It can write a local index cache, but never changes the archive. The README lists every exit code.

Restore from a bucket

Mount the bucket with rclone and point hbkit at the mount. hbk mount sets the rclone flags that matter and loads the folder listings once, at the start. It stores no keys. rclone config keeps them.

A 3 TB archive in Cloudflare R2Before tuningWith hbk mount
Mount and load the folder listingsabout 12 min16 s
Open the archive9 min 21 s1.8 s
Restore a 10 KB file584 s11 s

From R2, a restore ran at about 9.5 MB/s with -j 16. Decompressing and checking took 0.7% of the time, in that measurement. From Backblaze B2, a contributor rebuilt a 74,396,840-byte video exactly, with 9,072 chunks checked (PR #3). Start with one small folder and watch the speed.

Encrypted archives

hbkit reads archives with Hyper Backup's client-side encryption, with the password. It derives the public key from the password and compares it with the key in the archive. A wrong password is rejected before any data is read.

  • versions needs no password, because the version list is not encrypted.
  • The index cache in ~/.cache/hbkit holds the decrypted file names, not the contents. Delete it after the restore if that matters to you.
  • Tested on a small encrypted archive from Hyper Backup 4.1.2 and a 7-version encrypted archive from Hyper Backup 4.2.2 (#4).
  • Not supported: access with the key file, and older RSA-encrypted archives. Use Hyper Backup Explorer for those.

Leaving Synology

Synology's spec page says multi-version backups "can be read only with Hyper Backup, Hyper Backup Explorer, and Hyper Backup Vault." All three are Synology software. hbkit reads these backups without Synology software, and FORMAT.md is a public description of the .hbk format, written so archives stay readable. The Mac version of Explorer needs Rosetta. hbkit runs natively on Apple silicon. See the Mac guide for setup and ext4 USB disks. Before you move to other hardware:

  1. Run doctor on each archive from a computer, not from the NAS.
  2. Restore the data you want to keep into plain folders.
  3. Keep the .hbk folders. hbkit can still read their older versions with --version.

For errors during a restore, see damaged backups.

Start with doctor

brew install YordiLorenzo/tap/hbkit
hbk /Volumes/Backup doctor

doctor writes nothing to the backup. If it does not say "recoverable", open an issue with its output. Every command is in the README.