SNAPPER-CONFIGS(5)					  Filesystem Snapshot Management					SNAPPER-CONFIGS(5)

NAME

       snapper-configs - Configuration files for snapper configs

DESCRIPTION

       Each file /etc/snapper/configs/* describes a snapper config.

VARIABLES

       The following is a list of variables that can be present in the configuration file. Boolean values must be "yes" or "no".

       SUBVOLUME=path
	   Path of the subvolume or mount point.

	   There is no default value. The value must always be specified.

       FSTYPE=value
	   Filesystem type for the subvolume.

	   Default value is "btrfs" but it's recommended to always specify the filesystem type.

       ALLOW_USERS=users
	   List of users allowed to operate with the config. The user-names must be separated by spaces. Spaces in usernames can be escaped with a
	   "".

	   Default value is "" but "root" is always implicitly included.

       ALLOW_GROUPS=groups
	   List of groups allowed to operate with the config. The group-names must be separated by spaces. Spaces in group-names can be escaped
	   with a "".

	   Default value is "".

       BACKGROUND_COMPARISON=boolean
	   Defines whether pre and post snapshots should be compared in the background after creation.

	   Default value is "no".

       NUMBER_CLEANUP=boolean
	   Defines whether the number cleanup algorithm should be run for the config.

	   Default value is "no".

       NUMBER_MIN_AGE=seconds
	   Minimal age for snapshots to be deleted by the number cleanup algorithm.

	   Default value is "1800".

       NUMBER_LIMIT=number
	   Defines how many snapshots the number cleanup algorithm should keep. The youngest snapshots will be kept.

	   Default value is "50".

       TIMELINE_CREATE=boolean
	   Defines whether hourly snapshots should be created.

	   Together with the timeline cleanup algorithm this will create a collection of snapshots with more snapshots is the near past and less
	   snapshots in the far past.

	   Default value is "no".

       TIMELINE_CLEANUP=boolean
	   Defines whether the timeline cleanup algorithm should be run for the config.

	   Default value is "no".

       TIMELINE_MIN_AGE=seconds
	   Minimal age for snapshots to be deleted by the timeline cleanup algorithm.

	   Default value is "1800".

       TIMELINE_LIMIT_HOURLY=number
	   Defines how many hourly snapshots the timeline cleanup algorithm should keep. An hourly snapshots is the first snapshot in an hour. The
	   youngest hourly snapshots will be kept.

	   Default value is "10".

       TIMELINE_LIMIT_DAILY=number
	   Defines how many daily snapshots the timeline cleanup algorithm should keep. A daily snapshots is the first snapshot in a day. The
	   youngest daily snapshots will be kept.

	   Default value is "10".

       TIMELINE_LIMIT_MONTHLY=number
	   Defines how many daily snapshots the timeline cleanup algorithm should keep. A daily snapshots is the first snapshot in a day. The
	   youngest daily snapshots will be kept.

	   Default value is "10".

       TIMELINE_LIMIT_YEARLY=number
	   Defines how many daily snapshots the timeline cleanup algorithm should keep. A daily snapshots is the first snapshot in a day. The
	   youngest daily snapshots will be kept.

	   Default value is "10".

       EMPTY_PRE_POST_CLEANUP=boolean
	   Defines whether the empty-pre-post cleanup algorithm should be run for the config.

	   Default value is "no".

       EMPTY_PRE_POST_MIN_AGE=seconds
	   Minimal age for snapshots to be deleted by the empty-pre-post cleanup algorithm.

	   Default value is "1800".

HOMEPAGE

       http://snapper.io/

AUTHORS

       Arvin Schnell <aschnell@suse.de>

SEE ALSO

       snapper(8), snapperd(8)

0.1.7								    2013-07-09							SNAPPER-CONFIGS(5)