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 or size
32           Limit of the filesystems space the snapshots should use. Either a
33           fraction of the whole filesystem for an absolute value. An absolute
34           value must use the C locale.
35
36           Only supported for btrfs.
37
38           Default value is "0.5".
39
40           New in version 0.3.0, absolute value new in version 0.9.0.
41
42       FREE_LIMIT=float or size
43           Limit of the filesystem space that should be free. Either a
44           fraction of the whole filesystem for an absolute value. An absolute
45           value must use the C locale.
46
47           Only supported for btrfs.
48
49           Default value is "0.2".
50
51           New in version 0.8.0, absolute value new in version 0.9.0.
52
53       ALLOW_USERS=users
54           List of users allowed to operate with the config. The user-names
55           must be separated by spaces. Spaces in usernames can be escaped
56           with a "\".
57
58           Also see the PERMISSIONS section in snapper(8).
59
60           Default value is "" but "root" is always implicitly included.
61
62       ALLOW_GROUPS=groups
63           List of groups allowed to operate with the config. The group-names
64           must be separated by spaces. Spaces in group-names can be escaped
65           with a "\".
66
67           Also see the PERMISSIONS section in snapper(8).
68
69           Default value is "".
70
71       SYNC_ACL=boolean
72           Defines whether snapper will sync the users and groups from
73           ALLOW_USERS and ALLOW_GROUPS to the ACL of the .snapshots
74           directory.
75
76           Also see the PERMISSIONS section in snapper(8).
77
78           Default value is "no".
79
80           New in version 0.2.0.
81
82       BACKGROUND_COMPARISON=boolean
83           Defines whether pre and post snapshots should be compared in the
84           background after creation.
85
86           Default value is "yes".
87
88       COMPRESSION=algorithm
89           Defines the compression algorithm used for saving file list.
90           Allowed values are "none" and "gzip". Depending on the installed
91           libraries, some compression algorithms might not be available.
92
93           Default value is "gzip".
94
95           New in version 0.10.1.
96
97       NUMBER_CLEANUP=boolean
98           Defines whether the number cleanup algorithm should be run for the
99           config.
100
101           Default value is "no".
102
103       NUMBER_MIN_AGE=seconds
104           Minimal age for snapshots to be deleted by the number cleanup
105           algorithm.
106
107           Default value is "1800".
108
109       NUMBER_LIMIT=number or range
110           Defines how many snapshots the number cleanup algorithm should
111           keep. The youngest snapshots will be kept.
112
113           Default value is "50".
114
115       NUMBER_LIMIT_IMPORTANT=number or range
116           Defines how many important snapshots the number cleanup algorithm
117           should keep. Important snapshots have important=yes in the
118           userdata. The youngest important snapshots will be kept.
119
120           The number of normal and important snapshots are counted
121           independently.
122
123           Default value is "10".
124
125           New in version 0.1.8.
126
127       TIMELINE_CREATE=boolean
128           Defines whether hourly snapshots should be created.
129
130           Together with the timeline cleanup algorithm this will create a
131           collection of snapshots with more snapshots is the near past and
132           less snapshots in the far past.
133
134           Default value is "no".
135
136       TIMELINE_CLEANUP=boolean
137           Defines whether the timeline cleanup algorithm should be run for
138           the config.
139
140           Default value is "no".
141
142       TIMELINE_MIN_AGE=seconds
143           Minimal age for snapshots to be deleted by the timeline cleanup
144           algorithm.
145
146           Default value is "1800".
147
148       TIMELINE_LIMIT_HOURLY=number or range
149           Defines how many hourly snapshots the timeline cleanup algorithm
150           should keep. An hourly snapshot is the first snapshot in an hour.
151           The youngest hourly snapshots will be kept.
152
153           Default value is "10".
154
155       TIMELINE_LIMIT_DAILY=number or range
156           Defines how many daily snapshots the timeline cleanup algorithm
157           should keep. A daily snapshot is the first snapshot in a day. The
158           youngest daily snapshots will be kept.
159
160           Default value is "10".
161
162       TIMELINE_LIMIT_WEEKLY=number or range
163           Defines how many weekly snapshots the timeline cleanup algorithm
164           should keep. A weekly snapshot is the first snapshot in a week. The
165           youngest weekly snapshots will be kept. In compliance with ISO 8601
166           weeks start on Monday.
167
168           Default value is "0".
169
170       TIMELINE_LIMIT_MONTHLY=number or range
171           Defines how many monthly snapshots the timeline cleanup algorithm
172           should keep. A monthly snapshot is the first snapshot in a month.
173           The youngest monthly snapshots will be kept.
174
175           Default value is "10".
176
177       TIMELINE_LIMIT_YEARLY=number or range
178           Defines how many yearly snapshots the timeline cleanup algorithm
179           should keep. A yearly snapshot is the first snapshot in a year. The
180           youngest yearly snapshots will be kept.
181
182           Default value is "10".
183
184       EMPTY_PRE_POST_CLEANUP=boolean
185           Defines whether the empty-pre-post cleanup algorithm should be run
186           for the config.
187
188           Default value is "no".
189
190       EMPTY_PRE_POST_MIN_AGE=seconds
191           Minimal age for snapshots to be deleted by the empty-pre-post
192           cleanup algorithm.
193
194           Default value is "1800".
195

TYPES

197       Some of the types used for the variables deserve an explanation.
198
199       range
200           A range of numbers given as min-value-max-value, e.g. "10-20".
201
202       qgroup
203           A btrfs qgroup in the standard form level-id, e.g. "1/0".
204

NOTES

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

HOMEPAGE

211       http://snapper.io/
212

AUTHORS

214       Arvin Schnell <aschnell@suse.com>
215