Local

local outbound writes files to the local filesystem.

Structure

{
  "type": "local",
  "tag": "local-out",
  "path": "/restore",
  "sparse": false,
  "fake_super": false,

  ... // Metadata Fields
}

Fields

path

Required

The path to the directory on the local filesystem.

sparse

Write files sparsely: runs of zero bytes are turned into filesystem holes instead of allocated blocks. The restored content is identical; only the on-disk allocation differs.

Disabled by default.

Extended attributes carried by the Local inbound xattr option are applied automatically when present.

fake_super

Preserve metadata a capability-poor destination cannot represent natively — ownership, permissions, and special files such as devices, named pipes, sockets and symbolic links — by storing it in a companion sidecar file named .backup-dev~<name> instead of applying it to the filesystem. Special files are written as empty placeholders alongside their sidecar.

A Local inbound with fake_super reads the sidecars back and reconstructs the original entries, so a backup restored to NTFS, FAT, or an unprivileged location round-trips losslessly. This mirrors rsync's --fake-super; both ends must enable it.

Disabled by default.

Metadata Fields

See Metadata Fields for details.

Metadata fields control which file attributes are applied when writing entries to the filesystem.