1PAM_SNAPPER(8) Filesystem Snapshot Management PAM_SNAPPER(8)
2
6 pam_snapper - PAM module which creates filesystem snapshots via
7 "snapper"
8
10 pam_snapper.so [debug] [homeprefix=prefix] [ignoreservices=services]
11 [ignoreusers=users] [rootasroot] [ignoreroot] [openonly]
12 [closeonly] [cleanup=algorithm]
13
15 Create a snapshot at every login of a user, thus he or she always has a
16 save starting point.
17 As many users do not logout for some time, it is a good idea to enable
19 snapper's time based snapshots in addition.
20
22 debug
23 Switch on debugging in the module.
24 homeprefix=prefix
26 Prefix for the name of the snapper configuration. The username will
27 be appended to this prefix.
28 Default: "home_"
30 ignoreservices=comma separated list of services
32 Default: "crond"
33 ignoreusers=comma separated list of users
35 Default: (none)
36 rootasroot
38 Perform a snapshot using the snapper configuration "root" if the
39 user "root" logs in. In other words: the homeprefix is not used in
40 this case. As the snapper configuration "root" is used for the
41 system (the root filesystem), this means that with every login of
42 the user "root" the complete "/" filesystem will be snapshotted.
43 This can be useful to help administrators rolling back in case
44 their activity / configuration changes have been accidentally
45 wrong.
46 "rootasroot" and "ignoreroot" are mutually exclusive.
48 ignoreroot
50 No snapshot is taken, if the user "root" opens/closes a session.
51 "rootasroot" and "ignoreroot" are mutually exclusive.
53 openonly
55 Only create a single snapshot when opening the PAM session.
56 Default: create pre- and post-snapshots
58 closeonly
60 Only create a single snapshot when closing the PAM session.
61 Default: create pre- and post-snapshots
63 cleanup=cleanup-algorithm
65 Set snapper cleanup algorithm.
66 Default: (none)
68
70 Only the module type "session" is provided.
71
73 PAM_SUCCESS
74 pam_snapper will always return PAM_SUCCESS, to not prevent users
75 from login, in case a snapshot fails. This may change in the
76 future.
77
79 Basic usage
80 1. Create a btrfs subvolume for the new user and a snapper
81 configuration, e.g. using the tool
82 /usr/lib/pam_snapper/pam_snapper_useradd.sh.
83 2. Add the following line to /etc/pam.d/common-session:
85 session optional pam_snapper.so
87
91 snapper(8), pam.conf(5), pam(8), pam_snapper_homeconvert,
92 pam_snapper_pamconfig, pam_snapper_useradd, pam_snapper_userdel
93
95 http://snapper.io/
96
98 pam-snapper was written by Matthias G. Eckermann <mge@suse.com> as part
99 of SUSE Hackweek#9 in April 2013.
100 This module would not have been possible without the work of Arvin
102 Schnell on the snapper project. pam-snapper inherits DBUS handling from
103 "snapper_dbus_cli.c" by David Disseldorp.
104 The module builds on the Linux PAM stack and its documentation, written
106 by Thorsten Kukuk.
107
109 Copyright (c) 2013 SUSE
110 All Rights Reserved.
112 This program is free software; you can redistribute it and/or modify it
114 under the terms of version 2 of the GNU General Public License as
115 published by the Free Software Foundation.
116 This program is distributed in the hope that it will be useful, but
118 WITHOUT ANY WARRANTY without even the implied warranty of
119 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
120 General Public License for more details.
121 You should have received a copy of the GNU General Public License along
123 with this program; if not, contact SUSE.
124 To contact SUSE about this file by physical or electronic mail, you may
126 find current contact information at www.suse.com.
1270.8.16 2013-05-23 PAM_SNAPPER(8)