Archive

archive inbound reads file entries from an archive file.

Structure

{
  "type": "archive",
  "tag": "archive-in",
  "path": "/backup/backup.tar",
  "format": "tar",
  "at": "",
  "compression": {
    "algorithm": ""
  },
  "encryption": {
    "algorithm": "aes-256-gcm",
    "password": "$ENCRYPTION_KEY"
  }
}

Fields

path

Required

The path to the archive file, or to a directory of rotated archives produced by the keep field of the Archive outbound. The newest archive in the directory is used.

at

Read entries as of the specified time.

Format: 2006-01-02 15:04:05.

For the custom format, the latest version of each entry at or before the time is used. When path points to a directory of rotated archives, the newest archive at or before the time is selected.

The latest version is used if empty.

format

The archive format.

Format	Description
tar	Standard tar format
custom	Custom block-based archive format, .tes suffix

tar is used by default.

compression

Compression of the archive.

For the custom format, the algorithm is read from the archive header and this field is ignored.

For the tar format, the algorithm is detected from the file header if empty.

encryption

Encryption of the archive.

For the custom format, the algorithm is read from the archive header and only encryption.password is consulted.

For the tar format, both encryption.algorithm and encryption.password must be declared, since encrypted tar archives are not self-describing.

encryption.algorithm

The encryption algorithm.

Algorithm	Description
aes-256-gcm	AES-256 in GCM mode
chacha20	ChaCha20-Poly1305

encryption.password

The encryption password.

Entry-level Wrappers

The compression and encryption fields above reverse transformations that were applied to the archive as a whole.

Entries that were transformed individually by Compress, Encrypt, or Chunk outbounds must instead be read through the matching inbound wrappers, mirroring the outbound chain in reverse order.