Local

local inbound reads files from the local filesystem.

Structure

{
  "type": "local",
  "tag": "local-in",
  "path": "/data",
  "hard_links": true,
  "follow_symlinks": false,
  "xattr": false,
  "fake_super": false,
  "checksum": false
}

Fields

path

Required

The path to the directory or file on the local filesystem.

hard_links

Detect hard links.

When disabled, each path is emitted as an independent full entry.

Enabled by default.

follow_symlinks

Follow symbolic links and emit the target content instead of the link. Symbolic links to non-regular files are skipped with a warning.

When disabled, symbolic links are emitted as symbolic links.

Disabled by default.

xattr

Read extended attributes and carry them on each entry, so a Local outbound can restore them. On Linux this also carries POSIX ACLs, which are stored as system.posix_acl_* attributes.

Only supported on Linux and macOS.

Disabled by default.

fake_super

Reconstruct entries from the sidecar files written by a Local outbound with fake_super. Use this to read back a tree that was restored to a filesystem which could not hold that metadata natively.

Disabled by default.

checksum

Compute a SHA-256 checksum of each file while reading and carry it on the entry, for compare rules with checksum enabled.

Hashing costs extra CPU per file, so it is disabled by default.