obox-fs.sh(1) - Wrapper for doveadm-fs(1) commands

SYNOPSIS

obox-fs.sh [OPTIONS] command [command_arguments]

DESCRIPTION

This script wraps various sub-commands of doveadm-fs(1) with sanitized user input. For example the user and settings argument are looked up first before supplying them to the actual doveadm-fs(1) subcommand. Furthermore automatic cleanup of dangling links can be issued if desired.

All doveadm-fs(1) subcommands are called with the metawrap driver enabled as this is implied in the obox fs settings.

OPTIONS

-D

Enables verbosity and debug messages.

-set name

Operate on a specific setting by name can be one of obox_fs, obox_index_fs or fts_dovecot_fs (default is obox_fs).

• Use -set obox_fs for mail objects,
• use -set obox_index_fs for mailbox objects (iterating mailbox-guids, iterating and downloading index-bundles),
• use -set fts_dovecot_fs for fts objects (iterating and downloading fts index objects).

-delete-dangling-links

Automatically removes files that exist in dict but not in storage.

COMMANDS

obox-fs.sh get

obox-fs.sh [OPTIONS] get username object-path

Retrieve data associated with the path provided.

obox-fs.sh metadata

obox-fs.sh [OPTIONS] metadata username object-path

Retrieve metadata associated with the path provided.

obox-fs.sh stat

obox-fs.sh [OPTIONS] stat username object-path

Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.

obox-fs.sh iter

obox-fs.sh [OPTIONS] iter username object-path

Iterate through all data files in the path provided.

obox-fs.sh iter-dirs

obox-fs.sh [OPTIONS] iter-dirs username object-path

Iterate through all directories in the path provided.

obox-fs.sh put

obox-fs.sh [OPTIONS] put username object-path local-path

Store data as the path provided.

obox-fs.sh copy

obox-fs.sh [OPTIONS] copy username source-path dest-path

Copy source path to the destination path.

obox-fs.sh delete

obox-fs.sh [OPTIONS] delete username object-path

Delete all data associated with the path provided.

SEE ALSO

doveadm(1), doveadm-fs(1)