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       ALLOW_USERS=users
27           List of users allowed to operate with the config. The user-names
28           must be separated by spaces. Spaces in usernames can be escaped
29           with a "\".
30
31           Also see the PERMISSONS section in snapper(8).
32
33           Default value is "" but "root" is always implicitly included.
34
35       ALLOW_GROUPS=groups
36           List of groups allowed to operate with the config. The group-names
37           must be separated by spaces. Spaces in group-names can be escaped
38           with a "\".
39
40           Also see the PERMISSONS section in snapper(8).
41
42           Default value is "".
43
44       SYNC_ACL=boolean
45           Defines whether snapper will sync the users and groups from
46           ALLOW_USERS and ALLOW_GROUPS to the ACL of the .snapshots
47           directory.
48
49           Also see the PERMISSONS section in snapper(8).
50
51           Default value is "no".
52
53           New in version 0.2.0.
54
55       BACKGROUND_COMPARISON=boolean
56           Defines whether pre and post snapshots should be compared in the
57           background after creation.
58
59           Default value is "yes".
60
61       NUMBER_CLEANUP=boolean
62           Defines whether the number cleanup algorithm should be run for the
63           config.
64
65           Default value is "no".
66
67       NUMBER_MIN_AGE=seconds
68           Minimal age for snapshots to be deleted by the number cleanup
69           algorithm.
70
71           Default value is "1800".
72
73       NUMBER_LIMIT=number
74           Defines how many snapshots the number cleanup algorithm should
75           keep. The youngest snapshots will be kept.
76
77           Default value is "50".
78
79       NUMBER_LIMIT_IMPORTANT=number
80           Defines how many important snapshots the number cleanup algorithm
81           should keep. Important snapshots have important=yes in the
82           userdata. The youngest important snapshots will be kept.
83
84           The number of normal and important snapshots are counted
85           independently.
86
87           Default value is "10".
88
89           New in version 0.1.8.
90
91       TIMELINE_CREATE=boolean
92           Defines whether hourly snapshots should be created.
93
94           Together with the timeline cleanup algorithm this will create a
95           collection of snapshots with more snapshots is the near past and
96           less snapshots in the far past.
97
98           Default value is "no".
99
100       TIMELINE_CLEANUP=boolean
101           Defines whether the timeline cleanup algorithm should be run for
102           the config.
103
104           Default value is "no".
105
106       TIMELINE_MIN_AGE=seconds
107           Minimal age for snapshots to be deleted by the timeline cleanup
108           algorithm.
109
110           Default value is "1800".
111
112       TIMELINE_LIMIT_HOURLY=number
113           Defines how many hourly snapshots the timeline cleanup algorithm
114           should keep. An hourly snapshot is the first snapshot in an hour.
115           The youngest hourly snapshots will be kept.
116
117           Default value is "10".
118
119       TIMELINE_LIMIT_DAILY=number
120           Defines how many daily snapshots the timeline cleanup algorithm
121           should keep. A daily snapshot is the first snapshot in a day. The
122           youngest daily snapshots will be kept.
123
124           Default value is "10".
125
126       TIMELINE_LIMIT_WEEKLY=number
127           Defines how many weekly snapshots the timeline cleanup algorithm
128           should keep. A weekly snapshot is the first snapshot in a week. The
129           youngest weekly snapshots will be kept. In compliance with ISO 8601
130           weeks start on Monday.
131
132           Default value is "0".
133
134       TIMELINE_LIMIT_MONTHLY=number
135           Defines how many monthly snapshots the timeline cleanup algorithm
136           should keep. A monthly snapshot is the first snapshot in a month.
137           The youngest monthly snapshots will be kept.
138
139           Default value is "10".
140
141       TIMELINE_LIMIT_YEARLY=number
142           Defines how many yearly snapshots the timeline cleanup algorithm
143           should keep. A yearly snapshot is the first snapshot in a year. The
144           youngest yearly snapshots will be kept.
145
146           Default value is "10".
147
148       EMPTY_PRE_POST_CLEANUP=boolean
149           Defines whether the empty-pre-post cleanup algorithm should be run
150           for the config.
151
152           Default value is "no".
153
154       EMPTY_PRE_POST_MIN_AGE=seconds
155           Minimal age for snapshots to be deleted by the empty-pre-post
156           cleanup algorithm.
157
158           Default value is "1800".
159

NOTES

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

HOMEPAGE

166       http://snapper.io/
167

AUTHORS

169       Arvin Schnell <aschnell@suse.de>
170

NAME

DESCRIPTION

VARIABLES

NOTES

HOMEPAGE

AUTHORS

SEE ALSO