Skip to content

Rule Action

Types

Type Description
route Route to the specified outbound
reject Reject the file
compare Compare with existing destination

route

Route the file entry to the specified outbound.

{
  "action": "route",
  "outbound": "archive-out"
}

outbound

The tag of the target outbound.

reject

Reject the file entry. Rejected entries are not routed to any outbound.

{
  "action": "reject"
}

compare

Compare the file entry with the existing destination.

A non-final action. If the file is unchanged, it is rejected. If the file is changed or does not exist, matching continues to the next rule.

{
  "action": "compare",
  "outbound": "archive-out",
  "checksum": false,
  "modify_window": ""
}

outbound

Required

The tag of the destination outbound to compare against.

The referenced outbound must support entry lookup:

Outbound Lookup
local File stat on the destination filesystem
archive Index lookup, custom format only
remote Query on the remote destination

Startup fails when the referenced outbound does not support entry lookup.

checksum

Compare content checksums instead of size and modification time. Content with a matching checksum is unchanged even when its modification time differs, and changed content is caught even when size and modification time are identical.

The source checksum is carried on each entry when the inbound enables checksum; the destination checksum comes from the archive index, or is computed from the destination file for the local outbound. The comparison works against compressed and encrypted archives, including behind Compress and Encrypt outbounds, because checksums are always of the source content. When either side offers no checksum, the rule falls back to size and modification time with a warning.

Size and modification time are compared by default.

modify_window

The maximum modification time difference, as a duration, at which two entries are still considered unchanged.

0 is used by default, requiring an exact match. Set a small window such as 2s when the destination filesystem stores coarse timestamps such as FAT and exFAT, which truncate to 2 seconds, otherwise every run treats unchanged files as modified.