docs-xml/manpages/vfs_snapper.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_snapper.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_snapper</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_snapper</refname>
  16         <refpurpose>
  17                 Expose snapshots managed by snapper as shadow-copies
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = snapper</command>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29
  30         <para>This VFS module is part of the
  31         <citerefentry><refentrytitle>samba</refentrytitle>
  32         <manvolnum>8</manvolnum></citerefentry> suite.</para>
  33
  34         <para>
  35                 The <command>vfs_snapper</command> VFS module exposes snapshots
  36                 managed by snapper for use by Samba. This provides the ability
  37                 for remote SMB clients to access shadow-copies via Windows
  38                 Explorer using the "previous versions" dialog.
  39         </para>
  40
  41         <para>
  42                 Snapshots can also be created and remove remotely, using the
  43                 File Server Remote VSS Protocol (FSRVP). Snapshot creation and
  44                 deletion requests are forwarded to snapper via DBus.
  45         </para>
  46
  47         <para>
  48                 This module is stackable.
  49         </para>
  50 </refsect1>
  51
  52 <refsect1>
  53         <title>CONFIGURATION</title>
  54
  55         <para>
  56                 The underlying share path must have a corresponding snapper
  57                 configuration file. The snapshot directory tree must allow
  58                 access for relevant users.
  59         </para>
  60
  61         <programlisting>
  62                 <smbconfsection name="[share]"/>
  63                 <smbconfoption name="vfs objects">snapper</smbconfoption>
  64         </programlisting>
  65
  66         <para>
  67                 For remote snapshot creation and deletion, Samba's FSRVP
  68                 server must be configured in the [global] section:
  69         </para>
  70
  71         <programlisting>
  72                 <smbconfsection name="[global]"/>
  73                 <smbconfoption name="registry shares">yes</smbconfoption>
  74                 <smbconfoption name="include">registry</smbconfoption>
  75         </programlisting>
  76 </refsect1>
  77
  78 <refsect1>
  79         <title>PERMISSIONS</title>
  80         <para>
  81                 Snapper stores snapshots under a .snapshots subdirectory. This
  82                 directory must permit traversal for any users wishing to access
  83                 snapshots via the Windows Explorer previous versions dialog.
  84                 By default, traversal is forbidden for all non-root users.
  85                 Additionally, users must be granted permission to list snapshots
  86                 managed by snapper, via snapper's ALLOW_USERS or ALLOW_GROUPS
  87                 options. Snapper can grant these users and groups .snapshots
  88                 traversal access automatically via the SYNC_ACL option.
  89         </para>
  90         <para>
  91                 Remote snapshot creation and deletion is only permitted by Samba
  92                 for Active Directory administrators, backup operators, or users
  93                 explicitly granted SeBackupPrivilege. Snapper must also permit
  94                 creation and deletion for the appropriate user, via snapper's
  95                 ALLOW_USERS or ALLOW_GROUPS options.
  96         </para>
  97         <para>
  98                 The DiskShadow.exe FSRVP client initially authenticates as the
  99                 Active Directory computer account. This account must therefore
 100                 be granted the same permissions as the user account issuing the
 101                 snapshot creation and deletion requests.
 102         </para>
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>VERSION</title>
 107
 108         <para>
 109                 This man page is part of version &doc.version; of the Samba suite.
 110         </para>
 111 </refsect1>
 112
 113 <refsect1>
 114         <title>AUTHOR</title>
 115
 116         <para>The original Samba software and related utilities
 117         were created by Andrew Tridgell. Samba is now developed
 118         by the Samba Team as an Open Source project similar
 119         to the way the Linux kernel is developed.</para>
 120
 121 </refsect1>
 122
 123 </refentry>