VFS_FRUIT(8) | System Administration tools | VFS_FRUIT(8) |
NAME
vfs_fruit - Enhanced OS X and Netatalk interoperability
SYNOPSIS
vfs objects = fruit
DESCRIPTION
This VFS module is part of the samba(7) suite.
The vfs_fruit module provides enhanced compatibility with Apple SMB clients and interoperability with a Netatalk 3 AFP fileserver.
The module should be stacked with vfs_catia if enabling character conversion and must be stacked with vfs_streams_xattr, see the example section for the correct config.
The module enables alternate data streams (ADS) support for a share, intercepts the OS X special streams "AFP_AfpInfo" and "AFP_Resource" and handles them in a special way. All other named streams are deferred to vfs_streams_xattr which must be loaded together with vfs_fruit.
Be careful when mixing shares with and without vfs_fruit. OS X clients negotiate SMB2 AAPL protocol extensions on the first tcon, so mixing shares with and without fruit will globally disable AAPL if the first tcon is without fruit.
Having shares with ADS support enabled for OS X client is worthwhile because it resembles the behaviour of Apple's own SMB server implementation and it avoids certain severe performance degradations caused by Samba's case sensitivity semantics.
The OS X metadata and resource fork stream can be stored in a way compatible with Netatalk 3 by setting fruit:resource = file and fruit:metadata = netatalk.
OS X maps NTFS illegal characters to the Unicode private range in SMB requests. By setting fruit:encoding = native, all mapped characters are converted to native ASCII characters.
Finally, share access modes are optionally checked against Netatalk AFP sharing modes by setting fruit:locking = netatalk.
This module is not stackable other than described in this manpage.
GLOBAL OPTIONS
The following options must be set in the global smb.conf section and won't take effect when set per share.
fruit:aapl = yes | no
fruit:nfs_aces = yes | no
fruit:copyfile = yes | no
WARNING: the copyfile request is blocking the client while the server does the copy.
The default is no.
fruit:model = MacSamba
The default is MacSamba.
OPTIONS
The following options can be set either in the global smb.conf section or per share.
fruit:resource = [ file | xattr | stream ]
Due to a spelling bug in all Samba versions older than 4.6.0, this option can also be given as fruit:ressource, ie with two s.
Settings:
fruit:time machine = [ yes | no ]
fruit:time machine max size = SIZE [K|M|G|T|P]
IMPORTANT: This is an approximated calculation that only takes into account the contents of Time Machine sparsebundle images. Therefore you MUST NOT use this volume to store other content when using this option, because it would NOT be accounted.
The calculation works by reading the band size from the Info.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other.
fruit:metadata = [ stream | netatalk ]
fruit:locking = [ netatalk | none ]
fruit:encoding = [ native | private ]
Important: this is known to not fully work with fruit:metadata=stream or fruit:resource=stream.
fruit:veto_appledouble = yes | no
When fruit:resource is set to file, vfs_fruit may create ._ AppleDouble files. This options controls whether these ._ AppleDouble files are vetoed which prevents the client from accessing them.
Vetoing ._ files may break some applications, e.g. extracting Mac ZIP archives from Mac clients fails, because they contain ._ files. rsync will also be unable to sync files beginning with underscores, as the temporary files it uses for these will start with ._ and so cannot be created.
Setting this option to false will fix this, but the abstraction leak of exposing the internally created ._ files may have other unknown side effects.
The default is yes.
fruit:posix_rename = yes | no
The default is yes.
readdir_attr:aapl_rsize = yes | no
The default is yes.
readdir_attr:aapl_finder_info = yes | no
The default is yes.
readdir_attr:aapl_max_access = yes | no
The default is yes.
fruit:wipe_intentionally_left_blank_rfork = yes | no
The default is no.
fruit:delete_empty_adfiles = yes | no
The default is no.
fruit:zero_file_id = yes | no
Mac applications and / or the Mac SMB client code expect the on-disk file identifier to have the semantics of HFS+ Catalog Node Identifier (CNID). Samba provides File-IDs based on a file's inode number which gets recycled across file creation and deletion and can therefore not be used for Mac client. Returning a file identifier of zero causes the Mac client to stop using and trusting the file id returned from the server.
The default is yes.
fruit:convert_adouble = yes | no
The default is yes.
fruit:validate_afpinfo = yes | no
The default is yes.
EXAMPLES
[share] vfs objects = catia fruit streams_xattr fruit:resource = file fruit:metadata = netatalk fruit:locking = netatalk fruit:encoding = native
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.
09/04/2024 | Samba 4.21.0 |