TrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

SMB Shares Screens

12 minute read.

Last Modified 2024-02-15 08:29 EST

The first SMB share screen to display after you click Shares is the Sharing screen with the service widgets for the four supported share types.

If you have not added SMB shares to the system, clicking the Windows (SMB) Shares option on the Sharing screen displays the No SMB Shares have been configured yet screen with the Add SMB Share button in the center of the screen.

SMBShareScreenNoShare

Use this button or the Add button at the top right of the screen to configure your first SMB share. After adding the first SMB share, the Sharing SMB screen displays.

If you return to the Share option (click Shares on the main navigation panel), the Windows (SMB) Shares launch widget displays. It includes the current service status and a list of the SMB shares below it.

The Windows (SMB) Shares launch widget updates after adding SMB shares. It also updates when you click Shares on the main navigation panel to return to the Sharing screen.

SharingSMBServiceStatusScreen

Click Here for More SMB Shares Widget Information

Each SMB share toggle provides quick access to enable or disable the share.

The share Edit Share ACL icon displays the Edit Share ACL screen.

The security Edit Filesystem ACL icon opens the Edit Filesystem ACL screen.

Each share also has a delete delete option.

The SMB share row is a link to the Edit SMB screen.

The Windows (SMB) Shares launch toolbar displays the status of the SMB service as either STOPPED (red) or RUNNING (blue). Before adding the first share, the STOPPED status displays in the default color.

Both Windows (SMB) Shares and View Details at the bottom of the widget display the Sharing > SMB details screen.

The Add button displays the Add SMB share configuration screen.

The more_vert displays options to turn the SMB service on or off. Turn Off Service displays if the service is running, otherwise, Turn On Service displays. The Config Service option displays the System Settings > SMB configuration screen.

The delete trash can icon displays the Delete dialog.

Select Confirm to activate the Delete button.

Windows SMB Share launch displays The Sharing >SMB details screen. From this screen, you can add or edit an SMB share on the list.

SharingSMBScreen

Add displays the Add SMB configuration screen.

The Columns button displays a set of options to customize the list view. Options include Unselect All, Path, Description, Enabled and Reset to Defaults.

The Enabled checkbox provides the share status. If selected, it indicates the share path is available when the SMB service is active. If cleared, it disables but does not delete the share.

The more_vert displays a dropdown list of options for each share. The Edit displays the Edit SMB screen, Edit Share ACL displays the Edit Share ACL screen, Edit Filesystem ACL opens the Edit Filesystem ACL screen, and Delete displays the Delete dialog.

Add and Edit SMB Screens

The two SMB share configuration screens, Add SMB and Edit SMB, display the same setting options.

Click Save to create the share (or save an existing one) and add it to the Shares > Windows (SMB) Shares and Sharing SMB details lists.

Basic Options Settings

The Basic Options settings in this section display on the Advanced Options settings screen.

Setting	Description
Path	Enter the path or use the arrow_right icon to the left of folder/mnt to locate the dataset and populate the path. Path is the directory tree on the local file system that TrueNAS exports over the SMB protocol.
folder/mnt	Click the arrow_right icon to expand the path at each dataset until you get to the SMB share dataset you want to use. This populates the Path.
Name	Enter a name for this share that is less than or equal to 80 characters. Because of how the SMB protocol uses the name, the name must not exceed 80 characters. The name cannot have invalid characters as specified in Microsoft documentation MS-FSCC section 2.1.6. If not supplied, the share name becomes the last component of the path. This forms part of the full share path name when SMB clients perform and SMB tree connect. If you change the name, follow the naming conventions for files and directories or share names.
Purpose	Select a preset option from the dropdown list. The option applies predetermined settings (presets) and disables changing some share setting options.
Description	Enter a brief description or notes on how you use this share.
Enabled	Selected by default to enable sharing the path when the SMB service is activated. Clear to disable this SMB share without deleting it.

Purpose Setting Options

This table details the options found on the Purpose dropdown list.

Setting	Description
No presets	Select to retain control over all Advanced Options settings.
Default parameters for cluster share	Select when setting up an SMB cluster share.
Default share parameters	The default option when you open the Add SMB screen and to use for any basic SMB share.
Basic time machine share	Select to set up a basic time machine share.
Multi-User time machine	Select to set up a multi-user time machine share.
Multi-Protocol (NFSv3/SMB) shares	Select for multi-protocol (NFSv3/SMB) shares.
Private SMB Datasets and Shares	Select to use private SMB datasets and shares.
SMB WORM. Files become read-only via SMB after 5 minutes	The SMB WORM preset only impacts writes over the SMB protocol. Before deploying this option in a production environment, the user should determine whether the feature meets their requirements.

Advanced Options Settings

Click Advanced Options to display settings made available or locked based on the option selected in Purpose.

Access Settings

The Access settings let you customize access to the share and files. They also let you specify allow or deny access for host names or IP addresses.

Setting	Description
Enable ACL	Select to enable ACL support for the SMB share. A warning displays if you clear this option and the SMB dataset has an ACL, and you are required to strip the ACL from the dataset prior to creating the SMB share.
Export Read-Only	Select to prohibit writes to the share.
Browsable to Network Clients	Select to determine whether this share name is included when browsing shares. Home shares are only visible to the owner regardless of this setting. Enabled by default.
Allow Guest Access	Select to enable. Privileges are the same as the guest account. Guest access is disabled by default in Windows 10 version 1709 and Windows Server version 1903. Additional client-side configuration is required to provide guest access to these clients. MacOS clients: Attempting to connect as a user that does not exist in FreeNAS does not automatically connect as the guest account. You must specifically select the Connect As: Guest option in macOS to log in as the guest account. See the Apple documentation for more details.
Access Based Share Enumeration	Select to restrict share visibility to users with read or write access to the share. See the smb.conf manual page.
Hosts Allow	Enter a list of allowed host names or IP addresses. Separate entries by pressing `Enter`. You can find a more detailed description with examples here.
Hosts Deny	Enter a list of denied host names or IP addresses. Separate entries by pressing `Enter`.

Other Settings

The Other Options settings are for improving Apple software compatibility, ZFS snapshot features, and other advanced features.

Setting	Description
Use as Home Share	Select to allow the share to host user home directories. Each user has a personal home directory they use when connecting to the share that is not accessible by other users. Home Shares allow for personal, dynamic shares. You can only use one share as the home share. See Adding an SMB Home Share for more information.
Time Machine	Enables Apple Time Machine backups on this share. This option requires SMB2/3 protocol extension support. You can enable this in the general SMB server configuration.
Legacy AFP Compatibility	Select to enable the share to behave like the deprecated Apple Filing Protocol (AFP). Leave cleared for the share to behave like a normal SMB share. This option controls how the SMB share reads and writes data. Only enable this when this share originated as an AFP sharing configuration. You do not need legacy compatibility for pure SMB shares or macOS SMB clients. This option requires SMB2/3 protocol extension support. You can enable this in the general SMB server configuration.
Enable Shadow Copies	Select to export ZFS snapshots as Shadow Copies for Microsoft Volume Shadow Copy Service (VSS) clients.
Export Recycle Bin	Select to enable. Deleted files from the same dataset move to a Recycle Bin in that dataset and do not take any additional space.
Use Apple-style Character Encoding	Select to convert NTFS illegal characters in the same manner as macOS SMB clients. By default, Samba uses a hashing algorithm for NTFS illegal characters.
Enable Alternate Data Streams	Select to allow multiple NTFS data streams. Disabling this option causes macOS to write streams to files on the file system.
Enable SMB2/3 Durable Handles	Select to allow using open file handles that can withstand short disconnections. Support for POSIX byte-range locks in Samba is also disabled. We don’t recommend this option when configuring multi-protocol or local access to files.
Enable FSRVP	Select to enable support for the File Server Remote VSS Protocol (FSVRP). This protocol allows remote procedure call (RPC) clients to manage snapshots for a specific SMB share. The share path must be a dataset mount point. Snapshots have the prefix `fss-` followed by a snapshot creation timestamp. A snapshot must have this prefix for an RPC user to delete it.
Path Suffix	Appends a suffix to the share connection path. Use this to provide individualized shares on a per-user, per-computer, or per-IP address basis. Suffixes can contain a macro. See the smb.conf manual page for a list of supported macros. The connect path must be preset before a client connects.

Advanced Options Presets

The Purpose setting you select in the Basic Options affects which Advanced Options settings (presets) you can select. Some presets are available or locked based on your choice. The expandable below provides a comparison table that lists these presets and shows whether the option is available or locked.

What do all the presets do?

The following table shows the preset options for the different Purpose options and if those are locked.
A indicates the option is enabled while means the option is disabled. [ ] indicates empty text fields, and [%U] indicates the option the preset created.

Setting	Default Share Parameters	Multi-User Time Machine	Multi-Protocol (NFSv3/SMB) Shares	Private SMB Datasets and Shares	SMB Files become Read Only after 5 minutes
Enable ACL	(locked)		(locked)
Export Read Only	(locked)
Browsable to Network Clients	(locked)
Allow Guest Access
Access Based Share Enumeration	(locked)
Hosts Allow	(locked)
Hosts Deny	(locked)
Use as Home Share	(locked)
Time Machine	(locked)
Enable Shadow Copies	(locked)
Export Recycle Bin	(locked)
Use Apple-style Character Encoding	(locked)
Enable Alternate Data Streams	(locked)		(locked)
Enable SMB2/3 Durable Handles	(locked)		(locked)
Enable FSRVP	(locked)
Path Suffix	[ ] (locked)	[%U] (locked)	[%U]	[%U] (locked)	[ ] (locked)

Back to Advanced Options Settings

The SMB Share ACL screen displays when you click Edit Share ACL from the more_vert options list on the Sharing SMB details screen. These settings configure new ACL entries for the selected SMB share and apply them at the entire SMB share level. It is separate from file system permissions.

SMBShareACLScreen

ACL Entries Settings

ACL Entries are listed as a block of settings. Click Add to add a new entry.

Setting	Description
SID	Shows the SID trustee value (who) this ACL entry (ACE) applies to. SID is a unique value of variable length that identifies the trustee. Shown as a Windows Security Identifier. Click Save and re-open Edit Share ACL to update.
Who	Select the domain for account(s) (who) this ACL entry applies to. Options are User, Group, and everyone@.
User	Enter or select from the dropdown a user (who) this ACL entry applies to, shown as a user name. Available when Who is set to User.
Group	Enter or select from the dropdown a group (who) this ACL entry applies to, shown as a group name. Available when Who is set to Group.
Permission	Select predefined permission combinations from the dropdown list. Select FULL to grant read access, execute permission, write access, delete objects, change permissions, and take ownership (RXWDPO) permissions. Select CHANGE to grant read access, execute permission, write access, and delete object (RXWD) permissions. Select READ to grant read access and execute permission on the object (RX). For more details, see smbacls(1).
Type	Select the option from the dropdown list that specifies how TrueNAS applies permissions to the share. Select ALLOWED to deny all permissions by default, except manually defined permissions. Select DENIED to allow all permissions by default, except manually defined permissions.

Save stores the share ACL and immediately applies it to the share.

Edit Filesystem ACL Screen

Edit Filesystem ACL opens Datasets > Edit ACL screen for the shared dataset.

SMBACLEditor

The ACL editor screen lets you set permissions for the shared dataset. See Edit ACL Screens or Permissions for more information on configuring permissions.

SMB Shares Screens

Windows (SMB) Shares Widget

Add and Edit SMB Screens