Configuration reference

Common config properties

These properties are common to hopper, transform, and store configurations.

Name	Multi	Format	Description
include	Yes	property_name Value|Regex	Tests that a specific contextual property of a file is equal to a value or matches a regex. A file must pass all include tests
exclude	Yes	property_name Value|Regex	The opposite of include. Except a file is excluded if any exclusion rule is matched

Testable properties:

* source_type - What triggered the workflow, "directory" or "file"
* file_path - The full path of the individual files being considered, if the original file is an archive, this will bind to the extracted files
* file_name - The full name of the file extension and all
* file_stem - The name of the considered file, without its extension
* file_extension - The extension of the file considered file, without a dot

Hopper config

Name	Multi	Format	Optional	Description
path	No	Path	No	The path to the directory that should be watched for changes. Note that a change will only trigger the first hopper to match it
store	Yes	Text	No	A name of a store to which files should be offered
transform	Yes	Text	Yes	A name of a transform appropriate for files matched by this hopper
save	Yes	Text	Yes	A name of a property to save on the group that would be created for this file/directory/archive
phash_threshold	Yes	Number	Yes	A number between 0 to 64 indicating the amount of difference an image must have to all others for it to be considered unique

Transform config

Name	Multi	Format	Optional	Description
name	No	Text	No	A unique name so it can be referenced from hoppers
exec	No	Path	No	The path to the executable to invoke
args	No	Text	No	The format of the arguments to pass to the executable
consume	No	Bool	Yes	If yes or true, deletes the {from} file if the command does not

Available fields for args:

* {from} - The path of the file to process
* {to} - The path to the directory to where outputs should be emitted

Store config

Name	Multi	Format	Optional	Description
name	No	Text	No	A unique name so it can be referenced from hoppers
path	No	Text	No	The format of presented file paths
thumbnail_resolution	No	Number	Yes	The maximum number of pixels per side of a thumbnail
thumbnail_aspect	No	Text	Yes	The aspect ratio of thumbnails. The thumbnail will be cropped to fit this
thumbnail_path	No	Text	Yes	The format of thumbnails paths for presented files
thumbnail_format	No	Text	Yes	The kind of thumbnail to produce: PNG (default), or JPEG## (eg. JPEG92 for 92% quality jpeg)
transfer_method	No	Text	Yes	How the store accept files, link (default) for hard links, symblink for symbolic links, and copy for copy the file. Note that the service does not check whether hard links are supported and will promptly fail if the destination is not on the same file system

Available fields for path and thumbnail_path:

* {file_name} - The name of the file being projected
* {file_stem} - The name of the file being projected without extensions
* {file_extension} - The extension of the file (if any) without the dot
* {group_id} - The numeric id unique to the file's group
* {index} - The numeric (one based) id unique to the file within its group

Service config

Name	Multi	Format	Description
collection_path	No	Path	The location where index directories are stored. This must reside within the same filesystem as the stores and must never be deleted.
log_level	No	String	The level the daemon should log at: debug; (default) info; warning; error
ipc_socket	No	Path	The path of the unix domain socket used to control the daemon