Adding a Basic Time Machine SMB Share

SCALE uses predefined setting options to establish an SMB share that fits a predefined purpose, such as a basic time machine share.

Setting Up a Basic Time Machine SMB Share

To set up a basic time machine share:

  1. Create the user(s) that use this share. Go to Credentials > Local User and click Add.

  2. Create a dataset for the share to use.

  3. Modify the SMB service settings.

  4. Create the share with Purpose set to Basic time machine share.

After creating the share, enable the SMB service.

Creating the Dataset for the Share

When adding a share, first create the dataset you plan to use for the new share.

To create a dataset using the default settings, go to Datasets. Default settings include the settings datasets inherit from the parent dataset.

Select a dataset (root, parent, or child), then click Add Dataset.

Enter a value in Name.

For the Sync option, we recommend production systems with critical data use the default Standard choice or increase to Always. Choosing Disabled is only suitable in situations where data loss from system crash or power loss is acceptable.

Select either Sensitive or Insensitive from the Case Sensitivity dropdown.

Select the Share Type, then click Save. Options are Generic, Multiprotocol, SMB, or Apps.

You can create datasets optimized for SMB shares or with customized settings for your dataset use cases.

If you plan to deploy container applications, the system automatically creates the ix-applications dataset, but it is not used for application data storage. If you want to store data by application, create the dataset first, then deploy your application. When creating a dataset for an application, select App as the Share Type setting. This optimizes the dataset for use by an application.

Review the Share Type and Case Sensitivity options on the configuration screen before clicking Save. You cannot change these or the Name setting after clicking Save.

Select this dataset as the mount path when you create your SMB share that uses the Basic time machine share setting.

Modify the SMB Service

Go to System Settings > Services and scroll down to SMB.

  1. Click the toggle to turn off the SMB service if it is running, then click Configure to open the SMB Service settings screen..

  2. Click Advanced Settings.

  3. Verify or select Enable Apple SMB2/3 Protocol Extension to enable it, then click Save

  4. Click the toggle to restart the SMB service.

Create the Basic Time Machine SMB Share

Go to Shares and click Add on the Windows SMB Share widget to open the Add SMB Share screen.

  1. Enter the SMB share Path and Name.

    The Path is the directory tree on the local file system that TrueNAS exports over the SMB protocol.

    The Name is the SMB share name, which forms part of the full share pathname when SMB clients perform an SMB tree connect. Because of how the SMB protocol uses the name, it must be less than or equal to 80 characters. It cannot have invalid characters as specified in Microsoft documentation MS-FSCC section 2.1.6. If you do not enter a name, the share name becomes the last component of the path. If you change the name, follow the naming conventions for:

  2. Select a Basic time machine share from the Purpose dropdown list.

  3. (Optional) Enter a Description to help explain the share purpose.

  4. Select Enabled to allow sharing of this path when the SMB service is activated. Leave it cleared if you want to disable the share without deleting the configuration.

  5. Click Save to create the share and add it to the Shares > Windows (SMB) Shares list.

You can also choose to enable the SMB service at this time.