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
Limit for the fraction of the filesystems space the snapshots
should use.
Only supported for btrfs.
Default value is "0.5".
New in version 0.3.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).
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).
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".
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 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 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 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_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 "1800".
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 <[email protected]>
SEE ALSO
snapper(8), snapperd(8)
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
