NAME

       vfs_snapper - Expose snapshots managed by snapper as shadow-copies

SYNOPSIS

       vfs objects = snapper

DESCRIPTION

       This VFS module is part of the samba(8) suite.

       The vfs_snapper VFS module exposes snapshots managed by snapper for use by Samba. This
       provides the ability for remote SMB clients to access shadow-copies via Windows Explorer
       using the "previous versions" dialog.

       Snapshots can also be created and remove remotely, using the File Server Remote VSS
       Protocol (FSRVP). Snapshot creation and deletion requests are forwarded to snapper via
       DBus.

       This module is stackable.

CONFIGURATION

       The underlying share path must have a corresponding snapper configuration file. The
       snapshot directory tree must allow access for relevant users.

                     [share]
                     vfs objects = snapper

       For remote snapshot creation and deletion, Samba's FSRVP server must be configured in the
       [global] section:

                     [global]
                     registry shares = yes
                     include = registry

PERMISSIONS

       Snapper stores snapshots under a .snapshots subdirectory. This directory must permit
       traversal for any users wishing to access snapshots via the Windows Explorer previous
       versions dialog. By default, traversal is forbidden for all non-root users. Additionally,
       users must be granted permission to list snapshots managed by snapper, via snapper's
       ALLOW_USERS or ALLOW_GROUPS options. Snapper can grant these users and groups .snapshots
       traversal access automatically via the SYNC_ACL option.

       Remote snapshot creation and deletion is only permitted by Samba for Active Directory
       administrators, backup operators, or users explicitly granted SeBackupPrivilege. Snapper
       must also permit creation and deletion for the appropriate user, via snapper's ALLOW_USERS
       or ALLOW_GROUPS options.

       The DiskShadow.exe FSRVP client initially authenticates as the Active Directory computer
       account. This account must therefore be granted the same permissions as the user account
       issuing the snapshot creation and deletion requests.

VERSION

       This man page is part of version 4.18.6-Ubuntu of the Samba suite.

AUTHOR

       The original Samba software and related utilities were created by Andrew Tridgell. Samba
       is now developed by the Samba Team as an Open Source project similar to the way the Linux
       kernel is developed.