Skip to content

Commit

Permalink
DOCS-3751 updated SMBShareScreen.md
Browse files Browse the repository at this point in the history
Grammar check corrections.
  • Loading branch information
clairewrtr committed Aug 11, 2022
1 parent e9457ec commit f68c6ce
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions content/CORE/UIReference/Sharing/SMB/SMBShareScreen.md
Expand Up @@ -8,7 +8,7 @@ tags:

{{< toc >}}

Server Message Block (SMB) is a file sharing protocol utilized by Windows and other operating systems.
Server Message Block (SMB) is a file sharing protocol. Windows and other operating systems use SMB.

Go to **Sharing > Windows Shares (SMB)** to display the **SMB** screen and setup SMB shares on your TrueNAS.

Expand All @@ -26,9 +26,9 @@ Click **Add** to display the **BASIC Options** settings screen.
|---------|--------------|
| **Path** | Use the file browser or click the **/mnt** to select the pool, dataset or directory to share. |
| **Name** | Enter a name for the SMB share. |
| **Purpose** | Select a preset configuration to lock in predetermined values for the share using **Advanced Options**, including the **Path Suffix**. Select from the dropdown list. Options are: **No presets**, **Default share parameters**, **Multi-user time machine**, **Multi-protocol (AFP/SMB) shares**, **Multi-protocol (NFSv3/SMB) shares**, **Private SMB Datasets and Shares** or **SMB WORM. Files become readonly via SMB after 5 minutes**. See "What do all the presets do?" for more information on presets.|
| **Purpose** | Select a preset purpose configuration. This locks in predetermined values for the share. This includes **Advanced Options**, as well as the **Path Suffix**. Select from the dropdown list. Options are:<br>**No presets**<br>**Default share parameters**<br>**Multi-user time machine**<br>**Multi-protocol (AFP/SMB) shares**<br>**Multi-protocol (NFSv3/SMB) shares**<br>**Private SMB Datasets and Shares**<br>**SMB WORM. Files become readonly via SMB after 5 minutes**<br>See "What do all the presets do?" for more information on presets.|
| **Description** | Optional. Explains the purpose of the share. |
| **Enabled** | Select to allow this path to be shared when the SMB service is activated. Clear checkbox to disable the share without deleting the configuration. |
| **Enabled** | Select to enable this SMB share. Clear checkbox to disable the share without deleting the configuration. |

{{< expand "What do all the presets do?" "v" >}}
The following table shows the preset options for the different **Purposes** and if those options are locked.
Expand Down Expand Up @@ -59,43 +59,43 @@ An [x] indicates the option is enabled, [ ] means the option is disabled, and [t

![SharingSMBAdvancedOptions](/images/CORE/13.0/SharingSMBAdvancedOptions.png "SMB Share Advanced Options")

Options are divided into **Access** and **Other Options** groups.
**Access** options control various settings for allowing systems or users to access or modify the shared data.
**Access** and **Other Options** are the two options groups.
**Access** settings allow systems or users to access or change the shared data.

| Name | Description |
|---------|-------------|
| **Enable ACL** | Select to add Access Control List (ACL) support to the share. Leaving checkbox cleared disables ACL support and deletes any existing ACL for the share. |
| **Enable ACL** | Select to add Access Control List (ACL) support to the share. Leave checkbox clear to disable ACL support and delete any existing ACL for the share. |
| **Export Read Only** | Select to prohibit writes to the share. Leave checkbox clear to allow 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. |
| **Allow Guest Access** | Select to make privileges 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.<br><br> **MacOS clients**: Attempting to connect as a user that does not exist in FreeNAS *does not* automatically connect as the guest account. The **Connect As: Guest** option must be specifically chosen in MacOS to log in as the guest account. See the [Apple documentation](https://support.apple.com/guide/mac-help/connect-mac-shared-computers-servers-mchlp1140/mac) for more details. |
| **Browsable to Network Clients** | Select to include this share name when browsing shares. Home shares are only visible to the owner regardless of this setting. |
| **Allow Guest Access** | Select to make privileges the same as the guest account. Windows 10 version 1709 and Windows Server version 1903 have disabled guest access. Guest access for these clients requires extra client-side configuration.<br><br> **MacOS clients**: Trying to connect as a user that does not exist in TrueNAS does not default to the guest account. The **Connect As: Guest** option must be specifically chosen in MacOS to log in as the guest account. See the [Apple documentation](https://support.apple.com/guide/mac-help/connect-mac-shared-computers-servers-mchlp1140/mac) 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](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html) manual page. |
| **Hosts Allow** | Enter a list of allowed host names or IP addresses. Separate entries by pressing <kbd>Enter</kbd>. A more detailed description with examples see [here](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html#HOSTSALLOW).
| **Hosts Deny** | Enter a list of denied host names or IP addresses. Separate entries by pressing <kbd>Enter</kbd>. |

{{< expand "Host Allow and Hosts Deny Fields" >}}
The **Hosts Allow** and **Hosts Deny** fields work together to produce different situations:
* If neither **Hosts Allow** or **Hosts Deny** contain an entry, then SMB share access is allowed for any host.
* If neither **Hosts Allow** or **Hosts Deny** contain an entry, then allow SMB share access for any host.
* If there is an entry in **Hosts Allow** list but none in **Hosts Deny** list, then only allow hosts on the **Hosts Allow** list.
* If there is an entry in **Hosts Deny** list but none in **Hosts Allow** list, then allow all hosts that are not on the **Hosts Deny** list.
* If there are both an entry in **Hosts Allow** and **Hosts Deny** list, then allow all hosts that are on the **Hosts Allow** list. If there is a host not on the **Hosts Allow** and not on the **Hosts Deny** list, then allow it.
{{< /expand >}}

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

| Name | Description |
|---------|-------------|
| **Use as Home Share** | Select to allow the share to host user home directories. Each user is given a personal home directory when connecting to the share which is not accessible by other users. This allows for a personal, dynamic share. Only one share can be used as the home share. See the configuring [Home Share article]({{< relref "/CORE/CORETutorials/Sharing/SMB/HomeShare.md" >}}) for detailed instructions. |
| **Use as Home Share** | Select to allow the share to host user home directories. Gives each user a personal home directory when connecting to the share. This personal home directory is not accessible by other users. This allows for a personal, dynamic share. It is only possible to use one share as the home share. See the configuring [Home Share article]({{< relref "/CORE/CORETutorials/Sharing/SMB/HomeShare.md" >}}) for detailed instructions. |
| **Time Machine** | Select to enable [Apple Time Machine](https://support.apple.com/en-us/HT201250) backups on this share. |
| **Enable Shadow Copies** | Select to allow export ZFS snapshots as [Shadow Copies](https://docs.microsoft.com/en-us/windows/win32/vss/shadow-copies-and-shadow-copy-sets) for Microsoft Volume Shadow Copy Service (VSS) clients. |
| **Export Recycle Bin** | Select to allow files that are deleted from the same dataset to be moved to the Recycle Bin and not take any additional space. Deleting files over NFS removes the files permanently! When the files are in a different dataset or a child dataset, they are copied to the dataset where the Recycle Bin is located. To prevent excessive space usage, files larger than 20 MiB are deleted rather than moved. Adjust the **Auxiliary Parameter** `crossrename:sizelimit=` setting to allow larger files. For example, <code>crossrename:sizelimit=<i>50</i></code> allows moves of files up to 50 MiB in size. This means files can be permanently deleted or moved from the recycle bin. This is not a replacement for ZFS snapshots! |
| **Export Recycle Bin** | When selected, moves files deleted from the same dataset to the Recycle Bin. These files do not take any extra space. Deleting files over NFS is a permanent deletion! For files in a different dataset or a child dataset there is an extra step. These files are first copied to the dataset where the Recycle Bin is located. To prevent excessive space usage, deletes files larger than 20 MiB instead of moving them. Adjust the **Auxiliary Parameter** `crossrename:sizelimit=` setting to allow larger files. For example, <code>crossrename:sizelimit=<i>50</i></code> allows moves of files up to 50 MiB in size. This means files can be permanently deleted or moved from the recycle bin. This is not a replacement for ZFS snapshots! |
| **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](https://www.ntfs.com/ntfs-multiple.htm). 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. This option is not recommended when configuring multi-protocol or local access to files. |
| **Enable FSRVP** | Select to enable support for the File Server Remote VSS Protocol ([FSVRP](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-fsrvp/dae107ec-8198-4778-a950-faa7edad125b)). This protocol allows Remote Procedure Call (RPC) clients to manage snapshots for a specific SMB share. The share path must be a dataset mountpoint. 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. This provides unique shares on a per-user, per-computer, or per-IP address basis. Suffixes can contain a macro. See the [smb.conf](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html) manual page for a list of supported macros. The connectpath must be preset before a client connects. |
| **Auxiliary Parameters** | Additional [smb.conf](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html) settings. |

Use **Submit** to save setings, create the share and add it to the **Sharing > Windows Shares (SMB)** list.
Click **Submit** to save setings. This creates the share and adds it to the **Sharing > Windows Shares (SMB)** list.

Click **CANCEL** to exit without saving and return to the main **SMB** screen.

Expand Down

0 comments on commit f68c6ce

Please sign in to comment.