snapper-configs(5)

1SNAPPER-CONFIGS(5)      Filesystem Snapshot Management      SNAPPER-CONFIGS(5)
2
3
4

NAME

6       snapper-configs - Configuration files for snapper configs
7

DESCRIPTION

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

VARIABLES

12       The following is a list of variables that can be present in the
13       configuration file. Boolean values must be "yes" or "no".
14
15       SUBVOLUME=path
16           Path of the subvolume or mount point.
17
18           There is no default value. The value must always be specified.
19
20       FSTYPE=value
21           Filesystem type for the subvolume.
22
23           Default value is "btrfs" but it's recommended to always specify the
24           filesystem type.
25
26       QGROUP=qgroup
27           The btrfs quota group used for space aware cleanup algorithms.
28
29           Only supported for btrfs.
30
31       SPACE_LIMIT=float
32           Limit for the fraction of the filesystems space the snapshots
33           should use.
34
35           Only supported for btrfs.
36
37           Default value is "0.5".
38
39           New in version 0.3.0.
40
41       FREE_LIMIT=float
42           Limit for the fraction of the filesystem space that should be free.
43
44           Only supported for btrfs.
45
46           Default value is "0.2".
47
48           New in version 0.8.0.
49
50       ALLOW_USERS=users
51           List of users allowed to operate with the config. The user-names
52           must be separated by spaces. Spaces in usernames can be escaped
53           with a "\".
54
55           Also see the PERMISSIONS section in snapper(8).
56
57           Default value is "" but "root" is always implicitly included.
58
59       ALLOW_GROUPS=groups
60           List of groups allowed to operate with the config. The group-names
61           must be separated by spaces. Spaces in group-names can be escaped
62           with a "\".
63
64           Also see the PERMISSIONS section in snapper(8).
65
66           Default value is "".
67
68       SYNC_ACL=boolean
69           Defines whether snapper will sync the users and groups from
70           ALLOW_USERS and ALLOW_GROUPS to the ACL of the .snapshots
71           directory.
72
73           Also see the PERMISSIONS section in snapper(8).
74
75           Default value is "no".
76
77           New in version 0.2.0.
78
79       BACKGROUND_COMPARISON=boolean
80           Defines whether pre and post snapshots should be compared in the
81           background after creation.
82
83           Default value is "yes".
84
85       NUMBER_CLEANUP=boolean
86           Defines whether the number cleanup algorithm should be run for the
87           config.
88
89           Default value is "no".
90
91       NUMBER_MIN_AGE=seconds
92           Minimal age for snapshots to be deleted by the number cleanup
93           algorithm.
94
95           Default value is "1800".
96
97       NUMBER_LIMIT=number or range
98           Defines how many snapshots the number cleanup algorithm should
99           keep. The youngest snapshots will be kept.
100
101           Default value is "50".
102
103       NUMBER_LIMIT_IMPORTANT=number or range
104           Defines how many important snapshots the number cleanup algorithm
105           should keep. Important snapshots have important=yes in the
106           userdata. The youngest important snapshots will be kept.
107
108           The number of normal and important snapshots are counted
109           independently.
110
111           Default value is "10".
112
113           New in version 0.1.8.
114
115       TIMELINE_CREATE=boolean
116           Defines whether hourly snapshots should be created.
117
118           Together with the timeline cleanup algorithm this will create a
119           collection of snapshots with more snapshots is the near past and
120           less snapshots in the far past.
121
122           Default value is "no".
123
124       TIMELINE_CLEANUP=boolean
125           Defines whether the timeline cleanup algorithm should be run for
126           the config.
127
128           Default value is "no".
129
130       TIMELINE_MIN_AGE=seconds
131           Minimal age for snapshots to be deleted by the timeline cleanup
132           algorithm.
133
134           Default value is "1800".
135
136       TIMELINE_LIMIT_HOURLY=number or range
137           Defines how many hourly snapshots the timeline cleanup algorithm
138           should keep. An hourly snapshot is the first snapshot in an hour.
139           The youngest hourly snapshots will be kept.
140
141           Default value is "10".
142
143       TIMELINE_LIMIT_DAILY=number or range
144           Defines how many daily snapshots the timeline cleanup algorithm
145           should keep. A daily snapshot is the first snapshot in a day. The
146           youngest daily snapshots will be kept.
147
148           Default value is "10".
149
150       TIMELINE_LIMIT_WEEKLY=number or range
151           Defines how many weekly snapshots the timeline cleanup algorithm
152           should keep. A weekly snapshot is the first snapshot in a week. The
153           youngest weekly snapshots will be kept. In compliance with ISO 8601
154           weeks start on Monday.
155
156           Default value is "0".
157
158       TIMELINE_LIMIT_MONTHLY=number or range
159           Defines how many monthly snapshots the timeline cleanup algorithm
160           should keep. A monthly snapshot is the first snapshot in a month.
161           The youngest monthly snapshots will be kept.
162
163           Default value is "10".
164
165       TIMELINE_LIMIT_YEARLY=number or range
166           Defines how many yearly snapshots the timeline cleanup algorithm
167           should keep. A yearly snapshot is the first snapshot in a year. The
168           youngest yearly snapshots will be kept.
169
170           Default value is "10".
171
172       EMPTY_PRE_POST_CLEANUP=boolean
173           Defines whether the empty-pre-post cleanup algorithm should be run
174           for the config.
175
176           Default value is "no".
177
178       EMPTY_PRE_POST_MIN_AGE=seconds
179           Minimal age for snapshots to be deleted by the empty-pre-post
180           cleanup algorithm.
181
182           Default value is "1800".
183

TYPES

185       Some of the types used for the variables deserve an explanation.
186
187       range
188           A range of numbers given as min-value-max-value, e.g. "10-20".
189
190       qgroup
191           A btrfs qgroup in the standard form level-id, e.g. "1/0".
192

NOTES

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

HOMEPAGE

199       http://snapper.io/
200

AUTHORS

202       Arvin Schnell <aschnell@suse.com>
203