Skip to content

v0.1.0

Choose a tag to compare

@jzbz jzbz released this 21 Aug 19:55
· 41 commits to master since this release
v0.1.0
53db336

First tagged release.

brb bin-packs a directory tree into disc-sized groups using first-fit
decreasing packing, builds one self-contained SquashFS image per disc, encrypts
it with age, computes par2 recovery data over the
ciphertext, and images each disc as ISO 9660 for BD-R, BD-R DL or BDXL — built
on demand as you burn.

Every disc is independent: losing one loses only the files that lived on it,
and every disc carries the full directory structure of the original tree.
Restoring needs nothing but the Linux kernel and standard tools — repair with
par2, decrypt with age, mount the SquashFS. No brb, no Python, no bespoke
archive format.

Why 0.1.0

The number describes the tool, not the discs. Both readers are held to the same
on-disc format by a cross-implementation suite that builds a set with the Go
build and reads it with both, but the format has not earned a stability promise
yet, and neither has a 1.0. A disc written by this release is permanent
whatever the version says, and carries its own reader.

Artifacts

File What it is
brb-v0.1.0-linux-amd64 static binary, x86-64 — writes and reads
brb-v0.1.0-linux-aarch64 static binary, aarch64 — writes and reads
brb-v0.1.0.sh bash reader: doctor, ingest, restore, mount, list, index, verify-disc. It deliberately cannot write a set
brb-v0.1.0-src.tar.gz complete source, dependencies vendored, rebuilds with no network
SHA512SUMS hashes of the four above

Verify what you downloaded:

sha512sum --ignore-missing -c SHA512SUMS

The binaries are static — no libc, no interpreter, no shared libraries. The
source tarball rebuilds offline:

tar xzf brb-v0.1.0-src.tar.gz && cd brb-0.1.0/go && go build -mod=vendor ./cmd/brb

Requirements

Linux. Writing a set needs mksquashfs and unsquashfs (squashfs-tools 4.5 or
newer — 4.4 lacks -cpiostyle0 and is refused, which rules out Debian 11 and
Ubuntu 20.04), par2 and xorriso. It needs no age binary: encryption uses
filippo.io/age as a library. A restore through brb needs only unsquashfs
and par2; the final step can instead be a kernel mount,
sudo mount -o loop,ro disc07.squashfs /mnt (the images are zstd-compressed,
so kernel 4.14 or newer). Restoring with brb.sh, or by hand, also needs the
age binary. Building from source needs Go 1.25 or newer.

Installation

go install does not work on this repository, and no spelling of it does:
go/go.mod declares the module path as github.com/jzbz/brb while the module
lives in the repository's go/ subdirectory. Take a binary above, or build
from a checkout: cd go && go build -o ~/.local/bin/brb ./cmd/brb.

Generate a keypair before the first backup — brb init-key, or
brb init-key --rescue-key for a second, passphrase-protected identity.
brb backup refuses to start without a recipients file.

Before you rely on this

Test a restore before trusting a set. Every run is a full backup, not an
incremental one, and a completed set cannot be updated in place. A restore
overwrites its destination, mode and mtime included. Lose the age secret key
and the archive is unrecoverable — it is never written to a disc. The set is
not signed; the format has no signing key. See the README's Limitations section
for the rest.

MIT licensed.