1VFS_RECYCLE(8) System Administration tools VFS_RECYCLE(8)
2
6 vfs_recycle - Samba VFS recycle bin
7
9 vfs objects = recycle
10
12 This VFS module is part of the samba(7) suite.
13 The vfs_recycle intercepts file deletion requests and moves the
15 affected files to a temporary repository rather than deleting them
16 immediately. This gives the same effect as the Recycle Bin on Windows
17 computers.
18 The Recycle Bin will not appear in Windows Explorer views of the
20 network file system (share) nor on any mapped drive. Instead, a
21 directory called .recycle will be automatically created when the first
22 file is deleted and recycle:repository is not configured. If
23 recycle:repository is configured, the name of the created directory
24 depends on recycle:repository. Users can recover files from the recycle
25 bin. If the recycle:keeptree option has been specified, deleted files
26 will be found in a path identical with that from which the file was
27 deleted.
28 This module is stackable.
30
32 recycle:repository = PATH
33 Path of the directory where deleted files should be moved.
34 If this option is not set, the default path .recycle is used.
36 recycle:directory_mode = MODE
38 Set MODE to the octal mode the recycle repository should be created
39 with. The recycle repository will be created when first file is
40 deleted. If recycle:subdir_mode is not set, MODE also applies to
41 subdirectories.
42 If this option is not set, the default mode 0700 is used.
44 recycle:subdir_mode = MODE
46 Set MODE to the octal mode with which sub directories of the
47 recycle repository should be created.
48 If this option is not set, subdirectories will be created with the
50 mode from recycle:directory_mode.
51 recycle:keeptree = BOOL
53 Specifies whether the directory structure should be preserved or
54 whether the files in a directory that is being deleted should be
55 kept separately in the repository.
56 recycle:versions = BOOL
58 If this option is True, two files with the same name that are
59 deleted will both be kept in the repository. Newer deleted versions
60 of a file will be called "Copy #x of filename".
61 recycle:touch = BOOL
63 Specifies whether a file's access date should be updated when the
64 file is moved to the repository.
65 recycle:touch_mtime = BOOL
67 Specifies whether a file's last modified date should be updated
68 when the file is moved to the repository.
69 recycle:minsize = BYTES
71 Files that are smaller than the number of bytes specified by this
72 parameter will not be put into the repository.
73 recycle:maxsize = BYTES
75 Files that are larger than the number of bytes specified by this
76 parameter will not be put into the repository.
77 recycle:exclude = LIST
79 List of files that should not be put into the repository when
80 deleted, but deleted in the normal way. Wildcards such as * and ?
81 are supported.
82 recycle:exclude_dir = LIST
84 List of directories whose files should not be put into the
85 repository when deleted, but deleted in the normal way. Wildcards
86 such as * and ? are supported.
87 recycle:noversions = LIST
89 Specifies a list of paths (wildcards such as * and ? are supported)
90 for which no versioning should be used. Only useful when
91 recycle:versions is enabled.
92
94 Move files "deleted" on share to /data/share/.recycle instead of
95 deleting them:
96 [share]
98 path = /data/share
99 vfs objects = recycle
100 recycle:repository = .recycle
101 recycle:keeptree = yes
102 recycle:versions = yes
103
105 This man page is part of version 4.17.5 of the Samba suite.
106
108 The original Samba software and related utilities were created by
109 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
110 Source project similar to the way the Linux kernel is developed.
111Samba 4.17.5 01/26/2023 VFS_RECYCLE(8)