TrueNAS SCALETrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

NFS Shares Screens

The Sharing screen opens after you click Shares on the main navigation panel.

Unix (NFS) Share Widget

The Unix (NFS) Share launch widget includes the widget toolbar that displays the status of the NFS service and the Add button. After adding NFS shares, the widget displays a list of the shares below the toolbar.

Unix (NFS) Share Widget
Figure 1: Unix (NFS) Share Widget

After adding the first NFS share, the system opens an enable service dialog.

Unix Enable Service
Figure 2: Unix Enable Service

Enable Service turns the NFS service on and changes the toolbar status to Running.

The Enable toggle for each share shows the current status of the share. Disabling the share does not delete the configuration from the system.

The delete delete icon displays a delete confirmation dialog that removes the share from the system.

Unix (NFS) Share Delete
Figure 3: Unix (NFS) Share Delete

Click on Unix (NFS) Share to open the Sharing > NFS screen with the list view of NFS shares.

The NFS share on the widget opens the Edit NFS screen.

Add opens the Add NFS screen.

Unix (NFS) Share Widget Options
Figure 4: Unix (NFS) Share Widget Options

The more_vert icon displays three options available to NFS shares in general:

  • Turn Off Service what shows when the NFS service is enabled and that toggles to Turn On Service when the NFS service is disabled.
  • Config Service that opens the System Settings > NFS.
  • NFS Sessions that opens the NFS Sessions screen.

The toolbar displays the STOPPED service status in red before you start the service or click Enable Service when the dialog displays. When service starts, it displays RUNNING in blue.

Sharing NFS Details Screen

The Sharing > NFS details screen displays the same list of NFS shares as the Unix (NFS) Share widget.

Customize the information using the Columns dropdown list. Select from the Unselect All, Description, Enabled, and Reset to Defaults options.

Each share includes these options:

  • Edit opens the Edit NFS configuration screen.
  • Delete opens an Unshare path confirmation dialog.
Sharing NFS Delete
Figure 5: Sharing NFS Delete

Select Confirm and then UNSHARE to remove the share without affecting the data in the shared dataset.

Add and Edit NFS Screens

The Add NFS and Edit NFS display the same Basic Options and Advanced Options settings.

The UDP protocol is deprecated and not supported with NFS. It is disabled by default in the Linux kernel. Using UDP over NFS on modern networks (1Gb+) can lead to data corruption caused by fragmentation during high loads.

Basic Options Settings

The Basic Options settings display by default and also show in the Advanced Options settings.

Add NFS Basic Options
Figure 6: Add NFS Basic Options

Browsing to select a path

Click the arrow to the left of the folder icon to expand that folder and show any child datasets and directories. A solid folder icon shows for datasets and an outlined folder for directories. A selected dataset or directory folder and name shows in blue.

PathEnter 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/mntClick 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.
Create DatasetClick to open the Create Dataset dialog. Enter a name to create a new dataset for the share. Click Create to add the dataset and populate the Name field on the Add NFS screen.
DescriptionEnter any notes or reminders about the share.
EnabledSelect to enable this NFS share. Clear the checkbox to disable this NFS share without deleting the configuration.
Add networksClick Add to display the Authorized Networks IP address and CIDR fields. Enter an allowed network IP and select the mask CIDR notation. Click Add for each network address and CIDR you want to define as an authorized network. Defining an authorized network restricts access to all other networks. Leave empty to allow all networks.
Add hostsClick Add to display the Authorized Hosts and IP addresses field. Enter a host name or IP address to allow that system access to the NFS share. Click Add for each allowed system you want to define. Defining authorized systems restricts access to all other systems. Leave the field empty to allow all systems access to the share.

Advanced Options Settings

Advanced Options settings tune the share access permissions and define authorized networks. Only the Access settings display on the Advanced Options screen.

Add NSF Advanced Options Access Settings
Figure 8: Add NSF Advanced Options Access Settings
Read-OnlySelect to prohibit writing to the share.
Maproot UserEnter a string or select a user from the dropdown to apply permissions for that user to the root user.
Maproot GroupEnter a string or select a group from the dropdown to apply permissions for that group to the root user.
Mapall UserEnter a string or select a user to apply permission for the chosen user to all clients.
Mapall GroupEnter a string or select a group to apply permission for the chosen group to all clients.
SecuritySelect a security option from the dropdown list. Options are SYS, KRB5, KRB5I, KRB5P. Selecting KRB5 allows you to use a Kerberos ticket.

Security Types

SYSUses locally acquired UIDs and GIDs. No cryptographic security.
KRB5Uses Kerberos for authentication.
KRB5IUses Kerberos for authentication and includes a hash with each transaction to ensure integrity.
KRB5PUses Kerberos for authentication and encrypts all traffic between the client and server. KRB5P is the most secure but also incurs the most load.

NFS Sessions Screen

You can access the NFS Sessions screen from the NFS option on the System Settings > Services screen with the icon and from the more_vert on the Shares > Unix (NFS) Shares widget.

NFS Sessions Screen
Figure 9: NFS Sessions Screen

The NFS Sessions screen shows current NFS sessions.

Refresh updates the information displayed on the screen.

Column displays a dropdown list of options for the selected tab to customize the information included on the screen.

Click Sharing on the top breadcrumb to open the Shares dashboard.