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.

QGROUP=qgroup
    The btrfs quota group used for space aware cleanup algorithms.

    Only supported for btrfs.

SPACE_LIMIT=float or size
    Threshold for the maximum space snapshots should use on the filesystem. When snapshots exceed this limit (either as a fraction of the whole filesystem or an absolute value), snapper will remove older snapshots during cleanup operations. An absolute value must use the C locale.

    Only supported for btrfs.

    Default value is "0.5" (50% of the filesystem).

    New in version 0.3.0, absolute value new in version 0.9.0.

FREE_LIMIT=float or size
    Threshold for the minimum free space that should remain on the filesystem. When free space falls below this limit (either as a fraction of the whole filesystem or an absolute value), snapper will remove older snapshots during cleanup operations to reclaim space. An absolute value must use the C locale.

    Only supported for btrfs.

    Default value is "0.2" (20% of the filesystem).

    New in version 0.8.0, absolute value new in version 0.9.0.

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 "\".

    Also see the PERMISSIONS section in snapper(8).

    Using network users should be avoided since it can break most commands including rollback when the network does not work.

    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 "\".

    Also see the PERMISSIONS section in snapper(8).

    Using network groups should be avoided since it can break most commands including rollback when the network does not work.

    Default value is "".

SYNC_ACL=boolean
    Defines whether snapper will sync the users and groups from ALLOW_USERS and ALLOW_GROUPS to the ACL of the .snapshots directory.

    Also see the PERMISSIONS section in snapper(8).

    Default value is "no".

    New in version 0.2.0.

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

    Default value is "yes".

COMPRESSION=algorithm
    Defines the compression algorithm used for saving file list. Allowed values are "none" and "gzip". Depending on the installed libraries, some compression algorithms might not be available.

    Default value is "gzip".

    New in version 0.10.1.

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 "3600".

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

    Default value is "50".

NUMBER_LIMIT_IMPORTANT=number or range
    Defines how many important snapshots the number cleanup algorithm should keep. Important snapshots have important=yes in the userdata. The youngest important snapshots will be kept.

    The number of normal and important snapshots are counted independently.

    Default value is "10".

    New in version 0.1.8.

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 in the recent past and fewer 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 "3600".

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

    Default value is "10".

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

    Default value is "10".

TIMELINE_LIMIT_WEEKLY=number or range
    Defines how many weekly snapshots the timeline cleanup algorithm should keep. A weekly snapshot is the first snapshot in a week. The youngest weekly snapshots will be kept. In compliance with ISO 8601 weeks start on Monday.

    Default value is "0".

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

    Default value is "10".

TIMELINE_LIMIT_QUARTERLY=number or range
    Defines how many quarterly snapshots the timeline cleanup algorithm should keep. A quarterly snapshot is the first snapshot in a quarter. The youngest quarterly snapshots will be kept.

    Default value is "0".

TIMELINE_LIMIT_YEARLY=number or range
    Defines how many yearly snapshots the timeline cleanup algorithm should keep. A yearly snapshot is the first snapshot in a year. The youngest yearly 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 "3600".

TYPES

Some of the types used for the variables deserve an explanation.

range
    A range of numbers given as min-value-max-value, e.g. "10-20".

qgroup
    A btrfs qgroup in the standard form level-id, e.g. "1/0".

NOTES

The default values stated here are the values snapper uses when the entry is missing in the configuration file. Some are not identical to the values from the configuration file template.

HOMEPAGE

http://snapper.io/

AUTHORS

Arvin Schnell <aschnell@suse.com>

SEE ALSO

snapper(8), snapperd(8)